Merge pull request Lead-Studios#66 from Kaylahray/feat/escrow-actions

Implemented escrow actions

Author: BigBen-7

veritixpay/contract/token/src/admin.rs

@@ -2,32 +2,32 @@ use soroban_sdk::{Address, Env};
 
 use crate::storage_types::DataKey;
 
-pub fn read_administrator(e: &Env) -> Address {
+// --- Core admin storage helpers ---
+
+pub fn read_admin(e: &Env) -> Address {
     e.storage().instance().get(&DataKey::Admin).unwrap()
 }
 
-pub fn write_administrator(e: &Env, id: &Address) {
+pub fn write_admin(e: &Env, id: &Address) {
     e.storage().instance().set(&DataKey::Admin, id);
 }
 
-pub fn has_administrator(e: &Env) -> bool {
+pub fn has_admin(e: &Env) -> bool {
     e.storage().instance().has(&DataKey::Admin)
 }
 
+/// Verifies that `admin` is the current admin and has authorized the call.
 pub fn check_admin(e: &Env, admin: &Address) {
     admin.require_auth();
-    let stored = read_administrator(e);
+    let stored = read_admin(e);
     if admin != &stored {
         panic!("not authorized: caller is not the admin");
     }
 }
 
-
+/// Rotates the stored admin to `new_admin`. Must be called by the current admin.
 pub fn transfer_admin(e: &Env, new_admin: Address) {
-    // 1. Verify that the current admin is authorizing this call
     let current_admin = read_admin(e);
     current_admin.require_auth();
-
-    // 2. Write the new admin to persistent storage
     write_admin(e, &new_admin);
-}
+}

veritixpay/contract/token/src/allowance.rs

@@ -6,8 +6,12 @@ pub fn read_allowance(e: &Env, from: Address, spender: Address) -> AllowanceValu
         from: from.clone(),
         spender: spender.clone(),
     });
-    
-    if let Some(allowance) = e.storage().persistent().get::<DataKey, AllowanceValue>(&key) {
+
+    if let Some(allowance) = e
+        .storage()
+        .persistent()
+        .get::<DataKey, AllowanceValue>(&key)
+    {
         if allowance.expiration_ledger < e.ledger().sequence() {
             AllowanceValue {
                 amount: 0,
@@ -53,15 +57,15 @@ pub fn write_allowance(
 
 pub fn spend_allowance(e: &Env, from: Address, spender: Address, amount: i128) {
     let allowance = read_allowance(e, from.clone(), spender.clone());
-    
+
     if allowance.expiration_ledger < e.ledger().sequence() {
         panic!("allowance is expired");
     }
-    
+
     if allowance.amount < amount {
         panic!("insufficient allowance");
     }
-    
+
     write_allowance(
         e,
         from,

veritixpay/contract/token/src/balance.rs

@@ -1,11 +1,11 @@
-use crate::storage_types::{DataKey, BALANCE_LIFETIME_THRESHOLD, BALANCE_BUMP_AMOUNT};
+use crate::storage_types::{DataKey, BALANCE_BUMP_AMOUNT, BALANCE_LIFETIME_THRESHOLD};
 use soroban_sdk::{Address, Env};
 
 /// Returns the balance for an address, or 0 if not set
 pub fn read_balance(e: &Env, addr: Address) -> i128 {
     let key = DataKey::Balance(addr);
     let storage = e.storage().persistent();
-    
+
     if let Some(balance) = storage.get::<DataKey, i128>(&key) {
         storage.extend_ttl(&key, BALANCE_LIFETIME_THRESHOLD, BALANCE_BUMP_AMOUNT);
         balance
@@ -19,24 +19,27 @@ pub fn receive_balance(e: &Env, addr: Address, amount: i128) {
     if crate::freeze::is_frozen(e, &addr) {
         panic!("account frozen");
     }
-    
+
     let key = DataKey::Balance(addr.clone());
     let current_balance = read_balance(e, addr); // TTL is extended here
     let new_balance = current_balance + amount;
-    
+
     e.storage().persistent().set(&key, &new_balance);
 }
 /// Subtracts amount from address balance — panics if insufficient
 pub fn spend_balance(e: &Env, addr: Address, amount: i128) {
     let key = DataKey::Balance(addr.clone());
     let current_balance = read_balance(e, addr);
-    
+
     if current_balance < amount {
-        panic!("insufficient balance: attempted to spend {} but only {} available", amount, current_balance);
+        panic!(
+            "insufficient balance: attempted to spend {} but only {} available",
+            amount, current_balance
+        );
     }
-    
+
     let new_balance = current_balance - amount;
-    
+
     let storage = e.storage().persistent();
     storage.set(&key, &new_balance);
     storage.extend_ttl(&key, BALANCE_LIFETIME_THRESHOLD, BALANCE_BUMP_AMOUNT);
@@ -46,18 +49,25 @@ pub fn spend_balance(e: &Env, addr: Address, amount: i128) {
 // (Make sure to import DataKey if not already imported)
 
 pub fn read_total_supply(e: &Env) -> i128 {
-    e.storage().instance().get(&DataKey::TotalSupply).unwrap_or(0)
+    e.storage()
+        .instance()
+        .get(&DataKey::TotalSupply)
+        .unwrap_or(0)
 }
 
 pub fn increase_supply(e: &Env, amount: i128) {
     let supply = read_total_supply(e);
-    e.storage().instance().set(&DataKey::TotalSupply, &(supply + amount));
+    e.storage()
+        .instance()
+        .set(&DataKey::TotalSupply, &(supply + amount));
 }
 
 pub fn decrease_supply(e: &Env, amount: i128) {
     let supply = read_total_supply(e);
     if supply < amount {
         panic!("supply cannot be negative");
     }
-    e.storage().instance().set(&DataKey::TotalSupply, &(supply - amount));
-}
+    e.storage()
+        .instance()
+        .set(&DataKey::TotalSupply, &(supply - amount));
+}