@evvm/testnet-contracts 2.3.0 → 3.0.1

package/contracts/evvm/lib/SignatureUtils.sol

@@ -1,162 +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 {
-    SignatureUtil
-} from "@evvm/testnet-contracts/library/utils/SignatureUtil.sol";
-import {
-    AdvancedStrings
-} from "@evvm/testnet-contracts/library/utils/AdvancedStrings.sol";
-
-/**
- * @title SignatureUtils
- * @author Mate labs
- * @notice Library for EIP-191 signature verification exclusively for Evvm.sol payment functions
- * @dev This library provides signature verification utilities for the Evvm.sol contract,
- *      specifically for payment operations (pay and dispersePay). It constructs the message
- *      format expected by users and validates their signatures.
- *
- * Signature Verification:
- * - Uses EIP-191 standard for message signing and verification
- * - Constructs deterministic message strings from payment parameters
- * - Integrates with SignatureUtil for cryptographic verification
- * - Prevents replay attacks through nonce inclusion
- * - Supports cross-chain safety through EvvmID inclusion
- *
- * Message Format:
- * - pay: "receiver,token,amount,priorityFee,nonce,priorityFlag,executor"
- * - dispersePay: "hashOfRecipients,token,amount,priorityFee,nonce,priorityFlag,executor"
- *
- * @custom:scope Exclusive to Evvm.sol payment functions
- * @custom:standard EIP-191 (https://eips.ethereum.org/EIPS/eip-191)
- * @custom:security All signatures include EvvmID to prevent cross-chain replay attacks
- */
-library SignatureUtils {
-
-    /**
-     * @notice Verifies EIP-191 signature for single payment operations
-     * @dev Constructs the expected message from payment parameters and verifies
-     *      the signature matches the signer. Used in pay() and payMultiple() functions.
-     *
-     * Message Construction:
-     * - If receiverAddress is address(0): uses receiverIdentity string
-     * - Otherwise: converts receiverAddress to string
-     * - Concatenates all parameters with comma separators
-     * - Includes EvvmID for cross-chain replay protection
-     *
-     * @param evvmID Unique identifier of the EVVM instance for cross-chain safety
-     * @param signer Address that signed the message (payment sender)
-     * @param receiverAddress Direct recipient address (used if receiverIdentity is empty)
-     * @param receiverIdentity Username/identity to resolve (takes priority over address)
-     * @param token Address of the token to transfer
-     * @param amount Amount of tokens to transfer
-     * @param priorityFee Fee paid to the staker/fisher processing the transaction
-     * @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) = anyone)
-     * @param signature EIP-191 signature from the signer
-     * @return bool True if the signature is valid and matches the signer
-     */
-    function verifyMessageSignedForPay(
-        uint256 evvmID,
-        address signer,
-        address receiverAddress,
-        string memory receiverIdentity,
-        address token,
-        uint256 amount,
-        uint256 priorityFee,
-        uint256 nonce,
-        bool priorityFlag,
-        address executor,
-        bytes memory signature
-    ) internal pure returns (bool) {
-        return
-            SignatureUtil.verifySignature(
-                evvmID,
-                "pay",
-                string.concat(
-                    receiverAddress == address(0)
-                        ? receiverIdentity
-                        : AdvancedStrings.addressToString(receiverAddress),
-                    ",",
-                    AdvancedStrings.addressToString(token),
-                    ",",
-                    AdvancedStrings.uintToString(amount),
-                    ",",
-                    AdvancedStrings.uintToString(priorityFee),
-                    ",",
-                    AdvancedStrings.uintToString(nonce),
-                    ",",
-                    AdvancedStrings.boolToString(priorityFlag),
-                    ",",
-                    AdvancedStrings.addressToString(executor)
-                ),
-                signature,
-                signer
-            );
-    }
-
-    /**
-     * @notice Verifies EIP-191 signature for multi-recipient disperse payment operations
-     * @dev Constructs the expected message from disperse parameters and verifies
-     *      the signature matches the signer. Used in dispersePay() function.
-     *
-     * Message Construction:
-     * - Uses sha256 hash of recipient array instead of full data (gas optimization)
-     * - Concatenates hash and all other parameters with comma separators
-     * - Includes EvvmID for cross-chain replay protection
-     *
-     * Hash Calculation:
-     * - Client must calculate: sha256(abi.encode(toData))
-     * - toData is DispersePayMetadata[] array with recipients and amounts
-     * - Ensures tamper-proof verification of all recipients
-     *
-     * @param evvmID Unique identifier of the EVVM instance for cross-chain safety
-     * @param signer Address that signed the message (payment sender)
-     * @param hashList SHA256 hash of the recipient data array: sha256(abi.encode(toData))
-     * @param token Address of the token to distribute
-     * @param amount Total amount being distributed (must equal sum of individual amounts)
-     * @param priorityFee Fee paid to the staker/fisher processing the distribution
-     * @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 distribution (address(0) = anyone)
-     * @param signature EIP-191 signature from the signer
-     * @return bool True if the signature is valid and matches the signer
-     */
-    function verifyMessageSignedForDispersePay(
-        uint256 evvmID,
-        address signer,
-        bytes32 hashList,
-        address token,
-        uint256 amount,
-        uint256 priorityFee,
-        uint256 nonce,
-        bool priorityFlag,
-        address executor,
-        bytes memory signature
-    ) internal pure returns (bool) {
-        return
-            SignatureUtil.verifySignature(
-                evvmID,
-                "dispersePay",
-                string.concat(
-                    AdvancedStrings.bytes32ToString(hashList),
-                    ",",
-                    AdvancedStrings.addressToString(token),
-                    ",",
-                    AdvancedStrings.uintToString(amount),
-                    ",",
-                    AdvancedStrings.uintToString(priorityFee),
-                    ",",
-                    AdvancedStrings.uintToString(nonce),
-                    ",",
-                    AdvancedStrings.boolToString(priorityFlag),
-                    ",",
-                    AdvancedStrings.addressToString(executor)
-                ),
-                signature,
-                signer
-            );
-    }
-}

package/contracts/nameService/lib/ErrorsLib.sol

@@ -1,155 +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 NameService.sol contract
- * @dev This library defines all custom errors used by the NameService.sol 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 ownership and admin permissions
- * - Validation: Errors for invalid usernames, signatures, and input validation
- * - Registration: Errors specific to username registration and pre-registration
- * - Marketplace: Errors for offer management and username trading
- * - Metadata: Errors for custom metadata operations
- * - Time-Lock: Errors for governance and renewal timing
- *
- * @custom:scope Exclusive to the NameService.sol contract
- * @custom:security All errors provide clear failure reasons without exposing sensitive data
- */
-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 an operation is attempted by someone other than the username owner
-     * @dev Used in functions that modify username data or accept offers
-     */
-    error UserIsNotOwnerOfIdentity();
-
-    /**
-     * @notice Thrown when an operation is attempted by someone other than the offer creator
-     * @dev Used in withdrawOffer to ensure only the offerer can withdraw their own offer
-     */
-    error UserIsNotOwnerOfOffer();
-
-    /**
-     * @notice Thrown when the proposed admin tries to accept before meeting requirements
-     * @dev Part of the time-delayed admin transfer mechanism
-     */
-    error SenderIsNotProposedAdmin();
-
-    //█ Validation Errors ███████████████████████████████████████████████████████
-
-    /**
-     * @notice Thrown when the provided EIP-191 signature is invalid or doesn't match the signer
-     * @dev Used in all operations requiring signature verification
-     */
-    error InvalidSignatureOnNameService();
-
-    /**
-     * @notice Thrown when a username doesn't meet format requirements
-     * @dev Username must be 4+ characters, start with letter, contain only alphanumeric
-     */
-    error InvalidUsername();
-
-    /**
-     * @notice Thrown when an amount parameter is zero but should be positive
-     * @dev Used in makeOffer to ensure offers have value
-     */
-    error AmountMustBeGreaterThanZero();
-
-    /**
-     * @notice Thrown when a custom metadata key is invalid
-     * @dev Used when trying to remove metadata with a key that doesn't exist
-     */
-    error InvalidKey();
-
-    /**
-     * @notice Thrown when attempting to add empty custom metadata
-     * @dev Custom metadata value cannot be an empty string
-     */
-    error EmptyCustomMetadata();
-
-    /**
-     * @notice Thrown when a proposed address or configuration is invalid
-     * @dev Used in admin proposal functions
-     */
-    error InvalidAdminProposal();
-
-    /**
-     * @notice Thrown when the EVVM address being proposed is invalid
-     * @dev Used when updating the EVVM contract integration address
-     */
-    error InvalidEvvmAddress();
-
-    /**
-     * @notice Thrown when the withdrawal amount is invalid or exceeds available balance
-     * @dev Used in token withdrawal functions
-     */
-    error InvalidWithdrawAmount();
-
-    //█ Registration and Time-Based Errors █████████████████████████████████████
-
-    /**
-     * @notice Thrown when attempting to register a username that is already taken
-     * @dev Usernames are unique and cannot be registered twice
-     */
-    error UsernameAlreadyRegistered();
-
-    /**
-     * @notice Thrown when the pre-registration doesn't exist or has expired
-     * @dev Pre-registration must be completed within 30 minutes and by the same user
-     */
-    error PreRegistrationNotValid();
-
-    /**
-     * @notice Thrown when a timestamp/date is set to before the current time
-     * @dev Used for offer expiration dates and other future-dated operations
-     */
-    error CannotBeBeforeCurrentTime();
-
-    /**
-     * @notice Thrown when attempting operations on an expired username
-     * @dev Username ownership expires after the expireDate timestamp
-     */
-    error OwnershipExpired();
-
-    /**
-     * @notice Thrown when trying to renew a username beyond the maximum allowed period
-     * @dev Usernames can only be renewed up to 100 years in advance
-     */
-    error RenewalTimeLimitExceeded();
-
-    /**
-     * @notice Thrown when attempting to execute a time-locked action prematurely
-     * @dev Used in governance functions with time-delay requirements
-     */
-    error LockTimeNotExpired();
-
-    //█ Marketplace and Offer Errors ███████████████████████████████████████████
-
-    /**
-     * @notice Thrown when trying to accept or interact with an expired or non-existent offer
-     * @dev Offers expire at their expireDate timestamp or when offerer is address(0)
-     */
-    error OfferInactive();
-
-    //█ Identity Type Errors ██████████████████████████████████████████████████
-
-    /**
-     * @notice Thrown when an operation requiring a fully registered username is attempted on a pre-registration
-     * @dev Pre-registrations have flagNotAUsername = 0x01, full usernames have 0x00
-     */
-    error IdentityIsNotAUsername();
-}

package/contracts/nameService/lib/NameServiceStructs.sol

@@ -1,125 +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 NameServiceStructs
- * @author Mate labs
- * @notice Library of data structures used exclusively by the NameService.sol contract
- * @dev This contract defines the type system for the NameService.sol contract,
- *      providing structured data types for identity management, marketplace operations,
- *      and governance proposals. These structures are not shared with external services.
- *
- * Structure Categories:
- * - Identity Structures: IdentityBaseMetadata for username registration data
- * - Marketplace Structures: OfferMetadata for username trading
- * - Governance Structures: AddressTypeProposal, UintTypeProposal, BoolTypeProposal for time-delayed changes
- *
- * @custom:inheritance This contract is inherited by NameService.sol
- * @custom:scope Exclusive to the NameService.sol contract
- */
-abstract contract NameServiceStructs {
-    //░▒▓█ Governance Proposal Structures ███████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Time-delayed proposal structure for address-type governance changes
-     * @dev Used for admin changes and EVVM contract address updates with 1-day delay
-     *
-     * Governance Flow:
-     * 1. Admin proposes new address -> sets proposal and timeToAccept
-     * 2. Time delay passes (1 day)
-     * 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 token withdrawal amount changes with 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;
-    }
-
-    /**
-     * @notice Time-delayed proposal structure for boolean flag changes
-     * @dev Used for feature toggles and system state changes requiring governance
-     *
-     * @param flag Current boolean state of the feature/setting
-     * @param timeToAcceptChange Timestamp when the flag change can be executed
-     */
-    struct BoolTypeProposal {
-        bool flag;
-        uint256 timeToAcceptChange;
-    }
-
-    //░▒▓█ Identity Management Structures ███████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Core metadata for each registered identity/username
-     * @dev Stores essential registration information and ownership details
-     *
-     * Registration States:
-     * - flagNotAUsername = 0x01: Pre-registration (temporary reservation)
-     * - flagNotAUsername = 0x00: Full username registration (active identity)
-     *
-     * Ownership Model:
-     * - Owner has full control over the username
-     * - Ownership expires at expireDate (renewable up to 100 years)
-     * - Can be transferred through marketplace offers
-     *
-     * @param owner Address that owns this identity/username
-     * @param expireDate Timestamp when the registration expires (renewable)
-     * @param customMetadataMaxSlots Number of custom metadata entries stored for this identity
-     * @param offerMaxSlots Highest offer ID that has been created for this username
-     * @param flagNotAUsername 0x01 for pre-registration, 0x00 for full username
-     */
-    struct IdentityBaseMetadata {
-        address owner;
-        uint256 expireDate;
-        uint256 customMetadataMaxSlots;
-        uint256 offerMaxSlots;
-        bytes1 flagNotAUsername;
-    }
-
-    //░▒▓█ Marketplace Structures ███████████████████████████████████████████████████████▓▒░
-
-    /**
-     * @notice Metadata for marketplace offers on usernames
-     * @dev Represents a locked offer to purchase a username at a specific price
-     *
-     * Offer Lifecycle:
-     * 1. Created: Tokens are locked in contract (after 0.5% marketplace fee deduction)
-     * 2. Active: Can be accepted by owner or withdrawn by offerer before expiration
-     * 3. Expired/Completed: offerer set to address(0), tokens released
-     *
-     * Fee Structure:
-     * - 0.5% marketplace fee deducted from offer amount
-     * - Remaining 99.5% locked for potential acceptance
-     * - Additional fees for stakers processing the transaction
-     *
-     * @param offerer Address that created and can withdraw this offer
-     * @param expireDate Timestamp when the offer expires and can no longer be accepted
-     * @param amount Amount offered in Principal Tokens (after 0.5% marketplace fee deduction)
-     */
-    struct OfferMetadata {
-        address offerer;
-        uint256 expireDate;
-        uint256 amount;
-    }
-}