chore: local-env wizard mode improvements (#580)

Added:
- Entrypoint scripts will only start a node if they notice existing configuration. This allows to restart a node without reconfiguring network, as well as upgrading a node image.

Author: rsporny

dev/local-environment/configurations/wizard/governance-authority/entrypoint.sh

@@ -1,15 +1,39 @@
 #!/bin/bash
 
-echo "Installing dependencies..."
+start_node() {
+    echo "Starting the node..."
+    export MC__FIRST_EPOCH_TIMESTAMP_MILLIS=$(cat /shared/MC__FIRST_EPOCH_TIMESTAMP_MILLIS)
+
+    /usr/local/bin/partner-chains-node \
+        --validator \
+        --chain=/shared/chain-spec.json \
+        --node-key-file=/data/chains/partner_chains_template/network/secret_ed25519 \
+        --base-path=/data \
+        --keystore-path=/data/chains/partner_chains_template/keystore \
+        --unsafe-rpc-external \
+        --rpc-port=9933 \
+        --rpc-cors=all \
+        --prometheus-port=9615 \
+        --prometheus-external \
+        --state-pruning=archive \
+        --blocks-pruning=archive &
+    wait
+}
+
+if [ -f "/shared/partner-chains-wizard-1.ready" ]; then
+    echo "/shared/partner-chains-wizard-1.ready exists. Skipping configuration and starting the node..."
+    start_node
+    exit 0
+fi
+
 
+echo "Installing dependencies..."
 apt -qq update &> /dev/null
 apt -qq -y install expect curl jq ncat &> /dev/null
-
 cp /usr/local/bin/partner-chains-node /partner-chains-node
 
-echo "Beginning configuration..."
-
 
+echo "Beginning configuration..."
 echo "Generating keys..."
 expect <<EOF
 spawn ./partner-chains-node wizards generate-keys
@@ -21,7 +45,6 @@ EOF
 
 
 echo "Waiting for the Cardano network to sync and for Ogmios to start..."
-
 while true; do
     if nc -z ogmios $OGMIOS_PORT; then
         break
@@ -50,11 +73,11 @@ send "ogmios\r"
 expect "Ogmios port (1337)"
 send "\r"
 expect "path to the payment verification file (payment.vkey)"
-send "keys/funded_address.vkey\r"
+send "/keys/funded_address.vkey\r"
 expect "Select an UTXO to use as the genesis UTXO"
 send "\r"
 expect "path to the payment signing key file (payment.skey)"
-send "keys/funded_address.skey\r"
+send "/keys/funded_address.skey\r"
 expect "Do you want to configure a native token for you Partner Chain? (Y/n)"
 send "n\r"
 expect eof
@@ -63,7 +86,7 @@ EOF
 
 echo "Waiting for permissioned candidate's keys to be generated..."
 while true; do
-    if [ -f "/shared/partner-chains-wizard-2.ready" ]; then
+    if [ -f "/shared/partner-chains-wizard-2-keys.ready" ]; then
         break
     else
         sleep 1
@@ -108,7 +131,6 @@ echo "Copying chain-spec.json file to /shared/chain-spec.json..."
 cp chain-spec.json /shared/chain-spec.json
 echo "chain-spec.json generation complete."
 
-
 echo "Copying pc-chain-config.json file to /shared/pc-chain-config.json..."
 cp pc-chain-config.json /shared/pc-chain-config.json
 
@@ -129,28 +151,21 @@ expect "Ogmios hostname (ogmios)"
 send "\r"
 expect "Ogmios port (1337)"
 send "\r"
-expect "path to the payment signing key file (keys/funded_address.skey)"
+expect "path to the payment signing key file (/keys/funded_address.skey)"
 send "\r"
 expect "Do you want to set/update the D-parameter on the main chain? (y/N)"
 send "y\r"
 expect "Enter P, the number of permissioned candidates seats, as a non-negative integer. (0)"
 send "2\r"
 expect "Enter R, the number of registered candidates seats, as a non-negative integer. (0)"
 send "1\r"
-expect "path to the payment signing key file (keys/funded_address.skey)"
+expect "path to the payment signing key file (/keys/funded_address.skey)"
 send "\r"
 expect "Done. Main chain state is set."
 expect eof
 EOF
 
-
+touch /shared/partner-chains-wizard-1.ready
 echo "Partner Chain configuration is complete, and will be able to start after two mainchain epochs."
 
-echo "Starting the node..."
-expect <<EOF
-spawn ./partner-chains-node wizards start-node
-expect "Proceed? (Y/n)"
-send "\r"
-set timeout -1
-expect eof
-EOF
+start_node

dev/local-environment/configurations/wizard/permissioned/entrypoint.sh

@@ -1,27 +1,38 @@
 #!/bin/bash
 
 echo "Installing dependencies..."
-
 apt -qq update &> /dev/null
 apt -qq -y install expect jq &> /dev/null
+cp /usr/local/bin/partner-chains-node /data/partner-chains-node
+cd /data
 
-cp /usr/local/bin/partner-chains-node /partner-chains-node
 
-echo "Beginning configuration..."
+if [ -f "/shared/partner-chains-wizard-2.ready" ]; then
+    echo "/shared/partner-chains-wizard-2.ready exists. Skipping configuration and starting the node..."
+    expect <<EOF
+spawn ./partner-chains-node wizards start-node
+expect "Proceed? (Y/n)"
+send "Y\r"
+set timeout -1
+expect eof
+EOF
+    exit 0
+fi
 
 
+echo "Beginning configuration..."
 echo "Generating keys..."
 expect <<EOF
 spawn ./partner-chains-node wizards generate-keys
 set timeout 60
 expect "node base path (./data)"
-send "\r"
+send ".\r"
 expect "All done!"
 expect eof
 EOF
 
 cp partner-chains-public-keys.json /shared/partner-chains-public-keys.json
-touch /shared/partner-chains-wizard-2.ready
+touch /shared/partner-chains-wizard-2-keys.ready
 
 
 echo "Waiting for chain-spec.json and pc-chain-config.json to be ready..."
@@ -33,13 +44,15 @@ while true; do
     fi
 done
 
-cp /shared/chain-spec.json .
-cp /shared/pc-chain-config.json .
-
+cp /shared/chain-spec.json /data/chain-spec.json
+cp /shared/pc-chain-config.json /data/pc-chain-config.json
 
 echo "Configuring Node P2P port..."
 jq '.node_p2p_port = 30334' pc-resources-config.json > tmp.json && mv tmp.json pc-resources-config.json
 
+touch /shared/partner-chains-wizard-2.ready
+echo "Configuration complete."
+
 echo "Starting the node..."
 expect <<EOF
 spawn ./partner-chains-node wizards start-node

dev/local-environment/configurations/wizard/registered/entrypoint.sh

@@ -1,21 +1,38 @@
 #!/bin/bash
 
 echo "Installing dependencies..."
-
 apt -qq update &> /dev/null
 apt -qq -y install expect jq &> /dev/null
+cp /usr/local/bin/partner-chains-node /data/partner-chains-node
+cd /data
 
-cp /usr/local/bin/partner-chains-node /partner-chains-node
 
-echo "Beginning configuration..."
+start_node() {
+    echo "Starting the node..."
+    expect <<EOF
+spawn ./partner-chains-node wizards start-node
+expect "Proceed? (Y/n)"
+send "Y\r"
+set timeout -1
+expect eof
+EOF
+}
+
+
+if [ -f "/shared/partner-chains-wizard-3.ready" ]; then
+    echo "/shared/partner-chains-wizard-3.ready exists. Skipping configuration..."
+    start_node
+    exit 0
+fi
 
 
+echo "Beginning configuration..."
 echo "Generating keys..."
 expect <<EOF
 spawn ./partner-chains-node wizards generate-keys
 set timeout 60
 expect "node base path (./data)"
-send "\r"
+send ".\r"
 expect eof
 EOF
 
@@ -29,8 +46,8 @@ while true; do
     fi
 done
 
-cp /shared/chain-spec.json .
-cp /shared/pc-chain-config.json .
+cp /shared/chain-spec.json /data/chain-spec.json
+cp /shared/pc-chain-config.json /data/pc-chain-config.json
 
 
 echo "Registering candidate..."
@@ -44,7 +61,7 @@ send "ogmios\r"
 expect "Ogmios port (1337)"
 send "\r"
 expect "path to the payment verification file (payment.vkey)"
-send "keys/funded_address.vkey\r"
+send "/keys/funded_address.vkey\r"
 expect "Select UTXO to use for registration"
 send "\r"
 expect eof
@@ -61,7 +78,7 @@ register2_output=$(expect <<EOF
 spawn $register2_command
 set timeout 60
 expect "Path to mainchain signing key file (cold.skey)"
-send "keys/cold.skey\r"
+send "/keys/cold.skey\r"
 expect "/partner-chains-node wizards register3"
 expect eof
 catch wait result
@@ -77,7 +94,7 @@ expect <<EOF
 spawn $register3_command
 set timeout 300
 expect "path to the payment signing key file (payment.skey)"
-send "keys/funded_address.skey\r"
+send "/keys/funded_address.skey\r"
 expect "Ogmios protocol (http/https)"
 send "\r"
 expect "Ogmios hostname (ogmios)"
@@ -94,13 +111,7 @@ EOF
 echo "Configuring Node P2P port..."
 jq '.node_p2p_port = 30335' pc-resources-config.json > tmp.json && mv tmp.json pc-resources-config.json
 
-echo "Starting the node..."
-expect <<EOF
-spawn ./partner-chains-node wizards start-node
-expect "Proceed? (Y/n)"
-send "Y\r"
-set timeout -1
-expect eof
-EOF
+touch /shared/partner-chains-wizard-3.ready
+echo "Registration complete."
 
-# tail -f /dev/null
+start_node

dev/local-environment/modules/partner-chains-wizard.txt

@@ -6,16 +6,25 @@
     user: "0:0"
     volumes:
       - shared-volume:/shared
+      - partner-chains-node-1-data:/data
       - ./configurations/cardano/keys/funded_address.skey:/keys/funded_address.skey
       - ./configurations/cardano/keys/funded_address.vkey:/keys/funded_address.vkey
       - ./configurations/wizard/governance-authority/entrypoint.sh:/entrypoint.sh
     environment:
-      - OGMIOS_PORT=${OGMIOS_PORT}
-      - POSTGRES_PORT=${POSTGRES_PORT}
-      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+      OGMIOS_PORT: ${OGMIOS_PORT}
+      POSTGRES_PORT: ${POSTGRES_PORT}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      DB_SYNC_POSTGRES_CONNECTION_STRING: "postgres://postgres:${POSTGRES_PASSWORD}@postgres:${POSTGRES_PORT}/cexplorer"
+      SIDECHAIN_BLOCK_BENEFICIARY: "0000000000000000000000000000000000000000000000000000000000000001"
+      CARDANO_SECURITY_PARAMETER: "5"
+      CARDANO_ACTIVE_SLOTS_COEFF: "0.4"
+      MC__FIRST_EPOCH_NUMBER: "0"
+      MC__FIRST_SLOT_NUMBER: "0"
+      MC__EPOCH_DURATION_MILLIS: "120000"
+      BLOCK_STABILITY_MARGIN: "0"
     ports:
       - "30333:30333"
-      - "9933:9944"
+      - "9933:9933"
     entrypoint: ["/bin/bash", "/entrypoint.sh"]
 
   partner-chains-wizard-2:
@@ -25,13 +34,11 @@
     user: "0:0"
     volumes:
       - shared-volume:/shared
+      - partner-chains-node-2-data:/data
       - ./configurations/wizard/permissioned/entrypoint.sh:/entrypoint.sh
     environment:
       - POSTGRES_PORT=${POSTGRES_PORT}
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
-    ports:
-      - "30334:30334"
-      - "9934:9944"
     entrypoint: ["/bin/bash", "/entrypoint.sh"]
 
   partner-chains-wizard-3:
@@ -41,6 +48,7 @@
     user: "0:0"
     volumes:
       - shared-volume:/shared
+      - partner-chains-node-3-data:/data
       - ./configurations/cardano/keys/funded_address.skey:/keys/funded_address.skey
       - ./configurations/cardano/keys/funded_address.vkey:/keys/funded_address.vkey
       - ./configurations/cardano/keys/cold.skey:/keys/cold.skey
@@ -49,7 +57,4 @@
     environment:
       - POSTGRES_PORT=${POSTGRES_PORT}
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
-    ports:
-      - "30335:30335"
-      - "9935:9944"
     entrypoint: ["/bin/bash", "/entrypoint.sh"]