Split containers into 3

Author: TucksonDev

.env.example

@@ -42,7 +42,11 @@ ORBIT_CHAIN_NAME=
 
 # Other constants
 ##########################
-CHAIN_CONFIG_FOLDER="chainConfig"
-NODE_CONFIG_FILENAME="node-config"
 FUNDING_AMOUNT=
+
+# Configures the node to not wait for finalized blocks on the parent chain to sequence
+# delayed messages or read information from the parent chain.
 DISABLE_L1_FINALITY=true
+
+# Configures the node to post batches and make assertions every minute
+USE_FAST_L1_POSTING=true

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "nitro"]
 	path = nitro
 	url = https://github.com/OffchainLabs/nitro/
-	branch = v3.5.5
+	branch = v3.6.3

README.md

@@ -36,6 +36,22 @@ Make a copy of the `.env.example` file and call it `.env`. Then, make sure you s
 
     `yarn run deployTokenBridge`
 
+## Structure of docker containers
+
+When starting your nodes with `docker compose up`, 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)
+
 ## 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](https://docs.arbitrum.io/launch-orbit-chain/how-tos/customize-stf).

chainConfig/.gitignore

@@ -2,5 +2,10 @@
 *
 # Except this file
 !.gitignore
-!keys
-!keys/*
+
+!batch-poster
+!staker
+!rpc
+!das-server
+!das-server/keys
+!das-server/keys/*

chainConfig/keys/das_bls renamed to chainConfig/das-server/keys/das_bls

@@ -1,18 +1,48 @@
 version: '3.9'
 services:
-  nitro:
+  batch-poster:
+    image: "${NITRO_DOCKER_IMAGE_TAG}"
+    ports:
+      - "127.0.0.1:8149:${NITRO_PORT}"
+      - "127.0.0.1:9642:9642"
+    volumes:
+      - "./chainConfig/batch-poster:/home/user/.arbitrum"
+    command:
+      - --conf.file=/home/user/.arbitrum/batch-poster-config.json
+      - --node.feed.output.enable
+      - --node.feed.output.port=9642
+
+  staker:
+    depends_on:
+      - batch-poster
+    image: "${NITRO_DOCKER_IMAGE_TAG}"
+    ports:
+      - "127.0.0.1:8249:${NITRO_PORT}"
+    volumes:
+      - "./chainConfig/staker:/home/user/.arbitrum"
+    command:
+      - --conf.file=/home/user/.arbitrum/staker-config.json
+      - --execution.forwarding-target=http://batch-poster:8449
+      - --node.feed.input.url=ws://batch-poster:9642
+
+  rpc:
+    depends_on:
+      - batch-poster
     image: "${NITRO_DOCKER_IMAGE_TAG}"
     ports:
       - "127.0.0.1:${NITRO_PORT}:${NITRO_PORT}"
     volumes:
-      - "./${CHAIN_CONFIG_FOLDER}:/home/user/.arbitrum"
-    command: --conf.file /home/user/.arbitrum/${NODE_CONFIG_FILENAME}.json
+      - "./chainConfig/rpc:/home/user/.arbitrum"
+    command:
+      - --conf.file=/home/user/.arbitrum/rpc-config.json
+      - --execution.forwarding-target=http://batch-poster:8449
+      - --node.feed.input.url=ws://batch-poster:9642
 
   das-server:
     image: "${NITRO_DOCKER_IMAGE_TAG}"
     entrypoint: [ "/bin/bash", "-c", "/das-server.sh ${USE_ANYTRUST}" ]
     volumes:
-      - "./${CHAIN_CONFIG_FOLDER}:/home/user/.arbitrum"
+      - "./chainConfig/das-server:/home/user/.arbitrum"
       - "./shell-scripts/das-server.sh:/das-server.sh"
       - "./${DAS_LOCAL_STORAGE}:/home/user/das-data"
     ports:

chainConfig/keys/das_bls.pub renamed to chainConfig/das-server/keys/das_bls.pub

@@ -14,7 +14,7 @@
     "updateWASM": "ts-node ./scripts/updateWasmModuleRoot.ts",
     "updateNodeConfig": "ts-node ./scripts/updateNodeConfiguration.ts",
     "recoverFundsFromParentChain": "ts-node ./scripts/recoverFundsFromParentChain.ts",
-    "clean": "find chainConfig -mindepth 1 ! -name '.gitignore' ! -name 'keys' ! -name 'das_bls*' -delete && find chainDasData -mindepth 1 ! -name '.gitignore' -delete"
+    "clean": "find chainConfig -mindepth 1 ! -name '.gitignore' ! -name 'batch-poster' ! -name 'staker' ! -name 'rpc' ! -name 'das-server' ! -name 'keys' ! -name 'das_bls*' -delete && find chainDasData -mindepth 1 ! -name '.gitignore' -delete"
   },
   "keywords": [],
   "author": "",

docker-compose.yaml

@@ -22,6 +22,7 @@ import {
   prepareDasConfig,
   saveDasNodeConfigFile,
   chainIsAnytrust,
+  splitConfigPerType,
 } from '../../src/utils';
 import 'dotenv/config';
 
@@ -30,12 +31,10 @@ if (
   !process.env.PARENT_CHAIN_ID ||
   !process.env.CHAIN_OWNER_PRIVATE_KEY ||
   !process.env.BATCH_POSTER_PRIVATE_KEY ||
-  !process.env.STAKER_PRIVATE_KEY ||
-  !process.env.CHAIN_CONFIG_FOLDER ||
-  !process.env.NODE_CONFIG_FILENAME
+  !process.env.STAKER_PRIVATE_KEY
 ) {
   throw new Error(
-    'The following environment variables must be present: PARENT_CHAIN_ID, CHAIN_OWNER_PRIVATE_KEY, BATC_POSTER_PRIVATE_KEY, STAKER_PRIVATE_KEY, CHAIN_CONFIG_FOLDER, NODE_CONFIG_FILENAME',
+    'The following environment variables must be present: PARENT_CHAIN_ID, CHAIN_OWNER_PRIVATE_KEY, BATC_POSTER_PRIVATE_KEY, STAKER_PRIVATE_KEY',
   );
 }
 
@@ -139,22 +138,20 @@ const main = async () => {
       ? process.env.PARENT_CHAIN_BEACON_RPC_URL
       : undefined,
   };
-  let nodeConfig = prepareNodeConfig(nodeConfigParameters);
+  let baseNodeConfig = prepareNodeConfig(nodeConfigParameters);
 
-  if (process.env.DISABLE_L1_FINALITY) {
+  if (process.env.DISABLE_L1_FINALITY === 'true') {
     const updatedNodeConfig = {
       node: {
         'delayed-sequencer': {
           'require-full-finality': false,
         },
         'batch-poster': {
-          'max-delay': '1m',
           'data-poster': {
             'wait-for-l1-finality': false,
           },
         },
         'staker': {
-          'make-assertion-interval': '1m',
           'data-poster': {
             'wait-for-l1-finality': false,
           },
@@ -169,16 +166,50 @@ const main = async () => {
         },
       },
     };
-    nodeConfig = deepMerge(nodeConfig, updatedNodeConfig);
+    baseNodeConfig = deepMerge(baseNodeConfig, updatedNodeConfig);
+  }
+
+  if (process.env.USE_FAST_L1_POSTING === 'true') {
+    const updatedNodeConfig = {
+      node: {
+        'batch-poster': {
+          'max-delay': '1m',
+        },
+        'staker': {
+          'make-assertion-interval': '1m',
+        },
+      },
+    };
+    baseNodeConfig = deepMerge(baseNodeConfig, updatedNodeConfig);
   }
 
   // Extra customizable options
-  if (process.env.NITRO_PORT) {
-    nodeConfig.http!.port = Number(process.env.NITRO_PORT);
+  if (process.env.NITRO_PORT != '') {
+    baseNodeConfig.http!.port = Number(process.env.NITRO_PORT);
   }
 
-  const filePath = saveNodeConfigFile(nodeConfig);
-  console.log(`Node config written to ${filePath}`);
+  //
+  // NOTE:
+  // The following configuration is added to the batch poster in the docker-compose file
+  //    - --node.feed.output.enable
+  //    - --node.feed.output.port=9642
+  //
+  // The following configuration is added to the staker and rpc in the docker-compose file
+  //    - --execution.forwarding-target 'http://batch-poster:8449'
+  //    - --node.feed.input.url ws://batch-poster:9642
+  //
+
+  // Split config into the different entities
+  const { batchPosterConfig, stakerConfig, rpcConfig } = splitConfigPerType(baseNodeConfig);
+
+  const batchPosterfilePath = saveNodeConfigFile('batch-poster', batchPosterConfig);
+  console.log(`Batch poster config written to ${batchPosterfilePath}`);
+
+  const stakerFilePath = saveNodeConfigFile('staker', stakerConfig);
+  console.log(`Staker config written to ${stakerFilePath}`);
+
+  const rpcFilePath = saveNodeConfigFile('rpc', rpcConfig);
+  console.log(`RPC config written to ${rpcFilePath}`);
 
   // If we want to use AnyTrust, we need to:
   //    1. set the right keyset in the SequencerInbox