Add Contract Examples for Integrators

[mikewheeleer]

Implement Practical Contract Usage Examples

Description

Add end-to-end usage examples showing init, fund, settle, and claim flows for downstream backend and test integrators.

Requirements and context

• Must be secure, tested, and documented
• Should be efficient and easy to review

Suggested execution

• Fork the repo and create a branch
• git checkout -b docs/escrow-usage-examples
• Implement changes
• Update documentation: README.md
• Add code examples around escrow/src/lib.rs
• Validate assumptions for copy-paste reliability

Test and commit

• Run tests
• Cover edge cases
• Include test output and security notes

Example commit message

docs(escrow): add practical end-to-end integration examples

Guidelines

• Minimum 95 percent test coverage
• Clear documentation
• Timeframe: 96 hours

[Kanasjnr]

@Kanasjnr has applied to work on this issue as part of the Stellar Wave Program's 3rd wave.

I’d like to be assigned to this. I’ll focus on building developer-centric, “copy-paste” ready integration examples for the full lifecycle from init to claim. My priority is ensuring these examples are robust and include clear error-handling paths to simplify the onboarding experience for downstream integrators.

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

[drips-wave]

Congratulations, @Kanasjnr! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on March 30, 2026.

🧑‍💻 @Kanasjnr: 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 🌊

[Kanasjnr]

@mikewheeleer This branch (docs/escrow-usage-examples) contains the end-to-end integration documentation for the new claim() flow. However, these examples are currently non-functional because the claim() implementation and security refactor from PR #91 have not yet been merged into main.

Action required: This PR will be well executed only after #13 is successfully closed and #91 merged.