Skip to content

[Docs] Write a Soroban contract reference for lending_pool, loan_manager, multisig_governance, and remittance_nft #3

@grantfox-oss

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

wiki/contract-state-machine.md covers loan lifecycle at a high level, but there is no reference listing each contract's public functions, parameters, emitted events, error codes, and storage keys. This is essential for anyone integrating with or auditing the contracts.

Acceptance criteria

  • For each of the four contracts, list public functions with signatures and a one-line description
  • Document emitted events and their topics/data
  • Document the error enums and what triggers each variant
  • Document the storage keys and their storage class (instance/persistent/temporary) and TTL expectations

Files to touch

  • contracts-reference.md (new)
  • wiki/contract-state-machine.md

Out of scope

  • Formal verification writeups
  • Gas/size benchmarking docs

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationhardAdvanced / high-difficulty issuehelp wantedExtra attention is needed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions