@evvm/testnet-contracts 2.2.3 → 3.0.0

package/contracts/treasury/Treasury.sol

@@ -1,8 +1,17 @@
 // SPDX-License-Identifier: EVVM-NONCOMMERCIAL-1.0
-// Full license terms available at: https://www.evvm.info/docs/EVVMNoncommercialLicense
+// Full license terms available at: https://www.core.info/docs/EVVMNoncommercialLicense
 
 pragma solidity ^0.8.0;
 
+import {
+    TreasuryError as Error
+} from "@evvm/testnet-contracts/library/errors/TreasuryError.sol";
+
+import {Core} from "@evvm/testnet-contracts/contracts/core/Core.sol";
+
+import {IERC20} from "@evvm/testnet-contracts/library/primitives/IERC20.sol";
+import {SafeTransferLib} from "@solady/utils/SafeTransferLib.sol";
+
 /**
 ░██████████                                                     
     ░██                                                         
@@ -21,82 +30,84 @@ pragma solidity ^0.8.0;
    ██║   ███████╗███████║   ██║   ██║ ╚████║███████╗   ██║   
    ╚═╝   ╚══════╝╚══════╝   ╚═╝   ╚═╝  ╚═══╝╚══════╝   ╚═╝   
             
- * @title Treasury Contract
+ * @title EVVM Treasury
  * @author Mate labs
- * @notice Treasury for managing deposits and withdrawals in the EVVM ecosystem
- * @dev Secure vault for ETH and ERC20 tokens with EVVM integration and input validation
+ * @notice Vault for depositing and withdrawing assets in the EVVM ecosystem.
+ * @dev Handles ETH and ERC20 tokens, syncing balances with Core.sol. 
+ *      Principal Tokens are not withdrawable via this contract.
  */
 
-import {IERC20} from "@evvm/testnet-contracts/library/primitives/IERC20.sol";
-import {SafeTransferLib} from "@solady/utils/SafeTransferLib.sol";
-import {IEvvm} from "@evvm/testnet-contracts/interfaces/IEvvm.sol";
-import {
-    ErrorsLib
-} from "@evvm/testnet-contracts/contracts/treasury/lib/ErrorsLib.sol";
-
 contract Treasury {
-
-    IEvvm evvm;
+    /// @dev Reference to the EVVM core contract for balance management
+    Core core;
 
     /**
      * @notice Initialize Treasury with EVVM contract address
-     * @param _evvmAddress Address of the EVVM core contract
+     * @param _coreAddress Address of the EVVM core contract
      */
-    constructor(address _evvmAddress) {
-        evvm = IEvvm(_evvmAddress);
+    constructor(address _coreAddress) {
+        core = Core(_coreAddress);
     }
 
     /**
-     * @notice Deposit ETH or ERC20 tokens
-     * @param token ERC20 token address (ignored for ETH deposits)
-     * @param amount Token amount (ignored for ETH deposits)
+     * @notice Deposits ETH or ERC20 tokens into EVVM.
+     * @dev Credits the user's balance in Core.sol. ETH uses address(0).
+     * @param token Token address (address(0) for native ETH).
+     * @param amount Amount to deposit (must match msg.value for ETH).
      */
     function deposit(address token, uint256 amount) external payable {
         if (address(0) == token) {
             /// user is sending host native coin
             if (msg.value == 0)
-                revert ErrorsLib.DepositAmountMustBeGreaterThanZero();
-            if (amount != msg.value) revert ErrorsLib.InvalidDepositAmount();
+                revert Error.DepositAmountMustBeGreaterThanZero();
+
+            if (amount != msg.value) revert Error.InvalidDepositAmount();
 
-            evvm.addAmountToUser(msg.sender, address(0), msg.value);
+            core.addAmountToUser(msg.sender, address(0), msg.value);
         } else {
             /// user is sending ERC20 tokens
 
-            if (msg.value != 0) revert ErrorsLib.InvalidDepositAmount();
-            if (amount == 0)
-                revert ErrorsLib.DepositAmountMustBeGreaterThanZero();
+            if (msg.value != 0) revert Error.DepositCoinWithToken();
+
+            if (amount == 0) revert Error.DepositAmountMustBeGreaterThanZero();
 
             IERC20(token).transferFrom(msg.sender, address(this), amount);
-            evvm.addAmountToUser(msg.sender, token, amount);
+            core.addAmountToUser(msg.sender, token, amount);
         }
     }
 
     /**
-     * @notice Withdraw ETH or ERC20 tokens
-     * @param token Token address (address(0) for ETH)
-     * @param amount Amount to withdraw
+     * @notice Withdraws ETH or ERC20 tokens from EVVM.
+     * @dev Deducts from the user's balance in Core.sol. Principal Tokens cannot be withdrawn.
+     * @param token Token address to withdraw (address(0) for native ETH).
+     * @param amount Amount to withdraw.
      */
     function withdraw(address token, uint256 amount) external {
-        if (token == evvm.getEvvmMetadata().principalTokenAddress)
-            revert ErrorsLib.PrincipalTokenIsNotWithdrawable();
+        if (token == core.getPrincipalTokenAddress())
+            revert Error.PrincipalTokenIsNotWithdrawable();
 
-        if (evvm.getBalance(msg.sender, token) < amount)
-            revert ErrorsLib.InsufficientBalance();
+        if (core.getBalance(msg.sender, token) < amount)
+            revert Error.InsufficientBalance();
 
         if (token == address(0)) {
             /// user is trying to withdraw native coin
 
-            evvm.removeAmountFromUser(msg.sender, address(0), amount);
+            core.removeAmountFromUser(msg.sender, address(0), amount);
             SafeTransferLib.safeTransferETH(msg.sender, amount);
         } else {
             /// user is trying to withdraw ERC20 tokens
 
-            evvm.removeAmountFromUser(msg.sender, token, amount);
+            core.removeAmountFromUser(msg.sender, token, amount);
             IERC20(token).transfer(msg.sender, amount);
         }
     }
 
-    function getEvvmAddress() external view returns (address) {
-        return address(evvm);
+    /**
+     * @notice Returns the address of the connected EVVM core contract
+     * @dev Used for verification and integration purposes
+     * @return Address of the EVVM contract managing balances
+     */
+    function getCoreAddress() external view returns (address) {
+        return address(core);
     }
 }