protocol

Taiko Protocol

This repository contains the Taiko Based Contestable Rollup (BCR) protocol and supporting tools. The project is managed using pnpm and foundry.

Prerequisites

Before compiling the smart contracts, ensure the following are installed and up to date:

• Foundry
• pnpm

To install dependencies:

foundryup && pnpm install

Compilation and Testing

Taiko’s protocol is split between Layer 1 (L1) and Layer 2 (L2). The smart contracts need to be compiled and tested separately for each layer:

Layer 1 (Ethereum, Duncan Hardfork)

To compile, run tests, and generate the storage layout for L1:

pnpm compile:l1
pnpm test:l1
pnpm layout:l1

Layer 2 (Taiko, Shanghai Hardfork)

Similarly, for L2:

pnpm compile:l2
pnpm test:l2
pnpm layout:l2

Compile and Test for Both Layers

To compile and test contracts for both L1 and L2 at once:

pnpm compile
pnpm test
pnpm layout

Layer 2 Genesis Block

Generating a Dummy Genesis Block

To generate dummy data for the L2 genesis block, create a configuration file at ./test/genesis/data/genesis_config.js with the following content:

module.exports = {
  contractOwner: "0xDf08F82De32B8d460adbE8D72043E3a7e25A3B39",
  chainId: 167,
  seedAccounts: [
    { "0xDf08F82De32B8d460adbE8D72043E3a7e25A3B39": 1024 },
    { "0x79fcdef22feed20eddacbb2587640e45491b757f": 1024 },
  ],
  l1ChainId: 31337,
  ownerSecurityCouncil: "0xDf08F82De32B8d460adbE8D72043E3a7e25A3B39",
  ownerTimelockController: "0xDf08F82De32B8d460adbE8D72043E3a7e25A3B39",
  param1559: {
    gasExcess: 1,
  },
  predeployERC20: true,
};

Then compile the L2 contracts and generate the genesis block:

pnpm compile:l2
pnpm genesis:gen

This generates the following JSON files in ./test/genesis/data/:

• l2_genesis_alloc.json: Contains the alloc field for the L2 genesis block. Use this in a geth or taiko-geth genesis block following this guide.
• l2_genesis_storage_layout.json: Displays the storage layout of the pre-deployed contracts.

To validate the genesis data:

pnpm genesis:test

This runs tests using Docker and taiko-geth to simulate the L2 genesis block deployment, and generates a genesis.json file in ./test/genesis/data/.

Generating an Actual Genesis Block

To generate the actual L2 genesis block, create a genesis.json file based on l2_genesis_alloc.json, following this guide.

Next, initialize taiko-geth with the generated genesis.json:

geth --datadir ~/taiko-l2-network/node init test/layer2/genesis/data/genesis.json
geth --datadir ~/taiko-l2-network/node --networkid 167 --http --http.addr 127.0.0.1 --http.port 8552 --http.corsdomain "*"

You can retrieve the genesis block hash by attaching to the geth instance:

geth attach ~/taiko-l2-network/node/geth.ipc

Then run:

eth.getBlock(0)

Copy the genesis block hash and replace the L2_GENESIS_HASH variable in deploy_protocol_on_l1.sh with this value.

Deploying Taiko BCR on Layer 1

To deploy Taiko BCR on L1, start a local L1 network:

anvil --hardfork cancun

Make sure you have sufficient ether for transactions, then deploy the contracts:

pnpm test:deploy:l1

This command runs the deployment script located at script/deploy_protocol_on_l1.sh, assuming L1 is accessible at http://localhost:8545.

Style Guide

Refer to CONTRIBUTING.md for code style guidelines.

Before committing code, format and lint it using:

pnpm fmt:sol