Document the EscrowError catalog with trigger conditions

[mikewheeleer]

Description

EscrowError in types.rs defines 43 variants, several of which are unused (Accepted-related, SelfRating, CommentTooLong, EmptyComment, MilestonesAlreadyReleased, NotReadyForFinalization). Reviewers and integrators have no single reference mapping error codes to the conditions that raise them. Produce a complete error-code reference.

Requirements and context

• Scoped to TalentTrust escrow Soroban contract (contracts/escrow).
• For each EscrowError variant, document its numeric code, the entrypoint(s) that raise it, and the precise trigger condition; clearly mark variants that are currently unused/reserved.
• Cross-link to the relevant entrypoint docs and to issues that will start using reserved codes.
• Acceptance: the catalog matches the enum's numbering (1..=43) exactly.
• Must be secure, tested, and documented.

Suggested execution

• Fork the repo and create a branch:
  • git checkout -b docs/error-catalog
• Implement changes:
  • docs/escrow/SECURITY.md
  • Tests: contracts/escrow/src/test/security.rs
  • Docs: docs/escrow/SECURITY.md
  • Include rustdoc/NatSpec-style doc comments on public functions
  • Validate security assumptions (auth, overflow, fail-closed state machine, storage TTL, fee accounting)

Test and commit

• Run tests: cargo test
• Cover edge cases (unauthorized callers, double release/refund, expired approvals, fee rounding, paused state)
• Include test output and security notes in the PR

Example commit message

docs(escrow): document EscrowError code catalog

Guidelines

• Minimum 95% test coverage on new/changed code
• Clear documentation
• Timeframe: 96 hours from assignment

[spartan124]

@spartan124 has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

Hi, I have worked across several teams building rust smart contracts and will love to contribute to your project. Kindly assign

ℹ️ Repo Maintainers: To accept this application, review their application or assign @spartan124 to this issue.

[drips-wave]

Congratulations, @spartan124! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 2, 2026.

🧑‍💻 @spartan124: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊