Added cli wrappers to allow easy access to cli (#10)

* Make it easy to run node cli

* feat: if direnv isn't working give an appropriate error message.

* feat: automatically create a random node key.

* feat: only randomise the postgres password once.

* feat: parametrise cardano network

* feat: add details on how to reset the environment.

* feat: add script to run cardano cli commands

* feat: require signed commits at commit time rather than PR raising time

---------

Signed-off-by: Squirrel <giles.cope@shielded.io>
Co-authored-by: Fenton Haslam <fentonhaslam@gmail.com>

Author: gilescope

.envrc

@@ -1,17 +1,30 @@
 # If your on windows use wsl / git bash / cygwin / msys2 with direnv
 
+# This repo only accepts signed commits:
+# point out to users at commit time that commits need to be signed,
+# not once they've done many commits and are trying to push a PR:
+git config --local commit.gpgSign true
+git config --local tag.gpgSign true
+
 export MIDNIGHT_NODE_IMAGE="midnightnetwork/midnight-node:0.8.0"
 
-export POSTGRES_HOST="x.x.x.x" # TODO: replace x.x.x.x with IP or host to postgres connection
+export POSTGRES_HOST="postgres" # TODO: replace with IP or host to postgres connection if not connecting to the docker one.
 export POSTGRES_PORT="5432"
 export POSTGRES_USER="postgres"
 
 # A random password is used for your safety. Docker (but not podman) exposes
 # ports to the internet by default. This needs to be unguessable.
-export POSTGRES_PASSWORD=$(< /dev/random tr -dc 'A-Za-z0-9!@#$%^&*()_+-=' | head -c 20)
+if [ ! -f postgres.password ]; then
+    uuidgen | tr -d '-' | head -c 16 > postgres.password
+fi
+export POSTGRES_PASSWORD="$(cat ./postgres.password)"
+
 export POSTGRES_DB="cexplorer"
+
+# We bring together the above variables into a database connection string:
 export DB_SYNC_POSTGRES_CONNECTION_STRING="psql://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST:$POSTGRES_PORT/$POSTGRES_DB"
 
+# These are well known addresses of a network that allow you to discover all the other nodes.
 export BOOTNODES="/dns/boot-node-01.testnet-02.midnight.network/tcp/30333/ws/p2p/12D3KooWMjUq13USCvQR9Y6yFzYNYgTQBLNAcmc8psAuPx2UUdnB \
            /dns/boot-node-02.testnet-02.midnight.network/tcp/30333/ws/p2p/12D3KooWR1cHBUWPCqk3uqhwZqUFekfWj8T7ozK6S18DUT745v4d \
            /dns/boot-node-03.testnet-02.midnight.network/tcp/30333/ws/p2p/12D3KooWQxxUgq7ndPfAaCFNbAxtcKYxrAzTxDfRGNktF75SxdX5"
@@ -23,12 +36,18 @@ export APPEND_ARGS="--no-private-ip --validator --pool-limit 10 --trie-cache-siz
 export CFG_PRESET=testnet-02
 
 # Validator Values:
-# TODO: generate node key like this: docker run --rm -it docker.io/parity/subkey:latest generate-node-key. Use the second output for NODE_KEY
-export NODE_KEY=""
+if [ ! -f node.privatekey ]; then
+  # generate node key like this:
+  DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run --rm -it docker.io/parity/subkey:latest generate-node-key  | sed -n '2p' > midnight-node.privatekey
+  # Use the second line of output for NODE_KEY (that's what sed -n '2p' does)
+fi
+export NODE_KEY="$(cat ./midnight-node.privatekey)"
 
 #
 # Partner chains config:
 #
+export CARDANO_NETWORK=preview
+export CARDANO_IMAGE="ghcr.io/intersectmbo/cardano-node:10.2.1"
 export CARDANO_DATA_DIR=./cardano-data
-export CARDANO_CONFIG_DIR=./cardano-config/preview
+export CARDANO_CONFIG_DIR=./cardano-config/${CARDANO_NETWORK}
 export HOME_IPC=${HOME}/ipc

.gitignore

@@ -1 +1,4 @@
 /cardano-data/*
+/data
+*.privatekey
+*.password

CHANGELOG.md

@@ -5,4 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+
+### 🚀 Features
+
+- Port from prior repo (#3)
+- If direnv isn't working give an appropriate error message.
+- /data dir should be .gitignored
+- Automatically create a random node key.
+- Only randomise the postgres password once.
+- Parametise cardano network
+
+### 💼 Other
+
+- *(deps)* Bump checkmarx/ast-github-action from 2.3.18 to 2.3.19 (#9)
+- Be explicit about image

README.md

@@ -5,41 +5,81 @@ This allows for easy orchestration of the Midnight Node service.
 ## System requirements
 
 - Install [Docker Engine](https://docs.docker.com/engine/install/)
-- Install [Docker-Compose](https://docs.docker.com/compose/install/)
+- Install [Docker Compose](https://docs.docker.com/compose/install/)
 - Install [direnv](https://direnv.net/docs/installation.html)
 
 ## Usage
 
 1. Clone repo
 
-2. Modify values in `.envrc` file as applicable
+2. run `direnv allow` to load the environment variables
 
-3. Run `direnv allow` to load the environment variables
+3. Run `docker-compose up`
 
-3. Choose which compose files to use:
+The `.envrc` file will automatically create a random private key and save it as `midnight-node.privatekey`.
+
+Choose which compose files to use:
    - `compose.yml` for Midnight Node
-   - `compose-partner-chains.yml` for Cardano DB Sync
+   - `compose-partner-chains.yml` for Cardano + DB Sync
    - `proof-server.yml` for Local Proof Server
 
 One can use one or multiple compose files at once.
 
 For example, to run the Midnight Node, you can do:
 ```shell
-DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose up -d
+docker compose up -d
 ```
 
 or to run the Midnight Node and Cardano DB Sync, you can do:
 ```shell
-DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f ./compose-partner-chains.yml -f ./compose.yml up -d
+docker compose -f ./compose-partner-chains.yml -f ./compose.yml up -d
 ```
 
 or to run the Midnight Node, Cardano DB Sync and a local Proof Server, you can do:
 ```shell
-DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f ./compose-partner-chains.yml -f ./compose.yml -f ./proof-server.yml up -d
+docker compose -f ./compose-partner-chains.yml -f ./compose.yml -f ./proof-server.yml up -d
 ```
 
 🚀 That's it.
 
+### Troubleshooting
+
+### Clean start
+
+To restart from fresh, run:
+
+```sh
+docker compose -f ./compose-partner-chains.yml -f ./compose.yml -f ./proof-server.yml down -v
+docker compose -f ./compose-partner-chains.yml -f ./compose.yml -f ./proof-server.yml kill
+rm ~/ipc/node.socket
+rm -R ./data
+rm -R ./cardano-data
+```
+
+#### Env vars not setup
+
+If you get warnings like this then likely `direnv` is not setup or `direnv allow` has not been run:
+```
+WARN[0000] The "HOME_IPC" variable is not set. Defaulting to a blank string.
+```
+
+#### IPC Errors
+
+If you get IPC errors with Cardano node then delete the stale
+socket file: `rm ~/ipc/node.socket` and restart.
+
+#### Midnight node Errors
+
+If you encounter this message on the midnight node it's likely that the
+cardano-node is still syncing and it will go away once it's fully synced:
+
+```
+Unable to author block in slot. Failure creating inherent data provider:
+'No latest block on chain.' not found.
+Possible causes: main chain follower configuration error, db-sync not synced fully,
+or data not set on the main chain.
+```
+
 ### LICENSE
 
 Apache 2.0. PRs welcome, please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

cardano-cli.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+if [ "$CARDANO_NETWORK" = "preview" ]; then
+  CARDANO_NODE_NETWORK_ID=2
+elif [ "$CARDANO_NETWORK" = "mainnet" ]; then
+  CARDANO_NODE_NETWORK_ID=1
+elif [ "$CARDANO_NETWORK" = "preprod" ]; then
+  CARDANO_NODE_NETWORK_ID=0
+else
+  echo "Error: Unknown CARDANO_NETWORK: $CARDANO_NETWORK"
+  exit 1
+fi
+
+DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run --rm \
+  --network container:cardano-node \
+  -e CARDANO_NODE_SOCKET_PATH="/ipc/node.socket" \
+  -e CARDANO_NODE_NETWORK_ID=${CARDANO_NODE_NETWORK_ID} \
+  -v ~/ipc:/ipc \
+  ${CARDANO_IMAGE} \
+  cli $*

compose-partner-chains.yml

@@ -22,20 +22,21 @@ volumes:
 
 services:
   cardano-node:
-    image: ghcr.io/intersectmbo/cardano-node:10.1.4
+    image: ${CARDANO_IMAGE}
     restart: unless-stopped
     container_name: cardano-node
     ports:
       - "3001:3001"
     environment:
-      - NETWORK=preview
+      - NETWORK=${CARDANO_NETWORK}
       - CARDANO_NODE_SOCKET_PATH=/ipc/node.socket
     volumes:
       - ${HOME_IPC}:/ipc   # Use ${HOME_IPC} from .envrc
-      - $CARDANO_DATA_DIR:/data
+      - ${CARDANO_DATA_DIR}:/data
 
   postgres:
     image: postgres:15.3
+    platform: linux/amd64
     container_name: db-sync-postgres
     environment:
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
@@ -53,13 +54,14 @@ services:
 
   db-sync:
     image: ghcr.io/intersectmbo/cardano-db-sync:13.6.0.4
+    platform: linux/amd64
     container_name: db-sync
     restart: unless-stopped
     depends_on:
       postgres:
         condition: service_healthy
     environment:
-      - NETWORK=preview
+      - NETWORK=${CARDANO_NETWORK}
       - POSTGRES_HOST=${POSTGRES_HOST}
       - POSTGRES_PORT=${POSTGRES_PORT}
       - POSTGRES_DB=${POSTGRES_DB}
@@ -84,7 +86,7 @@ services:
       - --node-socket
       - /ipc/node.socket
       - --node-config
-      - /config/preview/cardano-node/config.json
+      - /config/${CARDANO_NETWORK}/cardano-node/config.json
       - --host
       - 0.0.0.0
 

compose.yml

@@ -21,7 +21,6 @@ services:
     container_name: midnight
     restart: unless-stopped
     image: ${MIDNIGHT_NODE_IMAGE}
-    platform: linux/amd64
     ports:
       - "9944:9944"   # WebSocket   - For RPC/relay type of nodes (queries, new transaction submissions etc).
       - "30333:30333" # P2P Traffic - Peer-to-peer communication for node connectivity.

midnight-node.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+if [ -z "$MIDNIGHT_NODE_IMAGE" ]; then
+  echo "Error: Env var MIDNIGHT_NODE_IMAGE is not set or is empty"
+  echo "Please install direnv and run `direnv allow` to activate it."
+  exit 1
+fi
+
+docker run -it \
+  -e CFG_PRESET=${CFG_PRESET} \
+  -e DB_SYNC_POSTGRES_CONNECTION_STRING=${DB_SYNC_POSTGRES_CONNECTION_STRING} \
+  -v ./data:/data ${MIDNIGHT_NODE_IMAGE} \
+  $*