fixed HA bugs and docs

Author: ngl-aws

lib/fantom/README.md

@@ -11,7 +11,7 @@ This blueprint is designed to assist in deploying a single node or a Highly Avai
 ## Overview of Deployment Architectures
 
 ### Single Node setup
-![Single Nodes Deployment](./doc/assets/Architecture-Single-Fantom-Node-Runners.drawio.png)
+![Single Nodes Deployment](./doc/assets/Architecture-Single-FANTOM-Node-Runners.drawio.png)
 
 1. The AWS Cloud Development Kit (CDK) is used to deploy a single node. The CDK application stores assets like scripts and config files in S3 bucket to copy them to the EC2 instance when launching a Fantom Node.
 2. A single RPC Fantom Fullnode is deployed within the [Default VPC](https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html) and continuously synchronizes with the rest of nodes on Fantom Blockchain Network through an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html).
@@ -20,7 +20,7 @@ This blueprint is designed to assist in deploying a single node or a Highly Avai
 
 ### Highly Available setup
 
-![Highly Available Nodes Deployment](./doc/assets/Architecture-HA-Fantom-Node-Runners.drawio.png)
+![Highly Available Nodes Deployment](./doc/assets/Architecture-HA-FANTOM-Node-Runners.drawio.png)
 
 1. The CDK is used to deploy a highly available (HA) architecture. An S3 bucket is utilized to store [User data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and other scripts and configuration files required when launching EC2 as the Fantom Node.
 2. A set of RPC Fantom Fullnodes that are deployed within the [Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-groups.html) in the [Default VPC](https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html) continuously synchronize with the rest of the nodes on Fantom Blockchain Network through an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html).
@@ -82,7 +82,7 @@ cd aws-blockchain-node-runners
 npm install
 ```
 
-### Deploy the HA Nodes
+### Prepare to deploy nodes
 
 1. Make sure you are in the root directory of the cloned repository
 
@@ -101,9 +101,9 @@ npm install
    Create your own copy of `.env` file and edit it to update with your AWS Account ID, AWS Region, and optionally the Fantom SNAPSHOTS URI:
 
    ```bash
-   # Make sure you are in aws-blockchain-node-runners/lib/fantom
    cd lib/fantom
    pwd
+   # Make sure you are in aws-blockchain-node-runners/lib/fantom
    cp ./sample-configs/.env-sample-read .env
    nano .env
    ```
@@ -152,25 +152,19 @@ Alternatively, you can manually check [Geth Syncing Status](https://geth.ethereu
 
    ```javascript
    {
-        "jsonrpc": "2.0",
-        "id": 1,
-        "result": {
-                 "currentBlock": "0x211f0d8",
-                 "healedBytecodeBytes": "0x0",
-                 "healedBytecodes": "0x0",
-                 "healedTrienodeBytes": "0x0",
-                 "healedTrienodes": "0x0",
-                 "healingBytecode": "0x0",
-                 "healingTrienodes": "0x0",
-                 "highestBlock": "0x2123bff",
-                 "startingBlock": "0x20910d7",
-                 "syncedAccountBytes": "0x0",
-                 "syncedAccounts": "0x0",
-                 "syncedBytecodeBytes": "0x0",
-                 "syncedBytecodes": "0x0",
-                 "syncedStorage": "0x0",
-                 "syncedStorageBytes": "0x0"
-        }
+        jsonrpc: "2.0",
+        id: 1,
+        result: {
+			currentBlock: 37676547,
+			currentBlockHash: "0x0001ab120000187fd8069d3a4f6501d48ad4800778f40a76d79cf02469272a43",
+			currentBlockTime: "0x16ec7a4b9a82ebfe",
+			currentEpoch: "0x1ab13",
+			highestBlock: 80196141,
+			highestEpoch: "0x44343",
+			knownStates: 0,
+			pulledStates: 0,
+			startingBlock: 0 
+		}
    }
    ```
 
@@ -192,7 +186,7 @@ Alternatively, you can manually check [Geth Syncing Status](https://geth.ethereu
 
 ### Option 2: Highly Available RPC Nodes
 
-1. The inital deployment of a Fantom Fullnode and downloading its snapshot typically takes about 2-3 hours. The Full node uses snapshots data, and downloading and decompressing the data takes time. You can grab a cup of coffee☕️ and patiently wait during this process. Maybe two. After deployment, you'll need to wait for another half a day to a day for your nodes to synchronize with the Fantom Blockchain Network, depending on how fresh the snapshot was.
+1. The inital deployment of a Fantom Full node and downloading its snapshot typically takes about 6 hours. The Full node uses snapshots data, and downloading and decompressing the data takes time. You can grab a cup of coffee☕️ and patiently wait during this process. Maybe two. After deployment, you'll need to wait for hour or more for your nodes to synchronize with the Fantom Blockchain Network, depending on how fresh the snapshot was.
 
    ```bash
       pwd
@@ -218,24 +212,18 @@ Alternatively, you can manually check [Geth Syncing Status](https://geth.ethereu
 
    ```javascript
    {
-        "jsonrpc": "2.0",
-        "id": 1,
-        "result": {
-                 "currentBlock": "0x211f0d8",
-                 "healedBytecodeBytes": "0x0",
-                 "healedBytecodes": "0x0",
-                 "healedTrienodeBytes": "0x0",
-                 "healedTrienodes": "0x0",
-                 "healingBytecode": "0x0",
-                 "healingTrienodes": "0x0",
-                 "highestBlock": "0x2123bff",
-                 "startingBlock": "0x20910d7",
-                 "syncedAccountBytes": "0x0",
-                 "syncedAccounts": "0x0",
-                 "syncedBytecodeBytes": "0x0",
-                 "syncedBytecodes": "0x0",
-                 "syncedStorage": "0x0",
-                 "syncedStorageBytes": "0x0"
+        jsonrpc: "2.0",
+        id: 1,
+        result: {
+			currentBlock: 37676547,
+			currentBlockHash: "0x0001ab120000187fd8069d3a4f6501d48ad4800778f40a76d79cf02469272a43",
+			currentBlockTime: "0x16ec7a4b9a82ebfe",
+			currentEpoch: "0x1ab13",
+			highestBlock: 80196141,
+			highestEpoch: "0x44343",
+			knownStates: 0,
+			pulledStates: 0,
+			startingBlock: 0 
         }
    }
    ```

lib/fantom/lib/assets/download-snapshot.sh

@@ -7,13 +7,15 @@ echo "Downloading FANTOM snapshot."
 
 cd /data
 
-for FILE in `curl https://snapshot.fantom.network/files/snapsync/latest/listtgzfiles.txt`; do
-        echo $FILE;
-        axel -n 20 https://snapshot.fantom.network/files/snapsync/$FILE && \
-        tar --use-compress-program="pigz -d" -xvf ${FILE##*/} && \
-        rm ${FILE##*/} || \
-        echo "Problem with downloading or expanding file $FILE"
-done
+if [[ -n ${FANTOM_SNAPSHOTS_URI} && ${FANTOM_SNAPSHOTS_URI} != "none" ]]; then
+        for FILE in `curl ${FANTOM_SNAPSHOTS_URI}`; do
+                echo $FILE;
+                axel -n 20 ${FANTOM_SNAPSHOTS_URI%%/latest/listtgzfiles.txt}/$FILE && \
+                tar --use-compress-program="pigz -d" -xvf ${FILE##*/} && \
+                rm ${FILE##*/} || \
+                echo "Problem with downloading or expanding file $FILE"
+        done
+fi
 
 echo "Downloading FANTOM snapshot finished"
 

lib/fantom/lib/assets/fantom-checker/syncchecker-fantom.sh

@@ -18,9 +18,11 @@ FANTOM_SYNC_STATS=$(su bcuser -c '/home/bcuser/go-opera/build/opera attach --dat
 # Synced status results:
 #
 # false
+#
+# TODO: if a node falls behind, does it revert to syncing?
 
 # If false, then get current block number:
-if $FANTOM_SYNC_STATS == false; then
+if $FANTOM_SYNC_STATS != false; then
 
 FANTOM_SYNC_BLOCK=$(echo $FANTOM_SYNC_STATS | jq -r ".currentBlock")
 FANTOM_HIGHEST_BLOCK=$(echo $FANTOM_SYNC_STATS | jq -r ".highestBlock")

lib/fantom/lib/assets/setup-instance-store-volumes.sh

@@ -4,7 +4,7 @@ source /etc/environment
 
 if [[ "$DATA_VOLUME_TYPE" == "instance-store" ]]; then
   echo "Data volume type is instance store"
-  export DATA_VOLUME_ID=/dev/$(lsblk -lnb | awk -v VOLUME_SIZE_BYTES="$DATA_VOLUME_SIZE" '{if ($4== VOLUME_SIZE_BYTES) {print $1}}')
+  export DATA_VOLUME_ID=/dev/$(lsblk -lnb | awk 'max < $4 {max = $4; vol = $1} END {print vol}')
 fi
 
 if [ -n "$DATA_VOLUME_ID" ]; then
@@ -30,8 +30,6 @@ if [ -n "$DATA_VOLUME_ID" ]; then
 
     sudo mount -a
 
-    /opt/download-snapshot.sh
-
     chown bcuser:bcuser -R /data
   else
     echo "Data volume is mounted, nothing changed"

lib/fantom/sample-configs/.env-sample-read

@@ -4,26 +4,26 @@
 
 ## Set the AWS account is and region for your environment ##
 AWS_ACCOUNT_ID="xxxxxxxxxxx"
-AWS_REGION="ap-southeast-2"
+AWS_REGION="us-east-1"
 
 ## Optional FANTOM snapshots download link                                          # IMPORTANT !!! Make sure the url is valid before you use it!
-#FANTOM_SNAPSHOTS_URI=https://snapshot.fantom.network/files/snapsync/          # Optional param. We extract the actual URL from https://raw.githubusercontent.com/48Club/fantom-snapshots/main/data.json if nothing is specified. Otherwise, check the latest vesion for Full node here: https://github.com/48Club/fantom-snapshots
+FANTOM_SNAPSHOTS_URI=https://snapshot.fantom.network/files/snapsync/latest/listtgzfiles.txt # Optional param. Do a full sync if not provided.
 
 ## Common configuration parameters ##
 FANTOM_NETWORK="mainnet"                                                            # All options:  "mainnet", "testnet"
 FANTOM_NODE_CONFIGURATION="read"                                                    # All options:   "read", "api", "validator"
 
 ## Instance Nodes
-FANTOM_INSTANCE_TYPE="m6a.2xlarge"
+FANTOM_INSTANCE_TYPE="i3en.xlarge"
 FANTOM_CPU_TYPE="x86_64"                                                            # All options: "x86_64", "ARM_64". IMPORTANT: Make sure the CPU type matches the instance type used
 
 # Data volume configuration
-FANTOM_DATA_VOL_TYPE="gp3"                                                          # Other options: "io1" | "io2" | "gp3" | "instance-store" . IMPORTANT: Use "instance-store" option only with instance types that support that feature, like popular for node im4gn, d3, i3en, and i4i instance families
+FANTOM_DATA_VOL_TYPE="instance-store"                                               # Other options: "io1" | "io2" | "gp3" | "instance-store" . IMPORTANT: Use "instance-store" option only with instance types that support that feature, like popular for node im4gn, d3, i3en, and i4i instance families
 FANTOM_DATA_VOL_SIZE="2000"                                                         # Current required data size to keep both snapshot archive and unarchived version of it
-FANTOM_DATA_VOL_IOPS="7000"                                                        # Max IOPS for EBS volumes (not applicable for "instance-store")
+FANTOM_DATA_VOL_IOPS="7000"                                                         # Max IOPS for EBS volumes (not applicable for "instance-store")
 FANTOM_DATA_VOL_THROUGHPUT="400"                                                    # Max throughput for EBS gp3 volumes (not applicable for "io1" | "io2" | "instance-store")
 
 ## HA nodes configuration ##
 FANTOM_HA_NUMBER_OF_NODES="2"                                                       # Total number of RPC nodes to be provisioned. Default: 2
-FANTOM_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="300"                                    # Time enough to initialize the instance
+FANTOM_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="10080"                                  # Time enough to initialize the instance
 FANTOM_HA_NODES_HEARTBEAT_DELAY_MIN="120"                                           # Time sufficient enough for a node do sync