docs: Comprehensive API Documentation for PrivacyPool Contract#149
Open
foorttesst-oss wants to merge 1 commit intoANAVHEOBA:mainfrom
Open
docs: Comprehensive API Documentation for PrivacyPool Contract#149foorttesst-oss wants to merge 1 commit intoANAVHEOBA:mainfrom
foorttesst-oss wants to merge 1 commit intoANAVHEOBA:mainfrom
Conversation
- Full documentation of all contract functions (initialize, deposit, withdraw) - View functions (get_root, deposit_count, is_known_root, is_spent, get_config) - Admin functions (pause, unpause) - Complete type definitions (Denomination, Proof, PublicInputs, PoolConfig, Error) - Event documentation (DepositEvent, WithdrawEvent) - Architecture diagram - Error codes reference table Resolves ANAVHEOBA#62
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.
Bounty: #62 — Create API Documentation with OpenAPI
What's included:
📚 Full API documentation covering:
Format:
docs/API.md)Notes:
Resolves #62