Repository navigation
feat(wallet): show a nonblocking protocol update advisory #1232
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.
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
Merged
Merged
Changes from 24 commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
ba3a095
feat(ios): integrate protocol compatibility checks and recovery
llbartekll efbf952
refactor(ios): make protocol checks informational
llbartekll f2cc437
chore(ios): integrate develop with advisory protocol checks
llbartekll 591c937
test(ios): cover local operation preparation invariants
llbartekll 383634e
chore(ios): pin advisory SDK on v5.1-dev
llbartekll 7d22d8d
fix(wallet): bind confirmations to the published wallet
llbartekll 905d005
fix(wallet): align registration logs with current logger
llbartekll 03a331f
merge: reconcile protocol advisory with restart-safe Core drain
llbartekll ba0c6fd
fix(wallet): address protocol review and integrate current develop
llbartekll 8a3b326
fix(wallet): preserve settled funds after identity top-up refusal
llbartekll 0c6d872
fix(wallet): observe protocol changes for the runtime lifetime
llbartekll fd9798e
chore(sdk): pin retry ambiguity fix
llbartekll 8208167
chore(sdk): pin final retry observation revision
llbartekll 55572a5
fix: retain committed asset lock across explicit send retries
llbartekll a45556e
fix: unwrap active network when capturing preparation
llbartekll 54adfd1
fix: authorize explicit send retries of recorded asset locks
llbartekll d8b3147
Merge develop and pin reviewed protocol SDK
llbartekll 3b103f6
fix: preserve existing transfer recovery and refresh stale confirmations
llbartekll 26b932d
fix: integrate typed SDK unconfirmed submission errors
llbartekll c945c5f
chore(sdk): pin unconfirmed outcome presentation fix
llbartekll 48d1014
fix: announce unconfirmed identity transfer outcomes
llbartekll 0767e58
refactor(wallet): reduce protocol checks to a background update advisory
llbartekll 4deec59
fix(wallet): match the existing Testflight Swift condition
llbartekll 95ffa0d
chore(sdk): pin empty epoch result compatibility fix
llbartekll 91860b3
fix(wallet): enable protocol auto-detection and unify update guidance
llbartekll c3f293d
docs: add protocol advisory review screenshots
llbartekll File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 84851397d7ad43988a5ad2c3860ca9e9e88677e3 | ||
| 5b89fe8b529c66d5e972880196545c902285258b |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
DashWallet/Sources/Infrastructure/SwiftDashSDK/SwiftDashSDKProtocolCompatibilityClient.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import SwiftDashSDK | ||
|
|
||
| @MainActor | ||
| struct SwiftDashSDKProtocolCompatibilityClient: WalletProtocolCompatibilityClient { | ||
| let sdk: SDK | ||
|
|
||
| func queryEpoch() async throws { | ||
| // The historical epoch's proof carries fresh signed response metadata. | ||
| // getEpochsInfo dispatches blocking FFI on the SDK's query queue. | ||
| _ = try await sdk.getEpochsInfo(startEpoch: 0, count: 1, ascending: true) | ||
| } | ||
|
|
||
| func protocolVersionInfo() throws -> ProtocolVersionInfo { | ||
| try sdk.protocolVersionInfo() | ||
| } | ||
| } | ||
77 changes: 77 additions & 0 deletions
77
DashWallet/Sources/Infrastructure/SwiftDashSDK/WalletProtocolCompatibilityController.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| import Combine | ||
| import Foundation | ||
| import SwiftDashSDK | ||
|
|
||
| @MainActor | ||
| protocol WalletProtocolCompatibilityClient { | ||
| func queryEpoch() async throws | ||
| func protocolVersionInfo() throws -> ProtocolVersionInfo | ||
| } | ||
|
|
||
| /// An advisory observation owned by the host. No operation depends on this task. | ||
| @MainActor | ||
| final class WalletProtocolCompatibilityController: ObservableObject { | ||
| @Published private(set) var snapshot: ProtocolVersionInfo? | ||
| private(set) var runtimeID: UUID? | ||
| private var client: (any WalletProtocolCompatibilityClient)? | ||
| private var network: String? | ||
| private var pending: Task<Void, Never>? | ||
| private var foregroundSubscription: AnyCancellable? | ||
| private let log: (String) -> Void | ||
|
|
||
| init( | ||
| foregroundNotification: Notification.Name, | ||
| notificationCenter: NotificationCenter = .default, | ||
| log: @escaping (String) -> Void = { _ in } | ||
| ) { | ||
| self.log = log | ||
| // Only the host-supplied willEnterForeground event. Dismissing Face ID | ||
| // emits didBecomeActive, which must not start another network query. | ||
| foregroundSubscription = notificationCenter.publisher(for: foregroundNotification) | ||
| .sink { [weak self] _ in | ||
| Task { @MainActor [weak self] in self?.refresh() } | ||
| } | ||
| } | ||
|
|
||
| @discardableResult | ||
| func attach(client: any WalletProtocolCompatibilityClient, network: String) -> Task<Void, Never> { | ||
| detach() | ||
| runtimeID = UUID() | ||
| self.client = client | ||
| self.network = network | ||
| return refresh() | ||
| } | ||
|
|
||
| func detach() { | ||
| pending?.cancel() | ||
| pending = nil | ||
| client = nil | ||
| runtimeID = nil | ||
| network = nil | ||
| snapshot = nil | ||
| } | ||
|
|
||
| @discardableResult | ||
| func refresh() -> Task<Void, Never> { | ||
| if let pending { return pending } | ||
| guard let client, let runtimeID, let network else { return Task {} } | ||
| let task = Task { [weak self] in | ||
| let started = Date() | ||
| var outcome = "success" | ||
| do { try await client.queryEpoch() } | ||
| catch { outcome = "query failed: \(error)" } | ||
| // The SDK may retain a verified observation even if this query | ||
| // failed. An error must not erase an earlier warning. | ||
| let observation = Result { try client.protocolVersionInfo() } | ||
| guard let self, self.runtimeID == runtimeID else { return } | ||
| self.pending = nil | ||
| switch observation { | ||
| case .success(let info): self.snapshot = info | ||
| case .failure(let error): outcome += "; snapshot failed: \(error)" | ||
| } | ||
| self.log("Protocol version network=\(network) runtime=\(runtimeID) elapsed=\(Date().timeIntervalSince(started)) outcome=\(outcome) info=\(String(describing: self.snapshot))") | ||
| } | ||
| pending = task | ||
| return task | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
DashWallet/Sources/UI/Main/ProtocolCompatibilityBanner.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| import Combine | ||
| import SwiftUI | ||
| import SwiftDashSDK | ||
|
|
||
| @MainActor | ||
| final class ProtocolCompatibilityBannerViewModel: ObservableObject { | ||
| @Published private(set) var snapshot: ProtocolVersionInfo? | ||
| private var subscription: AnyCancellable? | ||
|
|
||
| init(controller: WalletProtocolCompatibilityController) { | ||
| snapshot = controller.snapshot | ||
| subscription = controller.$snapshot.sink { [weak self] in self?.snapshot = $0 } | ||
| } | ||
|
|
||
| var message: String? { | ||
| guard snapshot?.newerProtocolAvailable == true else { return nil } | ||
|
llbartekll marked this conversation as resolved.
Resolved
|
||
| #if Testflight | ||
|
llbartekll marked this conversation as resolved.
Resolved
|
||
| return NSLocalizedString("The network uses a newer protocol than this version of the app. Check for updates in TestFlight.", comment: "Protocol version advisory") | ||
| #else | ||
| return NSLocalizedString("The network uses a newer protocol than this version of the app. Check for available updates.", comment: "Protocol version advisory") | ||
| #endif | ||
| } | ||
|
|
||
| var updateURL: URL? { | ||
| #if Testflight | ||
| return nil | ||
| #else | ||
| return URL(string: "https://apps.apple.com/app/dash-wallet/id1206647026") | ||
|
llbartekll marked this conversation as resolved.
Resolved
|
||
| #endif | ||
| } | ||
|
|
||
| } | ||
|
|
||
| struct ProtocolCompatibilityBanner: View { | ||
| @StateObject private var model: ProtocolCompatibilityBannerViewModel | ||
| @Environment(\.openURL) private var openURL | ||
|
|
||
| init(controller: WalletProtocolCompatibilityController) { | ||
| _model = StateObject(wrappedValue: ProtocolCompatibilityBannerViewModel(controller: controller)) | ||
| } | ||
|
|
||
| var body: some View { | ||
| Group { | ||
| if let message = model.message { | ||
| VStack(alignment: .leading, spacing: 8) { | ||
| Text(message) | ||
| .font(.footnote) | ||
| .fixedSize(horizontal: false, vertical: true) | ||
| if let url = model.updateURL { | ||
| Button(NSLocalizedString("Check for update", comment: "Protocol version update")) { | ||
| openURL(url) | ||
| } | ||
| } | ||
| } | ||
| .padding(12) | ||
| .frame(maxWidth: .infinity, alignment: .leading) | ||
| .background(.regularMaterial, in: RoundedRectangle(cornerRadius: 12)) | ||
| .accessibilityElement(children: .contain) | ||
| } | ||
| } | ||
| .fixedSize(horizontal: false, vertical: true) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.