feat: optimize IntraBlockTokenTracking _spotSend()

Author: PumpkingWok

src/HyperCoreToken.sol

@@ -11,7 +11,7 @@ import {PrecompileLib} from "hyper-evm-lib/PrecompileLib.sol";
 /// On burning side, any token holder can call it to burn them at 1:1 rate, the same amount will be receive at core
 contract HyperCoreToken is ERC20("HyperCoreUSDC", "HCUSDC") {
     /// @dev Wallet factory
-    IWalletFactory public immutable walletFactory;
+    IWalletFactory public immutable WALLET_FACTORY;
 
     /// @dev Core enabler fee (1 USDC)
     uint64 public constant ENABLER_FEE = 1e8;
@@ -26,7 +26,7 @@ contract HyperCoreToken is ERC20("HyperCoreUSDC", "HCUSDC") {
     error HCT_ReceiverNotEnabled();
 
     constructor(address walletFactory_) {
-        walletFactory = IWalletFactory(walletFactory_);
+        WALLET_FACTORY = IWalletFactory(walletFactory_);
     }
 
     /**
@@ -66,7 +66,7 @@ contract HyperCoreToken is ERC20("HyperCoreUSDC", "HCUSDC") {
     }
 
     modifier onlyWallet() {
-        if (!walletFactory.isWallet(msg.sender)) revert HCT_OnlyWallet();
+        if (!WALLET_FACTORY.isWallet(msg.sender)) revert HCT_OnlyWallet();
         _;
     }
 }

src/IntraBlockTokenTracking.sol

@@ -11,28 +11,35 @@ abstract contract IntraBlockTokenTracking {
     /// @dev last block interaction
     uint256 lastUsedBlock;
 
-    /// @dev trowed at invalid amount
-    error IBTT_InvalidAmount();
-
     /// @dev throwed if the balance is not enough
     error IBTT_InsufficientBalance();
 
     /// @dev throwed when tries to send zero amount
     error IBTT_ZeroAmount();
 
-    function getBalance() external view returns (uint64) {
-        return _getBalance();
+    /**
+     * @notice Get the available balance at the current block state
+     */
+    function getAvailableBalance() external view returns (uint64) {
+        return _getAvailableBalance();
     }
 
-    function _getBalance() internal view returns (uint64 balance) {
+    /**
+     * @notice Get the available balance at the current block state
+     */
+    function _getAvailableBalance() internal view returns (uint64 balance) {
         PrecompileLib.SpotBalance memory spotBalance = PrecompileLib.spotBalance(address(this), 0);
         uint64 total = spotBalance.total;
         uint64 usedAmount = _getUsedAmount();
 
-        if (usedAmount > total) return 0;
+        // total can't be > usedAmount
+        // check on that in the _spotSend()
         return total - usedAmount;
     }
 
+    /**
+     * @notice Add amount used in the current block
+     */
     function _addUsedAmount(uint64 amount) internal {
         if (lastUsedBlock != block.number) {
             usedTokenAmounts = amount;
@@ -42,6 +49,9 @@ abstract contract IntraBlockTokenTracking {
         }
     }
 
+    /**
+     * @notice Get used amount
+     */
     function _getUsedAmount() internal view returns (uint64) {
         return lastUsedBlock == block.number ? usedTokenAmounts : 0;
     }
@@ -54,17 +64,14 @@ abstract contract IntraBlockTokenTracking {
     function _spotSend(address to, uint64 amount) internal {
         if (amount == 0) revert IBTT_ZeroAmount();
 
-        bool activated;
-        uint64 balance = _getBalance();
-
-        if (PrecompileLib.coreUserExists(to)) {
-            activated = true;
-        }
-
+        // enabler fees not included
         CoreWriterLib.spotSend(to, 0, amount);
 
+        // get the balance - used amount in the same block
+        uint64 balance = _getAvailableBalance();
+
         // add 1USDC as fee to enable the recipient at core spot
-        amount = activated ? amount : amount + 1e8;
+        amount = PrecompileLib.coreUserExists(to) ? amount : amount + 1e8;
 
         if (amount > balance) revert IBTT_InsufficientBalance();
 

src/Wallet.sol

@@ -8,7 +8,7 @@ import {IHyperCoreToken} from "./interfaces/IHyperCoreToken.sol";
 /// @dev Wallet used to mint coreToken at evm, transferring spot usdc to coreToken's address at spot
 contract Wallet is Initializable, IntraBlockTokenTracking {
     /// @dev Core token
-    address public immutable coreToken;
+    address public immutable CORE_TOKEN;
 
     /// @dev Wallet owner (immutable)
     address public owner;
@@ -20,13 +20,13 @@ contract Wallet is Initializable, IntraBlockTokenTracking {
     error W_OnlyOwner();
 
     /// @dev emitted at mint
-    event Mint(address to, uint64 amount);
+    event Mint(address indexed to, uint64 amount);
 
     /// @dev emitted when a user withdraw
-    event Withdraw(address to, uint64 amount);
+    event Withdraw(address indexed to, uint64 amount);
 
     constructor(address coreToken_) {
-        coreToken = coreToken_;
+        CORE_TOKEN = coreToken_;
     }
 
     /**
@@ -59,15 +59,12 @@ contract Wallet is Initializable, IntraBlockTokenTracking {
      * @param amount amount to mint
      */
     function _mintToken(address to, uint64 amount) internal onlyOwner {
-        // check if there is enough balance at core
-        uint64 balance = _getBalance();
-        if (amount > balance) revert W_NotEnoughAmount();
-
         // transfer token to coreToken address at core
-        _spotSend(coreToken, amount);
+        // assume core token is enabled at core
+        _spotSend(CORE_TOKEN, amount);
 
         // mint token at evm
-        IHyperCoreToken(coreToken).mint(to, amount);
+        IHyperCoreToken(CORE_TOKEN).mint(to, amount);
 
         emit Mint(to, amount);
     }

test/BaseTest.t.sol

@@ -7,7 +7,6 @@ import {MockSpotBalance} from "./mocks/MockSpotBalance.sol";
 import {MockCoreUserExists} from "./mocks/MockCoreUserExists.sol";
 
 import {HLConstants} from "hyper-evm-lib/common/HLConstants.sol";
-//import {CoreWriterLib} from "hyper-evm-lib/CoreWriterLib.sol";
 
 abstract contract BaseTest is Test {
     MockSpotBalance internal spotBalancePrecompile;

test/Wallet.t.sol

@@ -1,8 +1,6 @@
 // SPDX-License-Identifier:  MIT
 pragma solidity ^0.8.18;
 
-import {HLConstants} from "hyper-evm-lib/common/HLConstants.sol";
-
 import {BaseTest} from "./BaseTest.t.sol";
 import {Wallet} from "src/Wallet.sol";
 import {WalletFactory} from "src/WalletFactory.sol";
@@ -23,7 +21,7 @@ contract WalletTest is BaseTest {
         // deploy factory
         factory = new WalletFactory();
         wallet = Wallet(factory.createWallet(user));
-        hcUsdc = HyperCoreToken(wallet.coreToken());
+        hcUsdc = HyperCoreToken(wallet.CORE_TOKEN());
 
         _setCore();
     }
@@ -33,7 +31,7 @@ contract WalletTest is BaseTest {
 
         assertEq(factory.isWallet(address(wallet)), true);
 
-        assertEq(address(hcUsdc.walletFactory()), address(factory));
+        assertEq(address(hcUsdc.WALLET_FACTORY()), address(factory));
         assertEq(hcUsdc.decimals(), 8);
     }