Skip to content

docs: add contract README and /// doc comments to aid_escrow public f…#197

Open
YahKazo wants to merge 2 commits intoPulsefy:mainfrom
YahKazo:soter
Open

docs: add contract README and /// doc comments to aid_escrow public f…#197
YahKazo wants to merge 2 commits intoPulsefy:mainfrom
YahKazo:soter

Conversation

@YahKazo
Copy link
Copy Markdown

@YahKazo YahKazo commented Mar 24, 2026

app/onchain/contracts/aid_escrow/README.md — created from scratch with:

  • What the contract does and the pool-based funding model
  • ASCII state machine diagram (Created → Claimed / Cancelled → Refunded / Expired → Refunded)
  • Full public function reference table with argument types, descriptions, and error lists
  • Complete Error enum reference table (all 14 variants with codes and trigger conditions)
  • Events table (all 11 event types with key fields)
  • Build/test/deploy quick-start commands

src/lib.rs — /// doc comments added to all 21 public functions:

  • Every function documents its # Arguments (with type and description) and # Errors (with the exact Error variant and the
    condition that triggers it)
  • Replaced the old inline prose comments on revoke, cancel_package, extend_expiration, and withdraw_surplus with proper
    structured doc comments
  • No logic was touched — only documentation
    closes Improve Contract README and Function Docs #74

@drips-wave
Copy link
Copy Markdown

drips-wave bot commented Mar 24, 2026

@YahKazo Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Cedarich
Copy link
Copy Markdown
Contributor

please resolve conflict

@Cedarich
Copy link
Copy Markdown
Contributor

@YahKazo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Contract README and Function Docs

2 participants