Skip to content

fix(platform-wallet): close the asset-lock resume broadcast race - #4636

Open
shumkov wants to merge 4 commits into
v4.2-devfrom
fix/asset-lock-resume-broadcast-race
Open

fix(platform-wallet): close the asset-lock resume broadcast race#4636
shumkov wants to merge 4 commits into
v4.2-devfrom
fix/asset-lock-resume-broadcast-race

Conversation

@shumkov

@shumkov shumkov commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Issue being fixed or feature implemented

Two defects on the asset-lock resume and create paths, both reachable today on v4.2-dev.

The create path could downgrade a concurrently finalized row. After its broadcast, broadcast_funded_asset_lock advanced the row to Broadcast unconditionally. If another flow carried the same lock to InstantSendLocked or ChainLocked while that broadcast was in flight, the advance overwrote the stronger status and persisted Broadcast with no proof.

A contested Broadcast row reported the wrong verdict. When a re-broadcast was rejected and an input conflict had been sighted, the Broadcast arm returned TransactionBroadcastUnconfirmed immediately, so the caller never saw AssetLockInputContested — the Built arm already had the opposite behaviour.

Note on scope. This PR opened as a re-derivation of #4016 ("close the asset-lock resume broadcast race") and originally carried a promote_built_to_broadcast CAS that advanced the row before broadcasting. That turned out to be unnecessary: #4355 landed claim_resume_dispatch on v4.2-dev, whose ResumeDispatchClaim — taken under the read guard at snapshot and read under the write guard in untrack_asset_lock — already prevents a create-path rejection from untracking a row and releasing its reservation while a resume's broadcast is in flight. Running the original regression against the merge-base, every safety assertion passes; only the assertions pinning the old promote-before-broadcast ordering fail. The CAS was therefore dropped and #4355's resume arm left untouched. The two fixes below are what genuinely remained.

What was done?

  • build.rs — the create path's post-broadcast advance now goes through advance_asset_lock_status_if(|s| s == Built, Broadcast, None). A row a concurrent flow already carried past Built is left alone, and the call still returns Ok, since the follow-up proof wait resolves from the stronger status.
  • sync/recovery.rs, Broadcast arm — on a rejected re-broadcast with no local proof, an input_conflict sighting now falls through to the existing bounded wait and input_conflict_verdict rather than returning early, mirroring the Built arm. The no-sighting path is unchanged.
  • Doc pass — comments that described Broadcast as proof the transaction reached the network now say a broadcast was attempted, across rs-platform-wallet, rs-platform-wallet-ffi and both mobile SDKs.

sync/recovery.rs's Built arm, await_broadcast_ready, resume_when_transport_ready, the ResumeDispatchClaim lifecycle and absorbing Consumed are byte-identical to the merge-base.

Tests

Test would have caught this in CI: ✖ before the fix, ✔ after — each proven by reverting one production hunk in isolation.

  • create_broadcast_does_not_downgrade_a_concurrently_finalized_row — revert only the build.rs hunk and it fails with left: Broadcast, right: ChainLocked.
  • a_rejected_rebroadcast_of_a_conflicted_built_lock_reports_the_contested_verdict — extended to a second resume with the row already at Broadcast. Revert only the recovery.rs hunk and it fails in that second-resume match with TransactionBroadcastUnconfirmed; the failure is past the whole first half, so the base's Built-arm assertions still pass and it is precisely the Broadcast-arm extension the base cannot satisfy.

Two tests from the original CAS design were removed because they can no longer fail, not because they now fail: rejected_create_while_resume_broadcasts_keeps_row_and_reservation uniquely pinned the abandoned promote-before-broadcast ordering, and every safety assertion it carried is asserted by the base's a_rejection_cleanup_cannot_release_inputs_under_a_parked_resume; stale_built_resume_does_not_downgrade_a_concurrently_finalized_row depended on a test-only hook that only existed alongside the CAS.

One behaviour worth stating plainly: under #4355's design a Built resume that snapshotted before a concurrent finalization still makes a benign redundant re-send. The network answers already-known, advance_if(Built) leaves the row alone, and the wait resolves from the row's proof. That is accepted base behaviour, not introduced here, and it is why the deleted test's "must not broadcast" half is gone.

cargo test -p platform-wallet and -p platform-wallet-ffi pass; clippy -D warnings and fmt --check clean.

Supersedes #4016, which is closed.

🤖 Generated with Claude Code

Promote Built rows before resume broadcasts through a shared compare-and-set.
Preserve concurrently advanced status and proof in both resume and create paths,
and keep rejected attempts tracked at Broadcast without releasing their inputs.

Test would have caught this in CI:
- rejected_create_while_resume_broadcasts_keeps_row_and_reservation: ✖ before
  the fix the rejected create removed the row and released its reservation;
  ✔ after the fix the row remains Broadcast and a rebuild cannot select its inputs.
- stale_built_resume_does_not_downgrade_a_concurrently_finalized_row: ✖ before
  the fix the stale resume timed out after replacing ChainLocked with Broadcast;
  ✔ after the fix it re-dispatches from the attached ChainLock proof.
- create_broadcast_does_not_downgrade_a_concurrently_finalized_row: ✖ before
  the fix the create completion replaced ChainLocked with Broadcast; ✔ after the
  fix it preserves the finalized status and proof.
- Built-resume rejection assertions: ✖ before the fix the row stayed Built;
  ✔ after the fix it stays tracked at Broadcast for defensive resume.
Keep definite rejections for Broadcast rows on the bounded proof-wait path when a standing input conflict exists, so later resumes reproduce AssetLockInputContested. Update status wording to reflect pre-send promotion.

Test would have caught this in CI:
- a_rejected_rebroadcast_of_a_conflicted_built_lock_reports_the_contested_verdict: ✖ before the fix the second resume returned TransactionBroadcastUnconfirmed; ✔ after the fix it returns AssetLockInputContested while the row remains Broadcast.
… send

A Broadcast row now means a broadcast was attempted, not that one reached the
network: two pre-dispatch rejections can leave a row at Broadcast having sent
nothing. The contested-verdict docs in the Rust error type and both mobile SDKs
still asserted an earlier call had sent the transaction.

Docs only; no behaviour change, so no test accompanies it.
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: b743fe5a-3321-4add-bb1f-de271f44eb80

📥 Commits

Reviewing files that changed from the base of the PR and between e9ddb20 and 7907237.

📒 Files selected for processing (7)
  • packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/tests/document/deletion.rs
  • packages/rs-platform-wallet-ffi/src/error.rs
  • packages/rs-platform-wallet/src/wallet/asset_lock/build.rs
  • packages/rs-platform-wallet/src/wallet/asset_lock/sync/recovery.rs
  • packages/rs-platform-wallet/src/wallet/asset_lock/sync/tracking.rs
  • packages/rs-platform-wallet/src/wallet/asset_lock/tracked.rs
  • packages/swift-sdk/Sources/SwiftDashSDK/PlatformWallet/PlatformWalletResult.swift
💤 Files with no reviewable changes (1)
  • packages/rs-platform-wallet/src/wallet/asset_lock/sync/recovery.rs
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/swift-sdk/Sources/SwiftDashSDK/PlatformWallet/PlatformWalletResult.swift
  • packages/rs-platform-wallet-ffi/src/error.rs
  • packages/rs-platform-wallet/src/wallet/asset_lock/tracked.rs

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Asset-lock creation and recovery now use conditional status advancement and RAII dispatch claims. Concurrent finalization, rejection, cancellation, and contested-proof scenarios preserve tracked state and verdicts. Related SDK documentation and one test formatting change were updated.

Changes

Asset-lock race handling

Layer / File(s) Summary
Resume dispatch claim tracking
packages/rs-platform-wallet/src/wallet/asset_lock/sync/tracking.rs
Adds RAII dispatch claims. Cleanup keeps claimed Built rows tracked. Status transitions clear claims when rows leave Built.
Create broadcast state preservation
packages/rs-platform-wallet/src/wallet/asset_lock/build.rs
The create path advances only rows that remain Built. Tests verify that concurrent finalization does not lose status or proof.
Resume recovery state handling
packages/rs-platform-wallet/src/wallet/asset_lock/sync/recovery.rs
A conflicted rejected re-broadcast now enters bounded proof waiting. Repeated resumes can report the contested verdict again.
Status and error contract wording
packages/rs-platform-wallet/src/wallet/asset_lock/tracked.rs, packages/rs-platform-wallet/src/error.rs, packages/kotlin-sdk/sdk/src/main/kotlin/org/dashfoundation/dashsdk/errors/DashSdkError.kt, packages/rs-platform-wallet-ffi/src/error.rs, packages/swift-sdk/Sources/SwiftDashSDK/PlatformWallet/PlatformWalletResult.swift, packages/rs-drive-abci/execution/validation/state_transition/state_transitions/batch/tests/document/deletion.rs
Documentation now describes uncertain earlier attempts. The document deletion test was reformatted without behavior changes.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CreateOrResume
  participant TransactionBroadcaster
  participant AssetLockManager
  participant ProofWait
  CreateOrResume->>TransactionBroadcaster: send or re-send asset-lock transaction
  TransactionBroadcaster-->>CreateOrResume: accepted or rejected
  CreateOrResume->>AssetLockManager: conditionally update tracked status
  AssetLockManager-->>CreateOrResume: preserve concurrent status and proof
  CreateOrResume->>ProofWait: wait when an input conflict is sighted
  ProofWait-->>CreateOrResume: contested or final proof verdict
Loading

Merge Risk: ⚪ Minimal · up to 79072

Asset-lock create and resume flows now retain state during concurrent dispatch and finalization, preventing stale cleanup or status downgrades. The covered race and recovery behavior has no identified current-head merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 93.75% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 16 functions across 11 files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: fixing the asset-lock resume broadcast race in platform-wallet.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/asset-lock-resume-broadcast-race

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@thepastaclaw

thepastaclaw commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

✅ Final review complete — no blockers (commit 7907237) · triage: critical · Phase 2 only (queue backlog)

Keep #4355's resume dispatch-claim and transport-readiness flow, and conditionally advance the create path after broadcast.

Test would have caught this in CI: ✖ the unconditional merged-parent advance downgraded ChainLocked to Broadcast; ✔ the conditional advance preserves the finalized row and proof.
@codecov

codecov Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.51%. Comparing base (caf2b29) to head (7907237).
⚠️ Report is 8 commits behind head on v4.2-dev.

Additional details and impacted files
@@             Coverage Diff              @@
##           v4.2-dev    #4636      +/-   ##
============================================
- Coverage     85.34%   84.51%   -0.84%     
============================================
  Files          2795     2796       +1     
  Lines        373566   375112    +1546     
============================================
- Hits         318827   317025    -1802     
- Misses        54739    58087    +3348     
Components Coverage Δ
dpp 84.16% <ø> (-0.21%) ⬇️
drive 84.65% <ø> (-0.30%) ⬇️
drive-abci 86.39% <ø> (-2.56%) ⬇️
sdk ∅ <ø> (∅)
dapi-client ∅ <ø> (∅)
platform-version ∅ <ø> (∅)
platform-value 92.92% <ø> (ø)
platform-wallet ∅ <ø> (∅)
drive-proof-verifier 41.44% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@thepastaclaw thepastaclaw left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Final validation — Phase 2 only (queue backlog)

Verified the changes at head 7907237; no actionable in-scope defects were found. The conditional create-path status update preserves concurrent finality, and rejected defensive re-broadcasts retain bounded conflict resolution without releasing reservations. Independent validation passed all 98 targeted asset-lock tests, the full platform-wallet and platform-wallet-ffi suites (1,361 passed, 5 ignored), and git diff --check; the worktree remains clean.

Source: reviewer 1: gpt-6-astra (agent: phase2-reviewer, role: general); reviewer 2: gpt-6-astra (agent: phase2-reviewer, role: ffi-engineer); reviewer 3: gpt-6-astra (agent: phase2-reviewer, role: rust-quality); reviewer 4: gpt-6-astra (agent: phase2-reviewer, role: security-auditor); final verifier: gpt-6-astra (agent: astra-verifier, role: final-verifier)

Review provenance

  • Triage: critical by gpt-6-astra (effort low) — The change modifies concurrent asset-lock state transitions, broadcast recovery, and funding-reservation protection, where incorrect ordering or status handling could release committed inputs, create conflicting transactions, or compromise wallet fund recovery.
  • Phase 1 reviewers: not run (skipped for throughput: 21 PRs queued, above the 10 limit)
  • Fresh verifier: gpt-6-astra — final-verifier; agent astra-verifier
  • Phase 2 reviewers: gpt-6-astra — general (completed, effort xhigh); agent phase2-reviewer, gpt-6-astra — ffi-engineer (completed, effort xhigh); agent phase2-reviewer, gpt-6-astra — rust-quality (completed, effort xhigh); agent phase2-reviewer, gpt-6-astra — security-auditor (completed, effort xhigh); agent phase2-reviewer

@llbartekll

Copy link
Copy Markdown
Contributor

Went through the diff against the merge-base (299d662). The code changes look right to me, a few things before I approve:

1. The description no longer matches the diff. It describes a promote_built_to_broadcast CAS returning AlreadyAdvanced, a Built arm that promotes before broadcasting, and a test rejected_create_while_resume_broadcasts_keeps_row_and_reservation verified RED on the parent. None of these are in the branch: the Built arm in recovery.rs is byte-identical to base (still sends first, advances only when undispatched.is_none()), and the updated test asserts the opposite ("a send rejected before dispatch must leave the row at Built"). The race in the title is already closed on base by claim_resume_dispatch (#4355). What the diff actually adds is (a) the create path's post-broadcast advance going through advance_asset_lock_status_if(Built), (b) the Broadcast arm keeping a sighted conflict through the bounded wait instead of returning TransactionBroadcastUnconfirmed early, and (c) the doc pass. Since the body becomes the squash commit message, could you rewrite it to describe those?

2. 180 s wait on an offline launch (recovery.rs Broadcast arm, the new if input_conflict.is_none() fall-through). A Broadcast row with a sighted conflict now waits the full UNCONFIRMED_BROADCAST_PROOF_TIMEOUT before reporting AssetLockInputContested, where it used to return right after await_broadcast_ready. When the re-broadcast was rejected because the client is unstarted, nothing can wake that wait, so it is dead time per contested row (Swift catch-up runs at most 4 at once). Is that intended? An alternative is to return the contested verdict straight away when transport_missed is set and leave the bounded wait to the deferred retry. Either way worth a line in the description, since the test only exercises a 10 ms bound.

3. Rebase please. The merge commit picked up a rustfmt-only hunk in rs-drive-abci/.../deletion.rs that is in neither parent; v4.2-dev already has the identical fix (#4586), so it disappears on rebase.

Minor, no action needed unless you are already in there: the code-48 docs (error.rs in both crates, Swift, Kotlin, ERROR_CODE_REGISTRY.md) still say "the lock was (re-)broadcast and waited on", which is no longer true on the new Rejected-with-conflict path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants