Issue/1756 mithril script updates

.github/workflows/autoupdate-testing.yml

@@ -0,0 +1,212 @@
+name: Autoupdate testing branches
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - alpha
+  schedule:
+    - cron:  '0 */8 * * *'
+
+jobs:
+  start-summary:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set summary details
+        run: |
+          echo "## Autoupdate Testing Branches Summary Details" >> $GITHUB_STEP_SUMMARY
+          echo "| Name | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| ---- | ----- |" >> $GITHUB_STEP_SUMMARY
+          echo "| GitHub Actor | ${GITHUB_ACTOR} |" >> $GITHUB_STEP_SUMMARY
+          echo "| GitHub Email | ${GITHUB_ACTOR}@users.noreply.github.com" >> $GITHUB_STEP_SUMMARY
+  get-node-prerelease:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set summary details
+        run: |
+          echo "## Get Node Pre-Release" >> $GITHUB_STEP_SUMMARY
+          echo "| Name | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| ---- | ----- |" >> $GITHUB_STEP_SUMMARY
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: preview
+      - name: Configure Git
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+      - name: Fetch node pre-release version
+        run: |
+          curl -sL https://api.github.com/repos/IntersectMBO/cardano-node/releases | jq -r '.[] | select(.prerelease == true) | .tag_name' | head -1 > files/docker/node/release-versions/cardano-node-prerelease.txt
+      - name: Assigns pre-release version
+        run: |
+          VERSION=$(cat files/docker/node/release-versions/cardano-node-prerelease.txt)
+      - name: Check for changes
+        id: git-check
+        run: |
+          export MODIFIED=$([ -z "`git status --porcelain`" ] && echo "false" || echo "true")
+          echo "MODIFIED=${MODIFIED}" >> "$GITHUB_OUTPUT"
+          echo "| Repository Modified | ${MODIFIED} |" >> "$GITHUB_STEP_SUMMARY"  
+      - name: Commit latest pre-release versions
+        if: steps.git-check.outputs.MODIFIED == 'true'
+        run: |
+          echo "| Modified files | $(git diff --name-only $(jq -r '.sha' "$GITHUB_OUTPUT")) |" >> "$GITHUB_STEP_SUMMARY"
+          git add files/docker/node/release-versions/cardano-node-prerelease.txt
+          git commit -am "New mithril pre-release versions: pre-release ${PRERELEASE_VERSION}"
+          git push
+  get-mithril-prerelease:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set summary details
+        run: |
+          echo "## Get Mithril Pre-Release" >> $GITHUB_STEP_SUMMARY
+          echo "| Name | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| ---- | ----- |" >> $GITHUB_STEP_SUMMARY
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: preview
+      - name: Configure Git
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+      - name: Fetch Mithril release and pre-release versions
+        run: |
+          mithril_release="$(curl -s https://api.github.com/repos/input-output-hk/mithril/releases/latest | jq -r '.tag_name')"
+          mithril_prerelease="$(curl -s https://api.github.com/repos/input-output-hk/mithril/releases | jq -r '.[] | select(.prerelease == true) | select(.tag_name | endswith("-pre")) | .tag_name' | head -n 1)"
+          if [[ "${mithril_release}-pre" == "${mithril_prerelease}" ]]; then
+            echo "${mithril_release}" > files/docker/node/release-versions/mithril-prerelease.txt
+            PRERELEASE_VERSION=${mithril_release}
+            echo "PRERELEASE_VERSION=${PRERELEASE_VERSION}" >> $GITHUB_ENV
+            echo "| Pre-release == Release | True" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "${mithril_prerelease}" > files/docker/node/release-versions/mithril-prerelease.txt
+            PRERELEASE_VERSION=${mithril_prerelease}
+            echo "PRERELEASE_VERSION=${PRERELEASE_VERSION}" >> $GITHUB_ENV
+            echo "| Pre-release == Release | False |" >> $GITHUB_STEP_SUMMARY
+          fi
+          echo "| Pre-release version | ${PRERELEASE_VERSION} |" >> $GITHUB_STEP_SUMMARY
+      - name: Check for changes
+        id: git-check
+        run: |
+          export MODIFIED=$([ -z "`git status --porcelain`" ] && echo "false" || echo "true")
+          echo "MODIFIED=${MODIFIED}" >> "$GITHUB_OUTPUT"
+          echo "| Repository Modified | ${MODIFIED} |" >> "$GITHUB_STEP_SUMMARY"  
+      - name: Commit latest pre-release versions
+        if: steps.git-check.outputs.MODIFIED == 'true'
+        run: |
+          echo "" Modified files | $(git diff --name-only $(jq -r '.sha' "$GITHUB_OUTPUT")) |" >> "$GITHUB_STEP_SUMMARY"
+          git add files/docker/node/release-versions/mithril-prerelease.txt
+          git commit -am "New mithril pre-release versions: pre-release ${PRERELEASE_VERSION}"
+          git push
+  get-mithril-unstable:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set summary details
+        run: |
+          echo "## Get Mithril Unstable" >> $GITHUB_STEP_SUMMARY
+          echo "| Name | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| ---- | ----- |" >> $GITHUB_STEP_SUMMARY
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: sanchonet
+      - name: Configure Git
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+      - name: Fetch Mithril unstable version
+        run: |
+          curl -sL https://api.github.com/repos/input-output-hk/mithril/releases | jq -r '.[] | select(.prerelease == true and .tag_name == "unstable") | .tag_name' | head -1 > files/docker/node/release-versions/mithril-unstable.txt
+      - name: Assign unstable version
+        run: |
+          export UNSTABLE_VERSION=$(cat files/docker/node/release-versions/mithril-unstable.txt)
+          echo "UNSTABLE_VERSION=${UNSTABLE_VERSION}" >> $GITHUB_ENV
+          echo "| Unstable version | ${UNSTABLE_VERSION} |" >> $GITHUB_STEP_SUMMARY
+      - name: Check for changes
+        id: git-check
+        run: |
+          export MODIFIED=$([ -z "`git status --porcelain`" ] && echo "false" || echo "true")
+          echo "MODIFIED=${MODIFIED}" >> "$GITHUB_OUTPUT"
+          echo "| Repository Modified | ${MODIFIED} |" >> "$GITHUB_STEP_SUMMARY"
+      - name: Commit latest unstable versions
+        if: steps.git-check.outputs.MODIFIED == 'true'
+        run: |
+          echo "| Modified files | $(git diff --name-only $(jq -r '.sha' "$GITHUB_OUTPUT")) |" >> "$GITHUB_STEP_SUMMARY"
+          git add files/docker/node/release-versions/mithril-unstable.txt
+          git commit -am "New mithril unstable versions: unstable ${UNSTABLE_VERSION}"
+          git push
+  rebase-preview:
+    needs: [get-node-prerelease, get-mithril-prerelease]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set summary details
+        run: |
+          echo "## Rebase Preview" >> $GITHUB_STEP_SUMMARY
+          echo "| Name | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| ---- | ----- |" >> $GITHUB_STEP_SUMMARY
+      - uses: actions/checkout@v2
+        with:
+          ref: preview
+          fetch-depth: 0
+      - name: Configure Git
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+      - name: Fetch alpha
+        run: |
+          git fetch origin alpha
+      - name: Get current SHA
+        run: |
+          echo "sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+      - name: Rebase on alpha
+        run: |
+          git rebase origin/alpha
+      - name: Check for changes
+        id: git-check
+        run: |
+          export MODIFIED=$([ "$(git rev-parse HEAD)" != "$(jq -r '.sha' "$GITHUB_OUTPUT")" ] && echo "true" || echo "false")
+          echo "MODIFIED=${MODIFIED}" >> "$GITHUB_OUTPUT"
+          echo "| Repository Modified | ${MODIFIED} |" >> "$GITHUB_STEP_SUMMARY"
+      - name: Push changes
+        if: steps.git-check.outputs.MODIFIED == 'true'
+        run: |
+          echo "| Changed Files | $(git diff --name-only $(jq -r '.sha' "$GITHUB_OUTPUT")) |" >> "$GITHUB_STEP_SUMMARY"
+          git push --force-with-lease
+  rebase-sanchonet:
+    needs: [get-node-prerelease, get-mithril-unstable]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set summary details
+        run: |
+          echo "## Rebase Sanchonet" >> $GITHUB_STEP_SUMMARY
+          echo "| Name | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| ---- | ----- |" >> $GITHUB_STEP_SUMMARY
+      - uses: actions/checkout@v2
+        with:
+          ref: sanchonet
+          fetch-depth: 0
+      - name: Configure Git
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+      - name: Fetch alpha
+        run: |
+          git fetch origin alpha
+      - name: Get current SHA
+        run: |
+          echo "sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+      - name: Rebase on alpha
+        run: |
+          git rebase origin/alpha
+      - name: Check for changes
+        id: git-check
+        run: |
+          export MODIFIED=$([ "$(git rev-parse HEAD)" != "$(jq -r '.sha' "$GITHUB_OUTPUT")" ] && echo "true" || echo "false")
+          echo "MODIFIED=${MODIFIED}" >> "$GITHUB_OUTPUT"
+          echo "| Repository Modified | ${MODIFIED} |" >> "$GITHUB_STEP_SUMMARY"
+      - name: Push changes
+        if: steps.git-check.outputs.MODIFIED == 'true'
+        run: |
+          echo "| Changed Files | $(git diff --name-only $(jq -r '.sha' "$GITHUB_OUTPUT")) |" >> "$GITHUB_STEP_SUMMARY"
+          git push --force-with-lease
+

.github/workflows/docker_bin.yml

@@ -49,10 +49,14 @@ jobs:
       id: set_short_sha
       run: |
         echo "short_sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
-    - name: Get CNVERSION
+    - name: Set CNVersion
       id: set_cnversion
       run: |
-        echo "cnversion=$(cat files/docker/node/release-versions/cardano-node-latest.txt)" >> $GITHUB_OUTPUT
+        if [[ "${{ steps.set_guild_deploy_branch.outputs.guild_deploy_branch }}" != "preview" && "${{ steps.set_guild_deploy_branch.outputs.guild_deploy_branch }}" != "sanchonet" ]]; then
+          echo "cnversion=$(cat files/docker/node/release-versions/cardano-node-latest.txt)" >> "$GITHUB_OUTPUT"
+        else
+          echo "cnversion=$(cat files/docker/node/release-versions/cardano-node-prerelease.txt)" >> "$GITHUB_OUTPUT"
+        fi
   build_production:
     needs: set_environment_vars
     if: needs.set_environment_vars.outputs.testing == 'false' && needs.set_environment_vars.outputs.guild_deploy_branch == 'master'

docs/Build/node-cli.md

@@ -63,7 +63,7 @@ POOL_NAME="GUILD"
 
 #### Start the node
 
-To test starting the node in interactive mode, we will make use of pre-built script `cnode.sh`. This script automatically determines whether to start the node as a relay or block producer (if the required pool keys are present in the `$CNODE_HOME/priv/pool/<POOL_NAME>` as mentioned above). The script contains a user-defined variable `CPU_CORES` which determines the number of CPU cores the node will use upon start-up:
+To test starting the node in interactive mode, we will make use of pre-built script `cnode.sh`. This script automatically determines whether to start the node as a relay or block producer (if the required pool keys are present in the `$CNODE_HOME/priv/pool/<POOL_NAME>` as mentioned above). If the `<MITHRIL_DOWNLOAD>` variable is set to 'Y' it will download the latest snapshot from a Mithril aggregator to speed up the blockchain synchronization. The script contains a user-defined variable `CPU_CORES` which determines the number of CPU cores the node will use upon start-up:
 
 ```bash
 ######################################

docs/Scripts/mithril-client.md

@@ -1,10 +1,37 @@
 `mithril-client.sh` is a script to manage the Mithril client, a tool used to set up the Mithril client environment and manage downloading Mithril snapshots and stake distributions. The main features include:
 
 - **environment** - Creates a new `mithril.env` file with all the necessary environment variables for the Mithril client.
-- **snapshot** - Download, list all or show a specific available Mithril snapshot.
+- **cardano-db** - Download, list all or show a specific available Mithril snapshot.
 - **stake-distribution** - Download or list available Mithril stake distributions.
 - **-u** - Skip script update check.
 
+## Usage
+
+```bash
+Usage: bash [-u] <command> <subcommand> [<sub arg>]
+A script to run Cardano Mithril Client
+
+-u          Skip script update check overriding UPDATE_CHECK value in env (must be first argument to script)
+
+Commands:
+environment           Manage mithril environment file
+  setup               Setup mithril environment file
+  override            Override default variable in the mithril environment file
+  update              Update mithril environment file
+cardano-db            Interact with Cardano DB
+  download            Download Cardano DB from Mithril snapshot
+  snapshot            Interact with Mithril snapshots
+    list              List available Mithril snapshots
+      json            List availble Mithril snapshots in JSON format
+    show              Show details of a Mithril snapshot
+      json            Show details of a Mithril snapshot in JSON format
+stake-distribution    Interact with Mithril stake distributions
+  download            Download latest stake distribution
+  list                List available stake distributions
+    json              Output latest Mithril snapshot in JSON format
+
+```
+
 ## Preparing a Relay or Block Producer Node
 
 To prepare a relay or block producer node, you should follow these steps:
@@ -18,7 +45,7 @@ To prepare a relay or block producer node, you should follow these steps:
 2. **Download the latest Mithril snapshot:** Once the environment file is set up, you can download the latest Mithril snapshot by running the script with the `snapshot download` command. This snapshot contains the latest state of the Cardano blockchain db from a Mithril Aggregator.
 
    ```bash
-   ./mithril-client.sh snapshot download
+   ./mithril-client.sh cardano-db download
    ```
 
 ## Investigating Available Snapshots
@@ -28,16 +55,16 @@ You can investigate the available snapshots by using the `snapshot list` and `sn
 - **List all available Mithril snapshots:** You can list all available Mithril snapshots by running the script with the `snapshot list` command. Add `json` at the end to get the output in JSON format.
 
   ```bash
-  ./mithril-client.sh snapshot list
-  ./mithril-client.sh snapshot list json
+  ./mithril-client.sh cardano-dbsnapshot list
+  ./mithril-client.sh cardano-dbsnapshot list json
   ```
 
 - **Show details of a specific Mithril snapshot:** You can show details of a specific Mithril snapshot by running the script with the `snapshot show <DIGEST>` command, where `<DIGEST>` is the digest of the snapshot. Add `json` at the end to get the output in JSON format.
 
   ```bash
-  ./mithril-client.sh snapshot show <DIGEST>
-  ./mithril-client.sh snapshot show <DIGEST> json
-  ./mithril-client.sh snapshot show json <DIGEST>
+  ./mithril-client.sh cardano-dbsnapshot show <DIGEST>
+  ./mithril-client.sh cardano-dbsnapshot show <DIGEST> json
+  ./mithril-client.sh cardano-dbsnapshot show json <DIGEST>
   ```
 
 ## Managing Stake Distributions

docs/Scripts/mithril-relay.md

@@ -7,12 +7,13 @@ loadbalancer. It provides functionalities such as:
 ## Usage
 
 ```bash
-Usage: mithril-relay.sh [-d] [-l]
+bash [-d] [-l] [-u] [-h]
+A script to setup Cardano Mithril relays
 
-Options:
-    -d  Install squid and configure as a relay
-    -l  Install nginx and configure as a load balancer
-    -h  Show this help text
+-d  Install squid and configure as a relay
+-l  Install nginx and configure as a load balancer
+-u  Skip update check
+-h  Show this help text
 ```
 
 # Description

docs/Scripts/mithril-signer.md

@@ -5,12 +5,17 @@ environment file to contain variables specific to the Mithril Signer.
 ## Usage
 
 ```bash
-Usage: mithril-signer.sh [-d] [-u]
-
-Options:
-    -d    Deploy mithril-signer as a systemd service
-    -u    Update mithril environment file
-    -h    Show this help text
+Usage: bash [-d] [-D] [-e] [-k] [-r] [-s] [-u] [-h]
+A script to setup, run and verify Cardano Mithril Signer
+
+-d    Deploy mithril-signer as a systemd service
+-D    Run mithril-signer as a daemon
+-e    Update mithril environment file
+-k    Stop signer using SIGINT
+-r    Verify signer registration
+-s    Verify signer signature
+-u    Skip update check
+-h    Show this help text
 ```
 
 # Description