Skip to content

Latest commit

 

History

History
257 lines (181 loc) · 8.32 KB

your-own-testnet.md

File metadata and controls

257 lines (181 loc) · 8.32 KB
Raw

Deploy Your Own stafihub Testnet

This document describes 3 ways to setup a network of stafihubd nodes, each serving a different usecase:

  1. Single-node, local, manual testnet
  2. Multi-node, local, automated testnet
  3. Multi-node, remote, automated testnet

Supporting code can be found in the networks directory and additionally the local or remote sub-directories.

NOTE: The remote network bootstrapping may be out of sync with the latest releases and is not to be relied upon.

Available Docker images

In case you need to use or deploy stafihub as a container you could skip the build steps and use the official images, $TAG stands for the version you are interested in:

  • docker run -it -v ~/.stafihub:/root/.stafihub tendermint:$TAG stafihubd init
  • docker run -it -p 26657:26657 -p 26656:26656 -v ~/.stafihub:/root/.stafihub tendermint:$TAG stafihubd start
  • ...
  • docker run -it -v ~/.stafihub:/root/.stafihub tendermint:$TAG stafihubd version

The same images can be used to build your own docker-compose stack.

Single-node, Local, Manual Testnet

This guide helps you create a single validator node that runs a network locally for testing and other development related uses.

Requirements

Create Genesis File and Start the Network

# You can run all of these commands from your home directory
cd $HOME

# Initialize the genesis.json file that will help you to bootstrap the network
stafihubd init my-node --chain-id my-chain

# Create a key to hold your validator account
stafihubd keys add my-account

# Add that key into the genesis.app_state.accounts array in the genesis file
# NOTE: this command lets you set the number of coins. Make sure this account has some coins
# with the genesis.app_state.staking.params.bond_denom denom, the default is staking
stafihubd add-genesis-account $(stafihubd keys show my-account -a) 1000000000ufis,1000000000validatortoken

# Generate the transaction that creates your validator
stafihubd gentx my-account 1000000000ufis --chain-id my-chain

# Add the generated bonding transaction to the genesis file
stafihubd collect-gentxs

# Now its safe to start `stafihubd`
stafihubd start

This setup puts all the data for stafihubd in ~/.stafihub. You can examine the genesis file you created at ~/.stafihub/config/genesis.json. With this configuration stafihubd is also ready to use and has an account with tokens (both staking and custom).

Multi-node, Local, Automated Testnet

From the networks/local directory:

Requirements

Build

Build the stafihubd binary (linux) and the tendermint/stafihubdnode docker image required for running the localnet commands. This binary will be mounted into the container and can be updated without rebuilding the image, so you only need to build the image once.

# Clone the stafihub repo
git clone https://github.com/stafihub/stafihub.git

# Work from the SDK repo
cd stafihub

# Build the linux binary in ./build
make build-linux

# Build tendermint/stafihubdnode image
make build-docker-stafihubdnode

Run Your Testnet

To start a 4 node testnet run:

make localnet-start

This command creates a 4-node network using the stafihubdnode image. The ports for each node are found in this table:

Node ID P2P Port RPC Port
stafihubnode0 26656 26657
stafihubnode1 26659 26660
stafihubnode2 26661 26662
stafihubnode3 26663 26664

To update the binary, just rebuild it and restart the nodes:

make build-linux localnet-start

Configuration

The make localnet-start creates files for a 4-node testnet in ./build by calling the stafihubd testnet command. This outputs a handful of files in the ./build directory:

$ tree -L 2 build/
build/
├── stafihubd
├── gentxs
│   ├── node0.json
│   ├── node1.json
│   ├── node2.json
│   └── node3.json
├── node0
│   └── stafihubd
│       ├── key_seed.json
│       ├── keys
│       ├── ${LOG:-stafihubd.log}
│       ├── config
│       └── data
├── node1
│       ├── key_seed.json
│       ├── ${LOG:-stafihubd.log}
│       ├── config
│       └── data
├── node2
│       ├── key_seed.json
│       ├── ${LOG:-stafihubd.log}
│       ├── config
│       └── data
└── node3
         ├── key_seed.json
         ├── ${LOG:-stafihubd.log}
         ├── config
         └── data

Each ./build/nodeN directory is mounted to the /stafihubd directory in each container.

Logging

Logs are saved under each ./build/nodeN/stafihubd/stafihub.log. You can also watch logs directly via Docker, for example:

docker logs -f stafihubdnode0

Keys & Accounts

To interact with stafihubd and start querying state or creating txs, you use the stafihubd directory of any given node as your home, for example:

stafihubd keys list --home ./build/node0/stafihubd

Now that accounts exists, you may create new accounts and send those accounts funds!

::: tip Note: Each node's seed is located at ./build/nodeN/stafihubd/key_seed.json and can be restored to the CLI using the stafihubd keys add --restore command :::

Special Binaries

If you have multiple binaries with different names, you can specify which one to run with the BINARY environment variable. The path of the binary is relative to the attached volume. For example:

# Run with custom binary
BINARY=stafihubfoo make localnet-start

Multi-Node, Remote, Automated Testnet

The following should be run from the networks directory.

Terraform & Ansible

Automated deployments are done using Terraform to create servers on AWS then Ansible to create and manage testnets on those servers.

Prerequisites

export AWS_ACCESS_KEY_ID="2345234jk2lh4234"
export AWS_SECRET_ACCESS_KEY="234jhkg234h52kh4g5khg34"
export TESTNET_NAME="remotenet"
export CLUSTER_NAME= "remotenetvalidators"
export SSH_PRIVATE_FILE="$HOME/.ssh/id_rsa"
export SSH_PUBLIC_FILE="$HOME/.ssh/id_rsa.pub"

These will be used by both terraform and ansible.

Create a Remote Network

SERVERS=1 REGION_LIMIT=1 make validators-start

The testnet name is what's going to be used in --chain-id, while the cluster name is the administrative tag in AWS for the servers. The code will create SERVERS amount of servers in each availability zone up to the number of REGION_LIMITs, starting at us-east-2. (us-east-1 is excluded.) The below BaSH script does the same, but sometimes it's more comfortable for input.

./new-testnet.sh "$TESTNET_NAME" "$CLUSTER_NAME" 1 1

Quickly see the /status Endpoint

make validators-status

Delete Servers

make validators-stop

Logging

You can ship logs to Logz.io, an Elastic stack (Elastic search, Logstash and Kibana) service provider. You can set up your nodes to log there automatically. Create an account and get your API key from the notes on this page, then:

yum install systemd-devel || echo "This will only work on RHEL-based systems."
apt-get install libsystemd-dev || echo "This will only work on Debian-based systems."

go get github.com/mheese/journalbeat
ansible-playbook -i inventory/digital_ocean.py -l remotenet logzio.yml -e LOGZIO_TOKEN=ABCDEFGHIJKLMNOPQRSTUVWXYZ012345

Monitoring

You can install the DataDog agent with:

make datadog-install