Skip to content

Latest commit

 

History

History
 
 

README.md

MyFans Contract Interfaces

Comprehensive documentation for all public contract methods, including arguments, authorization requirements, runnable soroban contract invoke examples (local network), and expected events.

Available Interfaces

All public contract methods documented with args, auth, examples, events. Examples runnable via --dry-run.

Usage

Examples assume local deployment (contract/deployed-local.json). Replace:

  • <CONTRACT_ID>: Contract address from deployed-local.json
  • <TOKEN_ID>: Token contract ID
  • Addresses/IDs with test values.

Run: soroban contract invoke --network local --source registry --wasm path/to/target.wasm --dry-run to validate.

Drift Check

To ensure contract interface docs stay linked to code, run:

  • npm run check:interfaces (validates all docs/interfaces/*.md method tables against referenced contracts/**/src/lib.rs files)
  • npm run test:interfaces (parser/unit tests for the drift check)

The release checklist (npm run release-check) now includes the interface drift check.