Starknet. Refactoring and bug fixing

Author: Nikolay

lib/constructs/amb-ethereum-single-node.ts

@@ -13,8 +13,10 @@ export interface SingleNodeAMBEthereumConstructCustomProps {
 export class SingleNodeAMBEthereumConstruct extends cdkContructs.Construct {
     public nodeId: string;
     public rpcUrl: string;
+    public wssRpcUrl: string;
     public billingToken: string;
     public rpcUrlWithBillingToken: string;
+    public wssRpcUrlWithBillingToken: string;
 
 
     constructor(scope: cdkContructs.Construct, id: string, props: SingleNodeAMBEthereumConstructCustomProps) {
@@ -63,8 +65,10 @@ export class SingleNodeAMBEthereumConstruct extends cdkContructs.Construct {
 
       this.nodeId = createNode.getResponseField('NodeId');
       this.rpcUrl = `https://${this.nodeId}.t.ethereum.managedblockchain.${REGION}.amazonaws.com`;
+      this.wssRpcUrl = `wss://${this.nodeId}.wss.t.ethereum.managedblockchain.${REGION}.amazonaws.com`;
       this.billingToken=createAccessor.getResponseField('BillingToken');
-      this.rpcUrlWithBillingToken = `${this.rpcUrl}?billingtoken=${this.billingToken}`;
+      this.rpcUrlWithBillingToken = `${this.rpcUrl}/?billingtoken=${this.billingToken}`;
+      this.wssRpcUrlWithBillingToken = `${this.wssRpcUrl}/?billingtoken=${this.billingToken}`;
 
       const deleteAccessor = new cr.AwsCustomResource(this, 'deleteAccessor', {
         onDelete: {

lib/starknet/.npmignore

@@ -1,6 +1,11 @@
-*.ts
-!*.d.ts
+*.js
+!jest.config.js
+*.d.ts
+node_modules
 
 # CDK asset staging directory
 .cdk.staging
 cdk.out
+.idea
+
+*-node.json

lib/starknet/README.md

@@ -87,8 +87,16 @@ We will use AWS Cloud9 to execute the subsequent commands. Follow the instructio
    > cdk bootstrap aws://ACCOUNT-NUMBER/REGION
    > ```
 
+5. [OPTIONAL] If you are not planning to set your own `STARKNET_L1_ENDPOINT` URL, deploy Amazon Managed Blockchain (AMB) Access Ethereum node and wait about 35-70 minutes for the node to sync
 
-5. Deploy Starknet Full Node
+   ```bash
+   pwd
+   # Make sure you are in aws-blockchain-node-runners/lib/starknet
+   npx cdk deploy starknet-ethereum-l1-node --json --outputs-file starknet-ethereum-l1-node.json
+   ```
+   To watch the progress, open the [AMB Web UI](https://console.aws.amazon.com/managedblockchain/home), click the name of your target network from the list (Mainnet, Goerly, etc.) and watch the status of the node to change from `Creating` to `Available`.
+
+6. Deploy Starknet Full Node
 
    ```bash
    pwd
@@ -143,7 +151,9 @@ A script on the Starknet node publishes current block and blocks behind metrics
 
    # Undeploy Single Node
    npx cdk destroy starknet-single-node
-
+   
+   # Undeploy AMB Etheruem node
+   npx cdk destroy starknet-ethereum-l1-node
 
    # Delete all common components like IAM role and Security Group
    npx cdk destroy starknet-common

lib/starknet/app.ts

@@ -2,8 +2,10 @@
 import 'dotenv/config'
 import 'source-map-support/register';
 import * as cdk from 'aws-cdk-lib';
+import * as nag from "cdk-nag";
 import * as config from "./lib/config/starknetConfig";
 import {StarknetCommonStack} from "./lib/common-stack";
+import {StarknetAMBEthereumSingleNodeStack} from "./lib/amb-ethereum-single-node-stack";
 import {StarknetSingleNodeStack} from "./lib/single-node-stack";
 
 const app = new cdk.App();
@@ -14,8 +16,16 @@ new StarknetCommonStack(app, "starknet-common", {
   env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
 });
 
+new StarknetAMBEthereumSingleNodeStack(app, "starknet-ethereum-l1-node", {
+  stackName: `starknet-amb-ethereum-single-node-${config.baseNodeConfig.ambEntereumNodeNetworkId}`,
+  env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
+
+  ambEthereumNodeNetworkId: config.baseNodeConfig.ambEntereumNodeNetworkId,
+  ambEthereumNodeInstanceType: config.baseNodeConfig.ambEntereumNodeInstanceType,
+});
+
 new StarknetSingleNodeStack(app, "starknet-single-node", {
-  stackName: `starknet-single-node`,
+  stackName: `starknet-single-node-${config.baseNodeConfig.starknetNetworkId}`,
   env: { account: config.baseConfig.accountId, region: config.baseConfig.region },
 
   instanceType: config.baseNodeConfig.instanceType,
@@ -25,3 +35,12 @@ new StarknetSingleNodeStack(app, "starknet-single-node", {
   starknetL1Endpoint: config.baseNodeConfig.starknetL1Endpoint,
   starknetNodeVersion: config.baseNodeConfig.starknetNodeVersion,
 });
+
+// Security Check
+cdk.Aspects.of(app).add(
+    new nag.AwsSolutionsChecks({
+        verbose: false,
+        reports: true,
+        logIgnores: false,
+    })
+);

lib/starknet/lib/amb-ethereum-single-node-stack.ts

@@ -0,0 +1,60 @@
+import * as cdk from "aws-cdk-lib";
+import * as cdkConstructs from "constructs";
+import * as nag from "cdk-nag";
+import * as configTypes from "./config/starknetConfig.interface";
+import { SingleNodeAMBEthereumConstruct } from "../../constructs/amb-ethereum-single-node";
+
+export interface ScrollAMBEthereumSingleNodeStackProps extends cdk.StackProps {
+    ambEthereumNodeNetworkId: configTypes.AMBEthereumNodeNetworkId,
+    ambEthereumNodeInstanceType: string,
+}
+
+export class StarknetAMBEthereumSingleNodeStack extends cdk.Stack {
+    constructor(scope: cdkConstructs.Construct, id: string, props: ScrollAMBEthereumSingleNodeStackProps) {
+        super(scope, id, props);
+
+        // Setting up necessary environment variables
+        const availabilityZones = cdk.Stack.of(this).availabilityZones;
+        const chosenAvailabilityZone = availabilityZones.slice(0, 1)[0];
+
+        // Getting our config from initialization properties
+        const {
+            ambEthereumNodeNetworkId,
+            ambEthereumNodeInstanceType,
+        } = props;
+
+        // Setting up L1 Ethereum node with AMB Ethereum node construct
+
+        const ambEthereumNode = new SingleNodeAMBEthereumConstruct(this, "amb-ethereum-l1-single-node", {
+            instanceType: ambEthereumNodeInstanceType,
+            availabilityZone: chosenAvailabilityZone,
+            ethNetworkId: ambEthereumNodeNetworkId,
+        })
+
+        new cdk.CfnOutput(this, "amb-eth-node-id", {
+            value: ambEthereumNode.nodeId,
+            exportName: "AmbEthereumNodeId"
+        });
+
+        new cdk.CfnOutput(this, "amb-eth-node-rpc-url-billing-token", {
+            value: ambEthereumNode.wssRpcUrlWithBillingToken,
+            exportName: "AmbEthereumNodeRpcUrlWithBillingToken",
+        });
+        
+        // Adding suppressions to the stack
+        nag.NagSuppressions.addResourceSuppressions(
+            this,
+            [
+                {
+                    id: "AwsSolutions-IAM5",
+                    reason: "Need to create custom resources to Create and Delete AMB node and accessor and IAM policy to support a generic case for AMB resources",
+                },
+                {
+                    id: "AwsSolutions-IAM4",
+                    reason: "Need to create custom resources to Create and Delete AMB node and accessor and IAM to support ti",
+                },
+            ],
+            true
+        );
+    }
+}

lib/starknet/lib/assets/starknet/rpc-template.sh

@@ -1,9 +1,16 @@
 #!/bin/bash
+
+source /etc/environment
+
+# Get local IP
+TOKEN=$(curl -s -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
+export EC2_INTERNAL_IP=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" -s "http://169.254.169.254/latest/meta-data/local-ipv4")
+
 # Start Juno node
 /home/ubuntu/juno-source/build/juno \
-    --db-path "/home/ubuntu/juno-source/juno-datadir" \
+    --db-path "/data/juno" \
     --http \
-    --http-host 0.0.0.0 \
+    --http-host "${EC2_INTERNAL_IP}" \
     --http-port 6060 \
-    --network ${_STARKNET_NETWORK_ID_} \
-    --eth-node ${_STARKNET_L1_ENDPOINT_}
+    --network ${STARKNET_NETWORK_ID} \
+    --eth-node ${STARKNET_L1_ENDPOINT}

lib/starknet/lib/assets/sync-checker/syncchecker-starknet.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
+TOKEN=$(curl -s -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
+EC2_INTERNAL_IP=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" -s "http://169.254.169.254/latest/meta-data/local-ipv4")
+
 # Getting syncing status from Starknet node
-STARKNET_SYNC_STATS=$(curl -s -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"starknet_syncing","params":[],"id":1}' http://localhost:6060 | jq -r ".result")
+STARKNET_SYNC_STATS=$(curl -s -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"starknet_syncing","params":[],"id":1}' http://$EC2_INTERNAL_IP:6060 | jq -r ".result")
 
 if [[ "$STARKNET_SYNC_STATS" == "false" ]]; then
     echo "Node is fully synced. No syncing data available."
@@ -16,11 +19,11 @@ else
     echo "Highest Block: $STARKNET_HIGHEST_BLOCK"
 fi
 
-STARKNET_BLOCKS_BEHIND=$(($STARKNET_HIGHEST_BLOCK - $STARKNET_CURRENT_BLOCK))
+STARKNET_BLOCKS_BEHIND="$((STARKNET_HIGHEST_BLOCK-STARKNET_CURRENT_BLOCK))"
+
     echo "STARKNET_BLOCKS_BEHIND Block: $STARKNET_BLOCKS_BEHIND"
 
 # Sending data to CloudWatch
-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)
 REGION=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" -s http://169.254.169.254/latest/dynamic/instance-identity/document | jq .region -r)
 TIMESTAMP=$(date +"%Y-%m-%dT%H:%M:%S%z")

lib/starknet/lib/assets/user-data/node.sh

@@ -1,20 +1,23 @@
 #!/bin/bash
 set +e
 
-echo "AWS_REGION=${_AWS_REGION_}" >> /etc/environment
-echo "ASSETS_S3_PATH=${_ASSETS_S3_PATH_}" >> /etc/environment
-echo "STACK_NAME=${_STACK_NAME_}" >> /etc/environment
-echo "STACK_ID=${_STACK_ID_}" >> /etc/environment
-echo "RESOURCE_ID=${_NODE_CF_LOGICAL_ID_}" >> /etc/environment
-echo "DATA_VOLUME_TYPE=${_DATA_VOLUME_TYPE_}" >> /etc/environment
-echo "DATA_VOLUME_SIZE=${_DATA_VOLUME_SIZE_}" >> /etc/environment
-echo "STARKNET_NODE_VERSION=${_STARKNET_NODE_VERSION_}" >> /etc/environment
-echo "STARKNET_NETWORK_ID=${_STARKNET_NETWORK_ID_}" >> /etc/environment
-echo "STARKNET_L1_ENDPOINT=${_STARKNET_L1_ENDPOINT_}" >> /etc/environment
+{
+  echo "AWS_REGION=${_AWS_REGION_}"
+  echo "ASSETS_S3_PATH=${_ASSETS_S3_PATH_}"
+  echo "STACK_NAME=${_STACK_NAME_}"
+  echo "STACK_ID=${_STACK_ID_}"
+  echo "RESOURCE_ID=${_NODE_CF_LOGICAL_ID_}"
+  echo "DATA_VOLUME_TYPE=${_DATA_VOLUME_TYPE_}"
+  echo "DATA_VOLUME_SIZE=${_DATA_VOLUME_SIZE_}"
+  echo "STARKNET_NODE_VERSION=${_STARKNET_NODE_VERSION_}"
+  echo "STARKNET_NETWORK_ID=${_STARKNET_NETWORK_ID_}"
+  echo "STARKNET_L1_ENDPOINT=${_STARKNET_L1_ENDPOINT_}" 
+} >> /etc/environment
+
 source /etc/environment
 
-sudo apt-get -yqq update
-sudo apt-get -yqq install -y build-essential cargo pkg-config git upx-ucl libjemalloc-dev libjemalloc2 awscli jq unzip python3-pip
+apt-get -yqq update
+apt-get -yqq install -y build-essential cargo pkg-config git upx-ucl libjemalloc-dev libjemalloc2 awscli jq unzip python3-pip
 
 cd /opt
 
@@ -25,14 +28,14 @@ unzip -q assets.zip
 
 echo "Install and configure CloudWatch agent"
 wget -q https://s3.amazonaws.com/amazoncloudwatch-agent/ubuntu/amd64/latest/amazon-cloudwatch-agent.deb
-sudo dpkg -i -E amazon-cloudwatch-agent.deb
+dpkg -i -E amazon-cloudwatch-agent.deb
 
 echo 'Configuring CloudWatch Agent'
 mkdir -p /opt/aws/amazon-cloudwatch-agent/etc/
 cp /opt/cw-agent.json /opt/aws/amazon-cloudwatch-agent/etc/custom-amazon-cloudwatch-agent.json
 
 echo "Starting CloudWatch Agent"
-sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl \
+/opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl \
 -a fetch-config -c file:/opt/aws/amazon-cloudwatch-agent/etc/custom-amazon-cloudwatch-agent.json -m ec2 -s
 systemctl status amazon-cloudwatch-agent
 
@@ -68,30 +71,31 @@ echo "Waiting for volumes to be available"
 sleep 60
 
 echo "Install Juno Starknet agent"
-pwd
-whoami
+
 cd /home/ubuntu
-pwd
+
 git clone --branch $STARKNET_NODE_VERSION --single-branch https://github.com/NethermindEth/juno.git juno-source
 cd /home/ubuntu/juno-source
 
 echo "Preparing EBS Volume"
 DATA_VOLUME_ID=/dev/$(lsblk -lnb | awk -v VOLUME_SIZE_BYTES="$DATA_VOLUME_SIZE" '{if ($4== VOLUME_SIZE_BYTES) {print $1}}')
-sudo mkfs -t xfs $DATA_VOLUME_ID
+mkfs -t xfs $DATA_VOLUME_ID
 sleep 10
 DATA_VOLUME_UUID=$(lsblk -fn -o UUID  $DATA_VOLUME_ID)
-DATA_VOLUME_FSTAB_CONF="UUID=$DATA_VOLUME_UUID /home/ubuntu/juno-source/juno-datadir xfs defaults 0 2"
+DATA_VOLUME_FSTAB_CONF="UUID=$DATA_VOLUME_UUID /data xfs defaults 0 2"
 echo "DATA_VOLUME_ID="$DATA_VOLUME_ID
 echo "DATA_VOLUME_UUID="$DATA_VOLUME_UUID
 echo "DATA_VOLUME_FSTAB_CONF="$DATA_VOLUME_FSTAB_CONF
 echo $DATA_VOLUME_FSTAB_CONF | sudo tee -a /etc/fstab
-sudo mkdir "juno-datadir"
-sudo mount -a
+mkdir "/data"
+mkdir "/data/juno"
+mount -a
+chown ubuntu:ubuntu -R /data
 
 echo "Install Go 1.22 Version"
-sudo snap info go
-sudo snap install go --channel=1.22/stable --classic
-whereis go
+snap info go
+snap install go --channel=1.22/stable --classic
+
 export GOPATH=/snap/bin/go
 go env|grep CACHE
 sudo su - ubuntu
@@ -139,10 +143,26 @@ EOF'
 sudo systemctl daemon-reload
 sudo systemctl enable --now starknet
 
+# Configuring logrotate
+sudo bash -c 'sudo cat > logrotate.starkneterr <<EOF
+/var/log/starknet/error.log {
+  rotate 7
+  daily
+  missingok
+  postrotate
+    systemctl kill -s USR1 starknet.service
+  endscript
+}
+EOF'
+
+sudo cp logrotate.starkneterr /etc/logrotate.d/starkneterr
+sudo systemctl restart logrotate.service
+
 echo "Configuring syncchecker script"
 cd /opt
 sudo mv /opt/sync-checker/syncchecker-starknet.sh /opt/syncchecker.sh
 sudo chmod +x /opt/syncchecker.sh
 
-(crontab -l; echo "*/1 * * * * /opt/syncchecker.sh >/tmp/syncchecker.log 2>&1") | crontab -
+echo "*/5 * * * * /opt/syncchecker.sh" | crontab
 crontab -l
+echo "All done!"

lib/starknet/lib/config/starknetConfig.interface.ts

@@ -3,6 +3,8 @@ import * as configTypes from "../../../constructs/config.interface";
 export type StarknetNetworkId = "mainnet" | "sepolia" | "sepolia-integration";
 export type StarknetL1Endpoint = string;
 
+export {AMBEthereumNodeNetworkId} from "../../../constructs/config.interface";
+
 export interface StarknetDataVolumeConfig extends configTypes.DataVolumeConfig {
 }
 
@@ -13,6 +15,8 @@ export interface StarknetBaseConfig extends configTypes.BaseConfig {
 }
 
 export interface StarknetBaseNodeConfig extends configTypes.BaseNodeConfig {
+    ambEntereumNodeNetworkId: configTypes.AMBEthereumNodeNetworkId;
+    ambEntereumNodeInstanceType: string;
     starknetL1Endpoint: StarknetL1Endpoint;
     starknetNetworkId: StarknetNetworkId;
     starknetNodeVersion: string;

lib/starknet/lib/config/starknetConfig.ts

@@ -24,16 +24,17 @@ export const baseConfig: configTypes.StarknetBaseConfig = {
 }
 
 export const baseNodeConfig: configTypes.StarknetBaseNodeConfig = {    
-    
+    ambEntereumNodeNetworkId: <configTypes.AMBEthereumNodeNetworkId> process.env.AMB_ENTEREUM_NODE_NETWORK_ID || "mainnet",
+    ambEntereumNodeInstanceType: process.env.AMB_ETHEREUM_NODE_INSTANCE_TYPE || "bc.m5.xlarge",
     instanceType: new ec2.InstanceType(process.env.STARKNET_INSTANCE_TYPE ? process.env.STARKNET_INSTANCE_TYPE : "m6a.2xlarge"),
     instanceCpuType: ec2.AmazonLinuxCpuType.X86_64,
     starknetNetworkId: <configTypes.StarknetNetworkId> process.env.STARKNET_NETWORK_ID || "mainnet",
     starknetNodeVersion: process.env.STARKNET_NODE_VERSION || "v0.11.7",
-    starknetL1Endpoint: process.env.STARKNET_L1_ENDPOINT || "ws://eth-mainnet.rpc.nethermind.io/ws",
+    starknetL1Endpoint: process.env.STARKNET_L1_ENDPOINT || constants.NoneValue,
     dataVolume: {
         sizeGiB: process.env.STARKNET_DATA_VOL_SIZE ? parseInt(process.env.STARKNET_DATA_VOL_SIZE): 250,
         type: parseDataVolumeType(process.env.STARKNET_DATA_VOL_TYPE?.toLowerCase() ? process.env.STARKNET_DATA_VOL_TYPE?.toLowerCase() : "gp3"),
         iops: process.env.STARKNET_DATA_VOL_IOPS ? parseInt(process.env.STARKNET_DATA_VOL_IOPS): 3000,
-        throughput: process.env.STARKNET_DATA_VOL_THROUGHPUT ? parseInt(process.env.STARKNET_DATA_VOL_THROUGHPUT): 700,
+        throughput: process.env.STARKNET_DATA_VOL_THROUGHPUT ? parseInt(process.env.STARKNET_DATA_VOL_THROUGHPUT): 250,
     },
 };