Merge pull request #1883 from input-output-hk/dlachaume/1880/implemen…

…t-cardano-stake-distribution-in-client-cli Implement Cardano stake distribution commands in `mithril-client` CLI
input-output-hk · Aug 12, 2024 · dea7b54 · dea7b54
2 parents c9a1e5b + bf5135f
commit dea7b54
Show file tree

Hide file tree

Showing 14 changed files with 559 additions and 24 deletions.
diff --git a/.github/workflows/test-client.yml b/.github/workflows/test-client.yml
@@ -77,7 +77,9 @@ jobs:
         shell: bash
         run: |
           CTX_CAPABILITY=$(wget -q -O - $AGGREGATOR_ENDPOINT | jq '.capabilities.signed_entity_types | contains(["CardanoTransactions"])')
+          CSD_CAPABILITY=$(wget -q -O - $AGGREGATOR_ENDPOINT | jq '.capabilities.signed_entity_types | contains(["CardanoStakeDistribution"])')
           echo "ctx_enabled=$CTX_CAPABILITY" >> $GITHUB_OUTPUT
+          echo "csd_enabled=$CSD_CAPABILITY" >> $GITHUB_OUTPUT
 
       - name: Assessing aggregator capabilities (Windows)
         id: aggregator_capability_windows
@@ -86,7 +88,9 @@ jobs:
         run: |
           aria2c -o aggregator_capabilities.json $AGGREGATOR_ENDPOINT
           CTX_CAPABILITY=$(jq '.capabilities.signed_entity_types | contains(["CardanoTransactions"])' aggregator_capabilities.json)
+          CSD_CAPABILITY=$(jq '.capabilities.signed_entity_types | contains(["CardanoStakeDistribution"])' aggregator_capabilities.json)
           echo "ctx_enabled=$CTX_CAPABILITY" >> $GITHUB_OUTPUT
+          echo "csd_enabled=$CSD_CAPABILITY" >> $GITHUB_OUTPUT
 
       - name: Checkout binary
         uses: dawidd6/action-download-artifact@v3
@@ -152,6 +156,28 @@ jobs:
         working-directory: ./bin
         run: ./mithril-client --unstable ${{ steps.prepare.outputs.debug_level }} cardano-transaction certify $TRANSACTIONS_HASHES_TO_CERTIFY
 
+      - name: Cardano Stake Distribution / list and get last epoch and hash
+        if: steps.aggregator_capability_unix.outputs.csd_enabled == 'true' || steps.aggregator_capability_windows.outputs.csd_enabled == 'true'
+        shell: bash
+        working-directory: ./bin
+        run: |
+          ./mithril-client --unstable ${{ steps.prepare.outputs.debug_level }} cardano-stake-distribution list
+          CMD_OUTPUT=$(./mithril-client --unstable cardano-stake-distribution list --json)
+          echo "CARDANO_STAKE_DISTRIBUTION_EPOCH=$(echo "$CMD_OUTPUT" | jq -r '.[0].epoch')" >> $GITHUB_ENV
+          echo "CARDANO_STAKE_DISTRIBUTION_HASH=$(echo "$CMD_OUTPUT" | jq -r '.[0].hash')" >> $GITHUB_ENV
+
+      - name: Cardano Stake Distribution / download & restore latest by epoch
+        if: steps.aggregator_capability_unix.outputs.csd_enabled == 'true' || steps.aggregator_capability_windows.outputs.csd_enabled == 'true'
+        shell: bash
+        working-directory: ./bin
+        run: ./mithril-client --unstable ${{ steps.prepare.outputs.debug_level }} cardano-stake-distribution download $CARDANO_STAKE_DISTRIBUTION_EPOCH
+
+      - name: Cardano Stake Distribution / download & restore latest by hash
+        if: steps.aggregator_capability_unix.outputs.csd_enabled == 'true' || steps.aggregator_capability_windows.outputs.csd_enabled == 'true'
+        shell: bash
+        working-directory: ./bin
+        run: ./mithril-client --unstable ${{ steps.prepare.outputs.debug_level }} cardano-stake-distribution download $CARDANO_STAKE_DISTRIBUTION_HASH
+
   test-docker:
     strategy:
       fail-fast: false
@@ -178,7 +204,9 @@ jobs:
         shell: bash
         run: |
           CTX_CAPABILITY=$(wget -q -O - $AGGREGATOR_ENDPOINT | jq '.capabilities.signed_entity_types | contains(["CardanoTransactions"])')
+          CSD_CAPABILITY=$(wget -q -O - $AGGREGATOR_ENDPOINT | jq '.capabilities.signed_entity_types | contains(["CardanoStakeDistribution"])')
           echo "ctx_enabled=$CTX_CAPABILITY" >> $GITHUB_OUTPUT
+          echo "csd_enabled=$CSD_CAPABILITY" >> $GITHUB_OUTPUT
 
       - name: Prepare Mithril client command
         id: command
@@ -227,6 +255,25 @@ jobs:
         shell: bash
         run: ${{ steps.command.outputs.mithril_client }} --unstable ${{ steps.prepare.outputs.debug_level }} cardano-transaction certify $TRANSACTIONS_HASHES_TO_CERTIFY
 
+      - name: Cardano Stake Distribution / list and get last epoch and hash
+        if: steps.aggregator_capability.outputs.csd_enabled == 'true'
+        shell: bash
+        run: |
+          ${{ steps.command.outputs.mithril_client }} --unstable cardano-stake-distribution list
+          CMD_OUTPUT=$(${{ steps.command.outputs.mithril_client }} --unstable cardano-stake-distribution list --json)
+          echo "CARDANO_STAKE_DISTRIBUTION_EPOCH=$(echo "$CMD_OUTPUT" | jq -r '.[0].epoch')" >> $GITHUB_ENV
+          echo "CARDANO_STAKE_DISTRIBUTION_HASH=$(echo "$CMD_OUTPUT" | jq -r '.[0].hash')" >> $GITHUB_ENV
+
+      - name: Cardano Stake Distribution / download & restore latest by epoch
+        if: steps.aggregator_capability.outputs.csd_enabled == 'true'
+        shell: bash
+        run: ${{ steps.command.outputs.mithril_client }} --unstable ${{ steps.prepare.outputs.debug_level }} cardano-stake-distribution download $CARDANO_STAKE_DISTRIBUTION_EPOCH --download-dir /app
+
+      - name: Cardano Stake Distribution / download & restore latest by hash
+        if: steps.aggregator_capability.outputs.csd_enabled == 'true'
+        shell: bash
+        run: ${{ steps.command.outputs.mithril_client }} --unstable ${{ steps.prepare.outputs.debug_level }} cardano-stake-distribution download $CARDANO_STAKE_DISTRIBUTION_HASH --download-dir /app
+
   test-mithril-client-wasm:
     strategy:
       fail-fast: false

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ As a minor extension, we have adopted a slightly different versioning convention
   - Implement the signable and artifact builders for the signed entity type `CardanoStakeDistribution`.
   - Implement the HTTP routes related to the signed entity type `CardanoStakeDistribution` on the aggregator REST API.
   - Added support in the `mithril-client` library for retrieving `CardanoStakeDistribution` by epoch or by hash, and for listing all available `CardanoStakeDistribution`.
+  - Implement `CardanoStakeDistribution` commands under the `--unstable` flag in the Mithril client CLI to list all available `CardanoStakeDistribution` and to download artifact by epoch or hash.
 
 - Crates versions:
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-client-cli/Cargo.toml b/mithril-client-cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.9.10"
+version = "0.9.11"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }