Merge pull request #108 from OffchainLabs/fee-token-reports

Do not send batch poster reports in fee token based chains

Author: gzeoneth

deploy/SequencerInboxStubCreator.js

@@ -17,7 +17,14 @@ module.exports = async hre => {
   }
   await deploy('SequencerInboxStub', {
     from: deployer,
-    args: [bridge.address, deployer, maxTime, 117964, reader4844.address],
+    args: [
+      bridge.address,
+      deployer,
+      maxTime,
+      117964,
+      reader4844.address,
+      false,
+    ],
   })
 }
 

scripts/deployment.ts

@@ -81,6 +81,7 @@ async function deployAllContracts(
   const ethBridge = await deployContract('Bridge', signer, [])
   const ethSequencerInbox = await deployContract('SequencerInbox', signer, [
     maxDataSize,
+    false,
   ])
   const ethInbox = await deployContract('Inbox', signer, [maxDataSize])
   const ethRollupEventInbox = await deployContract(
@@ -91,7 +92,10 @@ async function deployAllContracts(
   const ethOutbox = await deployContract('Outbox', signer, [])
 
   const erc20Bridge = await deployContract('ERC20Bridge', signer, [])
-  const erc20SequencerInbox = ethSequencerInbox
+  const erc20SequencerInbox = await deployContract('SequencerInbox', signer, [
+    maxDataSize,
+    true,
+  ])
   const erc20Inbox = await deployContract('ERC20Inbox', signer, [maxDataSize])
   const erc20RollupEventInbox = await deployContract(
     'ERC20RollupEventInbox',

src/bridge/SequencerInbox.sol

@@ -22,6 +22,7 @@ import {
     AlreadyValidDASKeyset,
     NoSuchKeyset,
     NotForked,
+    RollupNotChanged,
     DataBlobsNotSupported,
     InitParamZero,
     MissingDataHashes,
@@ -30,6 +31,7 @@ import {
     RollupNotChanged,
     EmptyBatchData,
     InvalidHeaderFlag,
+    NativeTokenMismatch,
     Deprecated
 } from "../libraries/Error.sol";
 import "./IBridge.sol";
@@ -46,6 +48,7 @@ import "../libraries/DelegateCallAware.sol";
 import {IGasRefunder} from "../libraries/IGasRefunder.sol";
 import {GasRefundEnabled} from "../libraries/GasRefundEnabled.sol";
 import "../libraries/ArbitrumChecker.sol";
+import {IERC20Bridge} from "./IERC20Bridge.sol";
 
 /**
  * @title Accepts batches from the sequencer and adds them to the rollup inbox.
@@ -110,15 +113,22 @@ contract SequencerInbox is DelegateCallAware, GasRefundEnabled, ISequencerInbox
     uint256 internal immutable deployTimeChainId = block.chainid;
     // If the chain this SequencerInbox is deployed on is an Arbitrum chain.
     bool internal immutable hostChainIsArbitrum = ArbitrumChecker.runningOnArbitrum();
-
-    constructor(uint256 _maxDataSize, IReader4844 reader4844_) {
+    // True if the chain this SequencerInbox is deployed on uses custom fee token
+    bool public immutable isUsingFeeToken;
+
+    constructor(
+        uint256 _maxDataSize,
+        IReader4844 reader4844_,
+        bool _isUsingFeeToken
+    ) {
         maxDataSize = _maxDataSize;
         if (hostChainIsArbitrum) {
             if (reader4844_ != IReader4844(address(0))) revert DataBlobsNotSupported();
         } else {
             if (reader4844_ == IReader4844(address(0))) revert InitParamZero("Reader4844");
         }
         reader4844 = reader4844_;
+        isUsingFeeToken = _isUsingFeeToken;
     }
 
     function _chainIdChanged() internal view returns (bool) {
@@ -163,6 +173,19 @@ contract SequencerInbox is DelegateCallAware, GasRefundEnabled, ISequencerInbox
     ) external onlyDelegated {
         if (bridge != IBridge(address(0))) revert AlreadyInit();
         if (bridge_ == IBridge(address(0))) revert HadZeroInit();
+
+        // Make sure logic contract was created by proper value for 'isUsingFeeToken'.
+        // Bridge in ETH based chains doesn't implement nativeToken(). In future it might implement it and return address(0)
+        bool actualIsUsingFeeToken = false;
+        try IERC20Bridge(address(bridge_)).nativeToken() returns (address feeToken) {
+            if (feeToken != address(0)) {
+                actualIsUsingFeeToken = true;
+            }
+        } catch {}
+        if (isUsingFeeToken != actualIsUsingFeeToken) {
+            revert NativeTokenMismatch();
+        }
+
         bridge = bridge_;
         rollup = bridge_.rollup();
         delayBlocks = maxTimeVariation_.delayBlocks;
@@ -432,7 +455,7 @@ contract SequencerInbox is DelegateCallAware, GasRefundEnabled, ISequencerInbox
         // same as using calldata, we only submit spending report if the caller is the origin of the tx
         // such that one cannot "double-claim" batch posting refund in the same tx
         // solhint-disable-next-line avoid-tx-origin
-        if (msg.sender == tx.origin) {
+        if (msg.sender == tx.origin && !isUsingFeeToken) {
             submitBatchSpendingReport(dataHash, seqMessageIndex, block.basefee, blobGas);
         }
     }
@@ -670,7 +693,8 @@ contract SequencerInbox is DelegateCallAware, GasRefundEnabled, ISequencerInbox
 
         totalDelayedMessagesRead = afterDelayedMessagesRead;
 
-        if (calldataLengthPosted > 0) {
+        if (calldataLengthPosted > 0 && !isUsingFeeToken) {
+            // only report batch poster spendings if chain is using ETH as native currency
             submitBatchSpendingReport(dataHash, seqMessageIndex, block.basefee, 0);
         }
     }

src/libraries/Error.sol

@@ -197,5 +197,8 @@ error EmptyBatchData();
 /// @dev Unsupported header flag was provided
 error InvalidHeaderFlag(bytes1);
 
+/// @dev SequencerInbox and Bridge are not in the same feeToken/ETH mode
+error NativeTokenMismatch();
+
 /// @dev Thrown when a deprecated function is called
 error Deprecated();

src/mocks/SequencerInboxStub.sol

@@ -14,8 +14,9 @@ contract SequencerInboxStub is SequencerInbox {
         address sequencer_,
         ISequencerInbox.MaxTimeVariation memory maxTimeVariation_,
         uint256 maxDataSize_,
-        IReader4844 reader4844_
-    ) SequencerInbox(maxDataSize_, reader4844_) {
+        IReader4844 reader4844_,
+        bool isUsingFeeToken_
+    ) SequencerInbox(maxDataSize_, reader4844_, isUsingFeeToken_) {
         bridge = bridge_;
         rollup = IOwnable(msg.sender);
         delayBlocks = maxTimeVariation_.delayBlocks;

test/contract/arbRollup.spec.ts

@@ -191,7 +191,8 @@ const setup = async () => {
   )) as SequencerInbox__factory
   const ethSequencerInbox = await ethSequencerInboxFac.deploy(
     117964,
-    dummy4844Reader
+    dummy4844Reader,
+    false
   )
 
   const ethInboxFac = (await ethers.getContractFactory(
@@ -214,7 +215,14 @@ const setup = async () => {
   )) as ERC20Bridge__factory
   const erc20Bridge = await erc20BridgeFac.deploy()
 
-  const erc20SequencerInbox = ethSequencerInbox
+  const erc20SequencerInboxFac = (await ethers.getContractFactory(
+    'SequencerInbox'
+  )) as SequencerInbox__factory
+  const erc20SequencerInbox = await erc20SequencerInboxFac.deploy(
+    117964,
+    dummy4844Reader,
+    true
+  )
 
   const erc20InboxFac = (await ethers.getContractFactory(
     'ERC20Inbox'

test/contract/sequencerInboxForceInclude.spec.ts

@@ -237,7 +237,8 @@ describe('SequencerInboxForceInclude', async () => {
     )) as SequencerInbox__factory
     const seqInboxTemplate = await sequencerInboxFac.deploy(
       117964,
-      reader4844.address
+      reader4844.address,
+      false
     )
     const inboxFac = (await ethers.getContractFactory(
       'Inbox'

test/foundry/BridgeCreator.t.sol

@@ -20,7 +20,8 @@ contract BridgeCreatorTest is Test {
             bridge: new Bridge(),
             sequencerInbox: new SequencerInbox(
                 MAX_DATA_SIZE,
-                dummyReader4844
+                dummyReader4844,
+                false
             ),
             inbox: new Inbox(MAX_DATA_SIZE),
             rollupEventInbox: new RollupEventInbox(),
@@ -29,7 +30,11 @@ contract BridgeCreatorTest is Test {
     BridgeCreator.BridgeContracts erc20BasedTemplates =
         BridgeCreator.BridgeContracts({
             bridge: new ERC20Bridge(),
-            sequencerInbox: ethBasedTemplates.sequencerInbox,
+            sequencerInbox: new SequencerInbox(
+                MAX_DATA_SIZE,
+                dummyReader4844,
+                true
+            ),
             inbox: new ERC20Inbox(MAX_DATA_SIZE),
             rollupEventInbox: new ERC20RollupEventInbox(),
             outbox: new ERC20Outbox()
@@ -40,7 +45,7 @@ contract BridgeCreatorTest is Test {
         creator = new BridgeCreator(ethBasedTemplates, erc20BasedTemplates);
     }
 
-    function getEthBasedTemplates() internal returns (BridgeCreator.BridgeContracts memory) {
+    function getEthBasedTemplates() internal view returns (BridgeCreator.BridgeContracts memory) {
         BridgeCreator.BridgeContracts memory templates;
         (
             templates.bridge,
@@ -52,7 +57,7 @@ contract BridgeCreatorTest is Test {
         return templates;
     }
 
-    function getErc20BasedTemplates() internal returns (BridgeCreator.BridgeContracts memory) {
+    function getErc20BasedTemplates() internal view returns (BridgeCreator.BridgeContracts memory) {
         BridgeCreator.BridgeContracts memory templates;
         (
             templates.bridge,

test/foundry/RollupCreator.t.sol

@@ -37,15 +37,20 @@ contract RollupCreatorTest is Test {
         bridge: new Bridge(),
         sequencerInbox: new SequencerInbox(
             MAX_DATA_SIZE,
-            dummyReader4844
+            dummyReader4844,
+            false
         ),
         inbox: new Inbox(MAX_DATA_SIZE),
         rollupEventInbox: new RollupEventInbox(),
         outbox: new Outbox()
     });
     BridgeCreator.BridgeContracts public erc20BasedTemplates = BridgeCreator.BridgeContracts({
         bridge: new ERC20Bridge(),
-        sequencerInbox: ethBasedTemplates.sequencerInbox,
+        sequencerInbox: new SequencerInbox(
+            MAX_DATA_SIZE,
+            dummyReader4844,
+            true
+        ),
         inbox: new ERC20Inbox(MAX_DATA_SIZE),
         rollupEventInbox: new ERC20RollupEventInbox(),
         outbox: new ERC20Outbox()