port transact feature from Passage to Zenith

Author: anna-carroll

.gas-snapshot

@@ -14,25 +14,24 @@ OrdersTest:test_sweepERC20() (gas: 60402)
 OrdersTest:test_sweepETH() (gas: 81940)
 OrdersTest:test_underflowETH() (gas: 63528)
 PassageTest:test_configureEnter() (gas: 82311)
-PassageTest:test_disallowedEnter() (gas: 17916)
-PassageTest:test_enter() (gas: 25563)
-PassageTest:test_enterToken() (gas: 64332)
-PassageTest:test_enterToken_defaultChain() (gas: 62915)
-PassageTest:test_enterTransact() (gas: 60890)
-PassageTest:test_enter_defaultChain() (gas: 24033)
-PassageTest:test_fallback() (gas: 21534)
-PassageTest:test_onlyTokenAdmin() (gas: 16926)
-PassageTest:test_receive() (gas: 21384)
-PassageTest:test_setUp() (gas: 16968)
-PassageTest:test_transact() (gas: 58562)
-PassageTest:test_transact_defaultChain() (gas: 57475)
-PassageTest:test_withdraw() (gas: 59033)
-ZenithTest:test_addSequencer() (gas: 88121)
-ZenithTest:test_badSignature() (gas: 37241)
-ZenithTest:test_incorrectHostBlock() (gas: 35086)
-ZenithTest:test_notSequencer() (gas: 34076)
-ZenithTest:test_notSequencerAdmin() (gas: 10125)
-ZenithTest:test_onePerBlock() (gas: 68193)
-ZenithTest:test_removeSequencer() (gas: 39665)
-ZenithTest:test_setUp() (gas: 8366)
-ZenithTest:test_submitBlock() (gas: 63333)
+PassageTest:test_disallowedEnter() (gas: 17938)
+PassageTest:test_enter() (gas: 25507)
+PassageTest:test_enterToken() (gas: 64354)
+PassageTest:test_enterToken_defaultChain() (gas: 62870)
+PassageTest:test_enter_defaultChain() (gas: 24011)
+PassageTest:test_fallback() (gas: 21445)
+PassageTest:test_onlyTokenAdmin() (gas: 16881)
+PassageTest:test_receive() (gas: 21339)
+PassageTest:test_setUp() (gas: 16901)
+PassageTest:test_withdraw() (gas: 59055)
+ZenithTest:test_addSequencer() (gas: 88222)
+ZenithTest:test_badSignature() (gas: 37320)
+ZenithTest:test_incorrectHostBlock() (gas: 35165)
+ZenithTest:test_notSequencer() (gas: 34155)
+ZenithTest:test_notSequencerAdmin() (gas: 10137)
+ZenithTest:test_onePerBlock() (gas: 68351)
+ZenithTest:test_removeSequencer() (gas: 39744)
+ZenithTest:test_setUp() (gas: 8410)
+ZenithTest:test_submitBlock() (gas: 63456)
+ZenithTest:test_transact() (gas: 32536)
+ZenithTest:test_transact_defaultChain() (gas: 31022)

script/Zenith.s.sol

@@ -16,7 +16,7 @@ contract ZenithScript is Script {
         address sequencerAdmin
     ) public returns (Zenith z, Passage p, HostOrders m) {
         vm.startBroadcast();
-        z = new Zenith(sequencerAdmin);
+        z = new Zenith(defaultRollupChainId, sequencerAdmin);
         p = new Passage(defaultRollupChainId, withdrawalAdmin, initialEnterTokens);
         m = new HostOrders();
     }

src/Passage.sol

@@ -36,17 +36,6 @@ contract Passage {
         uint256 indexed rollupChainId, address indexed rollupRecipient, address indexed token, uint256 amount
     );
 
-    /// @notice Emitted to send a special transaction to the rollup.
-    event Transact(
-        uint256 indexed rollupChainId,
-        address indexed sender,
-        address indexed to,
-        bytes data,
-        uint256 value,
-        uint256 gas,
-        uint256 maxFeePerGas
-    );
-
     /// @notice Emitted when the admin withdraws tokens from the contract.
     event Withdrawal(address indexed token, address indexed recipient, uint256 amount);
 
@@ -106,54 +95,6 @@ contract Passage {
         enterToken(defaultRollupChainId, rollupRecipient, token, amount);
     }
 
-    /// @notice Allows a special transaction to be sent to the rollup with sender == L1 msg.sender.
-    /// @dev Transaction is processed after normal rollup block execution.
-    /// @dev See `enterTransact` for docs.
-    function transact(
-        uint256 rollupChainId,
-        address to,
-        bytes calldata data,
-        uint256 value,
-        uint256 gas,
-        uint256 maxFeePerGas
-    ) public payable {
-        enterTransact(rollupChainId, msg.sender, to, data, value, gas, maxFeePerGas);
-    }
-
-    /// @dev See `transact` for docs.
-    function transact(address to, bytes calldata data, uint256 value, uint256 gas, uint256 maxFeePerGas)
-        external
-        payable
-    {
-        enterTransact(defaultRollupChainId, msg.sender, to, data, value, gas, maxFeePerGas);
-    }
-
-    /// @notice Send Ether on the rollup, send a special transaction to be sent to the rollup with sender == L1 msg.sender.
-    /// @dev Enter and Transact are processed after normal rollup block execution.
-    /// @dev See `enter` for Enter docs.
-    /// @param rollupChainId - The rollup chain to send the transaction to.
-    /// @param etherRecipient - The recipient of the ether.
-    /// @param to - The address to call on the rollup.
-    /// @param data - The data to send to the rollup.
-    /// @param value - The amount of Ether to send on the rollup.
-    /// @param gas - The gas limit for the transaction.
-    /// @param maxFeePerGas - The maximum fee per gas for the transaction (per EIP-1559).
-    /// @custom:emits Transact indicating the transaction to mine on the rollup.
-    function enterTransact(
-        uint256 rollupChainId,
-        address etherRecipient,
-        address to,
-        bytes calldata data,
-        uint256 value,
-        uint256 gas,
-        uint256 maxFeePerGas
-    ) public payable {
-        // if msg.value is attached, Enter
-        enter(rollupChainId, etherRecipient);
-        // emit Transact event
-        emit Transact(rollupChainId, msg.sender, to, data, value, gas, maxFeePerGas);
-    }
-
     /// @notice Alow/Disallow a given ERC20 token to enter the rollup.
     function configureEnter(address token, bool _canEnter) external {
         if (msg.sender != tokenAdmin) revert OnlyTokenAdmin();

src/Zenith.sol

@@ -4,6 +4,9 @@ pragma solidity ^0.8.24;
 import {Passage} from "./Passage.sol";
 
 contract Zenith {
+    /// @notice The chainId of rollup that Ether will be sent to by default when entering the rollup via fallback() or receive().
+    uint256 public immutable defaultRollupChainId;
+
     /// @notice The address that is allowed to set/remove sequencers.
     address public immutable sequencerAdmin;
 
@@ -63,10 +66,22 @@ contract Zenith {
         bytes32 blockDataHash
     );
 
+    /// @notice Emitted to send a special transaction to the rollup.
+    event Transact(
+        uint256 indexed rollupChainId,
+        address indexed sender,
+        address indexed to,
+        bytes data,
+        uint256 value,
+        uint256 gas,
+        uint256 maxFeePerGas
+    );
+
     /// @notice Emitted when a sequencer is added or removed.
     event SequencerSet(address indexed sequencer, bool indexed permissioned);
 
-    constructor(address _sequencerAdmin) {
+    constructor(uint256 _defaultRollupChainId, address _sequencerAdmin) {
+        defaultRollupChainId = _defaultRollupChainId;
         sequencerAdmin = _sequencerAdmin;
         deployBlockNumber = block.number;
     }
@@ -125,6 +140,32 @@ contract Zenith {
         );
     }
 
+    /// @notice Send a special transaction to be sent to the rollup with sender == L1 msg.sender.
+    /// @dev Transact is processed after normal rollup block execution.
+    /// @param rollupChainId - The rollup chain to send the transaction to.
+    /// @param to - The address to call on the rollup.
+    /// @param data - The data to send to the rollup.
+    /// @param value - The amount of Ether to send on the rollup.
+    /// @param gas - The gas limit for the transaction.
+    /// @param maxFeePerGas - The maximum fee per gas for the transaction (per EIP-1559).
+    /// @custom:emits Transact indicating the transaction to mine on the rollup.
+    function transact(
+        uint256 rollupChainId,
+        address to,
+        bytes calldata data,
+        uint256 value,
+        uint256 gas,
+        uint256 maxFeePerGas
+    ) public {
+        // emit Transact event
+        emit Transact(rollupChainId, msg.sender, to, data, value, gas, maxFeePerGas);
+    }
+
+    /// @dev See `transact` for docs.
+    function transact(address to, bytes calldata data, uint256 value, uint256 gas, uint256 maxFeePerGas) external {
+        transact(defaultRollupChainId, to, data, value, gas, maxFeePerGas);
+    }
+
     /// @notice Construct hash of block details that the sequencer signs.
     /// @param header - the header information for the rollup block.
     /// @return commit - the hash of the encoded block details.

test/Helpers.t.sol

@@ -18,7 +18,7 @@ contract HelpersTest is Test {
 
     function setUp() public {
         vm.createSelectFork("https://rpc.holesky.ethpandaops.io");
-        target = new Zenith(0x29403F107781ea45Bf93710abf8df13F67f2008f);
+        target = new Zenith(block.number + 1, 0x29403F107781ea45Bf93710abf8df13F67f2008f);
     }
 
     function check_signature() public {

test/Passage.t.sol

@@ -14,12 +14,6 @@ contract PassageTest is Test {
     address recipient = address(0x123);
     uint256 amount = 200;
 
-    address to = address(0x01);
-    bytes data = abi.encodeWithSelector(ERC20.transfer.selector, recipient, amount);
-    uint256 value = 100;
-    uint256 gas = 10_000_000;
-    uint256 maxFeePerGas = 50;
-
     uint256 tokenAdminKey = 123;
 
     event Enter(uint256 indexed rollupChainId, address indexed rollupRecipient, uint256 amount);
@@ -28,16 +22,6 @@ contract PassageTest is Test {
         uint256 indexed rollupChainId, address indexed rollupRecipient, address indexed token, uint256 amount
     );
 
-    event Transact(
-        uint256 indexed rollupChainId,
-        address indexed sender,
-        address indexed to,
-        bytes data,
-        uint256 value,
-        uint256 gas,
-        uint256 maxFeePerGas
-    );
-
     event Withdrawal(address indexed token, address indexed recipient, uint256 amount);
 
     event EnterConfigured(address indexed token, bool indexed canEnter);
@@ -150,36 +134,6 @@ contract PassageTest is Test {
         target.enterToken(recipient, token, amount);
     }
 
-    function test_transact() public {
-        vm.expectEmit();
-        emit Transact(chainId, address(this), to, data, value, gas, maxFeePerGas);
-        target.transact(chainId, to, data, value, gas, maxFeePerGas);
-
-        vm.expectEmit();
-        emit Enter(chainId, address(this), amount);
-        target.transact{value: amount}(chainId, to, data, value, gas, maxFeePerGas);
-    }
-
-    function test_transact_defaultChain() public {
-        vm.expectEmit();
-        emit Transact(target.defaultRollupChainId(), address(this), to, data, value, gas, maxFeePerGas);
-        target.transact(to, data, value, gas, maxFeePerGas);
-
-        vm.expectEmit();
-        emit Enter(target.defaultRollupChainId(), address(this), amount);
-        target.transact{value: amount}(to, data, value, gas, maxFeePerGas);
-    }
-
-    function test_enterTransact() public {
-        vm.expectEmit();
-        emit Transact(chainId, address(this), to, data, value, gas, maxFeePerGas);
-        target.enterTransact(chainId, recipient, to, data, value, gas, maxFeePerGas);
-
-        vm.expectEmit();
-        emit Enter(chainId, recipient, amount);
-        target.enterTransact{value: amount}(chainId, recipient, to, data, value, gas, maxFeePerGas);
-    }
-
     function test_withdraw() public {
         TestERC20(token).mint(address(target), amount);
 

test/Zenith.t.sol

@@ -15,6 +15,13 @@ contract ZenithTest is Test {
     uint256 sequencerKey = 123;
     uint256 notSequencerKey = 300;
 
+    uint256 chainId = 3;
+    address to = address(0x01);
+    bytes data = abi.encode(0xbeef);
+    uint256 value = 100;
+    uint256 gas = 10_000_000;
+    uint256 maxFeePerGas = 50;
+
     event BlockSubmitted(
         address indexed sequencer,
         uint256 indexed rollupChainId,
@@ -25,8 +32,18 @@ contract ZenithTest is Test {
 
     event SequencerSet(address indexed sequencer, bool indexed permissioned);
 
+    event Transact(
+        uint256 indexed rollupChainId,
+        address indexed sender,
+        address indexed to,
+        bytes data,
+        uint256 value,
+        uint256 gas,
+        uint256 maxFeePerGas
+    );
+
     function setUp() public {
-        target = new Zenith(address(this));
+        target = new Zenith(block.number + 1, address(this));
         target.addSequencer(vm.addr(sequencerKey));
 
         // set default block values
@@ -159,4 +176,16 @@ contract ZenithTest is Test {
         vm.expectRevert(Zenith.OnlySequencerAdmin.selector);
         target.removeSequencer(address(0x02));
     }
+
+    function test_transact() public {
+        vm.expectEmit();
+        emit Transact(chainId, address(this), to, data, value, gas, maxFeePerGas);
+        target.transact(chainId, to, data, value, gas, maxFeePerGas);
+    }
+
+    function test_transact_defaultChain() public {
+        vm.expectEmit();
+        emit Transact(target.defaultRollupChainId(), address(this), to, data, value, gas, maxFeePerGas);
+        target.transact(to, data, value, gas, maxFeePerGas);
+    }
 }