@evvm/testnet-contracts 2.3.0 → 3.0.1

package/contracts/evvm/lib/ErrorsLib.sol

@@ -1,131 +0,0 @@
-// SPDX-License-Identifier: EVVM-NONCOMMERCIAL-1.0
-// Full license terms available at: https://www.evvm.info/docs/EVVMNoncommercialLicense
-
-pragma solidity ^0.8.0;
-
-/**
- * @title ErrorsLib
- * @author Mate labs
- * @notice Library containing custom error definitions exclusively for the Evvm.sol contract
- * @dev This library defines all custom errors used by the Evvm.sol core contract.
- *      Custom errors are more gas-efficient than require statements with strings
- *      and provide better error handling in client applications.
- *
- * Error Categories:
- * - Access Control: Errors related to unauthorized access attempts
- * - Validation: Errors for invalid inputs or state conditions
- * - Nonce Management: Errors for transaction replay protection
- * - Time-Lock: Errors for governance time delay mechanisms
- * - Balance: Errors for insufficient funds or invalid amounts
- *
- * @custom:scope Exclusive to the Evvm.sol contract
- * @custom:security All errors are designed to provide clear failure reasons
- *                  without exposing sensitive internal state information
- */
-library ErrorsLib {
-    //░▒▓█ Access Control Errors ████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Thrown when a function restricted to admin is called by a non-admin address
-     * @dev Used in functions with the `onlyAdmin` modifier
-     */
-    error SenderIsNotAdmin();
-
-    /**
-     * @notice Thrown when attempting to use the proxy without a valid implementation contract
-     * @dev Occurs when the fallback function is called but currentImplementation is address(0)
-     */
-    error ImplementationIsNotActive();
-
-    /**
-     * @notice Thrown when the provided cryptographic signature is invalid or doesn't match the signer
-     * @dev Used in payment functions to verify EIP-191 signatures
-     */
-    error InvalidSignature();
-
-    /**
-     * @notice Thrown when a transaction specifies an executor but the caller is not that executor
-     * @dev Enforces that only the designated executor can process certain transactions
-     */
-    error SenderIsNotTheExecutor();
-
-    /**
-     * @notice Thrown when a function restricted to treasury is called by a non-treasury address
-     * @dev Used in treasury-exclusive functions like addAmountToUser and removeAmountFromUser
-     */
-    error SenderIsNotTreasury();
-
-    /**
-     * @notice Thrown when the proposed admin tries to accept before the time lock expires
-     * @dev Part of the time-delayed admin transfer mechanism
-     */
-    error SenderIsNotTheProposedAdmin();
-
-    /**
-     * @notice Thrown when a caller is not a smart contract (Contract Account)
-     * @dev Used in caPay and disperseCaPay to ensure only contracts can call these functions
-     */
-    error NotAnCA();
-
-    //░▒▓█ Nonce Management Errors ██████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Thrown when the provided synchronous nonce doesn't match the expected sequential nonce
-     * @dev Sync nonces must be used in order (0, 1, 2, ...)
-     */
-    error SyncNonceMismatch();
-
-    /**
-     * @notice Thrown when attempting to use an asynchronous nonce that has already been consumed
-     * @dev Async nonces can be used in any order but only once
-     */
-    error AsyncNonceAlreadyUsed();
-
-    //░▒▓█ Balance and Amount Errors ████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Thrown when a user doesn't have enough tokens to complete a transfer
-     * @dev Checked before any balance deduction to prevent underflows
-     */
-    error InsufficientBalance();
-
-    /**
-     * @notice Thrown when the provided amount doesn't match expected values
-     * @dev Used in dispersePay to verify total amount equals sum of individual amounts
-     */
-    error InvalidAmount();
-
-    //░▒▓█ Initialization and Setup Errors ██████████████████████████████████████▓▒░
-
-    /**
-     * @notice Thrown when attempting to call a one-time setup function after it has been used
-     * @dev Used in _setupNameServiceAndTreasuryAddress to prevent reconfiguration
-     */
-    error BreakerExploded();
-
-    /**
-     * @notice Thrown when attempting to change EVVM ID after the allowed time window has passed
-     * @dev The EVVM ID can only be changed within 24 hours of the last change
-     */
-    error WindowExpired();
-
-    /**
-     * @notice Thrown when address(0) is provided where a valid address is required
-     * @dev Used in constructor and setup functions to validate critical addresses
-     */
-    error AddressCantBeZero();
-
-    /**
-     * @notice Thrown when an address input doesn't meet validation requirements
-     * @dev Used when proposing new admin or implementation with invalid addresses
-     */
-    error IncorrectAddressInput();
-
-    //░▒▓█ Time-Lock Errors █████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Thrown when attempting to execute a time-locked action before the delay has passed
-     * @dev Used in acceptImplementation (30 days) and acceptAdmin (1 day) functions
-     */
-    error TimeLockNotExpired();
-}

package/contracts/evvm/lib/EvvmStorage.sol

@@ -1,217 +0,0 @@
-// SPDX-License-Identifier: EVVM-NONCOMMERCIAL-1.0
-// Full license terms available at: https://www.evvm.info/docs/EVVMNoncommercialLicense
-
-pragma solidity ^0.8.0;
-
-import {EvvmStructs} from "./EvvmStructs.sol";
-
-/**
- * @title EvvmStorage
- * @author Mate labs
- * @notice Storage layout contract exclusively for the Evvm.sol core contract
- * @dev This contract inherits all structures from EvvmStructs and defines
- *      the storage layout used by the Evvm.sol proxy pattern implementation.
- *      All state variables declared here are used by Evvm.sol and its upgradeable
- *      implementation contracts.
- *
- * Storage Organization:
- * - Constants: System-wide immutable values
- * - External Addresses: Integration points with other contracts
- * - Governance State: Admin and proposal management
- * - Balance Management: User token balances and nonce tracking
- * - Configuration: System parameters and metadata
- *
- * @custom:inheritance Inherited by Evvm.sol, should not be deployed directly
- * @custom:scope Exclusive to Evvm.sol contract and its implementations
- * @custom:proxy Storage layout must remain consistent across upgrades
- */
-
-abstract contract EvvmStorage is EvvmStructs {
-    //░▒▓█ Constants ██████████████████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Sentinel address representing native ETH in token operations
-     * @dev address(0) is used to represent the native blockchain token (ETH, MATIC, etc.)
-     */
-    address constant ETH_ADDRESS = address(0);
-
-    /**
-     * @notice Flag value indicating an address is a registered staker
-     * @dev Used in stakerList mapping to mark addresses with staking privileges
-     *      Value of 0x01 indicates active staker status
-     */
-    bytes1 constant FLAG_IS_STAKER = 0x01;
-
-    /**
-     * @notice Time delay required before accepting admin change proposals
-     * @dev 1 day delay provides time for community review of admin changes
-     *      Used in proposeAdmin and acceptAdmin functions
-     */
-    uint256 constant TIME_TO_ACCEPT_PROPOSAL = 1 days;
-
-    /**
-     * @notice Time delay required before accepting implementation upgrades
-     * @dev 30 day delay provides extended review period for critical contract upgrades
-     *      Used in proposeImplementation and acceptImplementation functions
-     */
-    uint256 constant TIME_TO_ACCEPT_IMPLEMENTATION = 30 days;
-
-    //░▒▓█ External Contract Addresses █████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Address of the NameService contract for identity resolution
-     * @dev Used to resolve username identities to wallet addresses in payment functions
-     *      Enables payments to usernames like "alice.evvm" instead of raw addresses
-     */
-    address nameServiceAddress;
-
-    /**
-     * @notice Address of the authorized staking contract
-     * @dev Controls staker status updates and receives staking-related rewards
-     *      Only this address can call pointStaker() to update staker status
-     */
-    address stakingContractAddress;
-
-    /**
-     * @notice Address of the Treasury contract with privileged balance operations
-     * @dev Can call addAmountToUser and removeAmountFromUser for token management
-     *      Used for cross-chain bridging, reward distributions, and system operations
-     */
-    address treasuryAddress;
-
-    //░▒▓█ Token Whitelist Proposal State ██████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Address of the token pending whitelist approval
-     * @dev Part of time-delayed token whitelisting mechanism
-     *      Set during prepareWhitelistToken(), cleared on acceptance
-     */
-    address whitelistTokenToBeAdded_address;
-
-    /**
-     * @notice Liquidity pool address for the token pending whitelist approval
-     * @dev Used to validate token has sufficient liquidity before whitelisting
-     *      Typically a Uniswap V3 pool address
-     */
-    address whitelistTokenToBeAdded_pool;
-
-    /**
-     * @notice Timestamp when the pending token whitelist can be accepted
-     * @dev After this timestamp, the token can be officially whitelisted
-     *      Zero value indicates no pending whitelist proposal
-     */
-    uint256 whitelistTokenToBeAdded_dateToSet;
-
-    //░▒▓█ Proxy Implementation State ██████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Address of the current active implementation contract
-     * @dev All non-matching function calls are delegated to this address
-     *      Updated through time-delayed governance process
-     * @custom:proxy Slot used by assembly in fallback for delegatecall
-     */
-    address currentImplementation;
-
-    /**
-     * @notice Address of the proposed implementation for upgrade
-     * @dev Set by admin, becomes active after time delay via acceptImplementation()
-     *      Zero address indicates no pending upgrade proposal
-     */
-    address proposalImplementation;
-
-    /**
-     * @notice Timestamp after which the implementation upgrade can be accepted
-     * @dev Must be >= current timestamp to call acceptImplementation()
-     *      Zero value indicates no pending implementation proposal
-     */
-    uint256 timeToAcceptImplementation;
-
-    //░▒▓█ EVVM Configuration State ████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Deadline for changing the EVVM ID
-     * @dev EVVM ID can only be changed within 24 hours of deployment or last change
-     *      Prevents unauthorized ID changes after initial configuration period
-     */
-    uint256 windowTimeToChangeEvvmID;
-
-    /**
-     * @notice Core metadata configuration for the EVVM instance
-     * @dev Contains:
-     *      - EvvmName: Human-readable name of this EVVM instance
-     *      - EvvmID: Unique identifier used in signature verification
-     *      - principalTokenName/Symbol: Principal token details
-     *      - principalTokenAddress: Address representing the Principal Token in balances
-     *      - totalSupply: Current total supply of principal token
-     *      - eraTokens: Threshold for next reward halving era
-     *      - reward: Current reward amount per transaction
-     */
-    EvvmMetadata evvmMetadata;
-
-    //░▒▓█ Admin Governance State ██████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Admin address management with time-delayed transitions
-     * @dev Contains:
-     *      - current: Active admin address with full privileges
-     *      - proposal: Proposed new admin (awaiting acceptance)
-     *      - timeToAccept: Timestamp when proposal can be accepted
-     */
-    AddressTypeProposal admin;
-
-    //░▒▓█ Initialization State ████████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice One-time setup breaker flag for NameService and Treasury configuration
-     * @dev Set to FLAG_IS_STAKER (0x01) in constructor, set to 0x00 after setup
-     *      Prevents _setupNameServiceAndTreasuryAddress from being called twice
-     */
-    bytes1 breakerSetupNameServiceAddress;
-
-    //░▒▓█ Staker Registry █████████████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Registry mapping addresses to their staker status
-     * @dev Key: User address
-     *      Value: Staker flag (FLAG_IS_STAKER = 0x01 for active stakers)
-     *      Stakers receive priority fees and Principal Token rewards for processing transactions
-     */
-    mapping(address => bytes1) stakerList;
-
-    //░▒▓█ Balance Management ██████████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Token balance storage for all users across all tokens
-     * @dev Primary balance mapping: user address => token address => balance
-     *      Supports Principal Token, ETH (address(0)), and whitelisted ERC20s
-     *      All payment operations update these balances
-     */
-    mapping(address user => mapping(address token => uint256 quantity)) balances;
-
-    //░▒▓█ Nonce Management █████████████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Sequential nonce tracking for synchronous transactions
-     * @dev Nonces must be used in strict sequential order (0, 1, 2, ...)
-     *      Provides ordered transaction execution and simpler replay protection
-     *      Incremented after each successful sync transaction
-     */
-    mapping(address user => uint256 nonce) nextSyncUsedNonce;
-
-    /**
-     * @notice Flexible nonce tracking for asynchronous transactions
-     * @dev Nonces can be used in any order but only once
-     *      Provides flexibility for parallel transaction submission
-     *      Marked as used (true) after consumption
-     */
-    mapping(address user => mapping(uint256 nonce => bool isUsed)) asyncUsedNonce;
-
-    //░▒▓█ Fisher Bridge State ██████████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Sequential nonce for Fisher Bridge cross-chain deposits
-     * @dev Tracks deposit operations for cross-chain asset bridging
-     *      Ensures ordered processing of bridge deposit transactions
-     */
-    mapping(address user => uint256 nonce) nextFisherDepositNonce;
-}

package/contracts/evvm/lib/EvvmStructs.sol

@@ -1,208 +0,0 @@
-// SPDX-License-Identifier: EVVM-NONCOMMERCIAL-1.0
-// Full license terms available at: https://www.evvm.info/docs/EVVMNoncommercialLicense
-
-pragma solidity ^0.8.0;
-
-/**
- * @title EvvmStructs
- * @author Mate labs
- * @notice Library of data structures used exclusively by the Evvm.sol core contract
- * @dev This contract defines the type system for the Evvm.sol contract,
- *      providing structured data types for payment operations, governance proposals,
- *      and system configuration. These structures are not shared with external services.
- *
- * Structure Categories:
- * - Payment Structures: PayData, DispersePayData, CaPayData for transaction processing
- * - Governance Structures: AddressTypeProposal, UintTypeProposal for time-delayed changes
- * - Metadata Structures: EvvmMetadata for system-wide configuration
- *
- * @custom:inheritance This contract is inherited by EvvmStorage, which is then inherited by Evvm.sol
- * @custom:scope Exclusive to the Evvm.sol contract and its storage layout
- * @custom:version 1.0.0
- */
-
-abstract contract EvvmStructs {
-    //░▒▓█ Payment Data Structures ██████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Data structure for single payment operations
-     * @dev Used in pay() and payMultiple() functions for individual transfers
-     *
-     * @param from Address of the payment sender (signer of the transaction)
-     * @param to_address Direct recipient address (used if to_identity is empty)
-     * @param to_identity Username/identity to resolve via NameService (takes priority)
-     * @param token Address of the token to transfer (address(0) for ETH)
-     * @param amount Amount of tokens to transfer to the recipient
-     * @param priorityFee Additional fee paid to staker for transaction processing
-     * @param nonce Transaction nonce for replay protection
-     * @param priorityFlag False for sync nonce (sequential), true for async nonce (flexible)
-     * @param executor Address authorized to execute this transaction (address(0) = any)
-     * @param signature EIP-191 signature authorizing this payment
-     */
-    struct PayData {
-        address from;
-        address to_address;
-        string to_identity;
-        address token;
-        uint256 amount;
-        uint256 priorityFee;
-        uint256 nonce;
-        bool priorityFlag;
-        address executor;
-        bytes signature;
-    }
-
-    /**
-     * @notice Data structure for single-source multi-recipient payment distributions
-     * @dev Used in dispersePay() for efficient batch distributions from one sender
-     *
-     * @param from Address of the payment sender (signer of the transaction)
-     * @param toData Array of recipient metadata with individual amounts and addresses
-     * @param token Address of the token to distribute (address(0) for ETH)
-     * @param totalAmount Total amount being distributed (must equal sum of toData amounts)
-     * @param priorityFee Fee paid to staker for processing the distribution
-     * @param nonce Transaction nonce for replay protection
-     * @param priorityFlag False for sync nonce, true for async nonce
-     * @param executor Address authorized to execute this distribution (address(0) = any)
-     * @param signature EIP-191 signature authorizing this distribution
-     */
-    struct DispersePayData {
-        address from;
-        DispersePayMetadata[] toData;
-        address token;
-        uint256 totalAmount;
-        uint256 priorityFee;
-        uint256 nonce;
-        bool priorityFlag;
-        address executor;
-        bytes signature;
-    }
-
-    /**
-     * @notice Data structure for contract-to-address payments without signatures
-     * @dev Used in caPay() for authorized contract distributions
-     *
-     * @param from Address of the sending contract (must be a contract, not EOA)
-     * @param to Address of the token recipient
-     * @param token Address of the token to transfer (address(0) for ETH)
-     * @param amount Amount of tokens to transfer
-     */
-    struct CaPayData {
-        address from;
-        address to;
-        address token;
-        uint256 amount;
-    }
-
-    /**
-     * @notice Data structure for contract-based multi-recipient distributions
-     * @dev Used in disperseCaPay() for batch distributions from contracts
-     *
-     * @param from Address of the sending contract (must be a contract, not EOA)
-     * @param toData Array of recipient metadata with individual amounts and addresses
-     * @param token Address of the token to distribute (address(0) for ETH)
-     * @param amount Total amount being distributed (must equal sum of toData amounts)
-     */
-    struct DisperseCaPayData{
-        address from;
-        DisperseCaPayMetadata[] toData;
-        address token;
-        uint256 amount;
-    }
-
-    //░▒▓█ Payment Metadata Structures ██████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Recipient metadata for user-signed disperse payments
-     * @dev Used within DispersePayData to specify individual recipients
-     *
-     * @param amount Amount of tokens to send to this recipient
-     * @param to_address Direct recipient address (used if to_identity is empty)
-     * @param to_identity Username/identity to resolve via NameService (takes priority)
-     */
-    struct DispersePayMetadata {
-        uint256 amount;
-        address to_address;
-        string to_identity;
-    }
-
-    /**
-     * @notice Recipient metadata for contract-based disperse payments
-     * @dev Used within DisperseCaPayData to specify individual recipients
-     *      Simpler than DispersePayMetadata as identity resolution is not supported
-     *
-     * @param amount Amount of tokens to send to this recipient
-     * @param toAddress Direct recipient address
-     */
-    struct DisperseCaPayMetadata {
-        uint256 amount;
-        address toAddress;
-    }
-
-    //░▒▓█ System Configuration Structures ██████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Core metadata configuration for the EVVM instance
-     * @dev Contains all system-wide parameters for the EVVM ecosystem
-     *
-     * Economic Model:
-     * - reward: Base Principal Tokens distributed per successful transaction
-     * - eraTokens: Supply threshold that triggers the next reward halving
-     * - totalSupply: Current total supply tracking for era calculations
-     *
-     * @param EvvmName Human-readable name of this EVVM instance
-     * @param EvvmID Unique identifier used in signature verification to prevent cross-chain replay
-     * @param principalTokenName Full name of the principal token (customizable)
-     * @param principalTokenSymbol Symbol of the principal token (customizable)
-     * @param principalTokenAddress Virtual address representing the Principal Token in balance mappings
-     * @param totalSupply Current total supply of principal tokens in circulation
-     * @param eraTokens Token supply threshold for next reward halving era
-     * @param reward Current reward amount in Principal Tokens per successful transaction
-     */
-    struct EvvmMetadata {
-        string EvvmName;
-        uint256 EvvmID;
-        string principalTokenName;
-        string principalTokenSymbol;
-        address principalTokenAddress;
-        uint256 totalSupply;
-        uint256 eraTokens;
-        uint256 reward;
-    }
-
-    //░▒▓█ Governance Proposal Structures ███████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Time-delayed proposal structure for address-type governance changes
-     * @dev Used for admin changes (1-day delay) and can be extended for other address proposals
-     *
-     * Governance Flow:
-     * 1. Admin proposes new address -> sets proposal and timeToAccept
-     * 2. Time delay passes (1 day for admin, 30 days for implementation)
-     * 3. Proposed address calls accept -> current is updated, proposal is cleared
-     *
-     * @param current Currently active address with the role/privilege
-     * @param proposal Proposed new address awaiting acceptance after time delay
-     * @param timeToAccept Timestamp after which the proposal can be accepted
-     */
-    struct AddressTypeProposal {
-        address current;
-        address proposal;
-        uint256 timeToAccept;
-    }
-
-    /**
-     * @notice Time-delayed proposal structure for uint-type governance changes
-     * @dev Used for numeric parameter changes requiring time-delayed governance
-     *      Follows the same pattern as AddressTypeProposal for consistency
-     *
-     * @param current Currently active value for the parameter
-     * @param proposal Proposed new value awaiting acceptance after time delay
-     * @param timeToAccept Timestamp after which the proposal can be accepted
-     */
-    struct UintTypeProposal {
-        uint256 current;
-        uint256 proposal;
-        uint256 timeToAccept;
-    }
-}