Skip to content

API docs: proposals contract interface #466

Description

@codebestia

Write contracts/docs/api-proposals.md documenting every public function in contracts/contracts/proposals/src/lib.rsinitialize, create_proposal, vote, finalize_proposal/finalize_expired_proposal, execute_proposal/execute_withdraw, get_proposal — including how execute_withdraw calls into the group_treasury contract via the cross-contract client.

Acceptance criteria:

  • Every public function is documented with its full signature, authorization requirements, and panics/error conditions
  • The full proposal lifecycle (create → vote → finalize → execute) is documented as one worked example, including the expiry path
  • The cross-contract call into group_treasury on execution is documented explicitly

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programcontractsdocumentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions