testnet-laconicd-stack/stack-orchestrator/stacks/laconicd-full-node/README.md

201 lines
4.9 KiB
Markdown
Raw Normal View History

2024-05-20 11:27:41 +00:00
# laconicd-full-node
2024-06-18 06:38:10 +00:00
Instructions for running a laconicd testnet full node and joining as a validator
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
## Prerequisites
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
* Minimum hardware requirements:
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
```bash
RAM: 8-16GB
Disk space: 200GB
CPU: 2 cores
```
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
* Testnet genesis file (file or an URL) and peer node addresses
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
## Setup
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
* Clone the stack repo:
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
```bash
laconic-so fetch-stack git.vdb.to/cerc-io/testnet-laconicd-stack
```
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
* Clone required repositories:
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
```bash
2024-06-18 07:13:37 +00:00
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconicd-full-node setup-repositories
2024-06-18 06:38:10 +00:00
```
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
* Build the container images:
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
```bash
2024-06-18 07:13:37 +00:00
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconicd-full-node build-containers
2024-06-18 06:38:10 +00:00
```
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
This should create the following docker images locally:
2024-06-18 06:38:10 +00:00
* `cerc/laconic2d`
2024-06-18 06:38:10 +00:00
## Create a deployment
2024-06-18 06:38:10 +00:00
* Create a spec file for the deployment:
2024-06-18 06:38:10 +00:00
```bash
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconicd-full-node deploy init --output laconic-full-node-spec.yml
```
2024-06-18 06:38:10 +00:00
* Edit `network` in the spec file to map container ports to host ports as required:
2024-06-18 06:38:10 +00:00
```bash
...
network:
ports:
laconicd:
- '6060:6060'
- '26657:26657'
- '26656:26656'
- '9473:9473'
- '9090:9090'
- '1317:1317'
```
2024-06-18 06:38:10 +00:00
* Create a deployment from the spec file:
2024-06-18 06:38:10 +00:00
```bash
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconicd-full-node deploy create --spec-file laconic-full-node-spec.yml --deployment-dir laconic-full-node-deployment
```
2024-06-18 10:19:39 +00:00
* Copy over the published testnet genesis file (`.json`) to data directory in deployment (`laconic-full-node-deployment/data/laconicd-data/tmp`):
2024-06-18 06:38:10 +00:00
```bash
# Example
2024-06-18 07:13:37 +00:00
mkdir -p laconic-full-node-deployment/data/laconicd-data/tmp
cp genesis.json laconic-full-node-deployment/data/laconicd-data/tmp/genesis.json
2024-06-18 06:38:10 +00:00
```
## Configuration
* Inside the deployment directory, open `config.env` file and set following env variables:
```bash
# Comma separated list of nodes to keep persistent connections to
# Example: "node-1-id@node-1-host:26656,node-2-id@node-2-host:26656"
CERC_PEERS=""
# Optional
# A custom human readable name for this node (default: TestnetNode)
CERC_MONIKER=
# Network chain ID (default: laconic_9000-1)
CERC_CHAIN_ID=
# Output log level (default: info)
CERC_LOGLEVEL=
```
## Start the deployment
```bash
laconic-so deployment --dir laconic-full-node-deployment start
2024-05-20 11:27:41 +00:00
```
## Check status
2024-06-18 06:38:10 +00:00
* To list down and monitor the running containers:
```bash
# With status
docker ps -a
2024-06-18 10:19:39 +00:00
# Get laconicd container id in a variable
LACONICD_CONTAINER_ID=$(docker ps --filter "name=laconicd" -q)
# Check logs for laconicd container
docker logs -f $LACONICD_CONTAINER_ID
2024-06-18 06:38:10 +00:00
```
* Check the sync status of your node:
```bash
2024-06-18 10:19:39 +00:00
docker exec -it $LACONICD_CONTAINER_ID bash -c "laconicd status | jq .sync_info"
2024-06-18 06:38:10 +00:00
```
2024-05-20 11:27:41 +00:00
## Join as testnet validator
* Create / import a new key pair:
2024-06-17 13:46:19 +00:00
```bash
# Create new keypair
docker exec -it $LACONICD_CONTAINER_ID bash -c "laconicd keys add <key-name>"
# OR
# Restore existing key with mnemonic seed phrase
# You will be prompted to enter mnemonic seed
docker exec -it $LACONICD_CONTAINER_ID bash -c "laconicd keys add <key-name> --recover"
# Query the keystore for your account's address
docker exec -it $LACONICD_CONTAINER_ID bash -c "laconicd keys show <key-name> -a"
```
* Request tokens from the testnet faucet for your account if required
* Check balance for your account:
```bash
docker exec -it $LACONICD_CONTAINER_ID bash -c "laconicd query bank balances <key-name>"
```
* Create required validator configuration:
```bash
# Edit the staking amount and other fields as required
docker exec -it $LACONICD_CONTAINER_ID bash -c 'cat <<EOF > <your-node-moniker>-validator.json
{
"pubkey": $(laconicd cometbft show-validator),
"amount": "900000000photon",
"moniker": "<your-node-moniker>",
"commission-rate": "0.1",
"commission-max-rate": "0.2",
"commission-max-change-rate": "0.01",
"min-self-delegation": "1"
}
EOF'
```
* Create a validator:
```bash
docker exec -it $LACONICD_CONTAINER_ID bash -c 'laconicd tx staking create-validator <your-node-moniker>-validator.json \
--fees 50photon \
--chain-id=laconic_9000-1 \
--from <key-name>'
```
* View staking validator details:
```bash
docker exec -it $LACONICD_CONTAINER_ID bash -c "laconicd query staking validator <key-name>"
```
2024-05-20 11:27:41 +00:00
## Clean up
2024-06-18 06:38:10 +00:00
* Stop all services running in the background:
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
```bash
# Stop the docker containers
laconic-so deployment --dir laconic-full-node-deployment stop
```
* To stop all services and also delete data:
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
```bash
# Stop the docker containers
laconic-so deployment --dir laconic-full-node-deployment stop --delete-volumes
2024-05-20 11:27:41 +00:00
2024-06-18 06:38:10 +00:00
# Remove deployment directory (deployment will have to be recreated for a re-run)
rm -r laconic-full-node-deployment
```