CW-53: Added a runtime metadata check

.github/scripts/run_consensus.sh

@@ -83,7 +83,7 @@ function generate_chainspec() {
 
   echo "Generate chainspec and keystores for accounts: ${account_ids_comma_separated[@]}"
   docker run --rm -v $(pwd)/docker/data:/data --entrypoint "/bin/sh" -e RUST_LOG=debug "${CHAIN_BOOTSTRAPPER_IMAGE}" \
-  -c "chain-bootstrapper bootstrap-chain --base-path /data --account-ids ${account_ids_comma_separated} --authorities-account-ids ${validator_ids_comma_separated}  > /data/chainspec.json"
+  -c "chain-bootstrapper bootstrap-chain --base-path /data --account-ids ${account_ids_comma_separated} --authorities-account-ids ${validator_ids_comma_separated} --raw > /data/chainspec.json"
 }
 
 function generate_bootnode_peer_id() {

.github/workflows/_check-runtime-metadata.yml

@@ -0,0 +1,109 @@
+---
+#  This workflow builds subxt-cli, starts local one-node consensus chain and
+#  uses subxt codegen to compare live chain data with what is versioned in git
+name: Check runtime metadata
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: "git ref: hash, branch, tag or 'mainnet' or 'testnet'"
+        type: string
+        required: true
+      artifact-aleph-node-image:
+        description: 'Name of aleph-node image stored in GH Artifacts'
+        type: string
+        required: true
+      artifact-chain-bootstrapper-image:
+        description: 'chain-bootstrapper image name in GH artifacts'
+        type: string
+        required: true
+jobs:
+  build-subxt:
+    name: Build subxt
+    runs-on: [self-hosted, Linux, X64, large]
+    env:
+      RUST_BACKTRACE: full
+      RUSTC_WRAPPER: sccache
+    steps:
+      - name: Checkout aleph-node source code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          fetch-depth: 0
+
+      - name: Call action get-ref-properties
+        id: get-ref-properties
+        uses: Cardinal-Cryptography/github-actions/get-ref-properties@v7
+
+      - name: Install Rust toolchain
+        uses: Cardinal-Cryptography/github-actions/install-rust-toolchain@v7
+        with:
+          targets: wasm32-unknown-unknown
+
+      - name: Build subxt-cli
+        shell: bash
+        run: |
+          # same version as in aleph-client's Cargo.toml
+          cargo install subxt-cli --version 0.30.1
+
+      - name: Get subxt-cli path
+        id: get-subxt-path
+        shell: bash
+        run: |
+          subxt_path=$(which subxt)
+          echo "path=${subxt_path}" >> $GITHUB_OUTPUT
+
+      - name: Upload subxt binary to GH artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: subxt-binary
+          path: ${{ steps.get-subxt-path.outputs.path }}
+          if-no-files-found: error
+          retention-days: 7
+
+  check-metadata:
+    name: Check runtime metadata
+    needs: [build-subxt]
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout aleph-node source code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          fetch-depth: 0
+
+      - name: Download node docker image
+        uses: actions/download-artifact@v4
+        with:
+          name: subxt-binary
+
+      - name: Download node docker image
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.artifact-aleph-node-image }}
+
+      - name: Load node docker image
+        shell: bash
+        run: docker load -i aleph-node.tar
+
+      - name: Download chain-bootstrapper image
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.artifact-chain-bootstrapper-image }}
+
+      - name: Load chain-bootstrapper image
+        shell: bash
+        run: docker load -i chain-bootstrapper.tar
+
+      - name: Run consensus party
+        shell: bash
+        run: |
+          ./.github/scripts/run_consensus.sh -n 1
+          sleep 30
+
+      - name: Check metadata
+        shell: bash
+        run: |
+          chmod +x subxt
+          cd aleph-client
+          SUBXT_BINARY=../subxt ./check-runtime-metadata.sh

.github/workflows/on-pull-request-commit.yml

@@ -49,6 +49,18 @@ jobs:
     name: Check production node and runtime
     uses: ./.github/workflows/_check-production-node-and-runtime.yml
 
+  check-runtime-metadata:
+    name: Check runtime metadata
+    needs:
+      - build-test-aleph-node
+      - build-chain-bootstrapper
+    uses: ./.github/workflows/_check-runtime-metadata.yml
+    with:
+      ref: ${{ github.ref }}
+      artifact-aleph-node-image: ${{ needs.build-test-aleph-node.outputs.artifact-name-image }}
+      # yamllint disable-line rule:line-length
+      artifact-chain-bootstrapper-image: ${{ needs.build-chain-bootstrapper.outputs.artifact-name-image }}
+
   build-test-aleph-node:
     name: Build test aleph-node
     uses: ./.github/workflows/_build-aleph-node.yml

aleph-client/docker/subxt-integration-entrypoint.sh → aleph-client/check-runtime-metadata.sh

@@ -1,10 +1,13 @@
 #!/usr/bin/env bash
 
-subxt codegen --derive Clone --derive Debug --derive PartialEq --derive Eq \
+echo "This script must be run from the aleph-client directory."
+SUBXT_BINARY=${SUBXT_BINARY:-"subxt"}
+
+"${SUBXT_BINARY}" codegen --derive Clone --derive Debug --derive PartialEq --derive Eq \
   --substitute-type 'sp_core::crypto::AccountId32=::subxt::utils::Static<::subxt::ext::sp_core::crypto::AccountId32>' \
-  | rustfmt --edition=2021 --config-path aleph-node/rustfmt.toml > aleph_zero.rs;
+  | rustfmt --edition=2021 --config-path rustfmt.toml > aleph_zero.rs;
 
-diff -y -W 200 --suppress-common-lines aleph_zero.rs aleph-node/aleph-client/src/aleph_zero.rs
+diff -y -W 200 --suppress-common-lines aleph_zero.rs src/aleph_zero.rs
 diff_exit_code=$?
 if [[ ! $diff_exit_code -eq 0 ]]; then
   echo "Current runtime metadata is different than versioned in git!"

aleph-client/src/aleph_zero.rs

@@ -2075,9 +2075,9 @@ pub mod api {
             .hash();
         runtime_metadata_hash
             == [
-                254u8, 200u8, 139u8, 229u8, 182u8, 242u8, 46u8, 196u8, 112u8, 184u8, 161u8, 232u8,
-                129u8, 49u8, 226u8, 113u8, 114u8, 72u8, 155u8, 188u8, 131u8, 171u8, 11u8, 1u8,
-                35u8, 152u8, 155u8, 138u8, 53u8, 78u8, 176u8, 47u8,
+                115u8, 13u8, 54u8, 26u8, 248u8, 53u8, 14u8, 227u8, 103u8, 17u8, 45u8, 180u8, 199u8,
+                63u8, 105u8, 193u8, 146u8, 2u8, 207u8, 204u8, 119u8, 126u8, 56u8, 214u8, 233u8,
+                168u8, 66u8, 4u8, 159u8, 15u8, 224u8, 180u8,
             ]
     }
     pub mod system {
@@ -9477,10 +9477,10 @@ pub mod api {
                         "NextAuthorities",
                         vec![],
                         [
-                            207u8, 65u8, 187u8, 184u8, 128u8, 170u8, 162u8, 124u8, 3u8, 121u8,
-                            231u8, 236u8, 27u8, 131u8, 223u8, 66u8, 81u8, 32u8, 28u8, 2u8, 228u8,
-                            174u8, 133u8, 85u8, 129u8, 207u8, 165u8, 61u8, 0u8, 124u8, 164u8,
-                            246u8,
+                            228u8, 138u8, 101u8, 251u8, 183u8, 146u8, 98u8, 145u8, 172u8, 29u8,
+                            10u8, 111u8, 91u8, 160u8, 3u8, 43u8, 189u8, 168u8, 233u8, 231u8, 105u8,
+                            190u8, 200u8, 168u8, 61u8, 22u8, 162u8, 126u8, 213u8, 63u8, 131u8,
+                            47u8,
                         ],
                     )
                 }

pallets/aleph/src/lib.rs

@@ -68,20 +68,13 @@ pub mod pallet {
         DEFAULT_FINALITY_VERSION
     }
 
-    /// Default value for `NextAuthorities` storage.
-    #[pallet::type_value]
-    pub(crate) fn DefaultNextAuthorities<T: Config>() -> Vec<T::AuthorityId> {
-        T::NextSessionAuthorityProvider::next_authorities()
-    }
-
     #[pallet::storage]
     #[pallet::getter(fn authorities)]
     pub(super) type Authorities<T: Config> = StorageValue<_, Vec<T::AuthorityId>, ValueQuery>;
 
     #[pallet::storage]
     #[pallet::getter(fn next_authorities)]
-    pub(super) type NextAuthorities<T: Config> =
-        StorageValue<_, Vec<T::AuthorityId>, ValueQuery, DefaultNextAuthorities<T>>;
+    pub(super) type NextAuthorities<T: Config> = StorageValue<_, Vec<T::AuthorityId>, ValueQuery>;
 
     /// Set of account ids that will be used as authorities in the next session
     #[pallet::storage]