docs: full contract API reference in README - #6
Merged
Merged
Conversation
Cover every public entry point, data type, event, and error code for the treasury, factory, and test-token contracts, all verified against source. Caller-facing signatures note injected Env and required auth; errors and events link to the corresponding source.
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
Adds a Contract reference section to the README documenting the complete callable interface of all three contracts. The README previously explained how the contracts work conceptually but never listed the actual entry points, so a developer couldn't see what to call.
Coverage
Category/Request/RequestStatustypes; all 9 events (topics vs data); all 11 error codes.OrgRecordtype;TreasuryDeployedevent; all 4 error codes. Documents the dual deployer+admin auth ondeploy_treasury.Accuracy
Every signature, event, and error was read from source (
contracts/*/src/{lib,types,events,errors}.rs), not inferred. Known-gap callouts link to the existing tracking issues (#2, #3). No contract logic changed — docs only.