A0-1502: Finality version e2e test

.github/scripts/run_consensus.sh

@@ -12,6 +12,9 @@ OVERRIDE_DOCKER_COMPOSE=${OVERRIDE_DOCKER_COMPOSE:-""}
 # default minimum validator count
 MIN_VALIDATOR_COUNT=4
 
+# default minimum validator count
+MIN_VALIDATOR_COUNT=4
+
 export NODE_IMAGE=aleph-node:latest
 
 mkdir -p docker/data/

.github/workflows/e2e-tests-main-devnet.yml

@@ -615,6 +615,21 @@ jobs:
         run: |
           ./scripts/catchup_version_upgrade_test.sh
 
+  run-e2e-finality-version-change:
+    needs: [build-test-docker, build-test-client]
+    name: Run finality version change test
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Run e2e test
+        uses: ./.github/actions/run-e2e-test
+        with:
+          test-case: finality_version_change
+          follow-up-finalization-check: true
+        timeout-minutes: 10
+
   check-e2e-test-suite-completion:
     needs: [
       run-e2e-finalization-test,
@@ -642,6 +657,7 @@ jobs:
       run-e2e-version-upgrade,
       run-e2e-failing-version-upgrade,
       run-e2e-version-upgrade-catchup,
+      run-e2e-finality-version-change,
     ]
     name: Check e2e test suite completion
     runs-on: ubuntu-20.04

aleph-client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aleph_client"
-version = "2.2.0"
+version = "2.3.0"
 edition = "2021"
 license = "Apache 2.0"
 

aleph-client/src/aleph_zero.rs

@@ -6386,6 +6386,26 @@ pub mod api {
                         ],
                     )
                 }
+                #[doc = " Next session finality version."]
+                pub fn next_session_finality_version(
+                    &self,
+                ) -> ::subxt::storage::address::StaticStorageAddress<
+                    ::subxt::metadata::DecodeStaticType<::core::primitive::u32>,
+                    ::subxt::storage::address::Yes,
+                    ::subxt::storage::address::Yes,
+                    (),
+                > {
+                    ::subxt::storage::address::StaticStorageAddress::new(
+                        "Aleph",
+                        "NextSessionFinalityVersion",
+                        vec![],
+                        [
+                            160u8, 211u8, 96u8, 130u8, 62u8, 24u8, 39u8, 81u8, 35u8, 251u8, 54u8,
+                            64u8, 148u8, 207u8, 140u8, 56u8, 1u8, 57u8, 20u8, 148u8, 54u8, 152u8,
+                            137u8, 146u8, 207u8, 116u8, 160u8, 50u8, 178u8, 126u8, 207u8, 117u8,
+                        ],
+                    )
+                }
                 #[doc = " Scheduled finality version change."]
                 pub fn finality_scheduled_version_change(
                     &self,
@@ -19418,9 +19438,9 @@ pub mod api {
         let runtime_metadata_hash = client.metadata().metadata_hash(&PALLETS);
         if runtime_metadata_hash
             != [
-                243u8, 4u8, 194u8, 236u8, 110u8, 103u8, 34u8, 147u8, 254u8, 117u8, 205u8, 237u8,
-                68u8, 20u8, 176u8, 209u8, 157u8, 106u8, 80u8, 136u8, 50u8, 186u8, 119u8, 248u8,
-                34u8, 65u8, 187u8, 187u8, 110u8, 81u8, 88u8, 22u8,
+                248u8, 246u8, 131u8, 72u8, 246u8, 127u8, 112u8, 242u8, 195u8, 249u8, 99u8, 217u8,
+                184u8, 235u8, 164u8, 100u8, 197u8, 133u8, 225u8, 3u8, 228u8, 60u8, 163u8, 20u8,
+                13u8, 159u8, 133u8, 146u8, 64u8, 89u8, 20u8, 39u8,
             ]
         {
             Err(::subxt::error::MetadataError::IncompatibleMetadata)

aleph-client/src/pallets/aleph.rs

@@ -1,8 +1,9 @@
 use codec::Encode;
-use primitives::{BlockNumber, SessionIndex};
+use primitives::{BlockNumber, SessionIndex, Version};
 use subxt::rpc_params;
 
 use crate::{
+    api,
     api::runtime_types::{
         pallet_aleph::pallet::Call::set_emergency_finalizer, primitives::app::Public,
         sp_core::ed25519::Public as EdPublic,
@@ -13,6 +14,13 @@ use crate::{
     Connection, Pair, RootConnection, SudoCall, TxStatus,
 };
 
+#[async_trait::async_trait]
+pub trait AlephApi {
+    async fn finality_version(&self, at: Option<BlockHash>) -> Version;
+
+    async fn next_session_finality_version(&self, at: Option<BlockHash>) -> Version;
+}
+
 #[async_trait::async_trait]
 pub trait AlephSudoApi {
     async fn set_emergency_finalizer(
@@ -39,6 +47,21 @@ pub trait AlephRpc {
     ) -> anyhow::Result<()>;
 }
 
+#[async_trait::async_trait]
+impl AlephApi for Connection {
+    async fn finality_version(&self, at: Option<BlockHash>) -> Version {
+        let addrs = api::storage().aleph().finality_version();
+
+        self.get_storage_entry(&addrs, at).await
+    }
+
+    async fn next_session_finality_version(&self, at: Option<BlockHash>) -> Version {
+        let addrs = api::storage().aleph().next_session_finality_version();
+
+        self.get_storage_entry(&addrs, at).await
+    }
+}
+
 #[async_trait::async_trait]
 impl AlephSudoApi for RootConnection {
     async fn set_emergency_finalizer(

bin/node/src/chain_spec.rs

@@ -5,8 +5,9 @@ use aleph_primitives::{
     AuthorityId as AlephId, ADDRESSES_ENCODING, TOKEN, TOKEN_DECIMALS,
 };
 use aleph_runtime::{
-    AccountId, AuraConfig, BalancesConfig, ElectionsConfig, GenesisConfig, Perbill, SessionConfig,
-    SessionKeys, StakingConfig, SudoConfig, SystemConfig, VestingConfig, WASM_BINARY,
+    AccountId, AlephConfig, AuraConfig, BalancesConfig, ElectionsConfig, GenesisConfig, Perbill,
+    SessionConfig, SessionKeys, StakingConfig, SudoConfig, SystemConfig, VestingConfig,
+    WASM_BINARY,
 };
 use clap::Args;
 use libp2p::PeerId;
@@ -395,6 +396,9 @@ fn generate_genesis_config(
             min_nominator_bond: MIN_NOMINATOR_BOND,
             ..Default::default()
         },
+        aleph: AlephConfig {
+            ..Default::default()
+        },
         treasury: Default::default(),
         vesting: VestingConfig { vesting: vec![] },
         nomination_pools: Default::default(),

bin/node/src/rpc.rs

@@ -39,6 +39,7 @@ where
     C::Api: pallet_contracts_rpc::ContractsRuntimeApi<Block, AccountId, Balance, BlockNumber, Hash>,
     C::Api: substrate_frame_rpc_system::AccountNonceApi<Block, AccountId, Index>,
     C::Api: pallet_transaction_payment_rpc::TransactionPaymentRuntimeApi<Block, Balance>,
+    C::Api: aleph_primitives::AlephSessionApi<Block>,
     C::Api: BlockBuilder<Block>,
     P: TransactionPool + 'static,
     B: BlockT,

bin/runtime/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aleph-runtime"
-version = "0.8.2"
+version = "0.9.0"
 authors = ["Cardinal Cryptography"]
 edition = "2021"
 homepage = "https://alephzero.org"

bin/runtime/src/lib.rs

@@ -108,7 +108,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
     spec_name: create_runtime_str!("aleph-node"),
     impl_name: create_runtime_str!("aleph-node"),
     authoring_version: 1,
-    spec_version: 41,
+    spec_version: 42,
     impl_version: 1,
     apis: RUNTIME_API_VERSIONS,
     transaction_version: 13,

e2e-tests/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aleph-e2e-client"
-version = "0.9.2"
+version = "0.10.0"
 edition = "2021"
 license = "Apache 2.0"
 

e2e-tests/src/cases.rs

@@ -9,7 +9,8 @@ use crate::{
         channeling_fee_and_tip as test_channeling_fee_and_tip,
         clearing_session_count as test_clearing_session_count, disable_node as test_disable_node,
         era_payouts_calculated_correctly as test_era_payout, era_validators as test_era_validators,
-        fee_calculation as test_fee_calculation, finalization as test_finalization,
+        fee_calculation as test_fee_calculation,
+        finality_version_change as test_finality_version_change, finalization as test_finalization,
         force_new_era as test_force_new_era, points_basic as test_points_basic,
         points_stake_change as test_points_stake_change,
         schedule_doomed_version_change_and_verify_finalization_stopped as test_schedule_doomed_version_change_and_verify_finalization_stopped,
@@ -51,6 +52,7 @@ pub async fn run_testcase(id: &str, config: &Config) -> anyhow::Result<()> {
         "doomed_version_upgrade" => {
             test_schedule_doomed_version_change_and_verify_finalization_stopped(config).await
         }
+        "finality_version_change" => test_finality_version_change(config).await,
         _ => panic!("unknown testcase"),
     }
 }
@@ -81,6 +83,7 @@ pub async fn run_all_testcases(config: &Config) -> anyhow::Result<()> {
         "ban_manual",
         "ban_threshold",
         "doomed_version_upgrade",
+        "finality_version_change",
     ];
 
     for testcase in all {

e2e-tests/src/finality_version.rs

@@ -0,0 +1,31 @@
+use aleph_client::{pallets::aleph::AlephApi, utility::BlocksApi, Connection};
+use log::info;
+use primitives::{BlockNumber, Version};
+
+pub async fn check_finality_version_at_block(
+    connection: &Connection,
+    block_number: BlockNumber,
+    expected_version: Version,
+) {
+    info!(
+        "Checking current session finality version for block {}",
+        block_number
+    );
+    let block_hash = connection.get_block_hash(block_number).await;
+    let finality_version = connection.finality_version(block_hash).await;
+    assert_eq!(finality_version, expected_version);
+}
+
+pub async fn check_next_session_finality_version_at_block(
+    connection: &Connection,
+    block_number: BlockNumber,
+    expected_version: Version,
+) {
+    info!(
+        "Checking next session finality version for block {}",
+        block_number
+    );
+    let block_hash = connection.get_block_hash(block_number).await;
+    let next_finality_version = connection.next_session_finality_version(block_hash).await;
+    assert_eq!(next_finality_version, expected_version);
+}

e2e-tests/src/lib.rs

@@ -6,6 +6,7 @@ mod ban;
 mod cases;
 mod config;
 mod elections;
+mod finality_version;
 mod rewards;
 mod test;
 mod transfer;