From e75ce24466061cad2c14c425e2a3322b3613227e Mon Sep 17 00:00:00 2001
From: ssd04 <dariussuirab@gmail.com>
Date: Wed, 15 May 2024 10:09:26 +0300
Subject: [PATCH] added observing guide README

---
 devel/observing-squad/README.md       | 131 ++++++++++++++++++++++++++
 devel/observing-squad/run-observer.sh |  14 +++
 2 files changed, 145 insertions(+)
 create mode 100644 devel/observing-squad/README.md
 create mode 100644 devel/observing-squad/run-observer.sh

diff --git a/devel/observing-squad/README.md b/devel/observing-squad/README.md
new file mode 100644
index 0000000..a6a7d92
--- /dev/null
+++ b/devel/observing-squad/README.md
@@ -0,0 +1,131 @@
+# Setting up Multiversx infrastructure
+
+In order to set up the infrastructure, the following two parts have to be in place:
+- observing squad
+- aggregator service
+
+
+## Observing squad
+
+An observing squad consists of a set of *Observer Nodes* (one for each shard,
+including Metachain).
+
+There is some [documentation](https://docs.multiversx.com/integrators/observing-squad/)
+on the official docs on how to run an observing on the Multiversx network, but without
+the proxy instace, we do not need a proxy instance for the current setup.
+
+There are
+also some notes in [README](https://github.com/multiversx/mx-chain-observing-squad/blob/master/README.md)
+on [mx-chain-observing-squad](https://github.com/multiversx/mx-chain-observing-squad/blob/master/README.md) repository.
+
+> Please note that we do not need a proxy instance (as stated in the above documentation)
+> for our purposes.
+
+### Setup with one machine
+
+There is `external.toml` file is used to setup the observer -> aggregator connector.
+The default values should be fine for the local testing/setup.
+The `HostDriverConfig` section from `external.toml` config file can be updated if needed,
+especially `URL` field.
+
+There is a setup script that can be used to manage the entire setup with docker images,
+on a single instance. It can be triggered based on the `run.sh` script.
+
+In order to setup the folder structure run:
+```bash
+./run.sh setup
+```
+
+Run command will start the nodes:
+```bash
+./run.sh run
+```
+
+The nodes can be managed with `start` and `stop` commands:
+```bash
+./run.sh start
+
+./run.sh stop
+```
+
+There is also a cleanup command, that will stop and remove the docker containers:
+```bash
+./run.sh cleanup
+```
+
+### Setup with multiple machines
+
+#### Pull docker images
+
+Pull images from [docker hub](https://hub.docker.com/u/multiversx).
+
+```bash
+docker pull multiversx/chain-observer:v1.7.10.0
+docker pull multiversx/chain-keygenerator:latest
+```
+
+#### Generate PEM files
+
+First, generate 4 PEM files, one for each Observer by running the keygenerator 4 times:
+
+```bash
+export KEYS_FOLDER=~/keys
+docker run --rm --mount type=bind,source=${KEYS_FOLDER},destination=/keys --workdir /keys multiversx/chain-keygenerator:latest
+```
+
+After running the command 4 times, rename the resulted files to:
+
+- `observerKey_0.pem`
+- `observerKey_1.pem`
+- `observerKey_2.pem`
+- `observerKey_metachain.pem`
+
+**Note:** the files will be owned by the `root` user. In order to `chown` them, do as follows:
+
+```bash
+sudo chown $(whoami) *
+```
+
+Copy external config and the generated pem file on each corresponding machine,
+into `OBSERVER_DIR/config` folder (see the following section with an example
+for `OBSERVER_DIR` variable)
+
+#### Start Observers
+
+On each machine:
+
+* Start Observer of Shard 0:
+
+```bash
+export SHARD=0
+export DISPLAY_NAME="MyObservingSquad-0"
+export OBSERVER_DIR=~/MyObservingSquad/node-0
+./run-observer.sh
+```
+
+* Start Observer of Shard 1:
+
+```bash
+export SHARD=1
+export DISPLAY_NAME="MyObservingSquad-1"
+export OBSERVER_DIR=~/MyObservingSquad/node-1
+./run-observer.sh
+```
+
+* Start Observer of Shard 2:
+
+```bash
+export SHARD=2
+export DISPLAY_NAME="MyObservingSquad-2"
+export OBSERVER_DIR=~/MyObservingSquad/node-2
+./run-observer.sh
+```
+
+* Start Observer of Metachain:
+
+```bash
+export SHARD=metachain
+export DISPLAY_NAME="MyObservingSquad-metachain"
+export OBSERVER_DIR=~/MyObservingSquad/node-metachain
+./run-observer.sh
+```
diff --git a/devel/observing-squad/run-observer.sh b/devel/observing-squad/run-observer.sh
new file mode 100644
index 0000000..3433b8e
--- /dev/null
+++ b/devel/observing-squad/run-observer.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# set -x
+
+docker run \
+    --mount type=bind,source=${OBSERVER_DIR}/db,destination=/go/mx-chain-go/cmd/node/db \
+    --mount type=bind,source=${OBSERVER_DIR}/logs,destination=/go/mx-chain-go/cmd/node/logs \
+    --mount type=bind,source=${OBSERVER_DIR}/config,destination=/config \
+    --network="host" \
+    --name squad-${SHARD} \
+    multiversx/chain-observer:v1.7.10.0 \
+    --destination-shard-as-observer=${SHARD} \
+    --validator-key-pem-file=/config/observerKey_${SHARD}.pem \
+    --display-name="${DISPLAY_NAME}"