Add eth get logs precompile specific types to a library and generate bindings for it in solidity-sdk

Author: jakovmitrovski

.github/workflows/test.yml

@@ -128,6 +128,12 @@ jobs:
           forge test -vvv
         id: test
         working-directory: solidity-sdk
+      
+      - name: Check bindings
+        run: |
+          make check
+        working-directory: solidity-sdk
+        id: bindings
 
   optimistic-auction:
     name: optimistic-auction 

Cargo.lock

@@ -3,6 +3,7 @@ members = [
   "examples/solidity/bindings",
   "types",
   "rust-sdk",
+  "solidity-sdk/bindings",
   "examples/notary",
   "examples/optimistic-auction",
   "examples/auction",

Cargo.toml

@@ -8,6 +8,7 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
 import {IERC20MintableAndBurnable} from "./interfaces/IERC20MintableAndBurnable.sol";
 import {WrappedToken} from "./WrappedToken.sol";
+import {EthGetLogsPrecompileHelperTypes} from "pod-sdk/types/EthGetLogsPrecompileHelperTypes.sol";
 
 /**
  * @title BridgeMintBurn
@@ -23,12 +24,6 @@ contract BridgeMintBurn is Bridge, IBridgeMintBurn {
      */
     bytes32 constant MINTER_ROLE = keccak256("MINTER_ROLE");
 
-    /**
-     * @dev The address of the external eth get logs precompile.
-     */
-    address constant ETH_EXTERNAL_ETH_GET_LOGS_PRECOMPILE =
-        address(uint160(uint256(keccak256("ETH_EXTERNAL_ETH_GET_LOGS"))));
-
     /**
      * @dev The source chain id.
      */
@@ -39,56 +34,6 @@ contract BridgeMintBurn is Bridge, IBridgeMintBurn {
      */
     bytes constant FINALIZED_BLOCK_BYTES = hex"66696e616c697a6564";
 
-    /**
-     * @dev The arguments for the external eth get logs precompile.
-     * @param fromBlock The block number to start searching from.
-     * @param toBlock The block number to stop searching at.
-     * @param addr The address to search logs for.
-     * @param blockHash The block hash to search logs for.
-     * @param topics The topics to search logs for.
-     */
-    struct EthGetLogsArgs {
-        bytes fromBlock;
-        bytes toBlock;
-        address addr;
-        bytes32 blockHash;
-        bytes32[] topics;
-    }
-
-    /**
-     * @dev The arguments for the external eth get logs precompile.
-     * @param chainId The chain id to search logs for.
-     * @param ethGetLogsArgs The arguments for the external eth get logs precompile.
-     */
-    struct ExternalEthGetLogsArgs {
-        uint256 chainId;
-        EthGetLogsArgs ethGetLogsArgs;
-    }
-
-    /**
-     * @dev The response from the external eth get logs precompile.
-     * @param addr The address of the log.
-     * @param topics The topics of the log.
-     * @param data The data of the log.
-     * @param blockNumber The block number of the log.
-     * @param transactionHash The transaction hash of the log.
-     * @param transactionIndex The transaction index of the log.
-     * @param blockHash The block hash of the log.
-     * @param logIndex The log index of the log.
-     * @param removed Whether the log was removed.
-     */
-    struct RpcLog {
-        address addr;
-        bytes32[] topics;
-        bytes data;
-        bytes blockNumber;
-        bytes32 transactionHash;
-        bytes transactionIndex;
-        bytes32 blockHash;
-        bytes logIndex;
-        bool removed;
-    }
-
     /**
      * @dev Constructor.
      */
@@ -112,17 +57,20 @@ contract BridgeMintBurn is Bridge, IBridgeMintBurn {
         topics[1] = bytes32(id);
         topics[2] = bytes32(uint256(uint160(token)));
 
-        (bool success, bytes memory output) = ETH_EXTERNAL_ETH_GET_LOGS_PRECOMPILE.staticcall(
+        (bool success, bytes memory output) = EthGetLogsPrecompileHelperTypes.PRECOMPILE_ADDRESS.staticcall(
             abi.encode(
-                ExternalEthGetLogsArgs(
+                EthGetLogsPrecompileHelperTypes.PrecompileArgs(
                     SOURCE_CHAIN_ID,
-                    EthGetLogsArgs(blockNumberFrom, FINALIZED_BLOCK_BYTES, address(token), bytes32(0), topics)
+                    EthGetLogsPrecompileHelperTypes.RpcArgs(
+                        blockNumberFrom, FINALIZED_BLOCK_BYTES, address(token), bytes32(0), topics
+                    )
                 )
             )
         );
         if (!success) revert PrecompileCallFailed();
 
-        RpcLog[] memory logs = abi.decode(output, (RpcLog[]));
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs =
+            abi.decode(output, (EthGetLogsPrecompileHelperTypes.RpcLog[]));
 
         if (logs.length == 0) revert NoDepositsFound();
         if (logs.length > 1) revert MultipleDepositsWithSameId();

protocol/src/BridgeMintBurn.sol

@@ -9,6 +9,7 @@ import {Bridge} from "../src/abstract/Bridge.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {WrappedToken} from "../src/WrappedToken.sol";
 import {Pausable} from "@openzeppelin/contracts/utils/Pausable.sol";
+import {EthGetLogsPrecompileHelperTypes} from "pod-sdk/types/EthGetLogsPrecompileHelperTypes.sol";
 
 contract BridgeMintBurnTest is BridgeBehaviorTest {
     BridgeMintBurn private _bridge;
@@ -49,7 +50,7 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     }
 
     function test_Claim_SingleLog_MintsToRecipient() public {
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](1);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](1);
         logs[0] = _makeLog(0, _mirror, DEPOSIT_AMOUNT, recipient);
         _mockEthGetLogs(0, bytes("0x1"), _mirror, logs);
         assertEq(_token.balanceOf(recipient), 0);
@@ -68,15 +69,15 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     }
 
     function test_Claim_RevertIfDailyLimitExhausted() public {
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](1);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](1);
         logs[0] = _makeLog(0, _mirror, tokenLimits.claim + 1, recipient);
         _mockEthGetLogs(0, bytes("0x1"), _mirror, logs);
         vm.expectRevert(abi.encodeWithSelector(IBridge.DailyLimitExhausted.selector));
         _bridge.claim(0, _mirror, bytes("0x1"));
     }
 
     function test_Claim_RevertIfDailyLimitExhausted_ButSucceedAfterOneDay() public {
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](1);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](1);
         logs[0] = _makeLog(0, _mirror, DEPOSIT_AMOUNT, recipient);
         _mockEthGetLogs(0, bytes("0x1"), _mirror, logs);
         _bridge.claim(0, _mirror, bytes("0x1"));
@@ -90,14 +91,14 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     }
 
     function test_Claim_RevertIfNoDepositsFound() public {
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](0);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](0);
         _mockEthGetLogs(0, bytes("0x1"), _mirror, logs);
         vm.expectRevert(abi.encodeWithSelector(IBridgeMintBurn.NoDepositsFound.selector));
         _bridge.claim(0, _mirror, bytes("0x1"));
     }
 
     function test_Claim_RevertIfMultipleDepositsFound() public {
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](2);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](2);
         logs[0] = _makeLog(0, _mirror, DEPOSIT_AMOUNT, recipient);
         logs[1] = _makeLog(0, _mirror, DEPOSIT_AMOUNT, recipient);
         _mockEthGetLogs(0, bytes("0x1"), _mirror, logs);
@@ -108,7 +109,7 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     function test_Claim_RevertIfMirrorTokenNotFound() public {
         // Use a token not mapped in mirrorTokens
         address unknownMirror = address(0xBEEF);
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](1);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](1);
         logs[0] = _makeLog(0, unknownMirror, DEPOSIT_AMOUNT, recipient);
         _mockEthGetLogs(0, bytes("0x1"), unknownMirror, logs);
 
@@ -117,7 +118,7 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     }
 
     function test_Claim_RevertIfAlreadyProcessed() public {
-        BridgeMintBurn.RpcLog[] memory logs = new BridgeMintBurn.RpcLog[](1);
+        EthGetLogsPrecompileHelperTypes.RpcLog[] memory logs = new EthGetLogsPrecompileHelperTypes.RpcLog[](1);
         logs[0] = _makeLog(0, _mirror, DEPOSIT_AMOUNT, recipient);
         _mockEthGetLogs(0, bytes("0x1"), _mirror, logs);
         _bridge.claim(0, _mirror, bytes("0x1"));
@@ -136,7 +137,7 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     }
 
     function test_Claim_RevertIfPrecompileCallFails() public {
-        BridgeMintBurn.ExternalEthGetLogsArgs memory args = _buildArgs(0, bytes("0x1"), _mirror);
+        EthGetLogsPrecompileHelperTypes.PrecompileArgs memory args = _buildArgs(0, bytes("0x1"), _mirror);
         podMockEthGetLogsRevert(abi.encode(args));
 
         vm.expectRevert(abi.encodeWithSelector(IBridgeMintBurn.PrecompileCallFailed.selector));
@@ -171,22 +172,25 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     function _buildArgs(uint256 id, bytes memory fromBlock, address tokenAddr)
         internal
         pure
-        returns (BridgeMintBurn.ExternalEthGetLogsArgs memory)
+        returns (EthGetLogsPrecompileHelperTypes.PrecompileArgs memory)
     {
-        BridgeMintBurn.EthGetLogsArgs memory inner = BridgeMintBurn.EthGetLogsArgs({
+        EthGetLogsPrecompileHelperTypes.RpcArgs memory inner = EthGetLogsPrecompileHelperTypes.RpcArgs({
             fromBlock: fromBlock,
             toBlock: hex"66696e616c697a6564",
             addr: tokenAddr,
             blockHash: bytes32(0),
             topics: _buildTopics(id, tokenAddr)
         });
-        return BridgeMintBurn.ExternalEthGetLogsArgs({chainId: 1, ethGetLogsArgs: inner});
+        return EthGetLogsPrecompileHelperTypes.PrecompileArgs({chainId: 1, ethGetLogsArgs: inner});
     }
 
-    function _mockEthGetLogs(uint256 id, bytes memory fromBlock, address tokenAddr, BridgeMintBurn.RpcLog[] memory logs)
-        internal
-    {
-        BridgeMintBurn.ExternalEthGetLogsArgs memory args = _buildArgs(id, fromBlock, tokenAddr);
+    function _mockEthGetLogs(
+        uint256 id,
+        bytes memory fromBlock,
+        address tokenAddr,
+        EthGetLogsPrecompileTypes.RpcLog[] memory logs
+    ) internal {
+        EthGetLogsPrecompileTypes.PrecompileArgs memory args = _buildArgs(id, fromBlock, tokenAddr);
         podMockEthGetLogs(abi.encode(args), abi.encode(logs));
     }
 
@@ -200,9 +204,9 @@ contract BridgeMintBurnTest is BridgeBehaviorTest {
     function _makeLog(uint256 id, address tokenAddr, uint256 amount, address to)
         internal
         pure
-        returns (BridgeMintBurn.RpcLog memory)
+        returns (EthGetLogsPrecompileTypes.RpcLog memory)
     {
-        return BridgeMintBurn.RpcLog({
+        return EthGetLogsPrecompileTypes.RpcLog({
             addr: tokenAddr,
             topics: _buildTopics(id, tokenAddr),
             data: abi.encode(amount, to),

protocol/test/BridgeMintBurn.t.sol

@@ -0,0 +1,8 @@
+generate:
+	forge bind --crate-name pod-solidity-sdk-types --bindings-path ./bindings --alloy-version 1.0.24 --force --no-metadata --select ".*HelperTypes$$" --overwrite
+
+check:
+	forge bind --crate-name pod-solidity-sdk-types --bindings-path ./bindings --alloy-version 1.0.24 --force --no-metadata --select ".*HelperTypes$$"
+
+.PHONY: generate
+.PHONY: check

solidity-sdk/Makefile

@@ -0,0 +1,8 @@
+[package]
+name = "pod-solidity-sdk-types"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+alloy = { version = "1.0.24", features = ["sol-types", "contract"] }
+serde = { version = "1.0", features = ["derive"] }