Skip to content

docs: add per-contract READMEs for six Stellar crates (#167) - #169

Merged
truthixify merged 1 commit into
wraith-protocol:developfrom
boalambo:docs/167-per-contract-readmes
Aug 26, 2026
Merged

docs: add per-contract READMEs for six Stellar crates (#167)#169
truthixify merged 1 commit into
wraith-protocol:developfrom
boalambo:docs/167-per-contract-readmes

Conversation

@boalambo

Copy link
Copy Markdown
Contributor

Summary

Adds README.md files to the six Stellar crates that were missing documentation, closing #167. This documentation is load-bearing for the upcoming third-party audit engagement (#4).

Changes

  • stealth-announcer/README.md — Frozen, stateless event emitter (v2 announcement schema). Marked ⚠️ DELIBERATELY FROZEN at the top.
  • stealth-batch-sender/README.md — Batch stealth transfers, ~100x efficiency gain over individual sends.
  • stealth-vault/README.md — Time-locked vault with refund safety net.
  • wraith-asset-policy/README.md — Admin-controlled asset allowlist.
  • wraith-metrics/README.md — Shared metrics library. Marked ⚠️ LIBRARY, NOT A DEPLOYABLE CONTRACT.
  • contracts/governance/README.md — Token-weighted governance PoC. Marked ⚠️ NOT PRODUCTION READY — PROOF OF CONCEPT ONLY.
  • stellar/README.md — Updated contracts table to link all 10 crate READMEs.

Each new README follows the shared template:

  • Purpose / overview
  • Entrypoints table (with authorization)
  • Error variants (as they appear in source)
  • Event topics with data structures
  • Storage layout (incl. TTL strategy where relevant)
  • Pause / admin / metrics posture
  • Cross-links to PAUSE.md, MULTISIG.md, METRICS.md, and ONCALL.md

Notes

Acceptance criteria

  • Every Stellar crate under stellar/contracts/* and stellar/* (excluding bench, bench-crossover, integration-tests, shared) has a README
  • Each README documents the full entrypoint list, error variants, and event topics as they appear in source
  • stellar/README.md contracts table links to every crate README

Closes #167

@drips-wave

drips-wave Bot commented Aug 24, 2026

Copy link
Copy Markdown

@boalambo 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! 🚀

Learn more about application limits

@truthixify
truthixify merged commit 7fb1957 into wraith-protocol:develop Aug 26, 2026
13 checks passed
@truthixify

Copy link
Copy Markdown
Contributor

Merged. Six READMEs in one pass and the entrypoint tables match source. Thanks @boalambo.

amosleoamadi added a commit to amosleoamadi/contracts that referenced this pull request Aug 26, 2026
truthixify pushed a commit that referenced this pull request Aug 27, 2026
* docs(dx): add unified error code catalog with CI validation

* docs: catalog stealth-vault errors added in #169
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing per-contract READMEs (announcer, batch-sender, vault, asset-policy, metrics, governance)

2 participants