Orbit playground

This repository contains everything that's needed to start playing with Orbit chains: deployment of contracts, customizing and building your nitro node and starting up your chain.

Setup

1. Clone the repository

   git clone https://github.com/TucksonDev/orbit-playground.git

2. Install dependencies

   yarn install

   git submodule update --init --recursive --force

Configure your chain

Make a copy of the .env.example file and call it .env. Then, make sure you set a private key for the Chain owner, Batch poster and Staker accounts. You can leave the rest of options with their default, or customize any of them.

Deploy an Orbit chain

1. Deploy the contracts

   yarn deploy-chain

2. Launch your nitro node

   yarn start-node

3. Initialize your chain

   yarn initialize-chain

4. (Optional) Deploy the Token Bridge

   yarn deploy-token-bridge

5. (Optional) Transfer ownership of the chain to the UpgradeExecutor

   yarn transfer-ownership

Structure of docker containers

When starting your nodes with yarn start-node, up to four containers will start:

• batch-poster: the sequencer/batch-poster for your chain
• staker: the validator/staker for your chain
• rpc: a regular RPC node for your chain
• das-server: a Data Availability Server if you're running an AnyTrust chain

You can manage each individual container with the following commands:

• docker compose stop <container>: stops the specified container
• docker compose start <container>: starts the specified container
• docker compose restart <container>: restarts the specified container
• docker compose create <container>: creates the specified container (in case it's been removed)

Enable Blockscout

Setting the env variable ENABLE_BLOCKSCOUT to true, will start the blockscout containers when running start-node.

Blockscout will be available at http://localhost/

Clean up data

To clean up all data generated while running the chain, you can run the following command

yarn clean

Update the WASM module root of your node (WIP)

When you modify the State Transition Function (STF) of your node, you have to update the WASM module root on-chain. You can find more information about what this means in the Arbitrum documentation portal.

Follow these steps to complete the process.

1. Obtain the new WASM module root

   yarn run buildNitro

2. Update the WASM module root

   yarn run updateWASM <WASM module root>