Test/revenue pool invariant runner - #467
Merged
greatest0fallt1me merged 2 commits intoJun 26, 2026
Merged
Conversation
|
@MerlinTheWhiz 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! 🚀 |
Contributor
Author
|
Hi @greatest0fallt1me Thanks for the opportunity to contribute. I applied for the remaining two issues on Creditra contract and Callora backend, please assign. |
3 tasks
Contributor
|
the revenue-pool invariant runner is great — codifying the conservation properties so they can't silently regress. merged 👍 |
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
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.
Revenue Pool Invariant Test:
balance >= scheduledper tickSummary
Adds a Foundry-style stateful invariant test for the
RevenuePoolcontract, verifying that the on-ledger USDC balance of the contract is always at least the sum of approved-but-not-yet-distributed payments at every step of a randomized trace.Closes #446
Changes
New:
contracts/revenue_pool/src/test_invariant.rsA deterministic stateful invariant runner with:
SimpleRngscheduledtotaldistribute, decrementscheduledon successbatch_distributewith 1-5 legsusdc.balance(pool) >= scheduledstd::panic::catch_unwindfor expected reverts so the trace continues after failures (e.g., distribute while paused, duplicate recipients, insufficient balance)Fixed:
contracts/revenue_pool/src/lib.rsPAUSED_KEYandERR_PAUSEDconstants — these were referenced bypause,unpause, andis_pausedbut not defined, preventing compilationmod test_invariant;declarationUpdated:
INVARIANTS.mdAdded "Revenue Pool On-Ledger Coverage Invariant" section documenting the invariant, its pre/post-conditions, the functions that affect it, and how the test suite validates it.
Test Results
All 128 traces passed — the invariant held across all 9,600 steps.
Run with:
Edge Cases Covered
ERR_PAUSED), verifiesscheduledis unchanged, then unpausesscheduled - batch_total; cap amounts ensure no arithmetic edge cases