BSC unit tests done

vlasonfa · vlasonfa · commit aed4ea987e3c · 2024-02-01T14:41:50.000+11:00
diff --git a/lib/bsc/README.md b/lib/bsc/README.md
@@ -1,8 +1,8 @@
 # Sample AWS Blockchain Node Runner app for BNB Smart Chain(BSC) Nodes
 
-BNB Smart Chain, BSC for shot, is a blockchain that supports EVM-compatible smart contracts and protocols. It utilizes the [Proof of Stake Authority(PoSA)](https://docs.bnbchain.org/docs/learn/intro#proof-of-staked-authority) consensus mechanism, which is a hybrid consensus mechanism based on a combination of [Proof of Authority (PoA)](https://en.wikipedia.org/wiki/Proof_of_authority) and [Delegated Proof of Stake (DPoS)](https://bitcoinwiki.org/wiki/DPoS).
+BNB Smart Chain (BSC), is a blockchain that supports EVM-compatible smart contracts and protocols. It utilizes the [Proof of Stake Authority(PoSA)](https://docs.bnbchain.org/docs/learn/intro#proof-of-staked-authority) consensus mechanism, which is a hybrid consensus mechanism based on a combination of [Proof of Authority (PoA)](https://en.wikipedia.org/wiki/Proof_of_authority) and [Delegated Proof of Stake (DPoS)](https://bitcoinwiki.org/wiki/DPoS).
 
-This blueprint is designed to assist in deploying a High Availability (HA) BNB Smart Chain (BSC) Fullnode on AWS. It is intended for use in development, testing, or Proof of Concept purposes. Learn more information about configuring the [Run A Fullnode on BNB Smart Chain](https://docs.bnbchain.org/docs/validator/fullnode), the following provides detailed information on High Availability deployment settings.
+This blueprint is designed to assist in deploying a single node or a Highly Available (HA) [BNB Smart Chain (BSC) Fullnode](https://docs.bnbchain.org/docs/validator/fullnode/) on AWS. It is intended for use in development, testing, or Proof of Concept purposes.
 
 ## Overview of Deployment Architectures for HA setups
 
@@ -116,27 +116,27 @@ npm install
 
 ### Option 1: Single RPC Node
 
-1. Deploying a BSC Fullnode node typically takes about 2-3 hours. The Fullnode uses snapshots data, and downloading and decompressing the data can take a considerable amount of time. You can grab a cup of coffee☕️ and patiently wait during this process. After deployment, you'll need to wait for the node to synchronize with the BSC Blockchain Network.
+1. The inital deployment a BSC full node and dwonloading 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. After deployment, you'll need to wait for the node to synchronize with the BSC Blockchain Network (next step).
 
    ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/bsc
-   npx cdk deploy bsc-single-node --json --outputs-file single-node.json
+      pwd
+      # Make sure you are in aws-blockchain-node-runners/lib/bsc
+      npx cdk deploy bsc-single-node --json --outputs-file single-node.json
    ```
 
-2. Give the new RPC nodes about few hours to initialize and then run the following query against the load balancer behind the RPC node created
+2. After the node is initialised from the snapshot you need to wait from another half a day to a day for the inital syncronization process to finish. The time depends on how fresh the snapshot was. You can use Amazon CloudWatch to track the progress. There is a script that publishes CloudWatch metrics every 5 minutes, where you can watch `sync distance` for consensus client and `blocks behind` for execution client. When the node is fully synced those two metrics shold show 0. To see them:
 
-   ```bash
-   INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
-   NODE_INTERNAL_IP=$(aws ec2 describe-instances --instance-ids $INSTANCE_ID --query 'Reservations[*].Instances[*].PrivateIpAddress' --output text)
+    - Navigate to [CloudWatch service](https://console.aws.amazon.com/cloudwatch/) (make sure you are in the region you have specified for `AWS_REGION`)
+    - Open `Dashboards` and select `bsc-single-node-<node_configuration>-<your_bsc_network>-<ec2_instance_id>` from the list of dashboards.
 
-   ```
-   
-   Check [Geth Syncing](https://geth.ethereum.org/docs/fundamentals/logs#syncing) Status:
+Alternatively, you can manually check [Geth Syncing Status](https://geth.ethereum.org/docs/fundamentals/logs#syncing). Run the following query from within the same VPC and against the private IP of the single RPC node you deployed:
 
    ```bash
-   curl http://$NODE_INTERNAL_IP:8545 -X POST -H "Content-Type: application/json" \
-   --data '{ "jsonrpc": "2.0", "id": 1, "method": "eth_syncing", "params": []}'
+      INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+      NODE_INTERNAL_IP=$(aws ec2 describe-instances --instance-ids $INSTANCE_ID --query 'Reservations[*].Instances[*].PrivateIpAddress' --output text)
+      
+      curl http://$NODE_INTERNAL_IP:8545 -X POST -H "Content-Type: application/json" \
+      --data '{ "jsonrpc": "2.0", "id": 1, "method": "eth_syncing", "params": []}'
    ```
 
    It will return `false` if the node is in sync. If `eth_syncing` returns anything other than false it has not finished syncing. Generally, if syncing is still ongoing, `eth_syncing` will return block info that looks as follows:
@@ -165,24 +165,40 @@ npm install
    }
    ```
 
+3. Once the initial synchronization is done, you should be able to access the RPC API of that node from within the same VPC. The RPC port is not exposed to the Internet. Run the following query against the private IP of the single RPC node you deployed:
+
+   ```bash
+      INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+      NODE_INTERNAL_IP=$(aws ec2 describe-instances --instance-ids $INSTANCE_ID --query 'Reservations[*].Instances[*].PrivateIpAddress' --output text)
+
+      # We query token balance of one of the system contracts: https://bscscan.com/address/0x0000000000000000000000000000000000001006
+      curl http://$NODE_INTERNAL_IP:8545 -X POST -H "Content-Type: application/json" \
+      --data '{"method":"eth_getBalance","params":["0x0000000000000000000000000000000000001006", "latest"],"id":1,"jsonrpc":"2.0"}'
+   ```
+   You will get a response similar to this:
+
+   ```json
+      {"jsonrpc":"2.0","id":1,"result":"0x3635c9adc5dea00000"}
+   ```
+
 ### Option 2: Highly Available RPC Nodes
 
-1. Deploy a BSC Fullnode node typically takes about 2-3 hours. The Fullnode uses snapshots data, and downloading and decompressing the data can take a considerable amount of time. You can grab a cup of coffee☕️ and patiently wait during this process. After deployment, you'll need to wait for the node to synchronize with the BSC Blockchain Network.
+1. The inital deployment a BSC full node and dwonloading 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. After deployment, you'll need to wait for your another half a day to a day for your nodes to synchronize with the BSC Blockchain Network, depending on how fresh the snapshot was.
 
    ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/bsc
-   npx cdk deploy bsc-ha-nodes --json --outputs-file ha-nodes-deploy.json
+      pwd
+      # Make sure you are in aws-blockchain-node-runners/lib/bsc
+      npx cdk deploy bsc-ha-nodes --json --outputs-file ha-nodes-deploy.json
    ```
 
 2. Give the new RPC nodes about few 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 '.["bsc-ha-nodes-full"].alburl? | select(. != null)')
-   echo $RPC_ALB_URL
+      export RPC_ALB_URL=$(cat ha-nodes-deploy.json | jq -r '.["bsc-ha-nodes-full"].alburl? | select(. != null)')
+      echo $RPC_ALB_URL
    ```
    
-   Check [Geth Syncing](https://geth.ethereum.org/docs/fundamentals/logs#syncing) Status:
+   Periodically check [Geth Syncing Status](https://geth.ethereum.org/docs/fundamentals/logs#syncing). Run the following query from within the same VPC and against the private IP of the load balancer fronting your nodes:
 
    ```bash
    curl http://$RPC_ALB_URL:8545 -X POST -H "Content-Type: application/json" \
@@ -217,6 +233,22 @@ npm install
 
 **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.
 
+3. Once the initial synchronization is done, you should be able to access the RPC API of that node from within the same VPC. The RPC port is not exposed to the Internet. Run the following query against the private IP of the single RPC node you deployed:
+
+   ```bash
+      export RPC_ALB_URL=$(cat ha-nodes-deploy.json | jq -r '.["bsc-ha-nodes-full"].alburl? | select(. != null)')
+      echo $RPC_ALB_URL
+
+      # We query token balance of one of the system contracts: https://bscscan.com/address/0x0000000000000000000000000000000000001006
+      curl http://$RPC_ALB_URL:8545 -X POST -H "Content-Type: application/json" \
+      --data '{"method":"eth_getBalance","params":["0x0000000000000000000000000000000000001006", "latest"],"id":1,"jsonrpc":"2.0"}'
+   ```
+   You will get a response similar to this:
+
+   ```json
+      {"jsonrpc":"2.0","id":1,"result":"0x3635c9adc5dea00000"}
+   ```
+
 ### Clearing up and undeploy everything
 
 1. Undeploy HA Nodes, Single Nodes and Common stacks
diff --git a/lib/bsc/app.ts b/lib/bsc/app.ts
@@ -17,7 +17,7 @@ new BscCommonStack(app, "bsc-common", {
 });
 
 new BscSingleNodeStack(app, "bsc-single-node", {
-    stackName: `bsc-single-node`,
+    stackName: `bsc-single-node-${config.baseNodeConfig.nodeConfiguration}-${config.baseNodeConfig.bscNetwork}`,
 
     env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
     nodeRole: <configTypes.BscNodeRole> "single-node",
@@ -29,7 +29,7 @@ new BscSingleNodeStack(app, "bsc-single-node", {
 });
 
 new BscHANodesStack(app, "bsc-ha-nodes", {
-    stackName: `bsc-ha-nodes-${config.baseNodeConfig.nodeConfiguration}`,
+    stackName: `bsc-ha-nodes-${config.baseNodeConfig.nodeConfiguration}-${config.baseNodeConfig.bscNetwork}`,
     env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
     nodeRole: <configTypes.BscNodeRole> "rpc-node",
     instanceType: config.baseNodeConfig.instanceType,
diff --git a/lib/bsc/lib/assets/user-data/node.sh b/lib/bsc/lib/assets/user-data/node.sh
@@ -90,9 +90,9 @@ else
   chmod -v u+x geth
 fi
 
-# download mainnet configuration
-wget $(curl -s https://api.github.com/repos/bnb-chain/bsc/releases/latest |grep browser_ |grep mainnet |cut -d\" -f4)
-unzip mainnet.zip
+# download network configuration
+wget $(curl -s https://api.github.com/repos/bnb-chain/bsc/releases/latest |grep browser_ |grep $BSC_NETWORK |cut -d\" -f4)
+unzip $BSC_NETWORK.zip
 
 # install aria2 a p2p downloader
 
@@ -181,7 +181,7 @@ fi
 
 lsblk -d
 
-echo "Downloading BSC snapshots from 46Club."
+echo "Downloading BSC snapshot from 46Club."
 
 cd /data
 
@@ -214,20 +214,20 @@ do
                         ;;
         esac
 done
-echo "Downloading BSC snapshots from 46Club succeed"
+echo "Downloading BSC snapshot from 46Club succeed"
 
 sleep 60
 # take about 2 hours to decompression the bsc snapshot
-echo "Decompression BSC snapshots start ..."
+echo "Decompression BSC snapshot start ..."
 
 zstd -cd geth.tar.zst | pv | tar xvf - 2>&1 | tee unzip.log && echo "decompression success..." || echo "decompression failed..." >> bsc-snapshots-decompression.log
-echo "Decompression BSC snapshots success ..."
+echo "Decompression BSC snapshot success ..."
 
 mv /data/geth.full/geth /data/
 sudo rm -rf /data/geth.full
 sudo rm -rf /data/geth.tar.zst
 
-echo "BSC snapshots is ready !!!"
+echo "BSC snapshot is ready !!!"
 
 chown bcuser:bcuser -R /data
 
diff --git a/lib/bsc/lib/single-node-stack.ts b/lib/bsc/lib/single-node-stack.ts
@@ -115,7 +115,7 @@ export class BscSingleNodeStack extends cdk.Stack {
         })
 
         new cw.CfnDashboard(this, 'single-cw-dashboard', {
-            dashboardName: STACK_NAME,
+            dashboardName: `${STACK_NAME}-${node.instanceId}`,
             dashboardBody: dashboardString,
         });
 
diff --git a/lib/bsc/test/ha-nodes-stack.test.ts b/lib/bsc/test/ha-nodes-stack.test.ts
@@ -3,6 +3,7 @@ import * as cdk from "aws-cdk-lib";
 import * as dotenv from 'dotenv';
 dotenv.config({ path: './test/.env-test' });
 import * as config from "../lib/config/bscConfig";
+import * as configTypes from "../lib/config/bscConfig.interface";
 import { BscHANodesStack } from "../lib/ha-nodes-stack";
 
 describe("BscHANodesStack", () => {
@@ -13,6 +14,7 @@ describe("BscHANodesStack", () => {
     const bscHANodesStack = new BscHANodesStack(app, "bsc-sync-node", {
     stackName: `bsc-ha-nodes-${config.baseNodeConfig.nodeConfiguration}`,
     env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
+    nodeRole: <configTypes.BscNodeRole> "rpc-node",
 
     instanceType: config.baseNodeConfig.instanceType,
     instanceCpuType: config.baseNodeConfig.instanceCpuType,
@@ -40,30 +42,30 @@ describe("BscHANodesStack", () => {
         }
        ],
        SecurityGroupIngress: [
-         {
+        {
           "CidrIp": "0.0.0.0/0",
-          "Description": "P2P protocols (gossip, turbine, repair, etc)",
+          "Description": "P2P",
           "FromPort": 30303,
           "IpProtocol": "tcp",
           "ToPort": 30303
          },
          {
           "CidrIp": "0.0.0.0/0",
-          "Description": "P2P protocols (gossip, turbine, repair, etc)",
+          "Description": "P2P",
           "FromPort": 30303,
           "IpProtocol": "udp",
           "ToPort": 30303
          },
          {
           "CidrIp": "1.2.3.4/5",
-          "Description": "RPC port HTTP (user access needs to be restricted. Allowed access only from internal IPs)",
+          "Description": "BSC RPC Port",
           "FromPort": 8545,
           "IpProtocol": "tcp",
           "ToPort": 8545
          },
          {
           "CidrIp": "1.2.3.4/5",
-          "Description": "RPC port WebSocket (user access needs to be restricted. Allowed access only from internal IPs)",
+          "Description": "BSC WebSocket Port",
           "FromPort": 8546,
           "IpProtocol": "tcp",
           "ToPort": 8546
@@ -72,20 +74,25 @@ describe("BscHANodesStack", () => {
           "Description": "Allow access from ALB to Blockchain Node",
           "FromPort": 0,
           "IpProtocol": "tcp",
-          "SourceSecurityGroupId": Match.anyValue(),
+          "SourceSecurityGroupId": {
+           "Fn::GetAtt": [
+            Match.anyValue(),
+            "GroupId"
+           ]
+          },
           "ToPort": 65535
          },
        ]
     })
 
     // Has security group from ALB to EC2.
     template.hasResourceProperties("AWS::EC2::SecurityGroupIngress", {
-      Description: Match.anyValue(),
-      FromPort: 8845,
+      Description: "Load balancer to target",
+      FromPort: 8545,
       GroupId: Match.anyValue(),
       IpProtocol: "tcp",
       SourceSecurityGroupId: Match.anyValue(),
-      ToPort: 8845,
+      ToPort: 8545,
     })
 
     // Has launch template profile for EC2 instances.
@@ -123,7 +130,7 @@ describe("BscHANodesStack", () => {
          EbsOptimized: true,
          IamInstanceProfile: Match.anyValue(),
          ImageId: Match.anyValue(),
-         InstanceType:"m7i.4xlarge",
+         InstanceType:"m7g.4xlarge",
          SecurityGroupIds: [Match.anyValue()],
          UserData: Match.anyValue(),
          TagSpecifications: Match.anyValue(),
@@ -165,9 +172,9 @@ describe("BscHANodesStack", () => {
       {
         "CidrIp": "1.2.3.4/5",
         "Description": "Blockchain Node RPC",
-        "FromPort": 8845,
+        "FromPort": 8545,
         "IpProtocol": "tcp",
-        "ToPort": 8845
+        "ToPort": 8545
       }
       ],
       VpcId: Match.anyValue(),
@@ -213,21 +220,21 @@ describe("BscHANodesStack", () => {
         }
        ],
        LoadBalancerArn: Match.anyValue(),
-       Port: 8899,
+       Port: 8545,
        Protocol: "HTTP"
     })
 
     // Has ALB target group.
     template.hasResourceProperties("AWS::ElasticLoadBalancingV2::TargetGroup", {
       HealthCheckEnabled: true,
       HealthCheckIntervalSeconds: 30,
-      HealthCheckPath: "/health",
-      HealthCheckPort: "8845",
+      HealthCheckPath: "/",
+      HealthCheckPort: "8545",
       HealthyThresholdCount: 3,
       Matcher: {
       HttpCode: "200-299"
       },
-      Port: 8845,
+      Port: 8545,
       Protocol: "HTTP",
       TargetGroupAttributes: [
       {
diff --git a/lib/bsc/test/single-node-stack.test.ts b/lib/bsc/test/single-node-stack.test.ts
