chore: example for a snapshot node (#89)

* chore: example for a snapshot node

* chore: add README, update cli

* chore: put latest version

* chore: update docs

Author: albttx

snapshots-node/.gitignore

@@ -0,0 +1,2 @@
+env
+gnoland-data/*

snapshots-node/README.md

@@ -0,0 +1,27 @@
+# Snapshots node
+
+## How it's works
+
+1. Setup the environment variables and setup the variables for the [minio-client](https://min.io) with your S3 credentials
+
+``` sh
+cp env.example env
+```
+
+2. Start the node
+
+By default, a snapshots will occur every 4 hours, and will upload it to S3
+
+``` sh
+docker compose up -d
+```
+
+## How to force a snapshot now
+
+``` sh
+docker compose exec snapshotter sh /scripts/snapshots.sh
+```
+
+## TO-DOs
+
+[ ] Prune the node before uploading the snapshots

snapshots-node/docker-compose.yml

@@ -0,0 +1,24 @@
+name: "gnoland-snapshot-node"
+
+services:
+  gnoland:
+    image: "ghcr.io/gnolang/gno/gnoland:chain-test4.3"
+    entrypoint: ["/scripts/entrypoint.gnoland.sh"]
+    ports:
+      - 127.0.0.1:26657:26657
+    volumes:
+      - ./scripts:/scripts
+      - ./gnoland-data:/gnoroot/gnoland-data
+
+  snapshotter:
+    image: "docker:27.2.0-cli-alpine3.20"
+    entrypoint: ["sh", "/scripts/entrypoint.snapshotter.sh"]
+    env_file: "env"
+    environment:
+      CHAIN_ID: "test4"
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+      - "./scripts:/scripts"
+      - "./docker-compose.yml:/docker-compose.yml"
+      - "./env:/env"
+      - "./gnoland-data:/gnoroot/gnoland-data:ro"

snapshots-node/env.example

@@ -0,0 +1,5 @@
+
+MC_ENDPOINT=""
+MC_ACCESS_KEY=""
+MC_SECRET_KEY=""
+MC_BUCKET=""

snapshots-node/scripts/entrypoint.gnoland.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+LOG_LEVEL=${LOG_LEVEL:-"info"}
+
+MONIKER=${MONIKER:-"gnode"}
+P2P_LADDR=${P2P_LADDR:-"tcp://0.0.0.0:26656"}
+RPC_LADDR=${RPC_LADDR:-"tcp://0.0.0.0:26657"}
+
+CHAIN_ID=${CHAIN_ID:-"dev"}
+
+gnoland config init
+
+gnoland config set rpc.laddr     "${RPC_LADDR}"
+gnoland config set p2p.laddr     "${P2P_LADDR}"
+
+exec gnoland start --lazy --genesis="./gnoland-data/genesis.json" --log-level=${LOG_LEVEL}

snapshots-node/scripts/entrypoint.snapshotter.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+
+apk add --no-cache curl jq lz4 minio-client
+
+export DAEMON_HOME="/gnoroot/gnoland-data"
+
+[ -z "$MC_ENDPOINT" ]   && echo "MC_ENDPOINT is not set, skip snapshot"   && exit 1
+[ -z "$MC_ACCESS_KEY" ] && echo "MC_ACCESS_KEY is not set, skip snapshot" && exit 1
+[ -z "$MC_SECRET_KEY" ] && echo "MC_SECRET_KEY is not set, skip snapshot" && exit 1
+
+mcli alias set s3 ${MC_ENDPOINT} ${MC_ACCESS_KEY} ${MC_SECRET_KEY}
+
+# exec snapshots script every 4 hours
+echo "0 */4 * * * sh /scripts/snapshots.sh" > /etc/crontabs/root
+crontab /etc/crontabs/root
+
+exec crond -f

snapshots-node/scripts/snapshots.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env sh
+
+DAEMON_HOME="/gnoroot/gnoland-data"
+
+HEIGHT=$(curl -s gnoland:26657/status | jq -r '.result.sync_info.latest_block_height')
+echo "[INFO] Snapshotting at height: ${HEIGHT}"
+
+echo "[INFO] Stopping gnoland..."
+docker compose stop gnoland
+
+FILE="gnoland-${HEIGHT}-${CHAIN_ID}.tar.lz4"
+
+tar cvf - -C ${DAEMON_HOME} wal db | lz4 > $FILE
+
+mcli cp --attr x-amz-acl=public-read --tags="type=snapshot" ${FILE} "s3/${MC_BUCKET}/${CHAIN_ID}/${FILE}"; echo
+
+rm -vf ${FILE}
+
+echo "[INFO] Starting gnoland ..."
+docker compose start gnoland