README - Aptos Core — ContextQMD

Run on AWS

This guide assumes you already have AWS account setup.

Install pre-requisites if needed:

Aptos CLI: https://github.com/aptos-labs/aptos-core/releases/tag/aptos-cli-v0.1.0-alpha
Terraform 1.1.7: https://www.terraform.io/downloads.html
Kubernetes CLI: https://kubernetes.io/docs/tasks/tools/
AWS CLI: https://aws.amazon.com/cli/

Create a working directory for your configuration.
- Choose a workspace name e.g. testnet. Note: This defines Terraform workspace name, which in turn is used to form resource names.
```
$ export WORKSPACE=testnet
```
- Create a directory for the workspace
```
$ mkdir -p ~/$WORKSPACE
```
Create a S3 storage bucket for storing the Terraform state on AWS, you can do this on AWS UI or by the command:
```
$ aws s3api create-bucket --bucket <bucket name> --region <region name>
```
Create Terraform file called main.tf in your working directory:

$ cd ~/$WORKSPACE
$ touch main.tf

Modify main.tf file to configure Terraform, and create fullnode from Terraform module. Example content for main.tf:

variable "region" {
  type    = string
  default = <aws region> # pick a region
}

terraform {
  required_version = "~> 1.2.0"
  backend "s3" {
    bucket = "terraform.aptos-node"
    key    = "state/aptos-node"
    region = var.region
  }
}

provider "aws" {
  region = var.region
}

module "aptos-node" {
  # download Terraform module from aptos-labs/aptos-core repo
  source        = "github.com/aptos-labs/aptos-core.git//terraform/aptos-node/aws?ref=main"
  region        = var.region  # Specify the region
  # zone_id     = "<Route53 zone id>"  # zone id for Route53 if you want to use DNS
  era           = 1              # bump era number to wipe the chain
  chain_id      = 5
  image_tag     = "testnet" # Specify the docker image tag to use
  validator_name = "<Name of Your Validator>"
}

For the full customization options, see the variables file here, and the helm values.

Initialize Terraform in the same directory of your main.tf file

$ terraform init

This will download all the terraform dependencies for you, in the .terraform folder in your current working directory.

Create a new Terraform workspace to isolate your environments:

$ terraform workspace new $WORKSPACE
# This command will list all workspaces
$ terraform workspace list

Apply the configuration.

$ terraform apply

This might take a while to finish (~20 minutes), Terraform will create all the resources on your cloud account.

Once terraform apply finishes, you can check if those resources are created:
- aws eks update-kubeconfig --name aptos-$WORKSPACE to configure access for your k8s cluster.
- kubectl get pods this should have haproxy, validator and fullnode. with validator and fullnode pod pending (require further action in later steps)
- kubectl get svc this should have validator-lb and fullnode-lb, with an external-IP you can share later for connectivity.

Get your node IP info:

$ export VALIDATOR_ADDRESS="$(kubectl get svc ${WORKSPACE}-aptos-node-validator-lb --output jsonpath='{.status.loadBalancer.ingress[0].hostname}')"

$ export FULLNODE_ADDRESS="$(kubectl get svc ${WORKSPACE}-aptos-node-fullnode-lb --output jsonpath='{.status.loadBalancer.ingress[0].hostname}')"

Generate key pairs (node owner key, consensus key and networking key) in your working directory.
```
$ aptos genesis generate-keys --output-dir ~/$WORKSPACE
```
This will create three files: private-keys.yaml, validator-identity.yaml, validator-full-node-identity.yaml for you. Backup your key files somewhere safe, this is important for you to establish ownership of your node, and it will be used to claim your rewards later if eligible. Very important!!

Configure validator information.

$ aptos genesis set-validator-configuration --keys-dir ~/$WORKSPACE --local-repository-dir ~/$WORKSPACE --username <pick a username for your node> --validator-host $VALIDATOR_ADDRESS:6180 --full-node-host $FULLNODE_ADDRESS:6182

This will create a YAML file in your working directory with your username, e.g. aptosbot.yaml, it should looks like below:

---
account_address: 7410973313fd0b5c69560fd8cd9c4aaeef873f869d292d1bb94b1872e737d64f
consensus_key: "0x4e6323a4692866d54316f3b08493f161746fda4daaacb6f0a04ec36b6160fdce"
account_key: "0x83f090aee4525052f3b504805c2a0b1d37553d611129289ede2fc9ca5f6aed3c"
network_key: "0xa06381a17b090b8db5ffef97c6e861baad94a1b0e3210e6309de84c15337811d"
validator_host:
  host: 30247cc34f270cb8.elb.us-west-2.amazonaws.com
  port: 6180
full_node_host:
  host: abc5b9734d4cc418.elb.us-west-2.amazonaws.com
  port: 6182
stake_amount: 1

Create layout YAML file, which defines the node in the validatorSet. For test mode, we can create a genesis blob containing only one node.
```
$ vi layout.yaml
```
Add root key, node username, and chain_id in the layout.yaml file, for example:
```
---
root_key: "0x5243ca72b0766d9e9cbf2debf6153443b01a1e0e6d086c7ea206eaf6f8043956"
users:
  - <username you created in step 5>
chain_id: 5
```
Download AptosFramework Move bytecodes into a folder named framework.

Download the Aptos Framework from the release page: https://github.com/aptos-labs/aptos-core/releases/tag/aptos-framework-v0.1.0
```
$ unzip framework.zip
```
You should now have a folder called framework, which contains move bytecodes with format .mv.
Compile genesis blob and waypoint
```
$ aptos genesis generate-genesis --local-repository-dir ~/$WORKSPACE --output-dir ~/$WORKSPACE
```
This should create two files in your working directory, genesis.blob and waypoint.txt
To re-cap, in your working directory, you should have a list of files:
- private-keys.yaml Private keys for owner account, consensus, networking
- validator-identity.yaml Private keys for setting validator identity
- validator-full-node-identity.yaml Private keys for setting validator full node identity
- <username>.yaml Node info for both validator / fullnode
- layout.yaml layout file to define root key, validator user, and chain ID
- framework folder which contains all the move bytecode for AptosFramework.
- waypoint.txt waypoint for genesis transaction
- genesis.blob genesis binary contains all the info about framework, validatorSet and more.

Insert genesis.blob, waypoint.txt and the identity files as secret into k8s cluster.

$ kubectl create secret generic ${WORKSPACE}-aptos-node-genesis-e1 \
    --from-file=genesis.blob=genesis.blob \
    --from-file=waypoint.txt=waypoint.txt \
    --from-file=validator-identity.yaml=validator-identity.yaml \
    --from-file=validator-full-node-identity.yaml=validator-full-node-identity.yaml

If you changed the era number, make sure it matches when creating the secret.

Check all pods running.

$ kubectl get pods

NAME                                        READY   STATUS    RESTARTS   AGE
node1-aptos-node-fullnode-e9-0              1/1     Running   0          4h31m
node1-aptos-node-haproxy-7cc4c5f74c-l4l6n   1/1     Running   0          4h40m
node1-aptos-node-validator-0                1/1     Running   0          4h30m