Docker local-testnet scripts

docker/node/Dockerfile

@@ -10,12 +10,10 @@ RUN go build -v -ldflags="-X main.appVersion=$(git describe --tags --long --dirt
 RUN cp /go/pkg/mod/github.com/multiversx/$(cat /go/mx-chain-go/go.mod | grep mx-chain-vm-v | sort -n | tail -n -1| awk -F '/' '{print$3}'| sed 's/ /@/g')/wasmer/libwasmer_linux_amd64.so /lib/libwasmer_linux_amd64.so
 RUN cp /go/pkg/mod/github.com/multiversx/$(cat /go/mx-chain-go/go.mod | grep mx-chain-vm-go | sort -n | tail -n -1| awk -F '/' '{print$3}'| sed 's/ /@/g')/wasmer2/libvmexeccapi.so /lib/libvmexeccapi.so
 
-WORKDIR /go/mx-chain-go/cmd/node
-
 # ===== SECOND STAGE ======
 FROM ubuntu:22.04
 RUN apt-get update && apt-get upgrade -y
-COPY --from=builder "/go/mx-chain-go/cmd/node" "/go/mx-chain-go/cmd/node/"
+COPY --from=builder "/go/mx-chain-go/cmd/node/node" "/go/mx-chain-go/cmd/node/"
 COPY --from=builder "/lib/libwasmer_linux_amd64.so" "/lib/libwasmer_linux_amd64.so"
 COPY --from=builder "/lib/libvmexeccapi.so" "/lib/libvmexeccapi.so"
 WORKDIR /go/mx-chain-go/cmd/node/

scripts/docker-testnet/README.md

@@ -0,0 +1,14 @@
+# Setting up a local-testnet with Docker
+
+First and foremost, one needs to build the **seednode** & **node** images. Hence, the **_build.sh_**
+script is provided. This can be done, by invoking the script or building the images manually.
+
+```
+./build.sh  # (Optional) Can be ignored if you already have the images stored in the local registry.
+./setup.sh  # Will setup the local-testnet.
+./clean.sh  # Will stop and remove the containers related to the local-testnet.
+
+Optionally
+./stop.sh   # Will stop all the containers in the local-testnet.
+./start.sh  # Will start all stopped containers from the initial local-testnet.
+```

scripts/docker-testnet/build.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -eux
+
+pushd ../..
+
+docker build -f docker/seednode/Dockerfile . -t seednode:dev
+
+docker build -f docker/node/Dockerfile . -t node:dev
+

scripts/docker-testnet/clean.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+set -eux
+
+# Delete the entire testnet folder, which includes configuration, executables and logs.
+
+export MULTIVERSXTESTNETSCRIPTSDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+source "$MULTIVERSXTESTNETSCRIPTSDIR/variables.sh"
+
+# Get the IDs of containers attached to the network
+CONTAINER_IDS=$(docker network inspect -f '{{range .Containers}}{{.Name}} {{end}}' "$DOCKER_NETWORK_NAME")
+
+# Stop each container
+echo "Removing containers..."
+for CONTAINER_ID in $CONTAINER_IDS; do
+    docker stop "$CONTAINER_ID"
+    docker rm "$CONTAINER_ID"
+done
+
+echo "Removing network..."
+docker network rm ${DOCKER_NETWORK_NAME}
+
+echo "Removing $TESTNETDIR..."
+rm -rf $TESTNETDIR

scripts/docker-testnet/functions.sh

@@ -0,0 +1,231 @@
+#!/usr/bin/env bash
+
+# Starts from 3, if the DOCKER_NETWORK_SUBNET ends with a 0. The first IP address is reserved for the gateway and the
+# second one is allocated to the seednode. Therefore the counting starts from 3. If you modify the DOCKER_NETWORK_SUBNET
+# variable, make sure to change this one accordingly too.
+IP_HOST_BYTE=3
+
+cloneRepositories() {
+  cd $(dirname $MULTIVERSXDIR)
+
+  git clone [email protected]:multiversx/mx-chain-deploy-go.git || true
+  git clone [email protected]:multiversx/mx-chain-proxy-go.git || true
+}
+
+buildNodeImages() {
+  cd $MULTIVERSXDIR
+
+  docker build -f docker/seednode/Dockerfile . -t seednode:dev
+
+  docker build -f docker/node/Dockerfile . -t node:dev
+}
+
+createDockerNetwork() {
+  docker network create -d bridge --subnet=${DOCKER_NETWORK_SUBNET} ${DOCKER_NETWORK_NAME}
+
+  # this variable is used to keep track of the allocated IP addresses in the network, by removing the last byte
+  # of the DOCKER_NETWORK_SUBNET. One can consider this the host network address without the last byte at the end.
+  export NETWORK_ADDRESS=$(echo "$DOCKER_NETWORK_SUBNET" | rev | cut -d. -f2- | rev)
+}
+
+startSeedNode() {
+  local publishPortArgs=""
+  if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+    publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+    (( DOCKER_PUBLISH_PORT_RANGE++ ))
+  fi
+
+  docker run -d --name seednode \
+      -v ${TESTNETDIR}/seednode/config:/go/mx-chain-go/cmd/seednode/config \
+      --network ${DOCKER_NETWORK_NAME} \
+      $publishPortArgs \
+      seednode:dev \
+      --rest-api-interface=0.0.0.0:10000
+}
+
+startObservers() {
+  local observerIdx=0
+  local publishPortArgs=""
+
+  # Example for loop with injected variables in Bash
+  for ((i = 0; i < SHARDCOUNT; i++)); do
+    for ((j = 0; j < SHARD_OBSERVERCOUNT; j++)); do
+      # Your commands or code to be executed in each iteration
+      KEY_INDEX=$((TOTAL_NODECOUNT - observerIdx - 1))
+
+      if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+        publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+      fi
+
+      docker run -d --name "observer${observerIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-shard${i}" \
+          -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
+          --network ${DOCKER_NETWORK_NAME} \
+          $publishPortArgs \
+          node:dev \
+          --destination-shard-as-observer $i \
+          --rest-api-interface=0.0.0.0:10200 \
+          --config ./config/config_observer.toml \
+          --sk-index=${KEY_INDEX} \
+          $EXTRA_OBSERVERS_FLAGS
+
+
+      (( IP_HOST_BYTE++ ))
+      (( DOCKER_PUBLISH_PORT_RANGE++ ))
+      ((observerIdx++)) || true
+    done
+  done
+
+  for ((i = 0; i < META_OBSERVERCOUNT; i++)); do
+     KEY_INDEX=$((TOTAL_NODECOUNT - observerIdx - 1))
+
+     if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+       publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+     fi
+
+     docker run -d --name "observer${observerIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-metachain" \
+         -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
+         --network ${DOCKER_NETWORK_NAME} \
+         $publishPortArgs \
+         node:dev \
+         --destination-shard-as-observer "metachain" \
+         --rest-api-interface=0.0.0.0:10200 \
+         --config ./config/config_observer.toml \
+         --sk-index=${KEY_INDEX} \
+         $EXTRA_OBSERVERS_FLAGS
+
+     (( IP_HOST_BYTE++ ))
+     (( DOCKER_PUBLISH_PORT_RANGE++ ))
+     ((observerIdx++)) || true
+  done
+}
+
+startValidators() {
+  local validatorIdx=0
+  local publishPortArgs=""
+  # Example for loop with injected variables in Bash
+  for ((i = 0; i < SHARDCOUNT; i++)); do
+    for ((j = 0; j < SHARD_VALIDATORCOUNT; j++)); do
+
+      if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+        publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+      fi
+
+      docker run -d --name "validator${validatorIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-shard${i}" \
+          -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
+          --network ${DOCKER_NETWORK_NAME} \
+          $publishPortArgs \
+          node:dev \
+          --rest-api-interface=0.0.0.0:10200 \
+          --config ./config/config_validator.toml \
+          --sk-index=${validatorIdx} \
+
+      (( IP_HOST_BYTE++ ))
+      (( DOCKER_PUBLISH_PORT_RANGE++ ))
+      ((validatorIdx++)) || true
+    done
+  done
+
+  for ((i = 0; i < META_VALIDATORCOUNT; i++)); do
+
+    if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+      publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+    fi
+
+    docker run -d --name "validator${validatorIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-metachain" \
+         -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
+         --network ${DOCKER_NETWORK_NAME} \
+         $publishPortArgs \
+         node:dev \
+         --rest-api-interface=0.0.0.0:10200 \
+         --config ./config/config_observer.toml \
+         --sk-index=${validatorIdx} \
+
+    (( IP_HOST_BYTE++ ))
+    (( DOCKER_PUBLISH_PORT_RANGE++ ))
+    ((validatorIdx++)) || true
+  done
+}
+
+updateProxyConfigDocker() {
+  pushd $TESTNETDIR/proxy/config
+  cp config.toml config_edit.toml
+
+  # Truncate config.toml before the [[Observers]] list
+  sed -i -n '/\[\[Observers\]\]/q;p' config_edit.toml
+
+  if [ "$SHARD_OBSERVERCOUNT" -le 0 ]; then
+    generateProxyValidatorListDocker config_edit.toml
+  else
+    generateProxyObserverListDocker config_edit.toml
+  fi
+
+  mv config_edit.toml config.toml
+  echo "Updated configuration for the Proxy."
+  popd
+}
+
+generateProxyObserverListDocker() {
+  local ipByte=3
+
+  for ((i = 0; i < SHARDCOUNT; i++)); do
+     for ((j = 0; j < SHARD_OBSERVERCOUNT; j++)); do
+
+        echo "[[Observers]]" >> config_edit.toml
+        echo "   ShardId = $i" >> config_edit.toml
+        echo "   Address = \"http://${NETWORK_ADDRESS}.${ipByte}:10200\"" >> config_edit.toml
+        echo ""$'\n' >> config_edit.toml
+
+        (( ipByte++ )) || true
+     done
+  done
+
+  for META_OBSERVER in $(seq $META_OBSERVERCOUNT); do
+        echo "[[Observers]]" >> config_edit.toml
+        echo "   ShardId = $METASHARD_ID" >> config_edit.toml
+        echo "   Address = \"http://${NETWORK_ADDRESS}.${ipByte}:10200\"" >> config_edit.toml
+        echo ""$'\n' >> config_edit.toml
+
+        (( ipByte++ )) || true
+  done
+}
+
+generateProxyValidatorListDocker() {
+  local ipByte=3
+
+  for ((i = 0; i < SHARDCOUNT; i++)); do
+     for ((j = 0; j < SHARD_VALIDATORCOUNT; j++)); do
+
+        echo "[[Observers]]" >> config_edit.toml
+        echo "   ShardId = $i" >> config_edit.toml
+        echo "   Address = \"http://${NETWORK_ADDRESS}.${ipByte}:10200\"" >> config_edit.toml
+        echo "   Type = \"Validator\"" >> config_edit.toml
+        echo ""$'\n' >> config_edit.toml
+
+        (( ipByte++ )) || true
+     done
+  done
+
+  for META_OBSERVER in $(seq $META_VALIDATORCOUNT); do
+        echo "[[Observers]]" >> config_edit.toml
+        echo "   ShardId = $METASHARD_ID" >> config_edit.toml
+        echo "   Address = \"http://${NETWORK_ADDRESS}.${ipByte}:10200\"" >> config_edit.toml
+        echo "   Type = \"Validator\"" >> config_edit.toml
+        echo ""$'\n' >> config_edit.toml
+
+        (( ipByte++ )) || true
+  done
+}
+
+buildProxyImage() {
+  pushd ${PROXYDIR}
+  cd ../..
+  docker build -f docker/Dockerfile . -t proxy:dev
+}
+
+startProxyDocker() {
+  docker run -d --name "proxy" \
+      -v $TESTNETDIR/proxy/config:/mx-chain-proxy-go/cmd/proxy/config \
+      --network ${DOCKER_NETWORK_NAME} \
+      -p $PORT_PROXY:8080 \
+      proxy:dev
+}

scripts/docker-testnet/setup.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -eux
+
+export DOCKERTESTNETDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+MULTIVERSXTESTNETSCRIPTSDIR="$(dirname "$DOCKERTESTNETDIR")/testnet"
+
+source "$DOCKERTESTNETDIR/variables.sh"
+source "$DOCKERTESTNETDIR/functions.sh"
+source "$MULTIVERSXTESTNETSCRIPTSDIR/include/config.sh"
+source "$MULTIVERSXTESTNETSCRIPTSDIR/include/build.sh"
+
+cloneRepositories
+
+prepareFolders
+
+buildConfigGenerator
+
+generateConfig
+
+copyConfig
+
+copySeednodeConfig
+updateSeednodeConfig
+
+copyNodeConfig
+updateNodeConfig
+
+createDockerNetwork
+
+startSeedNode
+startObservers
+startValidators
+
+if [ $USE_PROXY -eq 1 ]; then
+  buildProxyImage
+  prepareFolders_Proxy
+  copyProxyConfig
+  updateProxyConfigDocker
+  startProxyDocker
+fi
+

scripts/docker-testnet/start.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -eux
+
+file_path="./tmp/stopped_containers"
+
+# Check if the file exists
+if [ ! -f "$file_path" ]; then
+    echo "File $file_path not found."
+    exit 1
+fi
+
+# Read the file line by line
+while IFS= read -r line; do
+    docker start $line
+done < "$file_path"
+
+rmdir ./tmp

scripts/docker-testnet/stop.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -eux
+
+# Delete the entire testnet folder, which includes configuration, executables and logs.
+
+export MULTIVERSXTESTNETSCRIPTSDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+source "$MULTIVERSXTESTNETSCRIPTSDIR/variables.sh"
+
+# Get the IDs of containers attached to the network
+export CONTAINER_IDS=$(docker network inspect -f '{{range $k, $v := .Containers}}{{printf "%s\n" $k}}{{end}}' "$DOCKER_NETWORK_NAME")
+
+mkdir -p ./tmp
+
+# Stop each container
+echo "Stopping containers..."
+for CONTAINER_ID in $CONTAINER_IDS; do
+    docker stop "$CONTAINER_ID"
+    echo "$CONTAINER_ID" >> ./tmp/stopped_containers
+done