Harden auth and precondition guards (#351, #345, #336, #350) - #378
Merged
Conversation
…tests (Goldii-locks#290) Harden cancel_escrow with two missing validation rules and add a full test suite covering every guard, happy path, post-cancel state, event structure, and milestone isolation. Production changes (lib.rs): - Add EmergencyPaused guard: cancel_escrow now returns Error::Paused when the contract is emergency-paused, consistent with all other user-facing endpoints - Add duplicate-cancel guard: a second call while CancelLock is already active returns Error::EscrowLocked, preventing race conditions and redundant lock-sets Tests added (test.rs) — 20 new tests: Invalid address guards: - test_cancel_escrow_zero_account_address_rejected - test_cancel_escrow_zero_contract_address_rejected Not-initialized guard: - test_cancel_escrow_not_initialized_fails Not-funded guard: - test_cancel_escrow_not_funded_fails Unauthorized guards: - test_cancel_escrow_stranger_unauthorized - test_cancel_escrow_arbiter_unauthorized - test_cancel_escrow_admin_unauthorized Emergency-paused guard: - test_cancel_escrow_while_paused_fails Duplicate-cancel guard: - test_cancel_escrow_duplicate_call_fails - test_cancel_escrow_freelancer_duplicate_after_client_fails Happy paths: - test_cancel_escrow_client_succeeds - test_cancel_escrow_freelancer_succeeds Post-cancel state validation: - test_cancel_escrow_blocks_fund - test_cancel_escrow_blocks_mark_delivered - test_cancel_escrow_blocks_approve_milestone - test_cancel_escrow_blocks_raise_dispute Event validation: - test_cancel_escrow_emits_exactly_one_event - test_cancel_escrow_event_contains_correct_caller Milestone state isolation: - test_cancel_escrow_does_not_mutate_milestones - test_cancel_escrow_all_milestones_released_still_succeeds All 218 tests pass.
…tests (Goldii-locks#293) Expand CancelEscrowInitiatedEvent with full operational context so downstream indexers can reconstruct the complete cancellation state from the event payload alone, without querying contract storage. Production changes (lib.rs): - Expand CancelEscrowInitiatedEvent with six new fields: caller_is_client bool — true if initiator is the client, false if freelancer client Address — registered client address freelancer Address — registered freelancer address token Address — escrow token contract address milestone_count u32 — number of milestones at cancellation time total_amount i128 — aggregate milestone total (pre-release) - Update cancel_escrow event emission to populate all new fields, deriving caller_is_client from (caller == meta.client) No other code changed. Tests added (test.rs) — 14 new tests (396 -> 410): Event count: - test_cancel_escrow_event_emitted_exactly_once contract_id field: - test_cancel_escrow_event_contract_id_correct caller field: - test_cancel_escrow_event_caller_is_client_address - test_cancel_escrow_event_caller_is_freelancer_address caller_is_client role field: - test_cancel_escrow_event_caller_is_client_true_for_client - test_cancel_escrow_event_caller_is_client_false_for_freelancer client / freelancer / token fields: - test_cancel_escrow_event_client_field_correct - test_cancel_escrow_event_freelancer_field_correct - test_cancel_escrow_event_token_field_correct milestone_count field: - test_cancel_escrow_event_milestone_count_single - test_cancel_escrow_event_milestone_count_multiple total_amount field: - test_cancel_escrow_event_total_amount_correct_single_milestone - test_cancel_escrow_event_total_amount_correct_multi_milestone Full indexer round-trip: - test_cancel_escrow_event_full_indexer_parse All 410 tests pass.
|
@miss-yusrah Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
…ocks#298) Audited tax_withholding_deductions's existing validation against this issue's requirement ("assert that bad setups are rejected immediately with descriptive error types") and found the existing coverage already extensive: NotInitialized, NotFunded, InvalidMilestone, InvalidRatio, InvalidAmount (zero balance, overflow), and InvalidStatus for Released/Refunded milestones are all implemented and tested (test.rs, tax_withholding_tests.rs). One real gap: the status check only excluded Released/Refunded, not Disputed — unlike raise_dispute_inner and resolve_dispute elsewhere in this file, which both treat Disputed as its own case via an exhaustive match. A disputed milestone's funds are meant to be frozen pending resolve_dispute; tax_withholding_deductions could still compute and persist a TaxWithholdingRecord for one, moving money around that freeze. No existing test combined raise_dispute with tax_withholding_deductions, so this was uncovered on both the implementation and test side. Fixes the gap by converting the two equality checks to an exhaustive match over MilestoneStatus (so a future new variant fails to compile here instead of silently falling through as allowed), matching the established pattern elsewhere in this file, and adds a test exercising it via the existing dual-signature test fixture. Not touched: admin_tax_withholding_deductions, a separately-implemented sibling function (per its own doc comment, "arrived from a separate PR under the same name") that has no status check at all — a larger gap, but outside this issue's named scope (Module/Component: tax_withholding_deductions).
…erride_cancel_release and multisig_split_refund (closes Goldii-locks#330, Goldii-locks#341)
…erride_cancel_release and multisig_split_refund (closes Goldii-locks#330, Goldii-locks#341)
…341-harden-auth-preconditions Feat/issue 330 341 harden auth preconditions
…nd auth (closes Goldii-locks#327, Goldii-locks#337) Co-authored-by: Cursor <cursoragent@cursor.com>
…7-multisig-admin feat: add multisig_transfer_admin test suite and harden override-refu…
Drop the redundant MilestoneReleased(index) temporary-flag write from multisig_admin_override_release. The flag's only reader (is_milestone_released_flag) is dead code, and the persisted Released status on the milestone is the authoritative completion signal. This reduces the distinct storage keys written by the call from three (Milestone, MilestoneReleased, MultisigLocked) to two (Milestone, MultisigLocked), matching multisig_admin_override_refund. Adds test_multisig_admin_override_release_reduced_storage_footprint to assert the temporary flag is no longer written while token transfer, lock clearing, milestone state, and terminal re-entry rejection still hold. Updates the affected snapshot fixtures accordingly. Closes Goldii-locks#392
Guard the refund arithmetic so no input can cause a wrap or an unhandled panic (issue Goldii-locks#395). Negative amount / released_amount and released_amount > amount now return Error::InvalidAmount before any arithmetic runs, complementing the existing checked_sub and remaining<=0 guards. The same guards are applied to the sibling multisig_admin_override_release for consistency. Adds a comprehensive suite to multisig_admin_override_refund_tests asserting i128::MAX / i128::MIN operands return Error::InvalidAmount (rather than panicking) and that valid amounts refund exactly amount - released_amount, identical to prior behavior. Closes Goldii-locks#395
…_approve (closes Goldii-locks#354) Reorder multisig_approve so the signer-membership check runs before any job/token ledger reads (job meta load, cross-contract balance call), matching the guard ordering used elsewhere in the hardening series. Add dedicated tests asserting unauthorized and empty-balance rejections leave the proposal's approval bitmap unmutated.
…footprint and add checked ops in cancel_refund Issue Goldii-locks#383 - admin_override_cancel_release storage footprint - Remove the redundant store_milestone_released() temporary-storage write from the milestone loop inside admin_override_cancel_release. - The temporary MilestoneReleased(index) flag is a hot-read optimisation for the approve_milestone code path; it is not needed in the admin cancel-override path because the persistent Milestone entry already carries status=Released. - This reduces distinct ledger keys written per call by N (one per updated milestone), lowering both compute cost and storage rent burden. Issue Goldii-locks#386 - admin_override_cancel_refund checked arithmetic - Add explicit non-negativity guards on milestone.amount and milestone.released_amount before the checked_sub call. - A malformed on-chain entry with a negative field (e.g. i128::MIN) previously could pass through the remaining > 0 filter with a nonsensical value; now it is caught early and returns Error::InvalidAmount instead of causing a wrap or silent corruption. - All arithmetic (checked_sub, checked_add) already existed; the guard block tightens the contract so every exit path is provably safe. Tests (admin_override_cancel_tests.rs) - Happy-path release: verifies tokens transferred, milestones Released, CancelLock cleared, and MilestoneReleased temporary flag absent (Goldii-locks#383). - Skip-terminal release: milestones already Released are skipped and no temporary flag is written for the remaining ones (Goldii-locks#383). - Happy-path refund: verifies tokens transferred, milestones Refunded, CancelLock cleared, and YieldAccrued reset (Goldii-locks#386). - Skip-terminal refund: terminal milestones excluded from total (Goldii-locks#386). - All-terminal refund: returns Error::InvalidAmount, not panic (Goldii-locks#386). - Unauthorized / InvalidStatus guards verified for both functions. - Minimum-amount (1 stroop) and multi-milestone sum tests (Goldii-locks#386).
…6-admin-override-storage-checked-ops fix(Goldii-locks#383,Goldii-locks#386): reduce cancel_release ledger footprint and add checked ops in cancel_refund
…tisig-approval-init-guards fix: add storage non-mutation coverage to multisig_approval_init guar…
The conflict in test.rs was two branches each appending a module declaration at the same spot; both are needed, so both are declared. execute_transfer_swaps_admin_and_emits_event then failed on the event tally (left: 0, right: 1). The event is emitted -- the admin key swap and the pending-transfer removal above it both asserted correctly -- but the count was read after client.get_pending_admin_transfer(), and env.events().all() reflects the most recent contract invocation. Moved the two event assertions directly after execute_admin_transfer; the state assertions follow, unchanged. Same fix as on Goldii-locks#418, which hit this in multisig_admin_override_refund_tests. No production code touched. 543 tests passing / WASM release build OK
…347-execute-admin-transfer-guards feat: harden caller authorization and precondition guards in execute_admin_transfer (closes Goldii-locks#347)
main guards tax_withholding_deductions with two equality checks that reject Released and Refunded. This branch replaces them with an exhaustive match that also rejects Disputed, which is the whole point of Goldii-locks#298: a Disputed milestone's funds are frozen pending arbitration, so computing and persisting a tax split for it here would move money around a dispute that resolve_dispute is meant to gate. Took the branch's side. It strictly widens main's guard -- everything main rejected is still rejected -- and being exhaustive means a future MilestoneStatus variant fails to compile here rather than silently falling through as permitted. 544 tests passing / WASM release build OK
…8-tax-withholding-validation fix(tax_withholding_deductions): reject Disputed milestones (Goldii-locks#298)
The conflict was just a module declaration; it now sits under #[cfg(test)] alongside the others, matching what Goldii-locks#429 established. Two compile fixes in the new suite: - setup_funded_escrow was not in scope. Imported from crate::test, the same way admin_override_cancel_tests.rs does it. - DataKey::YieldRateBps does not exist. admin_set_yield_rate persists the rate as the yield_rate field of the YieldConfig entry under DataKey::YieldConfig, so read_yield_rate reads that instead. None still means "never written", which is what the no-mutation cases want. Three of the new tests then failed, and they were right to. They pause with emergency_pause and expect admin_set_yield_rate to return Paused, but it called only assert_not_paused, which reads DataKey::Paused -- the flag admin_pause_escrow sets. The emergency pause is a separate, stronger freeze recorded under DataKey::Ep, and nothing was checking it here, so a yield-rate change went straight through an emergency pause while the weaker admin pause blocked it. admin_set_yield_rate now rejects under either flag. That is the hardening this PR set out to add; the tests had simply reached for the pause that was not wired up. No existing test asserted the old behaviour. 558 tests passing / WASM release build OK
…set-yield-rate-guards feat: harden caller auth and precondition guards in admin_set_yield_rate
Dropping the EmergencyPauseLock dance from emergency_pause_admin_override is correct and is the point of Goldii-locks#399: the lock exists to close a reentrancy window around external calls, and this path makes none -- it reads the flag, compares, writes it back, and emits an event. EpLk is still taken by the paths that do call out. Three names had to be corrected against the enum as it actually exists: - DataKey::EmergencyPaused -> DataKey::Ep in lib.rs - DataKey::EmergencyPauseLock -> DataKey::EpLk in the new test suite One test then failed on the event tally. It calls the override twice and expects the count to go 1 then 2, but env.events().all() reports the most recent contract invocation rather than a running total, so the second call reports 1. Adjusted to assert the second call emits exactly one event, with the existing payload check confirming it is the new one. This is the same env behaviour that Goldii-locks#418 and Goldii-locks#438 ran into. 571 tests passing / WASM release build OK
…-pause-admin-override-storage-footprint Goldii-locks#399 - fix(emergency_pause_admin_override): remove unnecessary EmergencyPauseLock overhead
The branch's own copy of admin_pause_escrow does not parse. A line from
the previous version was left dangling after the new writes:
.set(&DataKey::EmergencyPauseLock, &true);
env.storage().instance().set(&DataKey::Paused, &true);
.set(&DataKey::EpLk, &true); <- orphaned continuation
That produced 90 errors, all downstream of "expected expression, found
`.`". DataKey::EmergencyPauseLock is also not a variant -- the enum
calls it EpLk -- in lib.rs and twice in the new test suite.
Rebuilt the function around the two guards this PR is actually for:
assert_emergency_pause_not_locked before any write, and an early return
when the escrow is already paused so a redundant call mutates nothing.
Because that early return now handles the repeat case, the inner
`if !already_paused` that main used to gate the event is redundant, and
the publish is unconditional inside the lock.
Two of the new tests then failed on event tallies. They read
pause_event_count after is_paused / is_lock_held, and those helpers go
through env.as_contract -- env.events().all() reports the most recent
invocation, not a running total. Reordered so the tally is read first.
The idempotency case now asserts the second call emits nothing at all,
which is what "no-op" means here. Same env behaviour as Goldii-locks#418, Goldii-locks#428
and Goldii-locks#438.
576 tests passing / WASM release build OK
…349-admin-pause-escrow-guards feat: harden caller authorization and precondition guards in admin_pause_escrow (closes Goldii-locks#349)
…om pf_alloc_admin_override Resolve the merge against main, which had already landed a narrower version of this event under the `pf_ovr` topic. The branch declared a second `PlatformFeeAllocationOverrideEvent` struct (same name, plus `contract_id` and `locked`) and published it a second time under a `pfovrride` topic after the allocation lock was released -- two identically named types will not compile, and the two publishes are the same event emitted twice. Unified to one struct carrying the branch's richer payload and one publish, kept inside the lock guard where main emits it. Retained main's already-published `pf_ovr` topic rather than renaming a topic that is live on the default branch. Updated main's existing assertion for the two new fields and repointed the branch's four new tests at `pf_ovr`. 580 tests pass; wasm32 release build is clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
feat(Goldii-locks#396): emit PlatformFeeAllocationOverrideEvent from pf_alloc_admin_override
…pf_alloc_admin_override Resolve the merge against main. Three fixes were needed on top of the branch: * The branch predates Goldii-locks#434, so taking its rewritten pf_alloc_admin_override body verbatim would have silently dropped the PlatformFeeAllocationOverrideEvent that call now emits. Kept the single-write optimisation and the event. * The branch deletes `mod admin_override_cancel_tests;` -- stale-branch damage that would drop a whole test module from the build. Kept ours. * Its new test referenced `DataKey::EmergencyPauseLock`, which does not exist; the variant is the short key `EpLk`. Also folded the branch's `setup_pf_alloc_escrow` helper together with Goldii-locks#434's `setup_locked_pf_alloc` instead of landing two near-identical copies. 591 tests pass; wasm32 release build is clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
perf(Goldii-locks#397): reduce ledger storage footprint of pf_alloc_admin_override
…time extensions
Main had already migrated MilestoneTimeExtension writes to temporary
storage, so the branch's remaining substance is the read fallback --
`load_time_extension` now checks temporary first and falls back to the
persistent key. Without it, any escrow whose extension was written before
the migration reads back 0 and auto-releases on the unextended deadline.
Fixes on top of the branch:
* Both new i128-extreme tests wrote storage from outside a contract
context, which panics in soroban-sdk 22 ("not accessible outside of a
contract"). Wrapped the seeding writes in `env.as_contract`.
* The branch reorders `mod admin_override_cancel_tests;` above `mod test;`
and drops the `#[cfg(test)]` attributes main added; kept ours.
593 tests pass; wasm32 release build is clean.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…etic-footprint fix-checked-arithmetic-footprint
…min paths Three footprint reductions, all consistent with the pattern main already applies elsewhere: * admin_tax_withholding_deductions no longer sets and immediately removes TaxWithholdingExecutionLock. Main had already hoisted every guard above the lock, leaving a set/remove pair that protected nothing. * admin_override_tax_release no longer writes the MilestoneReleased temporary flag. Nothing reads it (is_milestone_released_flag is dead_code) and the persistent status already carries Released -- the same rationale main documents for two other override paths under Goldii-locks#383. * multisig_admin_override_refund removes MultisigLocked instead of writing `false`, so no stale entry is left on the ledger. Two fixes on top of the branch: it re-added guards main had already hoisted (kept ours), and its new test read storage through env.as_contract before checking the event tally -- env.events().all() only reflects the most recent invocation, so the buffer was already cleared. Reordered the assertions. 596 tests pass; wasm32 release build is clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Minor Admin Changes
…row is paused admin_override_refund and multisig_admin_override_refund now reject their illegal source state (paused / not multisig-locked) before touching any job or milestone storage, so a rejected call writes nothing. Resolved against main: unioned the test module lists, kept main's crate-scoped `setup_funded_escrow`, and dropped the branch's duplicate imports. Replaced the branch's inlined Paused read with the existing `assert_not_paused` helper rather than adding a third hand-rolled copy. 600 tests pass; wasm32 release build is clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…rden-admin-override-refund-guards Harden caller authorization and precondition guards in admin_override…
…AdminOverrideEvent EmergencyPauseAdminOverrideEvent gains a `previous` field, so an indexer can see which transition an override actually performed rather than only its result. The branch predates Goldii-locks#428, which removed the re-entrancy guard from emergency_pause_admin_override, so it reinstated the lock write and published the event a second time. Kept main's single publish and added `previous: current` to it. Its new tests referenced `DataKey::EmergencyPaused` and `DataKey::EmergencyPauseLock`; neither variant exists (the short keys are `Ep` and `EpLk`). The lock assertion also expected `Some(false)` -- after Goldii-locks#428 the guard key is never written at all, so it now asserts `None`. 603 tests pass; wasm32 release build is clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
feat(Goldii-locks#398): structured event for emergency_pause_admin_override outcome
…#400) The same author's Goldii-locks#432 branch already carried this work -- the ArbitrationSplitAppliedEvent struct, its publish at the end of apply_dispute_arbitration_split, and arbitration_split_event_tests.rs -- so it landed with that merge. The only remaining difference here was a set of stale test snapshots; taking main's regenerated copies leaves the tree identical to main. Merging so the commits are recorded against this PR rather than closing it unmerged. 603 tests pass. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…i-locks#351, Goldii-locks#345, Goldii-locks#336, Goldii-locks#350) Four entrypoints now reject unauthorised callers and illegal source states before touching the ledger: * transfer_admin rejects a zero address (InvalidAddress) and refuses to rotate the admin while a multisig proposal is pending (AdminTransferPending). * emergency_unpause rejects NotPaused before taking the transition lock. * admin_resume_escrow rejects NotPaused instead of silently succeeding, so a mistaken call no longer reads as a completed recovery. * multisig_admin_override_release requires MultisigLocked to be active before any JobMeta or milestone read. lib.rs merged cleanly (main's DataKey renames Ep/EpLk applied to the branch's guards). test.rs needed hand-resolution: a three-way apply anchored the four multisig_lock insertions onto unrelated admin_override_release / admin_override_refund tests, which would have rewritten those tests into copies of the multisig ones. Reverted and placed each insertion on its intended test. 613 tests pass; wasm32 release build is clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
20 participants
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.
Summary
Closes #351
closes #345
closes #336
closes #350
Hardens caller authorization and illegal-source-state guards at the top of four admin entrypoints so rejected calls return specific typed errors and never mutate ledger state.
#351
emergency_unpauserequire_auth→NotInitialized→Unauthorized) with a singlerequire_auth(avoids hostAbortfrom duplicated auth).NotPausedchecked before the emergency-pause transition lock or any write.NotPausedwith no mutation.#345
transfer_adminnew_adminwithInvalidAddressbefore writingDataKey::Admin.AdminTransferPending).#336
multisig_admin_override_releaseMultisigLocked(InvalidStatus) before JobMeta/milestone reads — mirrors cancel-lock override ordering.multisig_lockfirst.InvalidStatus) paths assert no fund transfer and no milestone status change.#350
admin_resume_escrowNotPaused(no longer idempotent no-op).EmergencyPauseLock/Paused.NotPausedwith no mutation (viaget_yield_info).Test plan
cargo test -p milestone-escrow --lib no_mutationcargo test -p milestone-escrow --lib multisig_admin_override_releasecargo test -p milestone-escrow --lib emergency_unpause/unpausecargo test -p milestone-escrow --lib transfer_admin_uninitializedcargo test -p milestone-escrow --lib old_admin_rejected_after_transfercargo test -p milestone-escrowbefore merge