Skip to content

docs(soroban): add per-contract API reference and consolidated error table #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Meshmulla merged 1 commit into from
Jul 24, 2026
Merged

docs(soroban): add per-contract API reference and consolidated error table #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ cargo test
The release profile is tuned for small wasm output (`opt-level = "z"`, LTO,
symbol stripping) — see [`Cargo.toml`](./Cargo.toml).

## Contract API reference

Every public function under `soroban/src/` — arguments, authorization
requirements, and emitted events — is documented in
[`soroban/docs/API_REFERENCE.md`](./soroban/docs/API_REFERENCE.md), organized by
contract and grouped by what's actually compiled into the deployed contract
versus test-only or unreferenced code. The corresponding numeric error codes
are consolidated in [`soroban/docs/ERRORS.md`](./soroban/docs/ERRORS.md),
along with a check that each contract's codes are internally unique.

## Benchmarks

Resource-usage (CPU instructions, memory, ledger footprint) benchmarks for
Expand Down
Loading
Loading