docs: add complete escrow entrypoint and error-code reference#72
Merged
mikewheeleer merged 1 commit intoJun 24, 2026
Merged
Conversation
Adds docs/escrow/api.md documenting every entrypoint (signature, auth, pause behaviour, returns, panics) and the full EscrowError catalogue, cross-checked against the source. Linked from README. No logic change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Closes #26.
Summary
Adds
docs/escrow/api.md— a single, source-checked API reference for the escrow contract, linked from the README's Documentation section.Contents
EscrowErrorvariant → numeric code, trigger condition, and the entrypoints that raise it.version()vsget_schema_version()distinction.Tests
Docs-only change; no source modified.
Security notes
The doc states auth and pause requirements per entrypoint exactly as enforced in
lib.rs(verified line-by-line), so integrators cannot misread which calls are admin-gated.