Skip to content

Support all address types #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ben-kaufman wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Support all address types #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions Bitkit.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,6 @@
};
/* End PBXCopyFilesBuildPhase section */

/* Begin PBXShellScriptBuildPhase section */
96EMBED0012026012000FRAME /* Remove Static Framework Stubs */ = {
isa = PBXShellScriptBuildPhase;
buildActionMask = 2147483647;
files = (
);
inputFileListPaths = (
);
inputPaths = (
);
name = "Remove Static Framework Stubs";
outputFileListPaths = (
);
outputPaths = (
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# Remove static framework stubs from app bundle\\n# LDKNodeFFI is a static library - its code is linked into the main executable.\\n# The empty framework structure causes iOS install errors.\\nFRAMEWORK_PATH=\"${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app/Frameworks/LDKNodeFFI.framework\"\\n\\nif [ -d \"$FRAMEWORK_PATH\" ]; then\\n echo \"Removing LDKNodeFFI static framework stub...\"\\n rm -rf \"$FRAMEWORK_PATH\"\\n echo \"Done.\"\\nfi\\n";
};
/* End PBXShellScriptBuildPhase section */

/* Begin PBXFileReference section */
961058DC2C355B5500E1F1D8 /* BitkitNotification.appex */ = {isa = PBXFileReference; explicitFileType = "wrapper.app-extension"; includeInIndex = 0; path = BitkitNotification.appex; sourceTree = BUILT_PRODUCTS_DIR; };
96FE1F612C2DE6AA006D0C8B /* Bitkit.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Bitkit.app; sourceTree = BUILT_PRODUCTS_DIR; };
Expand Down Expand Up @@ -443,6 +422,27 @@
};
/* End PBXResourcesBuildPhase section */

/* Begin PBXShellScriptBuildPhase section */
96EMBED0012026012000FRAME /* Remove Static Framework Stubs */ = {
isa = PBXShellScriptBuildPhase;
buildActionMask = 2147483647;
files = (
);
inputFileListPaths = (
);
inputPaths = (
);
name = "Remove Static Framework Stubs";
outputFileListPaths = (
);
outputPaths = (
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# Remove static framework stubs from app bundle\\n# LDKNodeFFI is a static library - its code is linked into the main executable.\\n# The empty framework structure causes iOS install errors.\\nFRAMEWORK_PATH=\"${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app/Frameworks/LDKNodeFFI.framework\"\\n\\nif [ -d \"$FRAMEWORK_PATH\" ]; then\\n echo \"Removing LDKNodeFFI static framework stub...\"\\n rm -rf \"$FRAMEWORK_PATH\"\\n echo \"Done.\"\\nfi\\n";
};
/* End PBXShellScriptBuildPhase section */

/* Begin PBXSourcesBuildPhase section */
961058D82C355B5500E1F1D8 /* Sources */ = {
isa = PBXSourcesBuildPhase;
Expand Down Expand Up @@ -925,8 +925,8 @@
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/synonymdev/ldk-node";
requirement = {
branch = main;
kind = branch;
kind = revision;
revision = 2281589d699cb6f821f1ad720435c8110cf1fa7c;
};
};
96DEA0382DE8BBA1009932BF /* XCRemoteSwiftPackageReference "bitkit-core" */ = {
Expand Down
3 changes: 1 addition & 2 deletions Bitkit.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Bitkit/MainNavView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,7 @@ struct MainNavView: View {

// Advanced settings
case .coinSelection: CoinSelectionSettingsView()
case .addressTypePreference: AddressTypePreferenceView()
case .connections: LightningConnectionsView()
case let .connectionDetail(channelId): LightningConnectionDetailView(channelId: channelId)
case let .closeConnection(channel: channel): CloseConnectionConfirmation(channel: channel)
Expand Down
134 changes: 87 additions & 47 deletions Bitkit/Services/CoreService.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ class ActivityService {
// MARK: - Constants

/// Maximum address index to search when current address exists
private static let maxAddressSearchIndex: UInt32 = 100_000
private static let maxAddressSearchIndex: UInt32 = 1000
/// Lock to prevent concurrent address searches
private let addressSearchLock = NSLock()
private var isSearchingAddresses = false

// MARK: - BoostTxIds Cache

Expand Down Expand Up @@ -124,10 +127,8 @@ class ActivityService {
}

func isOnchainActivitySeen(txid: String) async -> Bool {
if let activity = try? await getOnchainActivityByTxId(txid: txid) {
return activity.seenAt != nil
}
return false
let activity = try? await getOnchainActivityByTxId(txid: txid)
return activity?.seenAt != nil
}

func markActivityAsSeen(id: String, seenAt: UInt64? = nil) async {
Expand Down Expand Up @@ -348,7 +349,7 @@ class ActivityService {
_ payment: PaymentDetails,
transactionDetails: BitkitCore.TransactionDetails? = nil
) async throws {
guard case let .onchain(txid, _) = payment.kind else { return }
guard case let .onchain(txid, txStatus) = payment.kind else { return }

let paymentTimestamp = payment.latestUpdateTimestamp

Expand All @@ -358,10 +359,15 @@ class ActivityService {
existingActivity = try BitkitCore.getActivityByTxId(txId: txid).map { .onchain($0) }
}

// Skip if existing activity has newer timestamp to avoid overwriting local data
// Determine if confirmation status is changing
let ldkConfirmed = if case .confirmed = txStatus { true } else { false }

// Skip if existing activity has newer timestamp, unless confirmation status is changing
if let existingActivity, case let .onchain(existing) = existingActivity {
let existingUpdatedAt = existing.updatedAt ?? 0
if existingUpdatedAt > paymentTimestamp {
let confirmationStatusChanging = existing.confirmed != ldkConfirmed

if existingUpdatedAt > paymentTimestamp && !confirmationStatusChanging {
return
}
}
Expand Down Expand Up @@ -396,6 +402,7 @@ class ActivityService {
let doesExist = existingOnchain?.doesExist ?? true
let seenAt = existingOnchain?.seenAt

// Preserve existing value if it's larger than what LDK reports
let ldkValue = payment.amountSats ?? 0
let value: UInt64 = if let existingValue = existingOnchain?.value, existingValue > ldkValue {
existingValue
Expand Down Expand Up @@ -487,7 +494,7 @@ class ActivityService {
}
return false
}) else {
Logger.warn("Payment not found for transaction \(txid) - LDK should have updated payment store before emitting event", context: context)
Logger.warn("Payment not found for transaction \(txid)", context: context)
return
}

Expand Down Expand Up @@ -659,17 +666,20 @@ class ActivityService {
let existingActivity = try getActivityById(activityId: payment.id)
let existingLightning: LightningActivity? = if let existingActivity, case let .lightning(ln) = existingActivity { ln } else { nil }

// Skip if existing activity has newer timestamp to avoid overwriting local data
if let existingUpdatedAt = existingLightning?.updatedAt, existingUpdatedAt > paymentTimestamp {
return
}

let state: BitkitCore.PaymentState = switch payment.status {
case .failed: .failed
case .pending: .pending
case .succeeded: .succeeded
}

// Skip if existing activity has newer timestamp, unless payment status is changing
if let existing = existingLightning, let existingUpdatedAt = existing.updatedAt {
let statusChanging = existing.status != state
if existingUpdatedAt > paymentTimestamp && !statusChanging {
return
}
}

let ln = LightningActivity(
id: payment.id,
txType: payment.direction == .outbound ? .sent : .received,
Expand Down Expand Up @@ -780,18 +790,10 @@ class ActivityService {
switch sweepBalance {
case let .broadcastAwaitingConfirmation(channelId, _, latestSpendingTxid, _):
if latestSpendingTxid.description == txid, let channelId {
Logger.info(
"Matched sweep tx \(txid) to channel \(channelId) via pendingSweepBalance (awaiting confirmation)",
context: "findClosedChannelForTransaction"
)
return channelId.description
}
case let .awaitingThresholdConfirmations(channelId, latestSpendingTxid, _, _, _):
if latestSpendingTxid.description == txid, let channelId {
Logger.info(
"Matched sweep tx \(txid) to channel \(channelId) via pendingSweepBalance (threshold confirmations)",
context: "findClosedChannelForTransaction"
)
return channelId.description
}
case .pendingBroadcast:
Expand Down Expand Up @@ -892,6 +894,20 @@ class ActivityService {
private func findReceivingAddress(for txid: String, value: UInt64,
transactionDetails: BitkitCore.TransactionDetails? = nil) async throws -> String?
{
// Prevent concurrent searches that could cause infinite loops
addressSearchLock.lock()
guard !isSearchingAddresses else {
addressSearchLock.unlock()
return nil
}
isSearchingAddresses = true
addressSearchLock.unlock()
defer {
addressSearchLock.lock()
isSearchingAddresses = false
addressSearchLock.unlock()
}

let details = if let provided = transactionDetails { provided } else { await fetchTransactionDetails(txid: txid) }
guard let details else {
Logger.warn("Transaction details not available for \(txid)", context: "CoreService.findReceivingAddress")
Expand All @@ -903,30 +919,21 @@ class ActivityService {

// Check if an address matches any transaction output
func matchesTransaction(_ address: String) -> Bool {
details.outputs.contains { output in
output.scriptpubkeyAddress == address
}
details.outputs.contains { $0.scriptpubkeyAddress == address }
}

// Find matching address from a list, preferring exact value match
func findMatch(in addresses: [String]) -> String? {
// Try exact value match first
for address in addresses {
for output in details.outputs {
if output.scriptpubkeyAddress == address,
output.value == value
{
if output.scriptpubkeyAddress == address, output.value == value {
return address
}
}
}
// Fallback to any address match
for address in addresses {
if matchesTransaction(address) {
return address
}
}
return nil
return addresses.first { matchesTransaction($0) }
}

// First, check pre-activity metadata for addresses in the transaction
Expand All @@ -939,19 +946,20 @@ class ActivityService {
return currentWalletAddress
}

// Search addresses forward in batches
func searchAddresses(isChange: Bool) async throws -> String? {
// Search addresses forward in batches across all address types
func searchAddresses(isChange: Bool, addressTypeString: String) async throws -> String? {
var index: UInt32 = 0
var currentAddressIndex: UInt32? = nil
var currentAddressIndex: UInt32?
let hasCurrentAddress = !currentWalletAddress.isEmpty
let maxIndex: UInt32 = hasCurrentAddress ? Self.maxAddressSearchIndex : batchSize
let maxIndex: UInt32 = hasCurrentAddress ? min(Self.maxAddressSearchIndex, 500) : batchSize

while index < maxIndex {
let accountAddresses = try await coreService.utility.getAccountAddresses(
walletIndex: 0,
isChange: isChange,
startIndex: index,
count: batchSize
count: batchSize,
addressTypeString: addressTypeString
)

let addresses = accountAddresses.unused.map(\.address) + accountAddresses.used.map(\.address)
Expand All @@ -961,7 +969,6 @@ class ActivityService {
currentAddressIndex = index
}

// Check for matches
if let match = findMatch(in: addresses) {
return match
}
Expand All @@ -981,12 +988,27 @@ class ActivityService {
return nil
}

let selectedAddressTypeString = UserDefaults.standard.string(forKey: "selectedAddressType") ?? "nativeSegwit"

// Search all address types, prioritizing the selected type
let addressTypesToSearch: [String] = {
var types = [selectedAddressTypeString]
for type in ["legacy", "nestedSegwit", "nativeSegwit", "taproot"] where !types.contains(type) {
types.append(type)
}
return types
}()

// Try receiving addresses first, then change addresses
if let address = try await searchAddresses(isChange: false) {
return address
for addressTypeString in addressTypesToSearch {
if let address = try await searchAddresses(isChange: false, addressTypeString: addressTypeString) {
return address
}
}
if let address = try await searchAddresses(isChange: true) {
return address
for addressTypeString in addressTypesToSearch {
if let address = try await searchAddresses(isChange: true, addressTypeString: addressTypeString) {
return address
}
}

// Fallback: return first output address
Expand Down Expand Up @@ -1710,7 +1732,8 @@ class UtilityService {
walletIndex: Int = 0,
isChange: Bool? = nil,
startIndex: UInt32? = nil,
count: UInt32? = nil
count: UInt32? = nil,
addressTypeString: String? = nil
) async throws -> AccountAddresses {
return try await ServiceQueue.background(.core) {
guard let mnemonic = try Keychain.loadString(key: .bip39Mnemonic(index: walletIndex)) else {
Expand All @@ -1719,9 +1742,26 @@ class UtilityService {

let passphrase = try Keychain.loadString(key: .bip39Passphrase(index: walletIndex))

// Create the correct derivation path based on network
// Create the correct derivation path based on address type and network
let coinType = Env.network == .bitcoin ? "0" : "1"
let derivationPath = "m/84'/\(coinType)'/0'/0"
let derivationPath = if let addressTypeString {
// Use specified address type
switch addressTypeString.lowercased() {
case "legacy":
"m/44'/\(coinType)'/0'/0" // BIP 44
case "nestedsegwit", "nested_segwit":
"m/49'/\(coinType)'/0'/0" // BIP 49
case "nativesegwit", "native_segwit":
"m/84'/\(coinType)'/0'/0" // BIP 84
case "taproot":
"m/86'/\(coinType)'/0'/0" // BIP 86
default:
"m/84'/\(coinType)'/0'/0" // Default to native segwit
}
} else {
// Default to native segwit (BIP 84) for backward compatibility
"m/84'/\(coinType)'/0'/0"
}

let response = try deriveBitcoinAddresses(
mnemonicPhrase: mnemonic,
Expand Down
Loading
Loading