Haven1 Validator

Welcome to the Haven1 Validator repository! This repository serves as a guide for validators to run validators on Haven1.

This repository uses Docker and Docker Compose as its base. Here is the Installation Guide for Docker and Docker Compose.

Summary

This guide will walk you through the process of spinning up a Haven1 Validator and Archive Node on AWS.
We will create all the infrastructure required to run the validator and archive node.
We will install the required packages and setup the validator and archive node.
Share the infroamtion with the haven1 team so we can add the nodes to the haven1 network.

Infra Setup

Open the AWS CloudShell

Install Terraform

sudo yum install -y yum-utils

sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/AmazonLinux/hashicorp.repo

sudo yum -y install terraform

terraform -help

Download the Terraform setup and unzip

wget https://github.com/haven1network/haven1-validator-docs/releases/download/v1.0.0/validator.tgz

tar -xvzf validator.tar.gz

cd validator-terraform

Add your configs to the validator.tf

module "validator" {
    source          = "./modules/validator"
    name            = "<YOUR ORGANISATION NAME HERE>"
    subnet_id       = "<YOUR SUBNET HERE>"
}

Add your region to the provider.tf

provider "aws" {
    region = "<YOUR REGION HERE>"
}

Test your infra setup
```
terraform init
```
```
terraform plan
```
In case of any issues during step 6, please reach out to the Haven1 Team
Install the infra setup
```
terraform apply
```
In case of any issues during step 7, please reach out to the Haven1 Team

Setup Validator and Archive Instance

Validator Hardware Requirements

AWS (t3.large)

CPU: 2 vCPU cores
Memory: 8 GB
OS Storage: 100 GB
Data Storage 150 GB

Prerequisites

Get the following file from the Haven1 Team

genesis.base64 (base 64 encoded)
link for cosigner image

Provide the address where you would like your rewards to be sent (Haven1 Team)

Initial Setup and Key Generation for Validator Instance

Connect to the validator instance with EC2 Instance Connect and run the following commands

Install the following packages on your "validator" machine:

sudo -s

sudo yum install -y git
sudo yum install -y docker
sudo mkdir -p /usr/local/lib /usr/local/lib/docker/cli-plugins
sudo curl -SL https://github.com/docker/compose/releases/download/v2.28.1/docker-compose-linux-x86_64 -o /usr/local/lib/docker/cli-plugins/docker-compose
sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
sudo systemctl start docker
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
source ~/.bashrc
nvm install 20
nvm use 20
sudo groupadd docker
sudo usermod -aG docker $USER

mkdir -p data
sudo mkfs -t xfs /dev/nvme1n1
sudo mount /dev/nvme1n1 data
UUID=$(sudo blkid -s UUID -o value /dev/nvme1n1)
echo "UUID=$UUID  $(pwd)/data  xfs  defaults,nofail  0  2" >> /etc/fstab

sudo fallocate -l 32G /swapfile
sudo chmod 600 /swapfile
sudo mkswap /swapfile
sudo swapon /swapfile
swapon --show
echo "/swapfile   swap    swap    defaults        0   0" >> /etc/fstab

Run the following code to verify if step 1 worked correctly

sudo docker version
docker compose version
nvm --version
node --version

The output should look similar to this

Client:
Version:           25.0.5
API version:       1.44
Go version:        go1.22.5
Git commit:        5dc9bcc
Built:             Wed Aug 21 00:00:00 2024
OS/Arch:           linux/amd64
Context:           default

Server:
Engine:
Version:          25.0.6
API version:      1.44 (minimum version 1.24)
Go version:       go1.22.5
Git commit:       b08a51f
Built:            Wed Aug 21 00:00:00 2024
OS/Arch:          linux/amd64
Experimental:     false
containerd:
Version:          1.7.22
GitCommit:        7f7fdf5fed64eb6a7caf99b3e12efcf9d60e311c
runc:
Version:          1.1.14
GitCommit:        2c9f5602f0ba3d9da1c2596322dfc4e156844890
docker-init:
Version:          0.19.0
GitCommit:        de40ad0
Docker Compose version v2.28.1
0.39.7
v20.18.0

Clone the repository in a folder which is mounted to a storage which can be expanded as the Haven1 Network keeps adding blocks over time.
```
git clone https://github.com/haven1network/validator.git
```
Create some directories for the new node in the validator directory:
```
cd validator
mkdir -p keystore
```
You need to change the .env file.

Variable Value

HOSTNAME Your Organisation Name

IP Public IP (Elastic IP in case of AWS)

Add KMS key to the validator env If you have changed the name of the key, you need to change it in the query

You can run the following command if you are on AWS

 echo "KEY_0=kms:$(aws kms list-aliases  --query "Aliases[?AliasName=='alias/Haven1-Validator'].TargetKeyId" --output text )" >> .env

If you are on GCP platform then replace the variables and run the following command

 echo "GCP_PROJECT_ID=$gcp_project_id" >> .env
 echo "GCP_LOCATION_ID=$gcp_location" >> .env
 echo "KEY_0=gcp:$key_ring_id:$key_id:$key_version" >> .env

Add your RPC urls in the command below, we support ETH, BASE and Haven1 Network at the moment.

echo 'RPC={"8811": "https://rpc.haven1.org", "1":"<your ETH RPC endpoint>" ,"8453":"<your BASE RPC endpoint>"}' >> .env

Copy the string inside genesis.base64 and run the following command

sudo bash -c "echo \"<YOUR genesis.base64 STRING>\" | base64 --decode > ../data/genesis.json"

Download and load cosigner image

curl -L -o cosigner.tar.gz '<link to cosigner image>'
docker load -i cosigner.tar.gz

Check if image has been loaded properly. If output is empty contact the Haven1 team.
```
docker images cosigner:private
```
Install and run the Quorum Genesis Tool to generate a new set of keys and node (press y to continue):
```
npx quorum-genesis-tool \
--validators 1 \
--members 0 \
--bootnodes 0 \
--outputPath artifacts
```

Copy the generated artifacts:

cp artifacts/*/validator0/nodekey* keystore
cp artifacts/*/validator0/account* keystore
cp artifacts/*/validator0/address keystore
rm -rf artifacts

Sharing Instance Information

Share the following information from the validator instance with the Haven1 team.
- address -> Used to validate blocks in the chain
- nodekey.pub -> Used to add the node to the network
- HOSTNAME value used
- public IP
- cosigner public key -> Used by the cosigner to sign critical network transactions
We will use this information to add the node to the network.

You can use this command, copy the result and send it to us: If you have changed the name of the key, you need to change it in the key-id
```
printf "\n\n\n\n Copy the following Data \n\n\n"
echo -n "AWS KMS Cosigner Public Key: $(aws kms get-public-key --key-id=alias/Haven1-Validator --query 'PublicKey' --output text)"
for file in keystore/address keystore/nodekey.pub .env; do printf "%s: %s\n" "$file" "$(cat "$file")"; done
printf "\n\n\n\n"
```

Archive Hardware Requirements

AWS (t3.large)

CPU: 2 vCPU cores
Memory: 8 GB
OS Storage: 100 GB
Data Storage 150 GB

Archive Prerequisites

genesis.base64 (base 64 encoded)

Initial Setup and Key Generation for Archive Instance

Connect to the archive instance with EC2 Instance Connect and run the following commands

Install the following packages on your "Archive" machine:

sudo -s

sudo yum install -y git
sudo yum install -y docker
sudo mkdir -p /usr/local/lib /usr/local/lib/docker/cli-plugins
sudo curl -SL https://github.com/docker/compose/releases/download/v2.28.1/docker-compose-linux-x86_64 -o /usr/local/lib/docker/cli-plugins/docker-compose
sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
sudo systemctl start docker
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
source ~/.bashrc
nvm install 20
nvm use 20
sudo groupadd docker
sudo usermod -aG docker $USER

mkdir -p data
sudo mkfs -t xfs /dev/nvme1n1
sudo mount /dev/nvme1n1 data
UUID=$(sudo blkid -s UUID -o value /dev/nvme1n1)
echo "UUID=$UUID  $(pwd)/data  xfs  defaults,nofail  0  2" >> /etc/fstab

sudo fallocate -l 32G /swapfile
sudo chmod 600 /swapfile
sudo mkswap /swapfile
sudo swapon /swapfile
swapon --show
echo "/swapfile   swap    swap    defaults        0   0" >> /etc/fstab

Run the following code to verify if step 1 worked correctly

sudo docker version
docker compose version
nvm --version
node --version

The output should look similar to this

Client:
Version:           25.0.5
API version:       1.44
Go version:        go1.22.5
Git commit:        5dc9bcc
Built:             Wed Aug 21 00:00:00 2024
OS/Arch:           linux/amd64
Context:           default

Server:
Engine:
Version:          25.0.6
API version:      1.44 (minimum version 1.24)
Go version:       go1.22.5
Git commit:       b08a51f
Built:            Wed Aug 21 00:00:00 2024
OS/Arch:          linux/amd64
Experimental:     false
containerd:
Version:          1.7.22
GitCommit:        7f7fdf5fed64eb6a7caf99b3e12efcf9d60e311c
runc:
Version:          1.1.14
GitCommit:        2c9f5602f0ba3d9da1c2596322dfc4e156844890
docker-init:
Version:          0.19.0
GitCommit:        de40ad0
Docker Compose version v2.28.1
0.39.7
v20.18.0

Clone the repository in a folder which is mounted to a storage which can be expanded as the Haven1 Network keeps adding blocks over time.
```
git clone https://github.com/haven1network/validator.git
```
Create some directories for the new node in the validator directory:
```
cd validator/archive-node
mkdir -p keystore
```
You need to change the .env file.

Variable Value

HOSTNAME Your Organisation Name-RPC

IP Public IP (Elastic IP in case of AWS)

Copy the string inside genesis.base64 and run the following command

bash -c "echo \"<YOUR genesis.base64 STRING>\" | base64 --decode > ../../data/genesis.json"

Install and run the Quorum Genesis Tool to generate a new set of keys and node (press y to continue):
```
npx quorum-genesis-tool \
--validators 1 \
--members 0 \
--bootnodes 0 \
--outputPath artifacts
```

Copy the generated artifacts:

cp artifacts/*/validator0/nodekey* keystore
cp artifacts/*/validator0/account* keystore
cp artifacts/*/validator0/address keystore
rm -rf artifacts

Archive Sharing Instance Information

Share the following information with the Haven1 team.

nodekey.pub -> Used to add the node to the network
HOSTNAME value used
public IP
Signer Public Key -> Used to sign network admin transactions

You can use this command, copy the result and send it to us:

printf "\n\n\n\n Copy the following Data \n\n\n"
echo -n "AWS KMS Signer Public Key: $(aws kms get-public-key --key-id=alias/Haven1-Signing --query 'PublicKey' --output text)"
for file in keystore/nodekey.pub .env; do printf "%s: %s\n" "$file" "$(cat "$file")"; done
printf "\n\n\n\n"

Wait for the Haven1 team to reach out for the integration process to be completed.

Spin up the Node Validator Node

Once the integration is complete, you will receive the following files:
- static-nodes.base64 (base 64 encoded)
- permission-config.base64 (base 64 encoded)

Place the files in the data folder and run the following command.

cd /home/ec2-user/data

sudo bash -c "echo \"<YOUR permission-config.base64 STRING>\" | base64 --decode > permission-config.json"
sudo bash -c "echo \"<YOUR static-nodes.base64 STRING>\" | base64 --decode > static-nodes.json"

sudo ln -s static-nodes.json permissioned-nodes.json

You can spin up the node by running docker-compose in the validator folder
```
cd /home/ec2-user/validator
docker compose up -d
```

Test that the node is validating as expected

Attach a geth console to the node:

docker compose exec -it node geth attach /data/geth.ipc

Verify Syncing Status. It should return false once the syncing is completed
```
eth.syncing
```
Once syncing is completed. Verify Mining Status. It should return true if mining is enabled on your validator.
```
eth.mining
```
The peer count should be equal to the total number of nodes minus one (representing the node itself).
```
admin.peers.length
```
Verify Block Number. To ensure that new blocks are being added to the blockchain, check the current block number with the following command:
```
eth.blockNumber
```

This number should increase over time as new blocks are added.

If all tests generate positive results, we have successfully added a new RPC node.
Exit the Geth console
```
exit
```

Spin up the Archive Node

Once the integration is complete, you will receive the following files:
- static-nodes.json
- permission-config.json

Place the files in the data folder and run the following command.

cd /home/ec2-user/data
sudo ln -s static-nodes.json permissioned-nodes.json

You can spin up the node by running docker-compose in the validator folder
```
cd /home/ec2-user/validator/archive-node

docker compose up -d
```

Test that the archive node is running as expected

Attach a geth console to the node:

docker compose exec -it node geth attach /data/geth.ipc

Verify Syncing Status. It should return false once the syncing is completed
```
eth.syncing
```
Once syncing is completed. Verify Mining Status. It should return false
```
eth.mining
```

The peer count should be equal to the total number of nodes minus one (representing the node itself).

Verify Block Number. To ensure that new blocks are being added to the blockchain, check the current block number with the following command:
```
eth.blockNumber
```

This number should increase over time as new blocks are added.

If all tests generate positive results, we have successfully added a new RPC node.
Exit the Geth console
```
exit
```

Debugging Validator FAQ

Problem: Geth Connection Refused running attach command

Possible Solution:

The container might be in the process of starting up.
If the container is running then check the logs if there is any specific issue.
If no issue then wait 10 mins for the container to spin up.
Else turn off your container
Remove geth.ipc if you still have a stray geth.ipc remaining, then remove it.

Start the container again and wait for it to spin up.

docker-compose down
rm -f data/geth.ipc
docker-compose up -d

Problem: No file geth.ipc

Possible Solution:

Check if container is running.
If the container is running then check the logs if there is any specific issue.
If no issue then wait 10 mins for the container to spin up.

Name		Name	Last commit message	Last commit date
Latest commit History 12 Commits
.github		.github
archive-node		archive-node
src		src
.env		.env
.gitignore		.gitignore
ACTIVITIES.md		ACTIVITIES.md
README.md		README.md
docker-compose.yaml		docker-compose.yaml
docker-entrypoint.sh		docker-entrypoint.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Haven1 Validator

Table of Contents

Summary

Infra Setup

Setup Validator and Archive Instance

Validator Hardware Requirements

Prerequisites

Initial Setup and Key Generation for Validator Instance

Sharing Instance Information

Archive Hardware Requirements

Archive Prerequisites

Initial Setup and Key Generation for Archive Instance

Archive Sharing Instance Information

Spin up the Node Validator Node

Test that the node is validating as expected

Spin up the Archive Node

Test that the archive node is running as expected

Debugging Validator FAQ

About

Releases 1

Packages

Contributors 2

Languages

Variable	Value
HOSTNAME	Your Organisation Name
IP	Public IP (Elastic IP in case of AWS)

Variable	Value
HOSTNAME	Your Organisation Name-RPC
IP	Public IP (Elastic IP in case of AWS)

haven1network/haven1-validator-docs

Folders and files

Latest commit

History

Repository files navigation

Haven1 Validator

Table of Contents

Summary

Infra Setup

Setup Validator and Archive Instance

Validator Hardware Requirements

Prerequisites

Initial Setup and Key Generation for Validator Instance

Sharing Instance Information

Archive Hardware Requirements

Archive Prerequisites

Initial Setup and Key Generation for Archive Instance

Archive Sharing Instance Information

Spin up the Node Validator Node

Test that the node is validating as expected

Spin up the Archive Node

Test that the archive node is running as expected

Debugging Validator FAQ

About

Resources

Stars

Watchers

Forks

Releases 1

Packages 0

Contributors 2

Languages

Packages