feat(evm-funtoken-precompile): Implement "balance", "bankBalance", an…

…d "whoAmI" methods (#2107)
NibiruChain · Nov 8, 2024 · 8907a61 · 8907a61
1 parent 94db838
commit 8907a61
Show file tree

Hide file tree

Showing 26 changed files with 872 additions and 160 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -100,6 +100,8 @@ tests for race conditions within funtoken precompile
 - [#2100](https://github.com/NibiruChain/nibiru/pull/2100) - refactor: cleanup statedb and precompile sections
 - [#2101](https://github.com/NibiruChain/nibiru/pull/2101) - fix(evm): tx receipt proper marshalling
 - [#2105](https://github.com/NibiruChain/nibiru/pull/2105) - test(evm): precompile call with revert
+- [#2107](https://github.com/NibiruChain/nibiru/pull/2107) -
+feat(evm-funtoken-precompile): Implement methods: balance, bankBalance, whoAmI
 
 #### Nibiru EVM | Before Audit 1 - 2024-10-18
 

diff --git a/eth/rpc/backend/account_info.go b/eth/rpc/backend/account_info.go
@@ -61,7 +61,8 @@ func (b *Backend) GetProof(
 	}
 	ctx := rpc.NewContextWithHeight(height)
 
-	// if the height is equal to zero, meaning the query condition of the block is either "pending" or "latest"
+	// if the height is equal to zero, meaning the query condition of the block
+	// is either "pending" or "latest"
 	if height == 0 {
 		bn, err := b.BlockNumber()
 		if err != nil {

diff --git a/eth/rpc/rpcapi/eth_api_test.go b/eth/rpc/rpcapi/eth_api_test.go
@@ -106,7 +106,11 @@ func (s *NodeSuite) Test_BlockNumber() {
 
 	ethBlockNumber, err := s.ethClient.BlockNumber(context.Background())
 	s.NoError(err)
-	s.Equal(networkBlockNumber, int64(ethBlockNumber))
+	// It might be off by 1 block in either direction.
+	blockDiff := networkBlockNumber - int64(ethBlockNumber)
+	s.Truef(blockDiff <= 2, "networkBlockNumber %d, ethBlockNumber %d",
+		networkBlockNumber, ethBlockNumber,
+	)
 }
 
 // Test_BlockByNumber EVM method: eth_getBlockByNumber
@@ -366,11 +370,10 @@ func (s *NodeSuite) Test_SmartContract() {
 	txHash, err := s.ethAPI.SendRawTransaction(txBz)
 	s.Require().NoError(err)
 
-	s.T().Log("Assert: tx IS pending just after execution")
-	pendingTxs, err := s.ethAPI.GetPendingTransactions()
-	s.NoError(err)
-	s.Require().Len(pendingTxs, 1)
-	_ = s.network.WaitForNextBlock()
+	s.T().Log("Wait a few blocks so the tx won't be pending")
+	for i := 0; i < 5; i++ {
+		_ = s.network.WaitForNextBlock()
+	}
 
 	s.T().Log("Assert: tx NOT pending")
 	{

diff --git a/x/evm/embeds/artifacts/contracts/IFunToken.sol/IFunToken.json b/x/evm/embeds/artifacts/contracts/IFunToken.sol/IFunToken.json
@@ -3,6 +3,110 @@
   "contractName": "IFunToken",
   "sourceName": "contracts/IFunToken.sol",
   "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "who",
+          "type": "address"
+        },
+        {
+          "internalType": "address",
+          "name": "funtoken",
+          "type": "address"
+        }
+      ],
+      "name": "balance",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "erc20Balance",
+          "type": "uint256"
+        },
+        {
+          "internalType": "uint256",
+          "name": "bankBalance",
+          "type": "uint256"
+        },
+        {
+          "components": [
+            {
+              "internalType": "address",
+              "name": "erc20",
+              "type": "address"
+            },
+            {
+              "internalType": "string",
+              "name": "bankDenom",
+              "type": "string"
+            }
+          ],
+          "internalType": "struct IFunToken.FunToken",
+          "name": "token",
+          "type": "tuple"
+        },
+        {
+          "components": [
+            {
+              "internalType": "address",
+              "name": "ethAddr",
+              "type": "address"
+            },
+            {
+              "internalType": "string",
+              "name": "bech32Addr",
+              "type": "string"
+            }
+          ],
+          "internalType": "struct IFunToken.NibiruAccount",
+          "name": "whoAddrs",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "who",
+          "type": "address"
+        },
+        {
+          "internalType": "string",
+          "name": "bankDenom",
+          "type": "string"
+        }
+      ],
+      "name": "bankBalance",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "bankBalance",
+          "type": "uint256"
+        },
+        {
+          "components": [
+            {
+              "internalType": "address",
+              "name": "ethAddr",
+              "type": "address"
+            },
+            {
+              "internalType": "string",
+              "name": "bech32Addr",
+              "type": "string"
+            }
+          ],
+          "internalType": "struct IFunToken.NibiruAccount",
+          "name": "whoAddrs",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [
         {
@@ -21,7 +125,7 @@
           "type": "string"
         }
       ],
-      "name": "bankSend",
+      "name": "sendToBank",
       "outputs": [
         {
           "internalType": "uint256",
@@ -31,6 +135,37 @@
       ],
       "stateMutability": "nonpayable",
       "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "string",
+          "name": "who",
+          "type": "string"
+        }
+      ],
+      "name": "whoAmI",
+      "outputs": [
+        {
+          "components": [
+            {
+              "internalType": "address",
+              "name": "ethAddr",
+              "type": "address"
+            },
+            {
+              "internalType": "string",
+              "name": "bech32Addr",
+              "type": "string"
+            }
+          ],
+          "internalType": "struct IFunToken.NibiruAccount",
+          "name": "whoAddrs",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "function"
     }
   ],
   "bytecode": "0x",

diff --git a/...ontracts/TestERC20TransferThenPrecompileSend.sol/TestERC20TransferThenPrecompileSend.json b/...ontracts/TestERC20TransferThenPrecompileSend.sol/TestERC20TransferThenPrecompileSend.json
diff --git a/...rtifacts/contracts/TestFunTokenPrecompileLocalGas.sol/TestFunTokenPrecompileLocalGas.json b/...rtifacts/contracts/TestFunTokenPrecompileLocalGas.sol/TestFunTokenPrecompileLocalGas.json
diff --git a/...acts/contracts/TestNativeSendThenPrecompileSend.sol/TestNativeSendThenPrecompileSend.json b/...acts/contracts/TestNativeSendThenPrecompileSend.sol/TestNativeSendThenPrecompileSend.json
diff --git a/...ds/artifacts/contracts/TestPrecompileSelfCallRevert.sol/TestPrecompileSelfCallRevert.json b/...ds/artifacts/contracts/TestPrecompileSelfCallRevert.sol/TestPrecompileSelfCallRevert.json
diff --git a/x/evm/embeds/contracts/IFunToken.sol b/x/evm/embeds/contracts/IFunToken.sol
@@ -1,24 +1,53 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.19;
 
-/// @dev Implements the "bankSend" functionality for sending ERC20 tokens as bank
-/// coins to a Nibiru bech32 address using the "FunToken" mapping between the
-/// ERC20 and bank.
+address constant FUNTOKEN_PRECOMPILE_ADDRESS = 0x0000000000000000000000000000000000000800;
+IFunToken constant FUNTOKEN_PRECOMPILE = IFunToken(FUNTOKEN_PRECOMPILE_ADDRESS);
+
+/// @dev Implements the functionality for sending ERC20 tokens and bank
+/// coins to various Nibiru accounts using either the Nibiru Bech32 address
+/// using the "FunToken" mapping between the ERC20 and bank.
 interface IFunToken {
-    /// @dev bankSend sends ERC20 tokens as coins to a Nibiru base account
+    /// @dev sendToBank sends ERC20 tokens as coins to a Nibiru base account
     /// @param erc20 - the address of the ERC20 token contract
     /// @param amount - the amount of tokens to send
     /// @param to - the receiving Nibiru base account address as a string
     /// @return sentAmount - amount of tokens received by the recipient. This may
     /// not be equal to `amount` if the corresponding ERC20 contract has a fee or
     /// deduction on transfer.
-    function bankSend(
+    function sendToBank(
         address erc20,
         uint256 amount,
-        string memory to
+        string calldata to
     ) external returns (uint256 sentAmount);
-}
 
-address constant FUNTOKEN_PRECOMPILE_ADDRESS = 0x0000000000000000000000000000000000000800;
+    struct NibiruAccount {
+        address ethAddr;
+        string bech32Addr;
+    }
+    struct FunToken {
+        address erc20;
+        string bankDenom;
+    }
 
-IFunToken constant FUNTOKEN_PRECOMPILE = IFunToken(FUNTOKEN_PRECOMPILE_ADDRESS);
+    function balance(
+        address who,
+        address funtoken
+    )
+        external
+        returns (
+            uint256 erc20Balance,
+            uint256 bankBalance,
+            FunToken memory token,
+            NibiruAccount memory whoAddrs
+        );
+
+    function bankBalance(
+        address who,
+        string calldata bankDenom
+    ) external returns (uint256 bankBalance, NibiruAccount memory whoAddrs);
+
+    function whoAmI(
+        string calldata who
+    ) external returns (NibiruAccount memory whoAddrs);
+}
diff --git a/x/evm/embeds/contracts/TestERC20TransferThenPrecompileSend.sol b/x/evm/embeds/contracts/TestERC20TransferThenPrecompileSend.sol
@@ -25,7 +25,7 @@ contract TestERC20TransferThenPrecompileSend {
             "ERC-20 transfer failed"
         );
 
-        uint256 sentAmount = FUNTOKEN_PRECOMPILE.bankSend(
+        uint256 sentAmount = FUNTOKEN_PRECOMPILE.sendToBank(
             erc20,
             precompileAmount,
             precompileRecipient
@@ -34,7 +34,7 @@ contract TestERC20TransferThenPrecompileSend {
         require(
             sentAmount == precompileAmount,
             string.concat(
-                "IFunToken.bankSend succeeded but transferred the wrong amount",
+                "IFunToken.sendToBank succeeded but transferred the wrong amount",
                 "sentAmount ",
                 Strings.toString(sentAmount),
                 "expected ",

diff --git a/x/evm/embeds/contracts/TestFunTokenPrecompileLocalGas.sol b/x/evm/embeds/contracts/TestFunTokenPrecompileLocalGas.sol
@@ -11,21 +11,21 @@ contract TestFunTokenPrecompileLocalGas {
         erc20 = erc20_;
     }
 
-    // Calls bankSend of the FunToken Precompile with the default gas.
+    // Calls sendToBank of the FunToken Precompile with the default gas.
     // Internal call could use all the gas for the parent call.
     function callBankSend(
         uint256 amount,
         string memory bech32Recipient
     ) public {
-        uint256 sentAmount = FUNTOKEN_PRECOMPILE.bankSend(
+        uint256 sentAmount = FUNTOKEN_PRECOMPILE.sendToBank(
             erc20,
-                amount,
+            amount,
             bech32Recipient
         );
         require(
             sentAmount == amount,
             string.concat(
-                "IFunToken.bankSend succeeded but transferred the wrong amount",
+                "IFunToken.sendToBank succeeded but transferred the wrong amount",
                 "sentAmount ",
                 Strings.toString(sentAmount),
                 "expected ",
@@ -34,22 +34,22 @@ contract TestFunTokenPrecompileLocalGas {
         );
     }
 
-    // Calls bankSend of the FunToken Precompile with the gas amount set in parameter.
+    // Calls sendToBank of the FunToken Precompile with the gas amount set in parameter.
     // Internal call should fail if the gas provided is insufficient.
     function callBankSendLocalGas(
         uint256 amount,
         string memory bech32Recipient,
         uint256 customGas
     ) public {
-        uint256 sentAmount = FUNTOKEN_PRECOMPILE.bankSend{gas: customGas}(
+        uint256 sentAmount = FUNTOKEN_PRECOMPILE.sendToBank{gas: customGas}(
             erc20,
             amount,
             bech32Recipient
         );
         require(
             sentAmount == amount,
             string.concat(
-                "IFunToken.bankSend succeeded but transferred the wrong amount",
+                "IFunToken.sendToBank succeeded but transferred the wrong amount",
                 "sentAmount ",
                 Strings.toString(sentAmount),
                 "expected ",

diff --git a/x/evm/embeds/contracts/TestNativeSendThenPrecompileSend.sol b/x/evm/embeds/contracts/TestNativeSendThenPrecompileSend.sol
@@ -20,15 +20,36 @@ contract TestNativeSendThenPrecompileSend {
         bool isSent = nativeRecipient.send(nativeAmount);
         require(isSent, "Failed to send native token");
 
-        uint256 sentAmount = FUNTOKEN_PRECOMPILE.bankSend(
+        uint256 sentAmount = FUNTOKEN_PRECOMPILE.sendToBank(
             erc20,
             precompileAmount,
             precompileRecipient
         );
         require(
             sentAmount == precompileAmount,
             string.concat(
-                "IFunToken.bankSend succeeded but transferred the wrong amount",
+                "IFunToken.sendToBank succeeded but transferred the wrong amount",
+                "sentAmount ",
+                Strings.toString(sentAmount),
+                "expected ",
+                Strings.toString(precompileAmount)
+            )
+        );
+    }
+
+    function justPrecompileSend(
+        string memory precompileRecipient,
+        uint256 precompileAmount
+    ) public {
+        uint256 sentAmount = FUNTOKEN_PRECOMPILE.sendToBank(
+            erc20,
+            precompileAmount,
+            precompileRecipient
+        );
+        require(
+            sentAmount == precompileAmount,
+            string.concat(
+                "IFunToken.sendToBank succeeded but transferred the wrong amount",
                 "sentAmount ",
                 Strings.toString(sentAmount),
                 "expected ",

diff --git a/x/evm/embeds/contracts/TestPrecompileSelfCallRevert.sol b/x/evm/embeds/contracts/TestPrecompileSelfCallRevert.sol
@@ -40,16 +40,16 @@ contract TestPrecompileSelfCallRevert {
     ) external {
         require(nativeRecipient.send(nativeAmount), "ETH transfer failed"); // wei
 
-        uint256 sentAmount = FUNTOKEN_PRECOMPILE.bankSend(
+        uint256 sentAmount = FUNTOKEN_PRECOMPILE.sendToBank(
             erc20,
-            precompileAmount,  // micro-WNIBI
-                precompileRecipient
+            precompileAmount, // micro-WNIBI
+            precompileRecipient
         );
 
         require(
             sentAmount == precompileAmount,
             string.concat(
-                "IFunToken.bankSend succeeded but transferred the wrong amount",
+                "IFunToken.sendToBank succeeded but transferred the wrong amount",
                 "sentAmount ",
                 Strings.toString(nativeAmount),
                 "expected ",