Deploy Arbitrum Orbit with Avail DA

This guide follows the deployment of an Arbitrum Orbit chain (L3) with Arbitrum Sepolia (L2) as the base chain. You can follow the same steps with any other supported chains with the relevant contract addresses.

Prerequisites

Docker

• You need to have docker (opens in a new tab) and docker-compose (opens in a new tab) installed on your machine.

Avail

• An Avail account with some AVAIL tokens in it. You can refer to our docs here to get started.
• An application key (app-id) for your rollup. Learn how to get your app-id here.

Arbitrum Sepolia

• At least 1 ETH over Arbsepolia Testnet. You can follow Step 1 (opens in a new tab) on Arbitrum Orbit Doc for acquiring testnet $ETH
• This guide will use Arbitrum's ArbSepolia (opens in a new tab) and Avail's Turing testnets.

Download avail-nitro-node docker image

Step-1: Download the avail-nitro-node (opens in a new tab) image from docker hub

docker pull availj/avail-nitro-node:v2.2.1-upstream-v3.2.1

Deploy Rollup Contracts

Step-1: Clone the arbitrum-orbit-sdk (opens in a new tab) with AvailDA

git clone https://github.com/availproject/arbitrum-orbit-sdk.git
git checkout avail-develop-upstream-v0.20.1
cd arbitrum-orbit-sdk/examples/create-avail-rollup-eth

Step-2: Create .env file

Create a copy of .env.sample as .env file and edit the following:

• Set EVM account keys of settlement layer

  DEPLOYER_PRIVATE_KEY :- Orbit rollup owner, Rollup contract deployer
  BATCH_POSTER_PRIVATE_KEY -: Batch poster
  VALIDATOR_PRIVATE_KEY :- Validator

• Set avail account info for DA submissions

  AVAIL_ADDR_SEED=
  AVAIL_APP_ID=

• Set Fallback S3, if you want to enable S3 storage as a fallback for AvailDA (its an optional feature)

  • Fill these required details where make FALLBACKS3_ENABLE = true

  FALLBACKS3_ENABLE=true
  FALLBACKS3_ACCESS_KEY=
  FALLBACKS3_SECRET_KEY=
  FALLBACKS3_REGION=
  FALLBACKS3_OBJECT_PREFIX=
  FALLBACKS3_BUCKET=

• Set parent chain rpc URL (other than infura will also works)

  PARENT_CHAIN_RPC=https://arbitrum-sepolia.infura.io/v3/YOUR_API_KEY

Step-3: Rollup contract deployment

• Run avail orbit rollup deployment command

  npm run deploy-avail-orbit-rollup

• You will find this kind of log

  
  

  

• You will get to see two files added nodeConfig.json and orbitSetupScriptConfig.json, which will be need in next step spin and set up avail orbit rollup

Before proceeding, let's briefly review what just happened:

1. You submitted a deployment transaction to an Orbit "factory" smart contract on the Arbitrum Sepolia testnet, the public L2 chain that your local Orbit chain will settle transactions to.
2. This Orbit smart contract then initialized your Orbit chain's base contracts with the values that you specified in the previous step, and deployed these base contracts to the Arbitrum Sepolia testnet.

Your Orbit chain's base contracts are responsible for facilitating the exchange of information between your chain's node(s) and its base chain's nodes. This includes the batch posting of transactions from your Orbit chain to its base chain, the staking of tokens by your Orbit chain's validators the challenge mechanism, bridging mechanisms, and more.

Spin up the avail orbit rollup chain using orbit-setup-script

Step-1: Download orbit-setup-script (opens in a new tab)

git clone https://github.com/availproject/orbit-setup-script.git
cd orbit-setup-script

Step-2 :- Run your chain

Add the nodeConfig.json and orbitSetupScriptConfig.json in ./config , that you get after completing Deploy Rollup contracts

cd orbit-setup-script
docker-compose up -d

A Nitro node and BlockScout explorer instance will be started. Visit http://localhost:4000/ (opens in a new tab) to access your BlockScout explorer instance - this will allow you to view your chain's transactions and blocks, which can be useful for debugging.

Step-3: Final Setup - Token bridge deployment

A Hardhat script that handles the following tasks:

1. Fund the batch-poster and validator (staker) accounts on your underlying L2 chain.
2. Deposit ETH into your account on the chain using your chain's newly deployed bridge.
3. Deploy your Token Bridge contracts on both L2 and local Orbit chains.
4. Configure parameters on the chain.

To run this script, issue the following command from the root of the orbit-setup-script repository, replacing OxYourPrivateKey with the private key of the Owner account you used to deploy your chain's contracts, and replacing http://localhost:8449 with the RPC URL of your chain's node.

PRIVATE_KEY="0xYourPrivateKey" L2_RPC_URL="https://sepolia-rollup.arbitrum.io/rpc" L3_RPC_URL="http://localhost:8449" yarn run setup

Hurray!

Congratulations, Your local Orbit chain with Avail DA is now running.

Appendix A:- Use Arbitrum bridge for your local chain

After completing final setup, you can find two files network.json and outputInfo.json. Add in your avail orbit rollup testnet to the bridge (opens in a new tab). This will only be for local testing. Paste outputInfo.json configuration in setting section of bridge

Appendix B: Logging

Run this command in the root directory of your orbit setup script repo to view your chain's logs:

docker-compose logs -f nitro

Appendix C: Depositing ETH/native token

If you need to deposit more ETH (or native tokens) into your Orbit chain account, run this command on the base directory of the setup script, replacing 0xYourPrivateKey with the private key of the originating account, and <AMOUNT> with the amount to send:

Using Arbitrum Sepolia:

PRIVATE_KEY="0xYourPrivateKey" L2_RPC_URL="https://sepolia-rollup.arbitrum.io/rpc" L3_RPC_URL="http://localhost:8449"
AMOUNT="<AMOUNT>" yarn run deposit

Appendix D: Refunding (For testing environments)

Once you're done with your local Orbit chain and want to refund any remaining balance from the batch poster and validator wallets, you can use the refund script by running:

PRIVATE_KEY="0xYourPrivateKey" L2_RPC_URL="<https://sepolia-rollup.arbitrum.io/rpc>" TARGET_ADDRESS="0xYourTargetAddress" yarn run refund

This will transfer any remaining balance from the batch poster and validator wallets to the specified target address.

Appendix E: Troubleshooting

You may see error getting latest batch count in your node's output logs (from Appendix B). This is usually safe to ignore. It's usually displayed when your Orbit chain's base contract deployment isn't yet finalized on the L1 chain. This finalization can take 15-20 minutes, but don't worry - the deployment doesn't need to be L1-finalized in order for your chain to function properly.

Learn more about customizing and using your Orbit chain from the Arbitrum Orbit Docs (opens in a new tab).

Reference

Currently chains supporting Arbitrum orbit chain deployment with AvailDA:-

• Arbitrum Sepolia (opens in a new tab)
• Base Sepolia (opens in a new tab)

Smart contract addresses

The following information may be useful to those building on Arbitrum. We list the addresses of the smart contracts related to the protocol

Previous Releases

v2.1.0-upstream-v3.1.0

• nitro-node: avail-nitro-node:v2.1.0-upstream-v3.1.0 (opens in a new tab)
• nitro-contracts: avail-nitro-contracts:v2.1.0-upstream-v2.0.0 (opens in a new tab)
• Rollup creator address:
  • Arbitrum Sepolia: 0x9673b69f55808c4eB56b4e5E29ec1aE85e7f20f4
  • Base Sepolia: 0xfB3b37b5685340169de1BcEc5d607912eBbB6668
• wasm module root: 0x29e13d2cf8e8e44b8306703e845e0b9ee732f5144da4666a0079e9f50aec21aa

v2.0.0-upstream-v2.3.1

• nitro-node: avail-nitro-node:v2.0.0-upstream-v2.3.1 (opens in a new tab)
• nitro-contracts: avail-nitro-contracts:v2.0.0-upstream-v1.2.1 (opens in a new tab)
• Rollup creator address:
  • Arbitrum Sepolia: 0x364DE2F72f1496Fdf02c133A5fe60e6a079f2178
  • Base Sepolia: 0x246A71eefDBd543D015dbE8CAe52263103d49315
• wasm module root: 0x9c5556e303c5b0399bde1391cbc61a195c95318e1c1a15b1c402d6a89ba1ebb3

v1.0.0

• nitro-node: avail-nitro-node:v1.0.0-upstream-v2.3.1 (opens in a new tab)
• nitro-contracts: avail-nitro-contracts:v1.0.0-upstream-v1.2.1 (opens in a new tab)
• Rollup creator address:
  • Arbitrum Sepolia: 0xADCBE5c221566FA6e6Ebf5BA08759c83177DfCDA
• wasm module root:
  • arm64:- 0x30d81f66d40dbb88484524cbce0982ee9adee944d9416c283313560efd5af958
  • amd64:- 0xc3d6717b86468b20ed2d74fa4484571b51595d56294d154b0fac19d55b599e09