@evvm/testnet-contracts 2.3.0 → 3.0.1

package/contracts/core/lib/CoreStorage.sol

@@ -0,0 +1,171 @@
+// SPDX-License-Identifier: EVVM-NONCOMMERCIAL-1.0
+// Full license terms available at: https://www.evvm.info/docs/EVVMNoncommercialLicense
+
+pragma solidity ^0.8.0;
+
+import {
+    CoreStructs as Structs
+} from "@evvm/testnet-contracts/library/structs/CoreStructs.sol";
+
+import {
+    ProposalStructs
+} from "@evvm/testnet-contracts/library/utils/governance/ProposalStructs.sol";
+
+/**
+ * @title CoreStorage
+ * @author Mate labs
+ * @notice Centralized storage layout for the EVVM Core contract.
+ * @dev Designed for use with proxy patterns. This contract must remain append-only
+ *      to maintain storage slots across upgrades.
+ */
+abstract contract CoreStorage {
+    //░▒▓█ Constants ██████████████████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Sentinel address representing native ETH (or the chain's native token).
+     */
+    address constant ETH_ADDRESS = address(0);
+
+    /**
+     * @notice Flag indicating an address is a registered staker.
+     * @dev Value 0x01 is used in stakerList to signify active status.
+     */
+    bytes1 constant FLAG_IS_STAKER = 0x01;
+
+    /**
+     * @notice Minimum time delay (1 day) to accept a proposed admin change.
+     */
+    uint256 constant TIME_TO_ACCEPT_PROPOSAL = 1 days;
+
+    /**
+     * @notice Minimum time delay (30 days) to accept a proposed implementation upgrade.
+     */
+    uint256 constant TIME_TO_ACCEPT_IMPLEMENTATION = 30 days;
+
+    //░▒▓█ External Contract Addresses █████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Address of the EVVM NameService for identity and username resolution.
+     */
+    address nameServiceAddress;
+
+    /**
+     * @notice Address of the Staking contract.
+     * @dev Authorized to update staker status and manage reward distributions.
+     */
+    address stakingContractAddress;
+
+    /**
+     * @notice Address of the Treasury contract.
+     * @dev Authorized for privileged balance operations (add/remove tokens).
+     */
+    address treasuryAddress;
+
+    //░▒▓█ Token Whitelist Proposal State ██████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Pending token address to be whitelisted.
+     */
+    address whitelistTokenToBeAdded_address;
+
+    /**
+     * @notice Uniswap V3 (or similar) pool address used to verify liquidity for the pending token.
+     */
+    address whitelistTokenToBeAdded_pool;
+
+    /**
+     * @notice Timestamp when the pending token whitelist proposal can be accepted.
+     */
+    uint256 whitelistTokenToBeAdded_dateToSet;
+
+    //░▒▓█ Proxy Implementation State ██████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Current active implementation address.
+     * @dev Used by the fallback function for delegatecall.
+     */
+    address currentImplementation;
+
+    /**
+     * @notice Proposed future implementation address.
+     */
+    address proposalImplementation;
+
+    /**
+     * @notice Timestamp after which the proposed implementation can be finalized.
+     */
+    uint256 timeToAcceptImplementation;
+
+    //░▒▓█ EVVM Configuration State ████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Timestamp limiting when the EVVM ID can be modified (initial window).
+     */
+    uint256 windowTimeToChangeEvvmID;
+
+    /**
+     * @notice Metadata configuration for this EVVM instance (ID, token info, rewards).
+     * @dev Crucial for EIP-191 signature verification to prevent replay attacks.
+     */
+    Structs.EvvmMetadata evvmMetadata;
+
+    //░▒▓█ Admin Governance State ██████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Management of the admin role with time-delayed transitions.
+     */
+    ProposalStructs.AddressTypeProposal admin;
+
+    //░▒▓█ Initialization State ████████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Internal guard to ensure system contracts are initialized only once.
+     */
+    bytes1 breakerSetupNameServiceAddress;
+
+    //░▒▓█ Staker Registry █████████████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Tracks addresses registered as active stakers.
+     */
+    mapping(address => bytes1) stakerList;
+
+    //░▒▓█ Balance Management ██████████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Internal ledger of user balances across different tokens.
+     * @dev Format: user => token => balance. address(0) = ETH.
+     */
+    mapping(address user => mapping(address token => uint256 quantity)) balances;
+
+    //░▒▓█ Fisher Bridge State ██████████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice Nonce tracking for ordered Fisher Bridge cross-chain deposits.
+     */
+    mapping(address user => uint256 nonce) nextFisherDepositNonce;
+
+    //░▒▓█ Nonce State ██████████████████████████████████████████████████████████▓▒░
+
+    /**
+     * @notice (Unused but kept for storage alignment) Proposed address for user validation.
+     */
+    ProposalStructs.AddressTypeProposal userValidatorAddress;
+
+    /**
+     * @notice tracks if a specific async nonce has already been consumed.
+     * @dev Async nonces allow parallel execution as they can be used in any order.
+     */
+    mapping(address user => mapping(uint256 nonce => bool isUsed)) asyncNonce;
+
+    /**
+     * @notice Reserves an async nonce for a specific service address.
+     * @dev Prevents different services from attempting to use the same user nonce simultaneously.
+     */
+    mapping(address user => mapping(uint256 nonce => address serviceReserved)) asyncNonceReservedPointers;
+
+    /**
+     * @notice tracks the next expected nonce for sequential (synchronous) transactions.
+     */
+    mapping(address user => uint256 nonce) nextSyncNonce;
+}