ref: Add/Sub Assignment Operations + e2e-tests.sh

CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- 
+
+### Changed
+
+- Refactor how `AddAssignUnchecked` and `SubAssignUnchecked` are used in `Erc20`, `Erc721`, and `Erc721Consecutive`. #467
+- Refactor `Nonces`. #467
+
+### Changed (Breaking)
+
+-
+
+### Fixed
+
+-
+
 ## [v0.2.0-alpha.2] - 2024-12-18
 
 ### Added

contracts/src/token/erc20/mod.rs

@@ -14,7 +14,10 @@
     stylus_proc::{public, SolidityError},
 };
 
-use crate::utils::introspection::erc165::{Erc165, IErc165};
+use crate::utils::{
+    introspection::erc165::{Erc165, IErc165},
+    math::storage::{AddAssignUnchecked, SubAssignUnchecked},
+};
 
 pub mod extensions;
 pub mod utils;
@@ -489,17 +492,15 @@
         }
 
         if to.is_zero() {
-            let total_supply = self.total_supply();
             // Overflow not possible:
             // `value` <= `_total_supply` or
             // `value` <= `from_balance` <= `_total_supply`.
-            self._total_supply.set(total_supply - value);
+            self._total_supply.sub_assign_unchecked(value);
         } else {
-            let balance_to = self._balances.get(to);
             // Overflow not possible:
             // `balance_to` + `value` is at most `total_supply`,
             // which fits into a `U256`.
-            self._balances.setter(to).set(balance_to + value);
+            self._balances.setter(to).add_assign_unchecked(value);
         }
 
         evm::log(Transfer { from, to, value });

contracts/src/token/erc721/extensions/consecutive.rs

@@ -452,17 +452,11 @@
             // Clear approval. No need to re-authorize or emit the `Approval`
             // event.
             self._approve(Address::ZERO, token_id, Address::ZERO, false)?;
-            self.erc721
-                ._balances
-                .setter(from)
-                .sub_assign_unchecked(uint!(1_U256));
+            self.erc721._balances.setter(from).sub_assign_unchecked(1);
         }
 
         if !to.is_zero() {
-            self.erc721
-                ._balances
-                .setter(to)
-                .add_assign_unchecked(uint!(1_U256));
+            self.erc721._balances.setter(to).add_assign_unchecked(1);
         }
 
         self.erc721._owners.setter(token_id).set(to);

contracts/src/token/erc721/mod.rs

@@ -1,7 +1,7 @@
 //! Implementation of the [`Erc721`] token standard.
 use alloc::vec;
 
-use alloy_primitives::{uint, Address, FixedBytes, U128, U256};
+use alloy_primitives::{Address, FixedBytes, U128, U256};
 use openzeppelin_stylus_proc::interface_id;
 use stylus_sdk::{
     abi::Bytes,
@@ -688,7 +688,7 @@
     /// * `account` - Account to increase balance.
     /// * `value` - The number of tokens to increase balance.
     pub fn _increase_balance(&mut self, account: Address, value: U128) {
-        self._balances.setter(account).add_assign_unchecked(U256::from(value));
+        self._balances.setter(account).add_assign_unchecked(value);
     }
 
     /// Transfers `token_id` from its current owner to `to`, or alternatively
@@ -738,11 +738,11 @@
             // Clear approval. No need to re-authorize or emit the `Approval`
             // event.
             self._approve(Address::ZERO, token_id, Address::ZERO, false)?;
-            self._balances.setter(from).sub_assign_unchecked(uint!(1_U256));
+            self._balances.setter(from).sub_assign_unchecked(1);
         }
 
         if !to.is_zero() {
-            self._balances.setter(to).add_assign_unchecked(uint!(1_U256));
+            self._balances.setter(to).add_assign_unchecked(1);
         }
 
         self._owners.setter(token_id).set(to);

contracts/src/utils/math/storage.rs

@@ -1,5 +1,5 @@
 //! Simple math operations missing in `stylus_sdk::storage`.
-use alloy_primitives::Uint;
+use alloy_primitives::{ruint::UintTryFrom, Uint};
 use stylus_sdk::storage::StorageUint;
 
 /// Adds value and assign the result to `self`, ignoring overflow.
@@ -8,11 +8,13 @@ pub(crate) trait AddAssignUnchecked<T> {
     fn add_assign_unchecked(&mut self, rhs: T);
 }
 
-impl<const B: usize, const L: usize> AddAssignUnchecked<Uint<B, L>>
+impl<T, const B: usize, const L: usize> AddAssignUnchecked<T>
     for StorageUint<B, L>
+where
+    Uint<B, L>: UintTryFrom<T>,
 {
-    fn add_assign_unchecked(&mut self, rhs: Uint<B, L>) {
-        let new_balance = self.get() + rhs;
+    fn add_assign_unchecked(&mut self, rhs: T) {
+        let new_balance = self.get() + Uint::<B, L>::from(rhs);
         self.set(new_balance);
     }
 }
@@ -23,11 +25,13 @@ pub(crate) trait SubAssignUnchecked<T> {
     fn sub_assign_unchecked(&mut self, rhs: T);
 }
 
-impl<const B: usize, const L: usize> SubAssignUnchecked<Uint<B, L>>
+impl<T, const B: usize, const L: usize> SubAssignUnchecked<T>
     for StorageUint<B, L>
+where
+    Uint<B, L>: UintTryFrom<T>,
 {
-    fn sub_assign_unchecked(&mut self, rhs: Uint<B, L>) {
-        let new_balance = self.get() - rhs;
+    fn sub_assign_unchecked(&mut self, rhs: T) {
+        let new_balance = self.get() - Uint::<B, L>::from(rhs);
         self.set(new_balance);
     }
 }

contracts/src/utils/nonces.rs

@@ -20,7 +20,7 @@ mod sol {
         /// The nonce used for an `account` is not the expected current nonce.
         #[derive(Debug)]
         #[allow(missing_docs)]
-        error InvalidAccountNonce(address account, uint256 currentNonce);
+        error InvalidAccountNonce(address account, uint256 current_nonce);
     }
 }
 
@@ -60,13 +60,17 @@ impl Nonces {
     /// * `&mut self` - Write access to the contract's state.
     /// * `owner` - The address for which to consume the nonce.
     ///
-    /// # Panics
+    /// # Safety
     ///
-    /// This function will panic if the nonce for the given `owner` has reached
-    /// the maximum value representable by `U256`, causing the `checked_add`
-    /// method to return `None`.
+    /// the function will experience **undefined behavior**, if the nonce for
+    /// the given `owner` has reached the maximum value representable by `U256`.
+    /// Extreme caution should be taken to ensure overflow cannot occur.
     pub fn use_nonce(&mut self, owner: Address) -> U256 {
         let nonce = self._nonces.get(owner);
+
+        // For each account, the nonce has an initial value of 0, can only be
+        // incremented by one, and cannot be decremented or reset. This
+        // guarantees that the nonce never overflows.
         self._nonces
             .setter(owner)
             .set(unsafe { nonce.checked_add(ONE).unwrap_unchecked() });
@@ -83,11 +87,11 @@ impl Nonces {
     /// * `owner` - The address for which to consume the nonce.
     /// * `nonce` - The nonce to consume.
     ///
-    /// # Panics
+    /// # Safety
     ///
-    /// This function will panic if the nonce for the given `owner` has reached
-    /// the maximum value representable by `U256`, causing the `checked_add`
-    /// method to return `None`.
+    /// the function will experience **undefined behavior**, if the nonce for
+    /// the given `owner` has reached the maximum value representable by `U256`.
+    /// Extreme caution should be taken to ensure overflow cannot occur.
     ///
     /// # Errors
     ///
@@ -98,19 +102,15 @@ impl Nonces {
         owner: Address,
         nonce: U256,
     ) -> Result<(), Error> {
-        let current_nonce = self._nonces.get(owner);
+        let current_nonce = self.use_nonce(owner);
 
         if nonce != current_nonce {
             return Err(Error::InvalidAccountNonce(InvalidAccountNonce {
                 account: owner,
-                currentNonce: current_nonce,
+                current_nonce,
             }));
         }
 
-        self._nonces
-            .setter(owner)
-            .set(unsafe { nonce.checked_add(ONE).unwrap_unchecked() });
-
         Ok(())
     }
 }

examples/erc1155/src/lib.rs

@@ -101,6 +101,10 @@ impl Erc1155Example {
         Erc1155::supports_interface(interface_id)
     }
 
+    /// WARNING: These functions are intended for **testing purposes** only. In
+    /// **production**, ensure strict access control to prevent unauthorized
+    /// pausing or unpausing, which can disrupt contract functionality. Remove
+    /// or secure these functions before deployment.
     fn pause(&mut self) -> Result<(), Vec<u8>> {
         self.pausable.pause().map_err(|e| e.into())
     }

examples/erc20/src/lib.rs

@@ -110,6 +110,10 @@ impl Erc20Example {
             || Erc20Metadata::supports_interface(interface_id)
     }
 
+    /// WARNING: These functions are intended for **testing purposes** only. In
+    /// **production**, ensure strict access control to prevent unauthorized
+    /// pausing or unpausing, which can disrupt contract functionality. Remove
+    /// or secure these functions before deployment.
     pub fn pause(&mut self) -> Result<(), Vec<u8>> {
         self.pausable.pause().map_err(|e| e.into())
     }

examples/erc721/src/lib.rs

@@ -156,6 +156,10 @@ impl Erc721Example {
             || Enumerable::supports_interface(interface_id)
     }
 
+    /// WARNING: These functions are intended for **testing purposes** only. In
+    /// **production**, ensure strict access control to prevent unauthorized
+    /// pausing or unpausing, which can disrupt contract functionality. Remove
+    /// or secure these functions before deployment.
     pub fn pause(&mut self) -> Result<(), Vec<u8>> {
         self.pausable.pause().map_err(|e| e.into())
     }

lib/e2e/README.md

@@ -108,7 +108,7 @@ Then altogether, your first test case can look like this:
 sol!("src/constructor.sol")
 
 #[e2e::test]
-async fn constructs(alice: Account) -> Result<()> {
+async fn constructs(alice: Account) -> eyre::Result<()> {
     let ctr = Example::constructorCall {
         name_: "Token".to_owned(),
         symbol_: "TKN".to_owned(),

lib/e2e/src/account.rs

@@ -4,7 +4,6 @@ use alloy::{
     providers::{Provider, ProviderBuilder},
     signers::{local::PrivateKeySigner, Signature, Signer},
 };
-use eyre::Result;
 use once_cell::sync::Lazy;
 use tokio::sync::{Mutex, MutexGuard};
 
@@ -30,7 +29,7 @@ impl Account {
     /// # Errors
     ///
     /// May fail if funding the newly created account fails.
-    pub async fn new() -> Result<Self> {
+    pub async fn new() -> eyre::Result<Self> {
         AccountFactory::create().await
     }
 

scripts/e2e-tests.sh

@@ -1,14 +1,35 @@
 #!/bin/bash
 set -e
 
-TEST_ARG="${1:-*}"
+# Default test file or wildcard
+TEST_ARG="*"
+CARGO_TEST_FLAGS=""
+TEST_BINARY_ARGS=""
 
-MYDIR=$(realpath "$(dirname "$0")")
-cd "$MYDIR"
-cd ..
+# Parse arguments
+for arg in "$@"; do
+    if [[ "$arg" == "--" ]]; then
+        # Everything after `--` goes to the test binary
+        shift
+        TEST_BINARY_ARGS="$@"
+        break
+    elif [[ "$arg" == -* ]]; then
+        # Capture cargo test flags (e.g., --exclude, --no-run)
+        CARGO_TEST_FLAGS="$CARGO_TEST_FLAGS $arg"
+    else
+        # Set the test file (first positional argument)
+        TEST_ARG="$arg"
+    fi
+done
 
+# Move to project root
+cd "$(dirname "$(realpath "$0")")/.."
+
+# Build the project
 cargo build --release --target wasm32-unknown-unknown -Z build-std=std,panic_abort -Z build-std-features=panic_immediate_abort
 
+# Set RPC_URL environment variable
 export RPC_URL=http://localhost:8547
 
-cargo test --features std,e2e --test "$TEST_ARG"
+# Run the tests with cargo test flags and test binary arguments
+cargo test --features std,e2e --test "$TEST_ARG" $CARGO_TEST_FLAGS -- $TEST_BINARY_ARGS