docs: add Contract Events table, security review version, and top_up new-token test - #346
Merged
icentedward76-sketch merged 1 commit intoAug 31, 2026
Conversation
…etadata Closes SoroWill#299 Closes SoroWill#300 Closes SoroWill#301 Closes SoroWill#302 - (SoroWill#302) Add Contract Events table to README.md mapping each state-mutating entry point to its emitted event topic symbol and payload shape, sourced from events.rs. Canonical source of truth link included. - (SoroWill#301) Add contract version (1.0.0 / CONTRACT_VERSION = 1_000_000) and staleness note to docs/SECURITY-REVIEW.md so readers can determine which codebase version the review covers and know how to request a re-review. - (SoroWill#300) README.md guardian section already links to docs/adr/0001-guardian-threshold.md — no change needed. - (SoroWill#299) Add issue_299_test.rs: creates a single-token will, tops up with a second brand-new token never seen by that will, asserts get_will reflects both balances, then triggers and releases to verify both tokens are correctly distributed to the beneficiary.
|
@iheomadev 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! 🚀 |
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
2 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
This PR resolves all four open issues assigned to me in the Stellar Wave program.
Changes
#302 — Contract Events table in README
Added a
## Contract Eventstable toREADME.mdmapping every state-mutating entry point to its topic symbol and payload shape, sourced fromevents.rs. SDK integrators can now discover event subscriptions directly from the README without reading contract source.#301 — Security review version metadata
Added
**Contract version:**header (1.0.0 /CONTRACT_VERSION = 1_000_000) and a staleness note todocs/SECURITY-REVIEW.mdso readers can tell which codebase revision was reviewed and how to request a re-review after significant changes.#300 — ADR link in README guardian section
The README's guardian section already links to
docs/adr/0001-guardian-threshold.md— no change needed.#299 — Test:
top_upwith a brand-new tokenAdded
contracts/will/src/issue_299_test.rswithtop_up_with_new_token_is_reflected_in_get_will_and_released:token_aonlytop_upwithtoken_b(never seen by that will before)get_willreflects both token balancesValidation
README.mdandSECURITY-REVIEW.md— no toolchain requiredissue_280_test.rsandallocation_test.rscargo test --workspaceandcargo clippy --all-targets -- -D warningsCloses #299
Closes #300
Closes #301
Closes #302