Use existing L1 accounts for deployment if found (#7)

Part of [Create bridge channel in go-nitro](https://www.notion.so/Create-bridge-channel-in-go-nitro-22ce80a0d8ae4edb80020a8f250ea270)
- Use existing accounts from a volume if present instead of creating new accounts and funding them

Reviewed-on: cerc-io/fixturenet-optimism-stack#7
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>

compose/docker-compose-fixturenet-optimism.yml

@@ -17,6 +17,8 @@ services:
       CERC_L1_ACCOUNTS_CSV_URL: ${CERC_L1_ACCOUNTS_CSV_URL}
       CERC_L1_ADDRESS: ${CERC_L1_ADDRESS}
       CERC_L1_PRIV_KEY: ${CERC_L1_PRIV_KEY}
+      CERC_PROPOSER_AMOUNT: ${CERC_PROPOSER_AMOUNT}
+      CERC_BATCHER_AMOUNT: ${CERC_BATCHER_AMOUNT}
     volumes:
       - ../config/network/wait-for-it.sh:/app/packages/contracts-bedrock/wait-for-it.sh
       - ../config/fixturenet-optimism/optimism-contracts/deploy-contracts.sh:/app/packages/contracts-bedrock/deploy-contracts.sh
@@ -47,6 +49,8 @@ services:
       - l2_config:/l2-config
     entrypoint: "bash"
     command: "/generate-l2-config.sh"
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
 
   # Initializes and runs the L2 execution client  (outputs to volume l2_geth_data)
   op-geth:
@@ -89,6 +93,7 @@ services:
     environment:
       CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
       CERC_L1_RPC: ${CERC_L1_RPC}
+      CERC_L1_BEACON: ${CERC_L1_BEACON}
     volumes:
       - ../config/fixturenet-optimism/run-op-node.sh:/run-op-node.sh
       - l1_deployment:/l1-deployment:ro

config/fixturenet-optimism/generate-l2-config.sh

@@ -14,6 +14,13 @@ l1_deployment_file="/l1-deployment/$DEPLOYMENT_CONTEXT-deploy.json"
 l2_allocs_file="/l2-config/allocs-l2.json"
 genesis_outfile="/l2-config/genesis.json"
 rollup_outfile="/l2-config/rollup.json"
+jwt_file="/l2-config/l2-jwt.txt"
+
+# Create a JWT secret at shared path if not found
+if [ ! -f "$jwt_file" ]; then
+  openssl rand -hex 32 > $jwt_file
+  echo "Generated JWT secret at $jwt_file"
+fi
 
 # Check if genesis.json and rollup.json already exist
 if [ -f "$genesis_outfile" ] && [ -f "$rollup_outfile" ]; then

config/fixturenet-optimism/l1-params.env

@@ -10,3 +10,6 @@ DEFAULT_CERC_L1_PORT=8545
 # that are used to send balance to Optimism Proxy contract
 # (enables them to do transactions on L2)
 DEFAULT_CERC_L1_ACCOUNTS_CSV_URL="http://fixturenet-eth-bootnode-geth:9898/accounts.csv"
+DEFAULT_CERC_PROPOSER_AMOUNT="0.2ether"
+DEFAULT_CERC_BATCHER_AMOUNT="0.1ether"
+DEFAULT_CERC_L1_BEACON=http://fixturenet-eth-lighthouse-1:8001

config/fixturenet-optimism/optimism-contracts/deploy-contracts.sh

@@ -9,6 +9,9 @@ CERC_L1_RPC="${CERC_L1_RPC:-${DEFAULT_CERC_L1_RPC}}"
 
 CERC_L1_ACCOUNTS_CSV_URL="${CERC_L1_ACCOUNTS_CSV_URL:-${DEFAULT_CERC_L1_ACCOUNTS_CSV_URL}}"
 
+CERC_PROPOSER_AMOUNT="${CERC_PROPOSER_AMOUNT:-${DEFAULT_CERC_PROPOSER_AMOUNT}}"
+CERC_BATCHER_AMOUNT="${CERC_BATCHER_AMOUNT:-${DEFAULT_CERC_BATCHER_AMOUNT}}"
+
 export DEPLOYMENT_CONTEXT="$CERC_L1_CHAIN_ID"
 # Optional create2 salt for deterministic deployment of contract implementations
 export IMPL_SALT=$(openssl rand -hex 32)
@@ -16,7 +19,7 @@ export IMPL_SALT=$(openssl rand -hex 32)
 echo "Using L1 RPC endpoint ${CERC_L1_RPC}"
 
 # Exit if a deployment already exists (on restarts)
-if [ -d "/l1-deployment/$DEPLOYMENT_CONTEXT-deploy.json" ]; then
+if [ -f "/l1-deployment/$DEPLOYMENT_CONTEXT-deploy.json" ]; then
   echo "Deployment directory /l1-deployment/$DEPLOYMENT_CONTEXT-deploy.json, checking OptimismPortal deployment"
 
   OPTIMISM_PORTAL_ADDRESS=$(cat /l1-deployment/$DEPLOYMENT_CONTEXT-deploy.json | jq -r .OptimismPortal)
@@ -47,59 +50,78 @@ wait_for_block() {
 }
 
 # We need four accounts and their private keys for the deployment: Admin, Proposer, Batcher, and Sequencer
-# If $CERC_L1_ADDRESS and $CERC_L1_PRIV_KEY have been set, we'll assign it to Admin and generate/fund the remaining three accounts from it
-# If not, we'll assume the L1 is the stack's own fixturenet-eth and use the pre-funded accounts/keys from $CERC_L1_ACCOUNTS_CSV_URL
-if [ -n "$CERC_L1_ADDRESS" ] && [ -n "$CERC_L1_PRIV_KEY" ]; then
-  wallet1=$(cast wallet new)
-  wallet2=$(cast wallet new)
-  wallet3=$(cast wallet new)
-  # Admin
-  ADMIN=$CERC_L1_ADDRESS
-  ADMIN_KEY=$CERC_L1_PRIV_KEY
-  # Proposer
-  PROPOSER=$(echo "$wallet1" | awk '/Address:/{print $2}')
-  PROPOSER_KEY=$(echo "$wallet1" | awk '/Private key:/{print $3}')
-  # Batcher
-  BATCHER=$(echo "$wallet2" | awk '/Address:/{print $2}')
-  BATCHER_KEY=$(echo "$wallet2" | awk '/Private key:/{print $3}')
-  # Sequencer
-  SEQ=$(echo "$wallet3" | awk '/Address:/{print $2}')
-  SEQ_KEY=$(echo "$wallet3" | awk '/Private key:/{print $3}')
+# Check if accounts file already exists
+l2_accounts_file="/l2-accounts/accounts.json"
+if [ -f $l2_accounts_file ]; then
+  echo "Using existing accounts from $l2_accounts_file."
 
-  echo "Funding accounts."
-  wait_for_block 1 300
-  cast send --from $ADMIN --rpc-url $CERC_L1_RPC --value 5ether $PROPOSER --private-key $ADMIN_KEY
-  cast send --from $ADMIN --rpc-url $CERC_L1_RPC --value 10ether $BATCHER --private-key $ADMIN_KEY
-  cast send --from $ADMIN --rpc-url $CERC_L1_RPC --value 2ether $SEQ --private-key $ADMIN_KEY
-else
-  curl -o accounts.csv $CERC_L1_ACCOUNTS_CSV_URL
-  # Admin
-  ADMIN=$(awk -F ',' 'NR == 1 {print $2}' accounts.csv)
-  ADMIN_KEY=$(awk -F ',' 'NR == 1 {print $3}' accounts.csv)
+  ADMIN=$(jq -r .Admin $l2_accounts_file)
+  ADMIN_KEY=$(jq -r .AdminKey $l2_accounts_file)
   # Proposer
-  PROPOSER=$(awk -F ',' 'NR == 2 {print $2}' accounts.csv)
-  PROPOSER_KEY=$(awk -F ',' 'NR == 2 {print $3}' accounts.csv)
+  PROPOSER=$(jq -r .Proposer $l2_accounts_file)
+  PROPOSER_KEY=$(jq -r .ProposerKey $l2_accounts_file)
   # Batcher
-  BATCHER=$(awk -F ',' 'NR == 3 {print $2}' accounts.csv)
-  BATCHER_KEY=$(awk -F ',' 'NR == 3 {print $3}' accounts.csv)
+  BATCHER=$(jq -r .Batcher $l2_accounts_file)
+  BATCHER_KEY=$(jq -r .BatcherKey $l2_accounts_file)
   # Sequencer
-  SEQ=$(awk -F ',' 'NR == 4 {print $2}' accounts.csv)
-  SEQ_KEY=$(awk -F ',' 'NR == 4 {print $3}' accounts.csv)
+  SEQ=$(jq -r .Seq $l2_accounts_file)
+  SEQ_KEY=$(jq -r .SeqKey $l2_accounts_file)
+else
+  # If $CERC_L1_ADDRESS and $CERC_L1_PRIV_KEY have been set, we'll assign it to Admin and generate/fund the remaining three accounts from it
+  # If not, we'll assume the L1 is the stack's own fixturenet-eth and use the pre-funded accounts/keys from $CERC_L1_ACCOUNTS_CSV_URL
+
+  if [ -n "$CERC_L1_ADDRESS" ] && [ -n "$CERC_L1_PRIV_KEY" ]; then
+    echo "Creating new accounts for Optimism deployment."
+    wallet1=$(cast wallet new)
+    wallet2=$(cast wallet new)
+    wallet3=$(cast wallet new)
+    # Admin
+    ADMIN=$CERC_L1_ADDRESS
+    ADMIN_KEY=$CERC_L1_PRIV_KEY
+    # Proposer
+    PROPOSER=$(echo "$wallet1" | awk '/Address:/{print $2}')
+    PROPOSER_KEY=$(echo "$wallet1" | awk '/Private key:/{print $3}')
+    # Batcher
+    BATCHER=$(echo "$wallet2" | awk '/Address:/{print $2}')
+    BATCHER_KEY=$(echo "$wallet2" | awk '/Private key:/{print $3}')
+    # Sequencer
+    SEQ=$(echo "$wallet3" | awk '/Address:/{print $2}')
+    SEQ_KEY=$(echo "$wallet3" | awk '/Private key:/{print $3}')
+
+    echo "Funding accounts..."
+    wait_for_block 1 300
+    cast send --from $ADMIN --rpc-url $CERC_L1_RPC --value $CERC_PROPOSER_AMOUNT $PROPOSER --private-key $ADMIN_KEY
+    cast send --from $ADMIN --rpc-url $CERC_L1_RPC --value $CERC_BATCHER_AMOUNT $BATCHER --private-key $ADMIN_KEY
+  else
+    curl -o accounts.csv $CERC_L1_ACCOUNTS_CSV_URL
+    # Admin
+    ADMIN=$(awk -F ',' 'NR == 1 {print $2}' accounts.csv)
+    ADMIN_KEY=$(awk -F ',' 'NR == 1 {print $3}' accounts.csv)
+    # Proposer
+    PROPOSER=$(awk -F ',' 'NR == 2 {print $2}' accounts.csv)
+    PROPOSER_KEY=$(awk -F ',' 'NR == 2 {print $3}' accounts.csv)
+    # Batcher
+    BATCHER=$(awk -F ',' 'NR == 3 {print $2}' accounts.csv)
+    BATCHER_KEY=$(awk -F ',' 'NR == 3 {print $3}' accounts.csv)
+    # Sequencer
+    SEQ=$(awk -F ',' 'NR == 4 {print $2}' accounts.csv)
+    SEQ_KEY=$(awk -F ',' 'NR == 4 {print $3}' accounts.csv)
+  fi
+
+  # These accounts will be needed by other containers, so write them to a shared volume
+  echo "Writing accounts/private keys to volume l2_accounts."
+  accounts_json=$(jq -n \
+    --arg Admin "$ADMIN" --arg AdminKey "$ADMIN_KEY" \
+    --arg Proposer "$PROPOSER" --arg ProposerKey "$PROPOSER_KEY" \
+    --arg Batcher "$BATCHER" --arg BatcherKey "$BATCHER_KEY" \
+    --arg Seq "$SEQ" --arg SeqKey "$SEQ_KEY" \
+    '{Admin: $Admin, AdminKey: $AdminKey, Proposer: $Proposer, ProposerKey: $ProposerKey, Batcher: $Batcher, BatcherKey: $BatcherKey, Seq: $Seq, SeqKey: $SeqKey}')
+  echo "$accounts_json" > $l2_accounts_file
 fi
 
 echo "Using accounts:"
 echo -e "Admin: $ADMIN\nProposer: $PROPOSER\nBatcher: $BATCHER\nSequencer: $SEQ"
 
-# These accounts will be needed by other containers, so write them to a shared volume
-echo "Writing accounts/private keys to volume l2_accounts."
-accounts_json=$(jq -n \
-  --arg Admin "$ADMIN" --arg AdminKey "$ADMIN_KEY" \
-  --arg Proposer "$PROPOSER" --arg ProposerKey "$PROPOSER_KEY" \
-  --arg Batcher "$BATCHER" --arg BatcherKey "$BATCHER_KEY" \
-  --arg Seq "$SEQ" --arg SeqKey "$SEQ_KEY" \
-  '{Admin: $Admin, AdminKey: $AdminKey, Proposer: $Proposer, ProposerKey: $ProposerKey, Batcher: $Batcher, BatcherKey: $BatcherKey, Seq: $Seq, SeqKey: $SeqKey}')
-echo "$accounts_json" > "/l2-accounts/accounts.json"
-
 # Get a finalized L1 block to set as the starting point for the L2 deployment
 # If the chain is a freshly created fixturenet-eth, a finalized block won't be available for many minutes; rather than wait, we can use block 1
 echo "Checking L1 for finalized block..."
@@ -163,7 +185,7 @@ echo "Done deploying contracts."
 echo "Generating L2 genesis allocs..."
 L2_CHAIN_ID=$(jq ".l2ChainID" $deploy_config_file)
 DEPLOY_CONFIG_PATH=$deploy_config_file \
-CONTRACT_ADDRESSES_PATH=deployments/$DEPLOYMENT_CONTEXT-deploy.json \
+CONTRACT_ADDRESSES_PATH="deployments/$DEPLOYMENT_CONTEXT-deploy.json" \
 forge script --chain-id $L2_CHAIN_ID scripts/L2Genesis.s.sol:L2Genesis --sig 'runWithAllUpgrades()' --private-key $ADMIN_KEY
 
 cp /app/packages/contracts-bedrock/state-dump-$L2_CHAIN_ID.json allocs-l2.json
@@ -171,10 +193,9 @@ echo "Done."
 echo "*************************************"
 
 # Copy files needed by other containers to the appropriate shared volumes
-echo "Copying deployment artifacts volume l1_deployment and deploy-config to volume l2_config"
+echo "Copying deployment artifacts to volume l1_deployment and deploy-config to volume l2_config"
 cp /app/packages/contracts-bedrock/deployments/$DEPLOYMENT_CONTEXT-deploy.json /l1-deployment
 cp /app/packages/contracts-bedrock/deploy-config/$DEPLOYMENT_CONTEXT.json /l2-config
 cp allocs-l2.json /l2-config
-openssl rand -hex 32 > /l2-config/l2-jwt.txt
 
 echo "Deployment successful. Exiting"

config/fixturenet-optimism/run-op-node.sh

@@ -7,6 +7,7 @@ fi
 CERC_L1_CHAIN_ID="${CERC_L1_CHAIN_ID:-${DEFAULT_CERC_L1_CHAIN_ID}}"
 CERC_L1_RPC="${CERC_L1_RPC:-${DEFAULT_CERC_L1_RPC}}"
 DEPLOYMENT_CONTEXT="$CERC_L1_CHAIN_ID"
+CERC_L1_BEACON="${CERC_L1_BEACON:-${DEFAULT_CERC_L1_BEACON}}"
 
 deploy_config_file="/l2-config/$DEPLOYMENT_CONTEXT.json"
 l1_deployment_file="/l1-deployment/$DEPLOYMENT_CONTEXT-deploy.json"
@@ -34,4 +35,4 @@ op-node \
   --p2p.sequencer.key="${SEQ_KEY#0x}" \
   --l1=$CERC_L1_RPC \
   --l1.rpckind=$RPC_KIND \
-  --l1.beacon=http://fixturenet-eth-lighthouse-1:8001
+  --l1.beacon=$CERC_L1_BEACON

stack/fixturenet-optimism/README.md

@@ -112,6 +112,15 @@ Inside the `fixturenet-eth-deployment` deployment directory, open `config.env` f
 CERC_ALLOW_UNPROTECTED_TXS=true
 ```
 
+Inside the `fixturenet-optimism-deployment` deployment directory, open `config.env` file and set following env variables:
+
+```bash
+# Optional
+# Funding amounts for proposer and batcher accounts on L1
+CERC_PROPOSER_AMOUNT=  # Default 0.2ether
+CERC_BATCHER_AMOUNT=   # Default 0.1ether
+```
+
 ## Start the stack
 
 Start the deployment:

stack/fixturenet-optimism/l2-only.md

@@ -64,6 +64,9 @@ Inside the deployment directory, open the file `config.env` and add the followin
   CERC_L1_HOST=
   CERC_L1_PORT=
 
+  # External L1 Beacon node endpoint
+  CERC_L1_BEACON=
+
   # URL to get CSV with credentials for accounts on L1
   # that are used to send balance to Optimism Proxy contract
   # (enables them to do transactions on L2)
@@ -74,6 +77,13 @@ Inside the deployment directory, open the file `config.env` and add the followin
   # Other generated accounts will be funded from this account, so it should contain ~20 Eth
   CERC_L1_ADDRESS=
   CERC_L1_PRIV_KEY=
+
+  # Optional
+
+  # Funding amounts for proposer and batcher accounts on L1
+  # (Accounts funded using the Admin account)
+  CERC_PROPOSER_AMOUNT=
+  CERC_BATCHER_AMOUNT=
   ```
 
 * NOTE: If L1 is running on the host machine, use `host.docker.internal` as the hostname to access the host port, or use the `ip a` command to find the IP address of the `docker0` interface (this will usually be something like `172.17.0.1` or `172.18.0.1`)