Merge pull request #396 from Gogo-Eng/ci/issue-310-add-clippy-step

ci: add cargo clippy checks to contract workflows (#310)

Author: leojay-net

.github/workflows/contract-tests.yml

@@ -17,12 +17,16 @@ jobs:
       - name: Install Rust stable toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
+          components: clippy
           targets: wasm32-unknown-unknown
 
       - name: Cache Cargo dependencies
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: stellar-contracts -> target
 
+      - name: Run clippy (deny warnings)
+        run: cd stellar-contracts && cargo clippy --all-targets --all-features -- -D warnings
+
       - name: Run contract tests
         run: cd stellar-contracts && cargo test

.github/workflows/contracts.yml

@@ -31,6 +31,7 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: stable
+          components: clippy
           targets: wasm32-unknown-unknown
 
       - name: Cache Cargo registry
@@ -49,3 +50,6 @@ jobs:
 
       - name: Build WASM release
         run: cargo build --target wasm32-unknown-unknown --release
+
+      - name: Run clippy (deny warnings)
+        run: cargo clippy --all-targets --all-features -- -D warnings

stellar-contracts/src/lib.rs

@@ -1,4 +1,6 @@
 #![no_std]
+#![allow(deprecated)]
+#![allow(clippy::too_many_arguments)]
 use soroban_sdk::{
     contract, contracterror, contractimpl, contracttype, token, xdr::ToXdr, Address, Bytes, BytesN,
     Env, Symbol, Vec,
@@ -409,7 +411,7 @@ impl FiatBridge {
 
         // Transfer
         let token_client = token::Client::new(&env, &token);
-        token_client.transfer(&from, &env.current_contract_address(), &amount);
+        token_client.transfer(&from, env.current_contract_address(), &amount);
 
         // State update
         let receipt_counter: u64 = env
@@ -2099,7 +2101,7 @@ impl FiatBridge {
             .ok_or(Error::NotInitialized)?;
         admin.require_auth();
 
-        let total_ops = operations.len() as u32;
+        let total_ops = operations.len();
         let mut success_count: u32 = 0;
         let mut failure_count: u32 = 0;
         let mut first_failed_index: Option<u32> = None;
@@ -2128,6 +2130,7 @@ impl FiatBridge {
         };
 
         env.events().publish(
+            (Symbol::new(&env, "batch_ok"), Symbol::new(&env, "v1")),
             (EVENT_VERSION, Symbol::new(&env, "batch_ok")),
             (success_count, failure_count, total_ops),
         );
@@ -2182,8 +2185,8 @@ impl FiatBridge {
             return Err(Error::InternalError);
         }
         let mut arr = [0u8; 4];
-        for i in 0..4 {
-            arr[i] = bytes.get(i as u32).ok_or(Error::InternalError)?;
+        for (i, slot) in arr.iter_mut().enumerate() {
+            *slot = bytes.get(i as u32).ok_or(Error::InternalError)?;
         }
         Ok(u32::from_be_bytes(arr))
     }
@@ -2193,8 +2196,8 @@ impl FiatBridge {
             return Err(Error::InternalError);
         }
         let mut arr = [0u8; 16];
-        for i in 0..16 {
-            arr[i] = bytes.get(i as u32).ok_or(Error::InternalError)?;
+        for (i, slot) in arr.iter_mut().enumerate() {
+            *slot = bytes.get(i as u32).ok_or(Error::InternalError)?;
         }
         Ok(i128::from_be_bytes(arr))
     }

stellar-contracts/src/test.rs

@@ -475,7 +475,7 @@ fn test_get_config_snapshot() {
     assert_eq!(config.lock_period, bridge.get_lock_period());
     assert_eq!(config.cooldown_ledgers, bridge.get_cooldown());
     assert_eq!(config.inactivity_threshold, DEFAULT_INACTIVITY_THRESHOLD);
-    assert_eq!(config.allowlist_enabled, false);
+    assert!(!config.allowlist_enabled);
     assert_eq!(config.emergency_recovery, None);
     assert_eq!(config.anti_sandwich_delay, bridge.get_anti_sandwich_delay());
 }
@@ -2608,6 +2608,10 @@ mod proptest_deposit {
     use proptest::prelude::*;
 
     // Deposit invariants that must hold for every positive amount <= limit:
+    // 1. deposit() succeeds
+    // 2. contract balance increases by exactly amount
+    // 3. user balance decreases by exactly amount
+    // 4. get_user_deposited() returns amount
     //   1. deposit() succeeds
     //   2. contract balance increases by exactly `amount`
     //   3. user balance decreases by exactly `amount`