escrow: 6 public functions have no rustdoc comment at all (get_admin, get_oracle, get_treasury, get_fee_bps, get_version, get_max_sponsors)

[abayomicornelius]

Overview

With #![warn(missing_docs)] not enabled anywhere in this workspace (tracked separately in the companion issue filed in this batch), nothing currently catches undocumented pub fns. A direct scan of contracts/escrow/src/lib.rs for pub fn declarations with no preceding /// doc comment finds six: get_admin (line 652), get_oracle (659), get_treasury (666), get_fee_bps (673), get_version (680), get_max_sponsors (684). Every other public function in this file (initialize, fund, contribute, release, refund, extend_deadline, keep_alive, pause, set_admin, set_fee_bps, etc.) has a substantial doc comment — these six view functions are the only ones with none at all, an inconsistency within the same file.

Requirements

Add a one-to-few-line /// doc comment to each of the six functions listed above, describing what it returns and, where relevant (e.g. get_version), any non-obvious default behavior.

Acceptance Criteria

• All six functions documented
• cargo doc --workspace --no-deps --document-private-items still passes

Additional Notes

Verified by scanning contracts/escrow/src/lib.rs for pub fn lines with no immediately-preceding /// line.

[rupesh-kumar-sah]

Hey team,

I would love to take this on. My planned approach:

• Implement escrow: 6 public functions have no rustdoc comment at all (get_admin, get_oracle, get_treasury, get_fee_bps, get_version, get_max_sponsors) with explicit require_auth checks, secure state storage, and gas optimization.
• Cover contract calls with hermetic unit tests verifying events and token balances.

I am ready to start immediately—please feel free to assign this to me!

[rushikeshgarad2024-dev]

Resolved in #393. Added rustdoc comments across all public getter and view functions in contracts/escrow/src/lib.rs.

Payout address (Stellar): GC5U46IS25KYFKNHDXEHR3KTQB3DVIBM4NW5BH4MVUE2G77STCJP4IHF

[danielchukuma-dev]

@danielchukuma-dev has applied to work on this issue as part of the Stellar Wave Program's 9th wave.

Hi Maintainer, I’m familiar with this issue and can implement a fix. Please assign it to me if possible.

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

[alfeedrips]

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

Can I work on this task?

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

[toroabduljalalyakubu]

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

Hello, I would like to work on this Issue. I believe I should be able to deliver on time. Thank you.

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

[drips-wave]

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

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

[grantfox-oss]

🎉 This issue has been marked as completed on GrantFox!

@alfeedrips's PR #426 was approved and merged by @chonilius.

🏆 @alfeedrips: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (662 total points). Track your full progress on GrantFox.

👏 Great work, @alfeedrips! Keep contributing to MergeFi.

[drips-wave]

This issue has been completed by @alfeedrips as part of the Stellar Wave Program's 9th Wave 🥳

😎 @alfeedrips: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.