docs(events): document the model and invariants - #429
Merged
mikewheeleer merged 2 commits intoJul 28, 2026
Conversation
env.events().all() reflects only the most recent contract invocation, not a running total across separate calls (consistent with every other event test in this file). The test compared post-transfer event count against a pre-transfer count captured after a *different* call (set_service_metadata), expecting accumulation that never happens, so it failed on every run regardless of contract behavior. Fixed to assert directly on this call's own event count.
Jagadeeshftw
force-pushed
the
docs/events-01-model
branch
from
July 28, 2026 21:18
e7f503f to
a344813
Compare
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
The escrow contract publishes 22 distinct event topics but had no catalog of them. Adds
docs/escrow/events.md:cfg_setwith its 6 config tags, anddisputewith itsopen/resolveactions) so indexers know how to disambiguate them.symbol_short!limit (compile-time enforced), and that every publish follows its storage write.set_agent_allowed,set_agent_blocked,propose_admin_transfer, andcancel_admin_transferwrite storage but emit no event, unlike every other setter in the contract. Cross-referenced againstdocs/escrow/storage.md's note thatUsageAlertThreshold(which would driveusage_hi) has no setter either.README.md's documentation index.No contract code changes — docs only.
Closes #291
Validation
cargo fmt --all -- --checkcargo build -p escrowcargo test -p escrow— 352 passed, 1 pre-existing failure unrelated to this change (test_transfer_service_ownership_genuine_transfer_emits_event, fails identically onmain)