From b751d69767a5411139256bd70d0f5bd8cb20595a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Calfeedrips=E2=80=9D?=
 <“garbaalfred4@gmail.com”>
Date: Mon, 28 Sep 2026 16:17:21 +0100
Subject: [PATCH] docs(escrow): add doc comments to six view functions

Add /// doc comments to get_admin, get_oracle, get_treasury, get_fee_bps,
get_version, and get_max_sponsors in contracts/escrow/src/lib.rs.

These were the only public functions in the file lacking documentation,
an inconsistency with the rest of the module. Each comment describes what
the function returns; get_version also notes its non-obvious default of 0
when the version flag has not been set.
---
 contracts/escrow/src/lib.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/contracts/escrow/src/lib.rs b/contracts/escrow/src/lib.rs
index b2d08b2..11b019c 100644
--- a/contracts/escrow/src/lib.rs
+++ b/contracts/escrow/src/lib.rs
@@ -661,6 +661,7 @@ mod contract {
         Ok(())
     }
 
+    /// Returns the admin address for this escrow contract.
     pub fn get_admin(env: Env) -> Result<Address, Error> {
         env.storage()
             .instance()
@@ -668,6 +669,7 @@ mod contract {
             .ok_or(Error::NotInitialized)
     }
 
+    /// Returns the oracle address for this escrow contract.
     pub fn get_oracle(env: Env) -> Result<Address, Error> {
         env.storage()
             .instance()
@@ -675,10 +677,12 @@ mod contract {
             .ok_or(Error::NotInitialized)
     }
 
+    /// Returns the treasury address for this escrow contract.
     pub fn get_treasury(env: Env) -> Result<Address, Error> {
         mergefi_common::require_treasury::<DataKey>(&env).ok_or(Error::NotInitialized)
     }
 
+    /// Returns the protocol fee in basis points (e.g. 250 = 2.5%).
     pub fn get_fee_bps(env: Env) -> Result<u32, Error> {
         mergefi_common::get_fee_bps::<DataKey>(&env).ok_or(Error::NotInitialized)
     }
@@ -691,10 +695,13 @@ mod contract {
         Ok(())
     }
 
+    /// Returns the contract version. Defaults to `0` if the version flag
+    /// has not been set (e.g. by `upgrade`).
     pub fn get_version(env: Env) -> u32 {
         env.storage().instance().get(&DataKey::Version).unwrap_or(0)
     }
 
+    /// Returns the maximum number of sponsors allowed per escrow.
     pub fn get_max_sponsors(env: Env) -> Result<u32, Error> {
         env.storage()
             .instance()