How to Use the OP Stack with Avail
Introduction
Embark on setting up your own Avail-Optimism chain. This guide targets Ethereum's Sepolia testnet and Avail Turing testnet. For a detailed understanding, review the Optimism Documentation (opens in a new tab).
Prerequisites
Ensure you have installed the following software.
Installation commands are based on Ubuntu 20.04 LTS:
|
|
Compile the Core Codebase
Setting up the EVM Rollup requires compiling code from two critical repositories: the optimism-Alt-DA-Avail monorepo (opens in a new tab) and the op-geth repository (opens in a new tab).
Build the Adapter Source
-
Clone and navigate to the Avail adapter:
git clone https://github.com/availproject/optimism-Alt-DA-Avail.git cd optimism-Alt-DA-Avail git submodule update --init --recursive
-
Install modules:
pnpm install
-
Compile the necessary packages:
make op-node op-batcher op-proposer pnpm build
Build the Optimism Geth Source
-
Clone and navigate to
op-geth
:git clone https://github.com/ethereum-optimism/op-geth.git cd op-geth
-
Compile
op-geth
:make geth
Get Access to a Sepolia Node
For deploying to Sepolia, access an L1 node using a provider like Alchemy (opens in a new tab) or run your own Sepolia node (opens in a new tab).
Generate and Secure Keys
Create four essential accounts with private keys:
Admin
(contract upgrade authority)Batcher
(publishes Sequencer data to L1)Proposer
(publishes L2 results to L1)Sequencer
(signs blocks on the p2p network)
You can use cast wallet
in the contracts-bedrock
package for key generation:
-
In the Avail adapter repo, navigate to the contracts-bedrock package (opens in a new tab):
cd ~/optimism-Alt-DA-Avail/packages/contracts-bedrock
-
Generate accounts:
echo "Admin:" cast wallet new echo "Proposer:" cast wallet new echo "Batcher:" cast wallet new echo "Sequencer:" cast wallet new
You should see an output similar to:
Admin: Successfully created new keypair. Address: 0xc4A01194958DE0D90A876e8A5fc9D7B530072148 Private key: 0xb8e39bd94a210e410c4024e1cc91014de45a5eb1e42f3aa99a368b5a5ac19b45 Proposer: Successfully created new keypair. Address: 0xFC0374Ae658e46cA4022acA179d3cb6D8e1A4934 Private key: 0xa9bc1b3f5deb1e00251df68bf86e3493b25bc5430665433546f2f9aacc748d1a Batcher: Successfully created new keypair. Address: 0xD6857B5BE9468Be67d64ABaB48459378d5329b96 Private key: 0xe9cd8960fc7984a301d567b819e0c62871eb2c7239c2e66b8f319eaa45c3cbd5 Sequencer: Successfully created new keypair. Address: 0x33348817E4B1192D576C4f157e9a5EC93dc5392D Private key: 0xd98b49e11e4e0be9931017831395e6644a50c36285d08e14d1a479af5ee08675
Record and securely store these key details. You'll need to fund
Admin
,Proposer
, andBatcher
with Sepolia ETH (0.5 ETH forAdmin
, 0.2 ETH forProposer
, 0.1 ETH forBatcher
).
NOTE FOR PRODUCTION
Use secure hardware for key management in production environments.
cast wallet
is not designed for production deployments.
Network Configuration and Setup
After building the repositories, configure your chain settings in the contracts-bedrock package (opens in a new tab).
-
Ensure you are in the
contracts-bedrock
sub-directory:cd ~/optimism-Alt-DA-Avail/packages/contracts-bedrock
-
Activate the environment with
direnv
:If you need to install
direnv
, ensure you also modify the shell configuration (opens in a new tab).direnv allow .
Core Contract Deployment
Deploy essential L1 contracts for the chainโs functionality:
- Update
/optimism-Alt-DA-Avail/packages/contracts-bedrock/deploy-config
and update filedevnetL1-template.json
by referencing the following configs ( addresses will vary for each user, the following is a demo-config deployed for sepolia L1):
{
"finalSystemOwner": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"superchainConfigGuardian": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"l1StartingBlockTag": "0x48f520cf4ddaf34c8336e6e490632ea3cf1e5e93b0b2bc6e917557e31845371b",
"l1ChainID": 11155111,
"l2ChainID": 11155420,
"l2BlockTime": 2,
"l1BlockTime": 12,
"maxSequencerDrift": 600,
"sequencerWindowSize": 3600,
"channelTimeout": 300,
"p2pSequencerAddress": "0x57CACBB0d30b01eb2462e5dC940c161aff3230D3",
"batchInboxAddress": "0xff00000000000000000000000000000011155420",
"batchSenderAddress": "0x8F23BB38F531600e5d8FDDaAEC41F13FaB46E98c",
"l2OutputOracleSubmissionInterval": 120,
"l2OutputOracleStartingBlockNumber": 0,
"l2OutputOracleStartingTimestamp": 1690493568,
"l2OutputOracleProposer": "0x49277EE36A024120Ee218127354c4a3591dc90A9",
"l2OutputOracleChallenger": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"finalizationPeriodSeconds": 12,
"proxyAdminOwner": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"baseFeeVaultRecipient": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"l1FeeVaultRecipient": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"sequencerFeeVaultRecipient": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"baseFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
"l1FeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
"sequencerFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
"baseFeeVaultWithdrawalNetwork": 0,
"l1FeeVaultWithdrawalNetwork": 0,
"sequencerFeeVaultWithdrawalNetwork": 0,
"enableGovernance": true,
"governanceTokenSymbol": "OP",
"governanceTokenName": "Optimism",
"governanceTokenOwner": "0xfd1D2e729aE8eEe2E146c033bf4400fE75284301",
"l2GenesisBlockGasLimit": "0x1c9c380",
"l2GenesisBlockBaseFeePerGas": "0x3b9aca00",
"eip1559Denominator": 50,
"eip1559Elasticity": 6,
"l2GenesisRegolithTimeOffset": "0x0",
"systemConfigStartBlock": 0,
"requiredProtocolVersion": "0x0000000000000000000000000000000000000004000000000000000000000001",
"recommendedProtocolVersion": "0x0000000000000000000000000000000000000004000000000000000000000001",
"fundDevAccounts": true,
"faultGameAbsolutePrestate": "0x03e69d3de5155f4a80da99dd534561cbddd4f9dd56c9ecc704d6886625711d2b",
"faultGameMaxDepth": 73,
"faultGameClockExtension": 10800,
"faultGameMaxClockDuration": 302400,
"faultGameGenesisBlock": 9496192,
"faultGameGenesisOutputRoot": "0x63b1cda487c072b020a57c1203f7c2921754005cadbd54bed7f558111b8278d8",
"faultGameSplitDepth": 30,
"faultGameWithdrawalDelay": 604800,
"preimageOracleMinProposalSize": 126000,
"preimageOracleChallengePeriod": 86400,
"proofMaturityDelaySeconds": 604800,
"disputeGameFinalityDelaySeconds": 302400,
"respectedGameType": 0,
"useFaultProofs": true,
"usePlasma": true,
"daCommitmentType": "GenericCommitment",
"daChallengeWindow": 160,
"daResolveWindow": 160,
"daBondSize": 1000000,
"daResolverRefundPercentage": 0,
"cliqueSignerAddress": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
"l1UseClique": true,
"gasPriceOracleOverhead": 2100,
"gasPriceOracleScalar": 1000000,
"gasPriceOracleBaseFeeScalar": 1368,
"gasPriceOracleBlobBaseFeeScalar": 810949,
"eip1559DenominatorCanyon": 250,
"l1GenesisBlockTimestamp": "0x64c811bf",
"l2GenesisDeltaTimeOffset": null,
"l2GenesisCanyonTimeOffset": "0x0"
}
- Navigate to
/optimism-Alt-DA-Avail/packages/contracts-bedrock/deployments
, and createavail-optimism
directory:
cd ~/optimism-Alt-DA-Avail/packages/contracts-bedrock/deployments
mkdir avail-optimism
- Navigate to
/optimism-Alt-DA-Avail/packages/contracts-bedrock/
and the deploy contracts (this can take up to 15 minutes):DEPLOYMENT_OUTFILE=deployments/artifact.json \ DEPLOY_CONFIG_PATH=deploy-config/devnetL1-template.json \ forge script scripts/Deploy.s.sol:Deploy --broadcast --private-key $GS_ADMIN_PRIVATE_KEY \ --rpc-url $L1_RPC_URL
- L2 Allocs
CONTRACT_ADDRESSES_PATH=deployments/artifact.json DEPLOY_CONFIG_PATH=deploy-config/devnetL1-template.json STATE_DUMP_PATH=deploy-config/statedump.json forge script scripts/L2Genesis.s.sol:L2Genesis --sig 'runWithStateDump()' --chain <YOUR_L2_CHAINID>
If you see a nondescript error that includes EvmError: Revert
and Script failed then you likely need to change the IMPL_SALT
environment variable. This variable determines the addresses of various smart contracts that are deployed via CREATE2
.
If the same IMPL_SALT
is used to deploy the same
contracts twice, the second deployment will fail.
You can generate a new
IMPL_SALT
by runningdirenv reload
anywhere in the Avail Optimism Monorepo.
Setting Up L2 Configuration
After configuring the L1 layer, focus shifts to establishing the L2 infrastructure. This involves generating three key files:
genesis.json
for the genesis blockrollup.json
for rollup configurationsjwt.txt
for secure communication betweenop-node
andop-geth
-
Navigate to the
op-node
directory:cd ~/optimism-Alt-DA-Avail/op-node
-
Run the following command, ensuring you replace
<RPC>
with your specific L1 RPC URL. This generates thegenesis.json
androllup.json
files:go run cmd/main.go genesis l2 \ --deploy-config ../packages/contracts-bedrock/deploy-config/devnetL1-template.json \ --l1-deployments ../packages/contracts-bedrock/deployments/artifact.json \ --outfile.l2 genesis.json \ --outfile.rollup rollup.json \ --l1-rpc $L1_RPC_URL \ --l2-allocs ../packages/contracts-bedrock/deploy-config/statedump.json
You'll find the newly created
genesis.json
androllup.json
in theop-node
package. -
Generate a
jwt.txt
file, which is crucial for the secure interaction between nodes:openssl rand -hex 32 > jwt.txt
-
To get
op-geth
ready, move thegenesis.json
andjwt.txt
files into its directory:cp genesis.json ~/op-geth cp jwt.txt ~/op-geth
These steps ensure the L2 layer is correctly configured and ready for integration with the L1 components, paving the way for a fully functional EVM Rollup on the Avail-OP Stack.
Setup Avail DA-server
Prepare the avail-da server.
- Navigate to
cd op-plasma
-
Build Avail DA Server:
make avail-da-server
-
Run you DA sidecar:
go run ./cmd/avail --addr=localhost --port=8000 --avail.rpc=<WS url to an avail node> --avail.seed=<> --avail.appid=<>
Initialize and Configure Geth
Prepare op-geth
for running the chain:
-
Navigate to
op-geth
:cd ~/op-geth
-
Create a data directory:
mkdir datadir
-
Initialize with the genesis file:
build/bin/geth init --datadir=datadir genesis.json
Running op-geth
To initiate op-geth
, navigate to its directory and execute the following commands:
cd ~/op-geth
./build/bin/geth \
--datadir ./datadir \
--http \
--http.corsdomain="*" \
--http.vhosts="*" \
--http.addr=0.0.0.0 \
--http.port=9545 \
--http.api=web3,debug,eth,txpool,net,engine \
--ws \
--ws.addr=0.0.0.0 \
--ws.port=9546 \
--ws.origins="*" \
--ws.api=debug,eth,txpool,net,engine \
--syncmode=full \
--gcmode=archive \
--nodiscover \
--maxpeers=0 \
--networkid=42069 \
--authrpc.vhosts="*" \
--authrpc.addr=0.0.0.0 \
--authrpc.port=9551 \
--authrpc.jwtsecret=./jwt.txt \
--rollup.disabletxpoolgossip=true
op-geth
is now active, but block creation will begin once op-node
is operational.
Why Archive Mode?
Archive mode, requiring more disk space than full mode, is essential for:
op-proposer
to access the full state history.- The explorer's functionality.
Reinitializing op-geth
In cases of database corruption indicated by op-node
errors or failure to find L2 heads, follow these steps:
- Stop
op-geth
. - Remove the existing data:
cd ~/op-geth rm -rf datadir/geth
- Reinitialize:
build/bin/geth init --datadir=datadir genesis.json
- Restart
op-geth
and thenop-node
.
Running op-node
To launch op-node
, which acts as a consensus client, run:
cd ~/optimism-Alt-DA-Avail/op-node
./bin/op-node \
--l2=http://localhost:9551 \
--l2.jwt-secret=./jwt.txt \
--sequencer.enabled \
--sequencer.l1-confs=5 \
--verifier.l1-confs=4 \
--rollup.config=./rollup.json \
--rpc.addr=0.0.0.0 \
--rpc.port=8547 \
--p2p.disable \
--rpc.enable-admin \
--p2p.sequencer.key=$GS_SEQUENCER_PRIVATE_KEY \
--l1=$L1_RPC_URL \
--l1.rpckind=$L1_RPC_KIND \
--plasma.enabled=true \
--plasma.da-server=<DA_SERVER_URL> \
Block creation will commence once op-node
starts processing L1 information and interfaces with op-geth
.
P2P Synchronization
To optimize synchronization and avoid network resource waste:
- Disable p2p sync (
--p2p.disable
) by default. - Use specific command line parameters for synchronization among multiple nodes.
Running op-batcher
op-batcher
is crucial in publishing transactions from the Sequencer to L1. Ensure it has at least 1 Sepolia ETH for operational continuity.
cd ~/optimism-Alt-DA-Avail/op-batcher
./bin/op-batcher \
--l2-eth-rpc=http://localhost:8545 \
--rollup-rpc=http://localhost:8547 \
--poll-interval=1s \
--sub-safety-margin=6 \
--num-confirmations=1 \
--safe-abort-nonce-too-low-count=3 \
--resubmission-timeout=30s \
--rpc.addr=0.0.0.0 \
--rpc.port=8548 \
--rpc.enable-admin \
--max-channel-duration=1 \
--l1-eth-rpc=$L1_RPC_URL \
--private-key=$GS_BATCHER_PRIVATE_KEY
--plasma.enabled=true \
--plasma.da-server=<DA_SERVER_HTTP_URL>
Controlling Batcher Costs
Adjust the --max-channel-duration=n
setting to balance transaction frequency on L1 and the operational costs of the batcher. Recommended is a minumum of 2 since avail block time is 20s and ethereum's 12sec.
Running op-proposer
Finally, start op-proposer
to propose new state roots:
cd ~/optimism-Alt-DA-Avail/op-proposer
./bin/op-proposer \
--poll-interval=12s \
--rpc.port=9560 \
--rollup-rpc=http://localhost:9547 \
--l2oo-address=$L2OO_ADDR \
--private-key=$PROPOSER_KEY \
--l1-eth-rpc=$L1_RPC
Acquire Sepolia ETH for Layer 2
To obtain ETH on your Rollup:
-
Go to
contracts-bedrock
:cd ~/optimism-Alt-DA-Avail/packages/contracts-bedrock
-
Find the L1 standard bridge contract address:
cat deployments/avail-optimism/L1StandardBridgeProxy.json | jq -r .address
-
Send Sepolia ETH to the bridge contract address.
Conduct Test Transactions
You now have a fully operational Avail-Powered Optimism-based EVM Rollup. Experiment with it as you would with any other test blockchain.
Congratulations on setting up your chain!