Skip to content

README.md

Latest commit

 

History

History
35 lines (25 loc) · 1.72 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.72 KB
Raw

Fund-My-Cause API Reference

Contract version: 4 · Network: Stellar / Soroban · Rustdoc

This directory contains the full API surface of both on-chain contracts.

Document Contents
crowdfund.md Every public function on the crowdfund contract
registry.md Campaign discovery registry contract
events.md Complete event reference with payloads
errors.md All ContractError codes with remediation
types.md Every #[contracttype] struct and enum
graphql.md Generated GraphQL API schema and operations reference
sdk-js/ Generated TypeScript reference for @fund-my-cause/sdk

sdk-js/ is generated by TypeDoc from the SDK's JSDoc and committed to the repo. Do not edit those files by hand — change the JSDoc in sdks/js/src/ and run npm run docs from sdks/js. See the SDK README.

Quick links

Conventions

Amounts — all token amounts are in stroops (1 XLM = 10 000 000 stroops) unless otherwise noted.

Auth — functions that mutate state require the caller identified by the first Address argument to sign the transaction. Read-only functions (view) do not require auth.

Errors — all mutable functions return Result<_, ContractError>. See errors.md for the full table.