Merge pull request #114 from aws-samples/stacks

Stacks

Author: frbrkoala

lib/stacks/README.md

@@ -142,7 +142,7 @@ echo "NODE_INTERNAL_IP=$NODE_INTERNAL_IP"
 
 ``` bash
 # IMPORTANT: Run from CloudShell VPC environment tab
-curl http://$NODE_INTERNAL_IP:20443/v2/info'
+curl http://$NODE_INTERNAL_IP:20443/v2/info
 ```
 
 You should get a response like this:
@@ -192,13 +192,13 @@ npx cdk deploy stacks-ha-nodes --json --outputs-file ha-nodes-deploy.json
 2. Give the new RPC nodes about 90 minutes to initialize and then run the following query against the load balancer behind the RPC node created
 
 ```bash
-export RPC_ABL_URL=$(cat ha-nodes-deploy.json | jq -r '..|.alburl? | select(. != null)')
+export RPC_ALB_URL=$(cat ha-nodes-deploy.json | jq -r '..|.alburl? | select(. != null)')
 echo RPC_ALB_URL=$RPC_ALB_URL
 ```
 
 ```bash
 # IMPORTANT: Run from CloudShell VPC environment tab
-curl http://$RPC_ABL_URL:20443/v2/info' | jq
+curl http://$RPC_ALB_URL:20443/v2/info | jq
 ```
 
 The result should show the status of the blockchain.

lib/stacks/lib/assets/build-binaries.sh

@@ -52,6 +52,7 @@ SOURCE_DIR="$PWD/$STACKS_REPO-$VERSION_TAG"
 
 # Build relevant source code
 cd "$SOURCE_DIR" || return
+cargo update
 cargo build --features monitoring_prom,slog_json --release --workspace
 
 sudo mkdir -p "$START_DIR/bin"

lib/stacks/lib/assets/download-binaries.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# shellcheck source=/dev/null
+source /etc/environment
+
+# Download
+STACKS_REPO="stacks-core"
+STACKS_ORG="stacks-network"
+START_DIR=$PWD
+STACKS_BINARIES_FILE_NAME="source.zip"
+
+# Install build dependencies.
+sudo yum update
+sudo yum -y install clang llvm git
+
+mkdir -p src && cd src || return
+
+if [ -z "$HOME" ]; then
+  # Set $HOME to /root. $HOME isn't set to be /root when this
+  # script first runs on the host.
+  export HOME="/root"
+  echo "HOME is not set. Setting it to /root."
+fi
+
+# Get tag for the latest version.
+echo "Getting the source for stable version $STACKS_VERSION"
+if [ "$STACKS_VERSION" = "latest" ]; then
+  echo "Aquiring tag for latest stable release."
+  VERSION_TAG=$(curl -sL https://api.github.com/repos/$STACKS_ORG/$STACKS_REPO/releases/latest | jq -r .tag_name)
+else
+  VERSION_TAG=$STACKS_VERSION
+fi
+
+arch=$(uname -m)
+
+echo "Architecture detected: $arch"
+echo "Fetching stacks latest code from stacks release $VERSION_TAG and architecture $arch"
+if [ "$arch" == "x86_64" ]; then
+  wget "https://github.com/$STACKS_ORG/$STACKS_REPO/releases/download/$VERSION_TAG/linux-glibc-x64.zip" -O $STACKS_BINARIES_FILE_NAME
+else
+  wget "https://github.com/$STACKS_ORG/$STACKS_REPO/releases/download/$VERSION_TAG/linux-glibc-arm64.zip" -O $STACKS_BINARIES_FILE_NAME
+fi
+
+unzip ./$STACKS_BINARIES_FILE_NAME -d $START_DIR/bin

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

@@ -34,6 +34,8 @@ CLOUD_ASSETS_PATH=/var/tmp/assets
   echo "DATA_VOLUME_SIZE=${_DATA_VOLUME_SIZE_}"
   echo "ASG_NAME=${_ASG_NAME_}"
   echo "LIFECYCLE_HOOK_NAME=${_LIFECYCLE_HOOK_NAME_}"
+  echo "BUILD_FROM_SOURCE=${_BUILD_FROM_SOURCE_}"
+  echo "DOWNLOAD_CHAINSTATE=${_DOWNLOAD_CHAINSTATE_}"
   # Place shared environment variables here.
   echo "DATA_VOLUME_PATH=$DATA_VOLUME_PATH"
   echo "CLOUD_ASSETS_PATH=$CLOUD_ASSETS_PATH"
@@ -149,26 +151,33 @@ lsblk
 
 # Build Binaries & Download Chainstate -----------------------------------------
 
-(
-  # Impropperly using the data volume path temporarily because it will have the
-  # space required to store the compressed chainstate.
-  sudo mkdir -p $DATA_VOLUME_PATH/tmp
-  wget -q "$STACKS_CHAINSTATE_ARCHIVE" \
-    -O "$DATA_VOLUME_PATH/tmp/chainstate.tar.gz"
-  tar -vxf "$DATA_VOLUME_PATH/tmp/chainstate.tar.gz" \
-    -C "$DATA_VOLUME_PATH"
-  rm -rf "$DATA_VOLUME_PATH/tmp"
-) &
-
-(
-  # build-binaries.sh will ensure that the working directory the script is called from
-  # has a ./src and a ./bin directory and will populate the ./src with the source code
-  # and the ./bin with the compiled binaries.
+if [[ "$DOWNLOAD_CHAINSTATE" = "true" ]]; then
+  (
+    # Impropperly using the data volume path temporarily because it will have the
+    # space required to store the compressed chainstate.
+    sudo mkdir -p $DATA_VOLUME_PATH/tmp
+    wget -q "$STACKS_CHAINSTATE_ARCHIVE" \
+      -O "$DATA_VOLUME_PATH/tmp/chainstate.tar.gz"
+    tar -vxf "$DATA_VOLUME_PATH/tmp/chainstate.tar.gz" \
+      -C "$DATA_VOLUME_PATH"
+    rm -rf "$DATA_VOLUME_PATH/tmp"
+  ) &
+fi
+
+if [[ "$BUILD_FROM_SOURCE" = "true" ]]; then
+  (
+    # build-binaries.sh will ensure that the working directory the script is called from
+    # has a ./src and a ./bin directory and will populate the ./src with the source code
+    # and the ./bin with the compiled binaries.
+    cd /usr/local || return
+    "$CLOUD_ASSETS_PATH"/build-binaries.sh
+  ) &
+else
   cd /usr/local || return
-  "$CLOUD_ASSETS_PATH"/build-binaries.sh
-) &
+  "$CLOUD_ASSETS_PATH"/download-binaries.sh
+fi
 
-wait # Wait for both background processes to finish
+wait # Wait for download or build or both to finish in background, if they were started
 
 # No new directories are made at this point; ensure that the stacks
 # user has all necessary permissions.

lib/stacks/lib/config/stacksConfig.interface.ts

@@ -27,6 +27,8 @@ export interface StacksBaseNodeConfig extends StacksNetworkConfig, configTypes.B
     stacksNodeConfiguration: StacksNodeConfiguration;
     stacksSignerSecretArn: string;
     stacksMinerSecretArn: string;
+    buildFromSource: boolean;
+    downloadChainstate: boolean;
     dataVolume: StacksVolumeConfig;
 }
 

lib/stacks/lib/config/stacksConfig.ts

@@ -40,6 +40,8 @@ export const baseNodeConfig: configTypes.StacksBaseNodeConfig = {
     stacksNetwork: stacksNetwork,
     stacksVersion: process.env.STACKS_VERSION || defaults.stacksVersion,
     stacksNodeConfiguration: <configTypes.StacksNodeConfiguration> process.env.STACKS_NODE_CONFIGURATION || defaults.stacksNodeConfiguration,
+    buildFromSource: process.env.STACKS_BUILD_FROM_SOURCE?.toLowerCase() === "true" ? true : defaults.buildFromSource,
+    downloadChainstate: process.env.STACKS_DOWNLOAD_CHAINSTATE?.toLowerCase() === "false" ? false : defaults.downloadChainstate,
     stacksBootstrapNode: process.env.STACKS_BOOTSTRAP_NODE || defaults.stacksBootstrapNode,
     stacksChainstateArchive: process.env.STACKS_CHAINSTATE_ARCHIVE || defaults.stacksChainstateArchive,
     stacksP2pPort: process.env.STACKS_P2P_PORT ? parseInt(process.env.STACKS_P2P_PORT) : defaults.stacksP2pPort,

lib/stacks/lib/config/stacksConfigDefaults.ts

@@ -63,6 +63,8 @@ export function stacksNodeConfigDefaults(
         stacksVersion: "latest",
         stacksSignerSecretArn: "none",
         stacksMinerSecretArn: "none",
+        buildFromSource: false,
+        downloadChainstate: true,
         dataVolume: defaultDataVolume,
         // High availability configs defaults.
         albHealthCheckGracePeriodMin: 10,

lib/stacks/lib/ha-nodes-stack.ts

@@ -31,6 +31,8 @@ export class StacksHANodesStack extends cdk.Stack {
             stacksNetwork,
             stacksVersion,
             stacksNodeConfiguration,
+            buildFromSource,
+            downloadChainstate,
             // Stacks networking
             stacksBootstrapNode,
             stacksChainstateArchive,
@@ -109,6 +111,8 @@ export class StacksHANodesStack extends cdk.Stack {
             _DATA_VOLUME_SIZE_: dataVolumeSizeBytes.toString(),
             _LIFECYCLE_HOOK_NAME_: lifecycleHookName,
             _ASG_NAME_: autoScalingGroupName,
+            _BUILD_FROM_SOURCE_: buildFromSource.toString(),
+            _DOWNLOAD_CHAINSTATE_: downloadChainstate.toString(),
         });
 
         // Path on the rpc port that will return a successful status code when the node

lib/stacks/lib/single-node-stack.ts

@@ -34,6 +34,8 @@ export class StacksSingleNodeStack extends cdk.Stack {
             stacksNetwork,
             stacksVersion,
             stacksNodeConfiguration,
+            buildFromSource,
+            downloadChainstate,
             // Stacks networking
             stacksBootstrapNode,
             stacksChainstateArchive,
@@ -123,6 +125,8 @@ export class StacksSingleNodeStack extends cdk.Stack {
             _ASSETS_S3_PATH_: `s3://${asset.s3BucketName}/${asset.s3ObjectKey}`,
             _LIFECYCLE_HOOK_NAME_: constants.NoneValue,
             _ASG_NAME_: constants.NoneValue,
+            _BUILD_FROM_SOURCE_: buildFromSource.toString(),
+            _DOWNLOAD_CHAINSTATE_: downloadChainstate.toString(),
         });
         node.instance.addUserData(modifiedInitNodeScript);
 

lib/stacks/sample-configs/.env-sample-follower

@@ -12,6 +12,8 @@ AWS_REGION="us-west-2"                                      # AWS region for dep
 # STACKS_INSTANCE_TYPE="m5.large"                             # The type of EC2 instance to use for the Stacks node
 # STACKS_CPU_TYPE="x86_64"                                    # CPU architecture: "x86_64", "ARM_64". IMPORTANT: Ensure compatibility with instance type
 # STACKS_VERSION="latest"                                     # Stacks node version to deploy. Use "latest" for the most recent version
+# STACKS_BUILD_FROM_SOURCE="true"                             # By default we download binaries from official GitHub. Uncomment to build from source.
+# STACKS_DOWNLOAD_CHAINSTATE="true"                            # Set to "false" to let the node sync data from block 0
 STACKS_NODE_CONFIGURATION="follower"                          # Node configuration type: "follower", "signer", "miner"
 # STACKS_BOOTSTRAP_NODE="..."                                 # Address of the bootstrap node for network connection
 # STACKS_CHAINSTATE_ARCHIVE="..."                             # Archive node for initial chain state.