π Description
Write the complete API reference documentation for Alien Gateway, covering all Soroban contract entry points and all TypeScript SDK methods. This documentation will live in docs/ and be linked from the README.
β
Requirements
- Document all public contract entry points:
submit_proof, resolve, add_stellar_address, add_chain_address, set_memo, create_vault, deposit, withdraw, schedule_payment
- Document all SDK methods:
resolveUsername, sendToUsername, fetchProxyAddress, verifyOwnership
- Include input/output types, error codes, and example calls for each
- Markdown format, clear headings, and code examples
π― Acceptance Criteria
π Expected files to change/structure
docs/api-reference.md β new file
README.md β add link to docs
πΏ Branch: docs/api-reference | Priority: LOW | Difficulty: β one-coffee
π Description
Write the complete API reference documentation for Alien Gateway, covering all Soroban contract entry points and all TypeScript SDK methods. This documentation will live in
docs/and be linked from the README.β Requirements
submit_proof,resolve,add_stellar_address,add_chain_address,set_memo,create_vault,deposit,withdraw,schedule_paymentresolveUsername,sendToUsername,fetchProxyAddress,verifyOwnershipπ― Acceptance Criteria
docs/api-reference.mdexists and is linked fromREADME.mdπ Expected files to change/structure
docs/api-reference.mdβ new fileREADME.mdβ add link to docs