Document the fees model and its invariants

Document the fees model

Description

The fees model and its invariants are undocumented, making audits harder. This issue documents them.

Requirements and context

Repository scope: Agentpay-Org/Agentpay-contracts only.
Add docs/fees.md describing the fees data model, its invariants, and the entrypoints that touch it.
Cross-reference the code with a worked example; keep it accurate.
Read the relevant module first.

Suggested execution

Fork the repo and create a branch
git checkout -b docs/fees-01-model
Implement changes
- Write code in: the relevant module.
- Write comprehensive tests in: cover the new behaviour and edge cases.
Test and commit

Test and commit

Run cargo fmt, cargo clippy --all-targets -- -D warnings, and cargo test.
Cover edge cases: n/a — verify invariants against source.
Include the full test output in the PR description.

Example commit message

docs(fees): document the model and invariants

Guidelines

Minimum 95 percent test coverage for impacted modules.
Clear, reviewer-focused documentation.
Timeframe: 96 hours.

Community & contribution rewards

💬 Join the AgentPay community on Discord: https://discord.gg/eXvRKkgcv
⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — a 5-star rating is much appreciated.

Hi, I’d love to take on this issue! With my expertise in Rust, Stellar, and smart contract development, I can implement a clean and efficient solution.

🚀 Why Me?

Proven Blockchain Experience – Hands-on work with Stellar, Solidity, and Rust, building secure and optimized smart contracts.
Open Source Contributor – Actively contributed to 50+ open-source projects, showcasing adaptability and collaboration.
Efficient & Reliable – I deliver high-quality, production-ready solutions quickly, ensuring security and scalability.

⏱ Timeline

I estimate completing this within 24 hours. Let me know if I can proceed!

@Jagadeeshftw

🦊 GrantFox — @Jagadeeshftw has been assigned to this issue as part of the Official Campaign | FWC26 campaign!

Next steps:

Open a Pull Request referencing this issue (e.g., Closes #296)
Your PR will be reviewed by the Agentpay-Org maintainers

Good luck! Track your progress on GrantFox.

@Jagadeeshftw

🎉 You're assigned, @Jagadeeshftw! Part of the Stellar Wave Program — join our Telegram to coordinate: https://t.me/+OhR36aTevMYwYzI9 🚀

@Jagadeeshftw

🎉 This issue has been marked as completed on GrantFox as part of the Official Campaign | FWC26 campaign!

@Jagadeeshftw's PR #430 was approved and merged by @mikewheeleer.

🏆 @Jagadeeshftw: You earned 45 FoxPoints for this contribution! Your current tier: Specialist (3,581 total points). Track your full progress on GrantFox.

👏 Great work, @Jagadeeshftw! Keep contributing to Agentpay-Org.

Navigation Menu

Repository navigation

Document the fees model and its invariants #296