From 466679abea020f79a746792f67da3c8da29ddda5 Mon Sep 17 00:00:00 2001 From: Leothosine Date: Wed, 13 May 2026 05:03:50 +0100 Subject: [PATCH] docs: add doc comment to VaultRouter struct --- contracts/vault_router/src/lib.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/contracts/vault_router/src/lib.rs b/contracts/vault_router/src/lib.rs index 48f39f3..da109a1 100644 --- a/contracts/vault_router/src/lib.rs +++ b/contracts/vault_router/src/lib.rs @@ -1,6 +1,12 @@ #![no_std] use soroban_sdk::{contract, contractimpl, Env}; +/// VaultRouter is the user-facing entry point for the YieldLadder protocol. +/// +/// It routes deposit, withdrawal, and early-exit operations to the appropriate +/// tier vault ( ault_l3, ault_l6, or ault_l12) based on the lock-up +/// period chosen by the user. All share minting and yield accounting is +/// delegated to the selected tier vault. #[contract] pub struct VaultRouter; @@ -22,4 +28,4 @@ mod tests { let env = Env::default(); let _id = env.register_contract(None, VaultRouter); } -} +} \ No newline at end of file