Tier: L (1-2 weeks) Type: tooling
Context
docs/contracts/stellar.mdx is hand-maintained and drifts. The contract source has all the type info. Generate the reference section automatically from contract WASM or TypeScript bindings.
Scope
Build scripts/generate-stellar-reference.ts:
- Reads bindings from
wraith-protocol/contracts/stellar/bindings/typescript/ (or queries deployed contracts via stellar contract inspect)
- For each contract emits MDX section: title + addresses, function table (name, params, types, return, auth-required), event signatures, storage keys
- Inserts between marker comments in
docs/contracts/stellar.mdx, preserving hand-written prose around the markers
- CI fails when generated section is stale
Acceptance criteria
Files to start with
- New:
scripts/generate-stellar-reference.ts
docs/contracts/stellar.mdx
Tier: L (1-2 weeks) Type: tooling
Context
docs/contracts/stellar.mdxis hand-maintained and drifts. The contract source has all the type info. Generate the reference section automatically from contract WASM or TypeScript bindings.Scope
Build
scripts/generate-stellar-reference.ts:wraith-protocol/contracts/stellar/bindings/typescript/(or queries deployed contracts viastellar contract inspect)docs/contracts/stellar.mdx, preserving hand-written prose around the markersAcceptance criteria
docs/CONTRIBUTING.md(when changing a Stellar contract, run this)Files to start with
scripts/generate-stellar-reference.tsdocs/contracts/stellar.mdx