From 885171d32805aac331c21d87de1919545c805eab Mon Sep 17 00:00:00 2001 From: Shreerang Kale Date: Tue, 10 Jun 2025 11:55:28 +0530 Subject: [PATCH] Restructure prerequisites in docs --- docs/run-first-validator.md | 16 +++++++------- docs/run-validator.md | 44 ++++++++++++++++++------------------- 2 files changed, 29 insertions(+), 31 deletions(-) diff --git a/docs/run-first-validator.md b/docs/run-first-validator.md index b5cb7ac..a3d6b4c 100644 --- a/docs/run-first-validator.md +++ b/docs/run-first-validator.md @@ -2,18 +2,18 @@ ## Prerequisites -- Machine 1: Where the SAPO testnet is running +- Machine 1: Where the SAPO testnet node is already running - Install `zstd` using `sudo apt install zstd` -- Machine 2: Where the genesis file is to be generated +- Machine 2: Where the mainnet first validator node is to be setup + +- Machine 3: Where the genesis file is to be generated - Install `zstd` using `sudo apt install zstd` - LPS distribution Google spreadsheet URL or CSV file path -- Machine 3: Where the first validator node is to be setup - - Following tools are required in all machines: - [ansible](playbooks/README.md#ansible-installation) @@ -27,7 +27,7 @@ ## Build laconicd to generate genesis file -- Run the following steps in a secure machine separate from the one where the node is to be setup +- Run the following steps in a secure machine (machine 3) separate from the one where the node is to be setup (machine 2) - Run playbook to build laconicd container: @@ -83,7 +83,7 @@ ## Export testnet state -- Run the following steps in machine where the testnet node is running +- Run the following steps in machine where the testnet node is already running (machine 1) - Get your private key from testnet deployment: @@ -109,7 +109,7 @@ ## Generate mainnet genesis file -- Run the following steps in machine where [the genesis file is to be generated](#build-laconicd-to-generate-genesis-file) +- Run the following steps in machine where [the genesis file is to be generated (machine 3)](#build-laconicd-to-generate-genesis-file) - Copy over compressed `testnet-state.zst` file to target machine @@ -177,7 +177,7 @@ ## Run node -- Run the following steps in the machine where the mainnet node is setup +- Run the following steps in the machine where the mainnet node is setup (machine 2) ### Setup TMKMS (Optional but Recommended) diff --git a/docs/run-validator.md b/docs/run-validator.md index 6b00f48..697e8e1 100644 --- a/docs/run-validator.md +++ b/docs/run-validator.md @@ -2,33 +2,31 @@ ## Prerequisites -- Machine 1: Where the SAPO testnet is running +- Machine 1: Where the SAPO testnet node is already running -- Machine 2: Where the validator node is to be setup +- Machine 2: Where the mainnet validator node is to be setup - - Fetch laconicd-stack: - - ```bash - laconic-so fetch-stack git.vdb.to/cerc-io/laconicd-stack --git-ssh --pull - ``` - -- Machine 3: Where the create-validator transaction is to be signed - - - Fetch laconicd-stack: - - ```bash - laconic-so fetch-stack git.vdb.to/cerc-io/laconicd-stack --git-ssh --pull - ``` - -- Following tools are required in all machines: + - laconicd-stack - [ansible](playbooks/README.md#ansible-installation) - - [laconic-so](https://github.com/cerc-io/stack-orchestrator/?tab=readme-ov-file#install) +- Machine 3: Where the create-validator transaction is to be signed + + - laconicd-stack + + - [ansible](playbooks/README.md#ansible-installation) + +- [laconic-so](https://github.com/cerc-io/stack-orchestrator/?tab=readme-ov-file#install) is required in all machines + +- To fetch laconicd-stack: + + ```bash + laconic-so fetch-stack git.vdb.to/cerc-io/laconicd-stack --git-ssh --pull + ``` ## Stop SAPO testnet node -- Run the following steps in machine where the testnet node is running +- Run the following steps in machine where the testnet node is already running (machine 1) - Get your private key from testnet deployment: @@ -46,7 +44,7 @@ ## Build laconicd to create validator -- Run the following steps in a secure machine separate from the one where the node is to be setup +- Run the following steps in a secure machine (machine 3) separate from the one where the node is to be setup (machine 2) - Run playbook to build laconicd container: @@ -56,7 +54,7 @@ ## Setup Node -- Run the following steps in the machine where the validator node is to be setup +- Run the following steps in the machine where the validator node is to be setup (machine 2) - Copy the example variables file: @@ -188,7 +186,7 @@ ## Create Validator -- Run these steps in a machine from where [the create-validator transaction is to be signed](#build-laconicd-to-create-validator) +- Run these steps in a machine from where [the create-validator transaction is to be signed (machine 3)](#build-laconicd-to-create-validator) This command clones the entire repository into the `~/cerc` folder, which includes the genesis file published by the first validator. @@ -228,7 +226,7 @@ - Input private key of the existing account that was exported in [previous steps](#stop-sapo-testnet-node) when prompted -- Run the following commands in the machine where the validator node is setup +- Run the following commands in the machine where the validator node is running (machine 2) - Check the validator list: