docs(contracts): document event schemas and add drift tests - #482
Open
dotmantissa wants to merge 2 commits into
Open
docs(contracts): document event schemas and add drift tests#482dotmantissa wants to merge 2 commits into
dotmantissa wants to merge 2 commits into
Conversation
Document all contract event schemas, topic tuples, payload structures, emission triggers, non-event operations, and indexer filter patterns in EVENTS.md and docs/EVENTS.md. Add unit tests asserting exact event topics and payloads across ProofRegistry, IssuerRegistry, CredentialVerifier, and GatedPool to prevent schema drift. Reference the event specifications in the indexer, SDK, and repo documentation.
|
@dotmantissa 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
1 participant
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.
What does this PR do?
Authoritatively documents all Soroban contract event schemas across ProofRegistry, IssuerRegistry, CredentialVerifier, and GatedPool in
EVENTS.mdanddocs/EVENTS.md. Defines topic tuples, contract payload structs, field types, emission triggers, non-event operations, and indexer filter patterns. Adds unit tests across all four contracts asserting that emitted event topic tuples and payload structures match the specification to prevent schema drift, and updates the indexer, SDK, and repository documentation to reference the authoritative event schemas.Closes #429
Type of change
Merge requirements
cargo test(contracts),pnpm tsc --noEmit(frontend),pnpm build(frontend), circuit tests — all greenfixtures/<type>/artifacts updatedNEXT_PUBLIC_prefix on server-only env varsprehash:falsepreserved on any issuer signing path touched✅ Merge requirements
Notes for reviewers
Event structs now derive
Debug, Eq, PartialEqto support direct assertions in tests without changing the on-chain XDR layout generated by#[contracttype]. Unit tests assert exact emitted topic tuples and payload structs against Soroban event buffers.