Smoothing the setup and readme (#1)

* Add becaming to a validator steps

* Make readme more spoon-feed

* Add region var and lint in readme

* Add more details to the peering acceptance step

* Whitespace

* Mode details

* Minor tweaks

* Don't include genesis.json

* Remove region

---------

Co-authored-by: Paulo Koch <[email protected]>

README.md

@@ -3,6 +3,7 @@
 This example is meant to be a bare-bones version of what's necessary to participate in an idOS network.
 
 1. You'll need to ask the idOS association for a few values to use in the next steps:
+
     - Access to the `idos-kgw` repository
     - Terraform variables
       - `remote_account_id`
@@ -15,84 +16,169 @@ This example is meant to be a bare-bones version of what's necessary to particip
       - `genesis.json`
 
 2. Fill in this module's variables.
+
     > 💡 Tip
     >
     > Use a `terraform.tfvars` file for them to be picked up automatically
 
 3. Generate a ssh keypair
-    ```
+
+    ```bash
     ssh-keygen -f id_example
     ```
 
 4. Apply this config by running
-    ```
+
+    ```bash
     terraform init
     terraform apply
     ```
 
-4. Tell idOS what's your `vpc_peering_connection_id`
+5. Tell idOS what's your `vpc_peering_connection_id`, and wait for the peering request to be accepted
+
+   You can get the `vpc_peering_connection_id` with `terraform output -raw vpc_peering_connection_id ; echo`
+
+   Here's how you can expect to see on AWS's console.
 
-    You can consult it with `terraform output -raw vpc_peering_connection_id ; echo`
+   Before acceptance:
+     ![](./readme-assets/peering-before-acceptance.png)
+   After acceptance:
+     ![](./readme-assets/peering-after-acceptance.png)
 
-5. Configure the VM to run the node
+6. Configure the VM to run the node
    1. Connect to the VM
-       ```
+
+       ```bash
        ssh -i id_example ec2-user@`terraform output -raw instance_public_ip`
        ```
+
    2. Install docker and log out
 
        If you don't log out after running `usermod`, the addition to the `docker` group won't be picked up.
-       ```
+
+       ```bash
        sudo dnf install -y docker
        sudo usermod -a -G docker ec2-user
        sudo systemctl enable --now docker.service
        exit
        ```
+
    3. Copy over the `genesis.json` file
-       ```
+
+       ```bash
        ssh -i id_example ec2-user@`terraform output -raw instance_public_ip` mkdir -p kwil-home-dir
        scp -i id_example genesis.json ec2-user@`terraform output -raw instance_public_ip`:kwil-home-dir/
        ```
-   3. Connect to the VM again
+
+   4. Connect to the VM again
+
        Note that we'll be using ssh agent forwarding (`-A`) to facilitate authentication with GitHub.
-       ```
+
+       ```bash
        ssh -A -i id_example ec2-user@`terraform output -raw instance_public_ip`
        ```
-   4. Do the rest of the ambient setup
-       ```
+
+   5. Do the rest of the ambient setup
+
+       ```bash
        sudo dnf install -y git git-lfs vim
        sudo curl -SL https://github.com/docker/compose/releases/download/v2.27.0/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
        sudo chmod 755 /usr/local/bin/docker-compose
        ssh-keyscan github.com >> .ssh/known_hosts
        ```
-   5. Clone `idos-kgw`
-       ```
+
+   6. Clone `idos-kgw`
+
+       ```bash
        git clone [email protected]:idos-network/idos-kgw.git
        cd idos-kgw
        git lfs pull
        ```
-   6. Create initial configuration
-       ```
+
+   7. Create initial configuration
+
+       ```bash
        docker network create kwil-dev
        sed -i 's/^ARCH=arm64/ARCH=amd64/' .env
        docker-compose -f compose.peer.yaml run --rm node /app/bin/kwil-admin setup peer --root-dir /app/home_dir/ --genesis /app/home_dir/genesis.json
-       docker-compose -f compose.peer.yaml up -d
-       ```
-   7. TODO Set `config.toml`
-       ```
-       ```
-   7. TODO Ask the network to join as a validator
-       ```
-       ```
-   8. Get the node's id
-       ```
-       docker-compose -f compose.peer.yaml run --rm -T node /app/bin/kwil-admin node status --rpcserver /sockets/node.admin-sock | jq -r .node.node_id
-       ```
-   8. Get back
-       ```
        exit
        ```
 
-6. Ask idOS to approve your request to join as a validator
+   8. Copy `config.toml` into `kwil-home-dir` folder (overwrite existing file in this folder)
+
+        The previous command creates `config.toml` file in the `kwil-home-dir` folder. But we need to replace it with the file provided by idOS.
+
+        ```bash
+        scp -i id_example config.toml ec2-user@`terraform output -raw instance_public_ip`:.
+        ssh -i id_example ec2-user@`terraform output -raw instance_public_ip` mv config.toml kwil-home-dir/
+        ```
+
+7. Run the node in peer mode
+   1. Connect to the VM again
+
+        ```bash
+        ssh -i id_example ec2-user@`terraform output -raw instance_public_ip`
+        ```
+
+   2. Run the node
+
+        ```bash
+        cd idos-kgw
+        docker-compose -f compose.peer.yaml up -d --build --force-recreate
+        ```
+
+   3. Wait until the node catches up the network. It may take a few minutes.
+
+        Watch the node logs
+        ```bash
+        docker-compose logs -f
+        ```
+
+        Look for obvious golang crash reports. Let us know if you need help fixing those.
+
+        The node will take some time to catch-up with the rest of the network. Let it run for a while. Eventually, you should start observing line logs with `"msg":"finalizing commit of block"`.
+
+   4.  Get back when you done
+
+        ```bash
+        exit
+        ```
+
+8.  How to make the node a validator
+
+    1. Connect to the VM
+
+        ```bash
+        ssh -i id_example ec2-user@`terraform output -raw instance_public_ip`
+        ```
+
+    2. Request the network to become a validator
+
+        ```bash
+        cd idos-kgw
+        docker-compose -f compose.peer.yaml run --rm node /app/bin/kwil-admin validators join --rpcserver /sockets/node.admin-sock
+        ```
+
+    3. Ask idOS to approve your request to join as a validator.
+
+    4. Wait until majority nodes of the network vote on this request. To observe the status:
+
+       1. Get the node's validator public key
+
+          ```bash
+          docker-compose -f compose.peer.yaml run --rm -T node /app/bin/kwil-admin node status --rpcserver /sockets/node.admin-sock | jq -r .validator.pubkey
+          ```
+
+       2. Look if the key is in validators list
+
+          ```bash
+          docker-compose -f compose.peer.yaml run --rm node /app/bin/kwil-admin validators list --rpcserver /sockets/node.admin-sock
+          ```
+
+       3. Get back
+
+          ```bash
+          exit
+          ```
 
-99. Provide the `instance_private_ip` output to idOS to be included in the load balancer.
+9. Provide the `instance_private_ip` output to idOS to be included in the load balancer.