Merge pull request #109 from OffchainLabs/4844-only

feat: 4844 implementation

Author: gzeoneth

.github/workflows/contract-tests.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Install packages
         run: yarn
 
-      - name: Run unit tests
+      - name: Build
         run: forge test
   tests:
     name: Contract tests
@@ -44,6 +44,13 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
 
       - name: Setup nodejs
         uses: actions/setup-node@v2
@@ -67,7 +74,7 @@ jobs:
         run: yarn lint:test
 
       - name: Build
-        run: yarn build
+        run: yarn build:all
 
       - name: Run tests
         run: yarn hardhat --network hardhat test test/contract/*.spec.ts
@@ -91,3 +98,37 @@ jobs:
           files: ./contracts/coverage.json
           verbose: false
           token: ${{ secrets.CODECOV_TOKEN }}
+  test-4844:
+    name: 4844 tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - uses: OffchainLabs/actions/run-nitro-test-node@test-node-args
+        with:
+          nitro-testnode-ref: deneb-integration
+          args: --pos
+          no-token-bridge: true
+
+      - name: Setup nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: yarn build:all
+
+      - name: Test 4844
+        run: yarn test:4844

.prettierrc.js

@@ -14,7 +14,7 @@ module.exports = {
         printWidth: 100,
         singleQuote: false,
         bracketSpacing: false,
-        compiler: '0.8.6',
+        compiler: '0.8.9',
       },
     },
   ],

deploy/SequencerInbox.js

@@ -3,6 +3,9 @@ module.exports = async hre => {
   const { deploy } = deployments
   const { deployer } = await getNamedAccounts()
 
+  const blobBasefeeReader = await ethers.getContract('BlobBasefeeReader')
+  const dataHashReader = await ethers.getContract('DataHashReader')
+
   await deploy('SequencerInbox', { from: deployer, args: [117964] })
 }
 

deploy/SequencerInboxStubCreator.js

@@ -1,9 +1,14 @@
+import { Toolkit4844 } from '../test/contract/toolkit4844'
+
 module.exports = async hre => {
-  const { deployments, getNamedAccounts, ethers } = hre
+  const { deployments, getSigners, getNamedAccounts, ethers } = hre
   const { deploy } = deployments
   const { deployer } = await getNamedAccounts()
 
   const bridge = await ethers.getContract('BridgeStub')
+  const reader4844 = await Toolkit4844.deployReader4844(
+    await ethers.getSigner(deployer)
+  )
   const maxTime = {
     delayBlocks: 10000,
     futureBlocks: 10000,
@@ -12,7 +17,7 @@ module.exports = async hre => {
   }
   await deploy('SequencerInboxStub', {
     from: deployer,
-    args: [bridge.address, deployer, maxTime, 117964],
+    args: [bridge.address, deployer, maxTime, 117964, reader4844.address],
   })
 }
 

foundry.toml

@@ -1,14 +1,20 @@
 [profile.default]
-src = 'src'
+src = 'src/'
 out = 'out'
 libs = ['node_modules', 'lib']
 test = 'test/foundry'
-cache_path  = 'forge-cache'
+cache_path  = 'forge-cache/sol'
 optimizer = true
 optimizer_runs = 20000
 via_ir = false
 solc_version = '0.8.9'
 
+[profile.yul]
+src = 'yul'
+out = 'out/yul'
+libs = ['node_modules', 'lib']
+cache_path  = 'forge-cache/yul'
+
 [fmt]
 number_underscore = 'thousands'
 line_length = 100

hardhat.config.ts

@@ -6,6 +6,7 @@ import '@typechain/hardhat'
 import 'solidity-coverage'
 import 'hardhat-gas-reporter'
 import 'hardhat-ignore-warnings'
+// import '@tovarishfin/hardhat-yul';
 import dotenv from 'dotenv'
 
 dotenv.config()

package.json

@@ -18,13 +18,19 @@
   },
   "scripts": {
     "prepublishOnly": "hardhat clean && hardhat compile",
+    "build:all": "yarn build && yarn build:forge",
     "build": "hardhat compile",
+    "build:forge:sol": "forge build --skip *.yul",
+    "build:forge:yul": "FOUNDRY_PROFILE=yul forge build --skip *.sol",
+    "build:forge": "yarn build:forge:sol && yarn build:forge:yul",
     "lint:test": "eslint ./test",
     "solhint": "solhint -f table src/**/*.sol",
     "prettier:solidity": "prettier --write src/**/*.sol",
     "format": "prettier './**/*.{js,json,md,ts,yml,sol}' --write && yarn run lint:test --fix",
     "build:0.6": "INTERFACE_TESTER_SOLC_VERSION=0.6.9 yarn run build",
     "build:0.7": "INTERFACE_TESTER_SOLC_VERSION=0.7.0 yarn run build",
+    "test": "DISABLE_GAS_REPORTER=true hardhat --network hardhat test test/contract/*.spec.ts",
+    "test:4844": "DISABLE_GAS_REPORTER=true hardhat --network hardhat test test/contract/*.spec.4844.ts",
     "test:compatibility": "yarn run build:0.6 && yarn run build:0.7",
     "test:storage": "./test/storage/test.bash",
     "test:e2e": "hardhat test test/e2e/*.ts",
@@ -46,6 +52,7 @@
     "@nomiclabs/hardhat-ethers": "npm:hardhat-deploy-ethers@^0.3.0-beta.13",
     "@nomiclabs/hardhat-etherscan": "^3.1.0",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
+    "@tovarishfin/hardhat-yul": "^3.0.5",
     "@typechain/ethers-v5": "^10.0.0",
     "@typechain/hardhat": "^6.0.0",
     "@types/chai": "^4.3.0",

scripts/rollupCreation.ts

@@ -85,15 +85,11 @@ export async function createRollup(feeToken?: string) {
       maxDataSize: maxDataSize,
       nativeToken: feeToken,
       deployFactoriesToL2: true,
-      maxFeePerGasForRetryables: MAX_FER_PER_GAS
+      maxFeePerGasForRetryables: MAX_FER_PER_GAS,
     }
-    const createRollupTx = await rollupCreator.createRollup(
-      deployParams,
-      {
-        value: feeCost,
-      }
-      
-    )
+    const createRollupTx = await rollupCreator.createRollup(deployParams, {
+      value: feeCost,
+    })
     const createRollupReceipt = await createRollupTx.wait()
 
     const rollupCreatedEvent = createRollupReceipt.events?.find(

src/bridge/IBridge.sol

@@ -8,6 +8,28 @@ pragma solidity >=0.6.9 <0.9.0;
 import "./IOwnable.sol";
 
 interface IBridge {
+    /// @dev This is an instruction to offchain readers to inform them where to look
+    ///      for sequencer inbox batch data. This is not the type of data (eg. das, brotli encoded, or blob versioned hash)
+    ///      and this enum is not used in the state transition function, rather it informs an offchain
+    ///      reader where to find the data so that they can supply it to the replay binary
+    enum BatchDataLocation {
+        /// @notice The data can be found in the transaction call data
+        TxInput,
+        /// @notice The data can be found in an event emitted during the transaction
+        SeparateBatchEvent,
+        /// @notice This batch contains no data
+        NoData,
+        /// @notice The data can be found in the 4844 data blobs on this transaction
+        Blob
+    }
+
+    struct TimeBounds {
+        uint64 minTimestamp;
+        uint64 maxTimestamp;
+        uint64 minBlockNumber;
+        uint64 maxBlockNumber;
+    }
+
     event MessageDelivered(
         uint256 indexed messageIndex,
         bytes32 indexed beforeInboxAcc,

src/bridge/ISequencerInbox.sol

@@ -12,23 +12,10 @@ import "./IBridge.sol";
 
 interface ISequencerInbox is IDelayedMessageProvider {
     struct MaxTimeVariation {
-        uint256 delayBlocks;
-        uint256 futureBlocks;
-        uint256 delaySeconds;
-        uint256 futureSeconds;
-    }
-
-    struct TimeBounds {
-        uint64 minTimestamp;
-        uint64 maxTimestamp;
-        uint64 minBlockNumber;
-        uint64 maxBlockNumber;
-    }
-
-    enum BatchDataLocation {
-        TxInput,
-        SeparateBatchEvent,
-        NoData
+        uint64 delayBlocks;
+        uint64 futureBlocks;
+        uint64 delaySeconds;
+        uint64 futureSeconds;
     }
 
     event SequencerBatchDelivered(
@@ -37,8 +24,8 @@ interface ISequencerInbox is IDelayedMessageProvider {
         bytes32 indexed afterAcc,
         bytes32 delayedAcc,
         uint256 afterDelayedMessagesRead,
-        TimeBounds timeBounds,
-        BatchDataLocation dataLocation
+        IBridge.TimeBounds timeBounds,
+        IBridge.BatchDataLocation dataLocation
     );
 
     event OwnerFunctionCalled(uint256 indexed id);
@@ -61,10 +48,41 @@ interface ISequencerInbox is IDelayedMessageProvider {
     function HEADER_LENGTH() external view returns (uint256);
 
     /// @dev If the first batch data byte after the header has this bit set,
-    ///      the sequencer inbox has authenticated the data. Currently not used.
+    ///      the sequencer inbox has authenticated the data. Currently only used for 4844 blob support.
+    ///      See: https://github.com/OffchainLabs/nitro/blob/69de0603abf6f900a4128cab7933df60cad54ded/arbstate/das_reader.go
     // solhint-disable-next-line func-name-mixedcase
     function DATA_AUTHENTICATED_FLAG() external view returns (bytes1);
 
+    /// @dev If the first data byte after the header has this bit set,
+    ///      then the batch data is to be found in 4844 data blobs
+    ///      See: https://github.com/OffchainLabs/nitro/blob/69de0603abf6f900a4128cab7933df60cad54ded/arbstate/das_reader.go
+    // solhint-disable-next-line func-name-mixedcase
+    function DATA_BLOB_HEADER_FLAG() external view returns (bytes1);
+
+    /// @dev If the first data byte after the header has this bit set,
+    ///      then the batch data is a das message
+    ///      See: https://github.com/OffchainLabs/nitro/blob/69de0603abf6f900a4128cab7933df60cad54ded/arbstate/das_reader.go
+    // solhint-disable-next-line func-name-mixedcase
+    function DAS_MESSAGE_HEADER_FLAG() external view returns (bytes1);
+
+    /// @dev If the first data byte after the header has this bit set,
+    ///      then the batch data is a das message that employs a merklesization strategy
+    ///      See: https://github.com/OffchainLabs/nitro/blob/69de0603abf6f900a4128cab7933df60cad54ded/arbstate/das_reader.go
+    // solhint-disable-next-line func-name-mixedcase
+    function TREE_DAS_MESSAGE_HEADER_FLAG() external view returns (bytes1);
+
+    /// @dev If the first data byte after the header has this bit set,
+    ///      then the batch data has been brotli compressed
+    ///      See: https://github.com/OffchainLabs/nitro/blob/69de0603abf6f900a4128cab7933df60cad54ded/arbstate/das_reader.go
+    // solhint-disable-next-line func-name-mixedcase
+    function BROTLI_MESSAGE_HEADER_FLAG() external view returns (bytes1);
+
+    /// @dev If the first data byte after the header has this bit set,
+    ///      then the batch data uses a zero heavy encoding
+    ///      See: https://github.com/OffchainLabs/nitro/blob/69de0603abf6f900a4128cab7933df60cad54ded/arbstate/das_reader.go
+    // solhint-disable-next-line func-name-mixedcase
+    function ZERO_HEAVY_MESSAGE_HEADER_FLAG() external view returns (bytes1);
+
     function rollup() external view returns (IOwnable);
 
     function isBatchPoster(address) external view returns (bool);
@@ -78,14 +96,15 @@ interface ISequencerInbox is IDelayedMessageProvider {
         uint64 creationBlock;
     }
 
+    /// @dev returns 4 uint256 to be compatible with older version
     function maxTimeVariation()
         external
         view
         returns (
-            uint256,
-            uint256,
-            uint256,
-            uint256
+            uint256 delayBlocks,
+            uint256 futureBlocks,
+            uint256 delaySeconds,
+            uint256 futureSeconds
         );
 
     function dasKeySetInfo(bytes32) external view returns (bool, uint64);
@@ -130,6 +149,15 @@ interface ISequencerInbox is IDelayedMessageProvider {
         IGasRefunder gasRefunder
     ) external;
 
+    function addSequencerL2BatchFromOrigin(
+        uint256 sequenceNumber,
+        bytes calldata data,
+        uint256 afterDelayedMessagesRead,
+        IGasRefunder gasRefunder,
+        uint256 prevMessageCount,
+        uint256 newMessageCount
+    ) external;
+
     function addSequencerL2Batch(
         uint256 sequenceNumber,
         bytes calldata data,
@@ -139,6 +167,14 @@ interface ISequencerInbox is IDelayedMessageProvider {
         uint256 newMessageCount
     ) external;
 
+    function addSequencerL2BatchFromBlobs(
+        uint256 sequenceNumber,
+        uint256 afterDelayedMessagesRead,
+        IGasRefunder gasRefunder,
+        uint256 prevMessageCount,
+        uint256 newMessageCount
+    ) external;
+
     // ---------- onlyRollupOrOwner functions ----------
 
     /**