Base. Pre-review fixes

vlasonfa · vlasonfa · commit 7f3eb45b6821 · 2024-08-08T11:58:16.000-07:00
diff --git a/lib/base/README.md b/lib/base/README.md
@@ -124,7 +124,7 @@ npx cdk deploy base-common
 
 ### Option 1: Deploy Single Node
 
-1. For L1 node you you can set your own URLs in `BASE_L1_EXECUTION_ENDPOINT` and `BASE_L1_CONSENSUS_ENDPOINT` properties of `.env` file. It can be one of [the providers recommended by Base](https://docs.base.org/tools/node-providers) or you can run your own Ethereum node [with Node Runner Ethereum blueprint](https://aws-samples.github.io/aws-blockchain-node-runners/docs/Blueprints/Ethereum) (tested with geth-lighthouse combination). For example:
+1. For L1 node you you can set your own URLs in `BASE_L1_EXECUTION_ENDPOINT` and `BASE_L1_CONSENSUS_ENDPOINT` properties of `.env` file. It can be one of [the providers recommended by Base](https://docs.base.org/tools/node-providers) or you can run your own Ethereum node [with Node Runner Ethereum blueprint](https://aws-samples.github.io/aws-blockchain-node-runners/docs/Blueprints/Ethereum) (tested with single-node geth-lighthouse combination). For example:
 
 ```bash
 #For Sepolia:
@@ -181,7 +181,7 @@ BASE_L1_CONSENSUS_ENDPOINT="https://ethereum-sepolia-beacon-api.publicnode.com"
       npx cdk deploy base-ha-nodes --json --outputs-file ha-nodes-deploy.json
    ```
 
-2. Give the new RPC **full** nodes about 2-3 hours (24 hours for **archive** node) to initialize and then run the following query against the load balancer behind the RPC node created
+2. Give the new RPC **full** nodes about 5 hours to initialize and then run the following query against the load balancer behind the RPC node created.
 
    ```bash
       export RPC_ALB_URL=$(cat ha-nodes-deploy.json | jq -r '..|.alburl? | select(. != null)')
@@ -197,6 +197,8 @@ BASE_L1_CONSENSUS_ENDPOINT="https://ethereum-sepolia-beacon-api.publicnode.com"
 
 **NOTE:** By default and for security reasons the load balancer is available only from within the default VPC in the region where it is deployed. It is not available from the Internet and is not open for external connections. Before opening it up please make sure you protect your RPC APIs.
 
+**NOTE:** We currently don't recommend running **archive** nodes in HA setup, because it takes way too long to get them synced. Use single-node setup instead.
+
 ### Monitoring
 Every 5 minutes a script on the Base node publishes to CloudWatch service the metrics for current block for L1/L2 clients as well as blocks behind metric for L1 and minutes behind for L2. When the node is fully synced the blocks behind metric should get to 4 and minutes behind should get down to 0. To see the metrics for **single node only**:
 
diff --git a/lib/base/lib/assets/base/node-start.sh b/lib/base/lib/assets/base/node-start.sh
@@ -6,4 +6,4 @@ echo "Script is starting..."
 cd /home/bcuser/node
 /usr/local/bin/docker-compose -f /home/bcuser/node/docker-compose.yml up -d
 
-echo "Started"
+echo "Started"
diff --git a/lib/base/lib/assets/base/node-stop.sh b/lib/base/lib/assets/base/node-stop.sh
@@ -6,4 +6,4 @@ echo "Script is stopping the node..."
 cd /home/bcuser/node
 /usr/local/bin/docker-compose -f /home/bcuser/node/docker-compose.yml down
 
-echo "Stopped"
+echo "Stopped"
diff --git a/lib/base/lib/assets/restore-from-snapshot-archive-s3.sh b/lib/base/lib/assets/restore-from-snapshot-archive-s3.sh
@@ -28,4 +28,4 @@ echo "Snapshot is ready, starting the service.."
 chown -R bcuser:bcuser $SNAPSHOT_DIR
 
 sudo systemctl daemon-reload
-sudo systemctl enable --now base
+sudo systemctl enable --now base
diff --git a/lib/base/lib/assets/restore-from-snapshot-http.sh b/lib/base/lib/assets/restore-from-snapshot-http.sh
@@ -59,4 +59,4 @@ echo "Snapshot is ready, starting the service.."
 chown -R bcuser:bcuser /data
 
 sudo systemctl daemon-reload
-sudo systemctl enable --now base
+sudo systemctl enable --now base
diff --git a/lib/base/lib/assets/setup-instance-store-volumes.sh b/lib/base/lib/assets/setup-instance-store-volumes.sh
@@ -15,7 +15,7 @@ if [ -n "$DATA_VOLUME_ID" ]; then
     echo "Data volume formatted. Mounting..."
     echo "waiting for volume to get UUID"
     OUTPUT=0;
-    while [ "$OUTPUT" = 0 ]; do 
+    while [ "$OUTPUT" = 0 ]; do
       DATA_VOLUME_UUID=$(lsblk -fn -o UUID $DATA_VOLUME_ID)
       OUTPUT=$(echo $DATA_VOLUME_UUID | grep -c - $2)
       echo $OUTPUT
@@ -41,4 +41,4 @@ if [ -n "$DATA_VOLUME_ID" ]; then
   else
     echo "Data volume is mounted, nothing changed"
   fi
-fi
+fi
diff --git a/lib/base/lib/assets/user-data/node.sh b/lib/base/lib/assets/user-data/node.sh
@@ -99,7 +99,7 @@ L1_EXECUTION_ENDPOINT=${_L1_EXECUTION_ENDPOINT_}
 L1_CONSENSUS_ENDPOINT=${_L1_CONSENSUS_ENDPOINT_}
 SNAPSHOT_URL=${_SNAPSHOT_URL_}
 
-{ 
+{
   echo "REGION=$REGION"
   echo "NETWORK_ID=$NETWORK_ID"
   echo "NODE_CONFIG=$NODE_CONFIG"
@@ -278,7 +278,7 @@ fi
 mkfs -t ext4 $DATA_VOLUME_ID
 echo "waiting for volume to get UUID"
   OUTPUT=0;
-  while [ "$OUTPUT" = 0 ]; do 
+  while [ "$OUTPUT" = 0 ]; do
     DATA_VOLUME_UUID=$(lsblk -fn -o UUID $DATA_VOLUME_ID)
     OUTPUT=$(echo $DATA_VOLUME_UUID | grep -c - $2)
     echo $OUTPUT
@@ -309,8 +309,8 @@ if [[ "$LIFECYCLE_HOOK_NAME" != "none" ]]; then
   echo "Signaling ASG lifecycle hook to complete"
   TOKEN=$(curl -s -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
   INSTANCE_ID=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" -s http://169.254.169.254/latest/meta-data/instance-id)
-  aws autoscaling complete-lifecycle-action --lifecycle-action-result CONTINUE --instance-id $INSTANCE_ID --lifecycle-hook-name "$LIFECYCLE_HOOK_NAME" --auto-scaling-group-name "$AUTOSCALING_GROUP_NAME"  --region $AWS_REGION
+  aws autoscaling complete-lifecycle-action --lifecycle-action-result CONTINUE --instance-id $INSTANCE_ID --lifecycle-hook-name "$LIFECYCLE_HOOK_NAME" --auto-scaling-group-name "$AUTOSCALING_GROUP_NAME"  --region $REGION
 fi
 
 echo "All Done!!"
-set -e
+set -e
diff --git a/lib/base/lib/config/baseConfig.interface.ts b/lib/base/lib/config/baseConfig.interface.ts
@@ -28,4 +28,4 @@ export interface BaseHAConfig {
     albHealthCheckGracePeriodMin: number;
     heartBeatDelayMin: number;
     numberOfNodes: number;
-}
+}
diff --git a/lib/base/sample-configs/.env-sample-archive b/lib/base/sample-configs/.env-sample-archive
@@ -33,4 +33,4 @@ BASE_SNAPSHOT_URL="none"                # Optionally provide the URL to download
 ## HA nodes configuration ##
 BASE_HA_NUMBER_OF_NODES="2"                                                       # Total number of RPC nodes to be provisioned. Default: 2
 BASE_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="300"                                    # Time enough to initialize the instance
-BASE_HA_NODES_HEARTBEAT_DELAY_MIN="1440"                                           # Time sufficient enough for a node do sync
+BASE_HA_NODES_HEARTBEAT_DELAY_MIN="1440"                                           # Time sufficient enough for a node do sync
diff --git a/lib/base/sample-configs/.env-sample-full b/lib/base/sample-configs/.env-sample-full
@@ -32,5 +32,5 @@ BASE_SNAPSHOT_URL="none"                # Optionally provide the URL to download
 
 ## HA nodes configuration ##
 BASE_HA_NUMBER_OF_NODES="2"                                                       # Total number of RPC nodes to be provisioned. Default: 2
-BASE_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="300"                                    # Time enough to initialize the instance
-BASE_HA_NODES_HEARTBEAT_DELAY_MIN="120"                                           # Time sufficient enough for a node do sync
+BASE_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="500"                                    # Time enough to initialize the instance
+BASE_HA_NODES_HEARTBEAT_DELAY_MIN="120"                                           # Time sufficient enough for a node do sync
diff --git a/lib/base/sample-configs/.env-sample-full-ha b/lib/base/sample-configs/.env-sample-full-ha
@@ -0,0 +1,36 @@
+#############################################################
+# Example configuration for Base nodes runner app on AWS  #
+#############################################################
+
+## Set the AWS account is and region for your environment ##
+AWS_ACCOUNT_ID="xxxxxxxx"
+AWS_REGION="us-east-1"
+
+## Common configuration parameters ##
+BASE_NETWORK_ID="mainnet"              # All options:  "mainnet", "sepolia"
+BASE_NODE_CONFIGURATION="full"         # All options: "full", "archive"
+BASE_INSTANCE_TYPE="m7g.2xlarge"       # Reconneded for Insance Store: i3en.3xlarge, "x86_64"
+BASE_CPU_TYPE="ARM_64"                 # All options: "x86_64", "ARM_64". IMPORTANT: Make sure the CPU type matches the instance type used
+
+# Data volume configuration
+BASE_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
+BASE_DATA_VOL_SIZE="4000"              # Current required data size in GB to keep both snapshot archive and unarchived version of it. For Sepolia 1000 will be sufficient.
+BASE_DATA_VOL_IOPS="5000"              # Max IOPS for EBS volumes (not applicable for "instance-store")
+BASE_DATA_VOL_THROUGHPUT="700"         # Max throughput for EBS gp3 volumes (not applicable for "io1" | "io2" | "instance-store")
+BASE_L1_EXECUTION_ENDPOINT="https://ethereum-sepolia-rpc.publicnode.com"        # Set your own URL to Ethereum L1 node: https://docs.base.org/tools/node-providers
+BASE_L1_CONSENSUS_ENDPOINT="https://ethereum-sepolia-beacon-api.publicnode.com"
+
+BASE_RESTORE_FROM_SNAPSHOT="true"      # Download snapshot to speed up statup time
+BASE_SNAPSHOT_URL="none"                # Optionally provide the URL to download snpashot: https://docs.base.org/tutorials/run-a-base-node/#snapshots
+
+# Example for Sepolia:
+#BASE_L1_EXECUTION_ENDPOINT=https://ethereum-sepolia-rpc.publicnode.com
+#BASE_L1_CONSENSUS_ENDPOINT=https://ethereum-sepolia-beacon-api.publicnode.com
+# Example for Mainnet and with Ethereum Blueprint with Geth-Lighthouse client combination and private IP:
+#BASE_L1_EXECUTION_ENDPOINT=http://172.31.15.220:8545
+#BASE_L1_CONSENSUS_ENDPOINT=http://172.31.15.220:5052
+
+## HA nodes configuration ##
+BASE_HA_NUMBER_OF_NODES="2"                                                       # Total number of RPC nodes to be provisioned. Default: 2
+BASE_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="500"                                    # Time enough to initialize the instance
+BASE_HA_NODES_HEARTBEAT_DELAY_MIN="120"                                           # Time sufficient enough for a node do sync
diff --git a/lib/base/test/.env-test b/lib/base/test/.env-test
@@ -31,4 +31,4 @@ BASE_L1_CONSENSUS_ENDPOINT=https://ethereum-sepolia-beacon-api.publicnode.com
 ## HA nodes configuration ##
 BASE_HA_NUMBER_OF_NODES="2"                                                       # Total number of RPC nodes to be provisioned. Default: 2
 BASE_HA_ALB_HEALTHCHECK_GRACE_PERIOD_MIN="300"                                    # Time enough to initialize the instance
-BASE_HA_NODES_HEARTBEAT_DELAY_MIN="120"                                           # Time sufficient enough for a node do sync
+BASE_HA_NODES_HEARTBEAT_DELAY_MIN="120"                                           # Time sufficient enough for a node do sync
diff --git a/lib/base/test/base-single-node.test.ts b/lib/base/test/base-single-node.test.ts
@@ -17,7 +17,7 @@ describe("BaseSingleNodeStack", () => {
     baseSingleNodeStack = new BaseSingleNodeStack(app, "base-single-node", {
       stackName: `base-single-node-${config.baseNodeConfig.baseNodeConfiguration}-${config.baseNodeConfig.baseNetworkId}`,
       env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
-    
+
       instanceType: config.baseNodeConfig.instanceType,
       instanceCpuType: config.baseNodeConfig.instanceCpuType,
       baseNetworkId: config.baseNodeConfig.baseNetworkId,
diff --git a/lib/base/test/ha-nodes-stack.test.ts b/lib/base/test/ha-nodes-stack.test.ts
@@ -14,7 +14,7 @@ describe("BaseHANodesStack", () => {
     const baseHANodesStack = new BaseHANodesStack(app, "base-sync-node", {
       stackName: `base-ha-nodes-${config.baseNodeConfig.baseNodeConfiguration}-${config.baseNodeConfig.baseNetworkId}`,
       env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
-    
+
       instanceType: config.baseNodeConfig.instanceType,
       instanceCpuType: config.baseNodeConfig.instanceCpuType,
       baseNetworkId: config.baseNodeConfig.baseNetworkId,
@@ -24,7 +24,7 @@ describe("BaseHANodesStack", () => {
       l1ConsensusEndpoint: config.baseNodeConfig.l1ConsensusEndpoint,
       snapshotUrl: config.baseNodeConfig.snapshotUrl,
       dataVolume: config.baseNodeConfig.dataVolume,
-    
+
       albHealthCheckGracePeriodMin: config.haNodeConfig.albHealthCheckGracePeriodMin,
       heartBeatDelayMin: config.haNodeConfig.heartBeatDelayMin,
       numberOfNodes: config.haNodeConfig.numberOfNodes
diff --git a/website/docs/Blueprints/Base.md b/website/docs/Blueprints/Base.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 10
 sidebar_label: Base
 ---
 #
