Merge pull request #26 from aws-samples/scroll

Add a new blueprint for Scroll Single-node deployment

Author: frbrkoala

.gitignore

@@ -34,3 +34,4 @@ ha-nodes-deploy*.json
 
 *.OLD
 .env
+.idea

docs/adding-new-nodes.md

@@ -31,4 +31,4 @@ First of all, THANK YOU! The easier it is to run a blockchain node on AWS the si
 - `lib/constructs/constants.ts` - Useful constants to use in configuration files and to set up infrastructure.
 - `lib/constructs/ha-rpc-nodes-with-alb.ts` - Provisions up to 4 identical EC2 instances to run nodes managed by an Auto Scaling Group and behind an Application Load Balancer.
 - `lib/constructs/single-node.ts` - Creates a single EC2 instance to run a blockchain node.
-- `lib/constructs/snapshots-bucket.ts` - Creates an S3 bucket to store a copy of blockchain node state to speed up syncing process.
+- `lib/constructs/snapshots-bucket.ts` - Creates an S3 bucket to store a copy of blockchain node state to speed up syncing process.

docs/pre-merge-tools.md

@@ -40,4 +40,4 @@ npm run install-pre-commit-mac
 
 # Run
 npm run run-pre-commit
-```
+```

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

@@ -0,0 +1,110 @@
+import * as cdk from "aws-cdk-lib";
+import * as cdkContructs from 'constructs';
+import * as cr from 'aws-cdk-lib/custom-resources';
+import * as configTypes from "./config.interface";
+import * as nag from "cdk-nag";
+
+export interface SingleNodeAMBEthereumConstructCustomProps {
+    instanceType: string,
+    availabilityZone: string,
+    ethNetworkId: configTypes.AMBEthereumNodeNetworkId,
+  }
+
+export class SingleNodeAMBEthereumConstruct extends cdkContructs.Construct {
+    public nodeId: string;
+    public rpcUrl: string;
+    public billingToken: string;
+    public rpcUrlWithBillingToken: string;
+
+
+    constructor(scope: cdkContructs.Construct, id: string, props: SingleNodeAMBEthereumConstructCustomProps) {
+      super(scope, id);
+
+      const REGION = cdk.Stack.of(this).region;
+      const {
+        instanceType,
+        availabilityZone,
+        ethNetworkId,
+      } = props;
+
+      const createNode = new cr.AwsCustomResource(this, 'createNode', {
+        onCreate: { // will be called for a CREATE event
+          service: 'ManagedBlockchain',
+          action: 'createNode',
+          parameters: {
+            NetworkId: `n-ethereum-${ethNetworkId}`,
+            NodeConfiguration: {
+              AvailabilityZone: availabilityZone,
+              InstanceType: instanceType
+            }
+          },
+          physicalResourceId: cr.PhysicalResourceId.of(Date.now().toString()), // Update physical id to always fetch the latest version
+        },
+        installLatestAwsSdk:true,
+        policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
+          resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
+        }),
+      });
+
+      const createAccessor = new cr.AwsCustomResource(this, 'createAccessor', {
+        onCreate: { // will be called for a CREATE event
+          service: 'ManagedBlockchain',
+          action: 'createAccessor',
+          parameters: {
+            AccessorType: 'BILLING_TOKEN'
+          },
+          physicalResourceId: cr.PhysicalResourceId.of(Date.now().toString()), // Update physical id to always fetch the latest version
+        },
+        installLatestAwsSdk:true,
+        policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
+          resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
+        }),
+      });
+
+      this.nodeId = createNode.getResponseField('NodeId');
+      this.rpcUrl = `https://${this.nodeId}.t.ethereum.managedblockchain.${REGION}.amazonaws.com`;
+      this.billingToken=createAccessor.getResponseField('BillingToken');
+      this.rpcUrlWithBillingToken = `${this.rpcUrl}?billingtoken=${this.billingToken}`;
+
+      const deleteAccessor = new cr.AwsCustomResource(this, 'deleteAccessor', {
+        onDelete: {
+          service: 'ManagedBlockchain',
+          action: 'deleteAccessor',
+          parameters: {
+            AccessorId: createAccessor.getResponseField('AccessorId'),
+          },
+        },
+        installLatestAwsSdk:true,
+        policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
+          resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
+        }),
+      });
+
+      const deleteNode = new cr.AwsCustomResource(this, 'deleteNode', {
+        onDelete: {
+          service: 'ManagedBlockchain',
+          action: 'deleteNode',
+          parameters: {
+            NetworkId: `n-ethereum-${ethNetworkId}`,
+            NodeId: this.nodeId,
+          },
+        },
+        installLatestAwsSdk:true,
+        policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
+          resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
+        }),
+      });
+
+    //   nag.NagSuppressions.addResourceSuppressions(
+    //     this,
+    //     [
+    //         {
+    //             id: "AwsSolutions-EC29",
+    //             reason: "Its Ok to terminate this instance as long as we have the data in the snapshot",
+
+    //         },
+    //     ],
+    //     true
+    // );
+    }
+  }

lib/constructs/config.interface.ts

@@ -28,3 +28,5 @@ export interface HaNodesConfig extends BaseNodeConfig {
     numberOfNodes: number;
     dataVolumes: DataVolumeConfig[];
 }
+
+export type AMBEthereumNodeNetworkId = "mainnet" | "goerli";

lib/scroll/.gitignore

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

lib/scroll/.npmignore

@@ -0,0 +1,6 @@
+*.ts
+!*.d.ts
+
+# CDK asset staging directory
+.cdk.staging
+cdk.out