From cc22d231e351cfe7f5a1fa70885a2f9abc6e61ac Mon Sep 17 00:00:00 2001
From: Svyatoslav Nikolsky <svyatonik@gmail.com>
Date: Tue, 26 Mar 2024 11:34:22 +0300
Subject: [PATCH] relayer waits until chain spec version matches the configured
in Client constructor/reconnect (#2894)
---
bridges/relays/client-substrate/Cargo.toml | 2 +-
bridges/relays/client-substrate/src/client.rs | 141 +++++++++++++++++-
bridges/relays/client-substrate/src/error.rs | 12 ++
bridges/relays/client-substrate/src/guard.rs | 10 +-
4 files changed, 153 insertions(+), 12 deletions(-)
diff --git a/bridges/relays/client-substrate/Cargo.toml b/bridges/relays/client-substrate/Cargo.toml
index c1dea9b5015..9240af7b59c 100644
--- a/bridges/relays/client-substrate/Cargo.toml
+++ b/bridges/relays/client-substrate/Cargo.toml
@@ -52,7 +52,7 @@ sp-version = { git = "https://github.com/paritytech/polkadot-sdk", branch = "mas
# Polkadot Dependencies
-xcm = { package = "staging-xcm", git = "https://github.com/paritytech/polkadot-sdk", branch = "master", default-features = false }
+xcm = { package = "staging-xcm", git = "https://github.com/paritytech/polkadot-sdk", branch = "master" }
[features]
default = []
diff --git a/bridges/relays/client-substrate/src/client.rs b/bridges/relays/client-substrate/src/client.rs
index 8328e1ce8be..676fea487b3 100644
--- a/bridges/relays/client-substrate/src/client.rs
+++ b/bridges/relays/client-substrate/src/client.rs
@@ -18,6 +18,7 @@
use crate::{
chain::{Chain, ChainWithTransactions},
+ guard::Environment,
rpc::{
SubstrateAuthorClient, SubstrateChainClient, SubstrateFinalityClient,
SubstrateFrameSystemClient, SubstrateStateClient, SubstrateSystemClient,
@@ -49,7 +50,7 @@ use sp_runtime::{
};
use sp_trie::StorageProof;
use sp_version::RuntimeVersion;
-use std::future::Future;
+use std::{cmp::Ordering, future::Future};
const SUB_API_GRANDPA_AUTHORITIES: &str = "GrandpaApi_grandpa_authorities";
const SUB_API_GRANDPA_GENERATE_KEY_OWNERSHIP_PROOF: &str =
@@ -101,7 +102,7 @@ impl SimpleRuntimeVersion {
}
/// Chain runtime version in client
-#[derive(Clone, Debug)]
+#[derive(Copy, Clone, Debug)]
pub enum ChainRuntimeVersion {
/// Auto query from chain.
Auto,
@@ -164,7 +165,7 @@ impl<C: Chain> Clone for Client<C> {
fn clone(&self) -> Self {
Client {
params: self.params.clone(),
- chain_runtime_version: self.chain_runtime_version.clone(),
+ chain_runtime_version: self.chain_runtime_version,
submit_signed_extrinsic_lock: self.submit_signed_extrinsic_lock.clone(),
genesis_hash: self.genesis_hash,
data: self.data.clone(),
@@ -214,14 +215,48 @@ impl<C: Chain> Client<C> {
})
.await??;
- let chain_runtime_version = params.chain_runtime_version.clone();
- Ok(Self {
+ let chain_runtime_version = params.chain_runtime_version;
+ let mut client = Self {
params,
chain_runtime_version,
submit_signed_extrinsic_lock: Arc::new(Mutex::new(())),
genesis_hash,
data: Arc::new(RwLock::new(ClientData { tokio, client })),
- })
+ };
+ Self::ensure_correct_runtime_version(&mut client, chain_runtime_version).await?;
+ Ok(client)
+ }
+
+ // Check runtime version to understand if we need are connected to expected version, or we
+ // need to wait for upgrade, we need to abort immediately.
+ async fn ensure_correct_runtime_version<E: Environment<C, Error = Error>>(
+ env: &mut E,
+ expected: ChainRuntimeVersion,
+ ) -> Result<()> {
+ // we are only interested if version mode is bundled or passed using CLI
+ let expected = match expected {
+ ChainRuntimeVersion::Auto => return Ok(()),
+ ChainRuntimeVersion::Custom(expected) => expected,
+ };
+
+ // we need to wait if actual version is < than expected, we are OK of versions are the
+ // same and we need to abort if actual version is > than expected
+ let actual = SimpleRuntimeVersion::from_runtime_version(&env.runtime_version().await?);
+ match actual.spec_version.cmp(&expected.spec_version) {
+ Ordering::Less =>
+ Err(Error::WaitingForRuntimeUpgrade { chain: C::NAME.into(), expected, actual }),
+ Ordering::Equal => Ok(()),
+ Ordering::Greater => {
+ log::error!(
+ target: "bridge",
+ "The {} client is configured to use runtime version {expected:?} and actual \
+ version is {actual:?}. Aborting",
+ C::NAME,
+ );
+ env.abort().await;
+ Err(Error::Custom("Aborted".into()))
+ },
+ }
}
/// Build client to use in connection.
@@ -849,3 +884,97 @@ impl<T: DeserializeOwned> Subscription<T> {
}
}
}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{guard::tests::TestEnvironment, test_chain::TestChain};
+ use futures::{channel::mpsc::unbounded, FutureExt};
+
+ async fn run_ensure_correct_runtime_version(
+ expected: ChainRuntimeVersion,
+ actual: RuntimeVersion,
+ ) -> Result<()> {
+ let (
+ (mut runtime_version_tx, runtime_version_rx),
+ (slept_tx, _slept_rx),
+ (aborted_tx, mut aborted_rx),
+ ) = (unbounded(), unbounded(), unbounded());
+ runtime_version_tx.send(actual).await.unwrap();
+ let mut env = TestEnvironment { runtime_version_rx, slept_tx, aborted_tx };
+
+ let ensure_correct_runtime_version =
+ Client::<TestChain>::ensure_correct_runtime_version(&mut env, expected).boxed();
+ let aborted = aborted_rx.next().map(|_| Err(Error::Custom("".into()))).boxed();
+ futures::pin_mut!(ensure_correct_runtime_version, aborted);
+ futures::future::select(ensure_correct_runtime_version, aborted)
+ .await
+ .into_inner()
+ .0
+ }
+
+ #[async_std::test]
+ async fn ensure_correct_runtime_version_works() {
+ // when we are configured to use auto version
+ assert!(matches!(
+ run_ensure_correct_runtime_version(
+ ChainRuntimeVersion::Auto,
+ RuntimeVersion {
+ spec_version: 100,
+ transaction_version: 100,
+ ..Default::default()
+ },
+ )
+ .await,
+ Ok(()),
+ ));
+ // when actual == expected
+ assert!(matches!(
+ run_ensure_correct_runtime_version(
+ ChainRuntimeVersion::Custom(SimpleRuntimeVersion {
+ spec_version: 100,
+ transaction_version: 100
+ }),
+ RuntimeVersion {
+ spec_version: 100,
+ transaction_version: 100,
+ ..Default::default()
+ },
+ )
+ .await,
+ Ok(()),
+ ));
+ // when actual spec version < expected spec version
+ assert!(matches!(
+ run_ensure_correct_runtime_version(
+ ChainRuntimeVersion::Custom(SimpleRuntimeVersion {
+ spec_version: 100,
+ transaction_version: 100
+ }),
+ RuntimeVersion { spec_version: 99, transaction_version: 100, ..Default::default() },
+ )
+ .await,
+ Err(Error::WaitingForRuntimeUpgrade {
+ expected: SimpleRuntimeVersion { spec_version: 100, transaction_version: 100 },
+ actual: SimpleRuntimeVersion { spec_version: 99, transaction_version: 100 },
+ ..
+ }),
+ ));
+ // when actual spec version > expected spec version
+ assert!(matches!(
+ run_ensure_correct_runtime_version(
+ ChainRuntimeVersion::Custom(SimpleRuntimeVersion {
+ spec_version: 100,
+ transaction_version: 100
+ }),
+ RuntimeVersion {
+ spec_version: 101,
+ transaction_version: 100,
+ ..Default::default()
+ },
+ )
+ .await,
+ Err(Error::Custom(_)),
+ ));
+ }
+}
diff --git a/bridges/relays/client-substrate/src/error.rs b/bridges/relays/client-substrate/src/error.rs
index 40015c122bb..257771b70b1 100644
--- a/bridges/relays/client-substrate/src/error.rs
+++ b/bridges/relays/client-substrate/src/error.rs
@@ -16,6 +16,7 @@
//! Substrate node RPC errors.
+use crate::SimpleRuntimeVersion;
use bp_polkadot_core::parachains::ParaId;
use jsonrpsee::core::Error as RpcError;
use relay_utils::MaybeConnectionError;
@@ -117,6 +118,17 @@ pub enum Error {
/// The Substrate transaction is invalid.
#[error("Substrate transaction is invalid: {0:?}")]
TransactionInvalid(#[from] TransactionValidityError),
+ /// The client is configured to use newer runtime version than the connected chain uses.
+ /// The client will keep waiting until chain is upgraded to given version.
+ #[error("Waiting for {chain} runtime upgrade: expected {expected:?} actual {actual:?}")]
+ WaitingForRuntimeUpgrade {
+ /// Name of the chain where the error has happened.
+ chain: String,
+ /// Expected runtime version.
+ expected: SimpleRuntimeVersion,
+ /// Actual runtime version.
+ actual: SimpleRuntimeVersion,
+ },
/// Custom logic error.
#[error("{0}")]
Custom(String),
diff --git a/bridges/relays/client-substrate/src/guard.rs b/bridges/relays/client-substrate/src/guard.rs
index 545396b30b8..47454892cd0 100644
--- a/bridges/relays/client-substrate/src/guard.rs
+++ b/bridges/relays/client-substrate/src/guard.rs
@@ -107,7 +107,7 @@ impl<C: Chain> Environment<C> for Client<C> {
}
#[cfg(test)]
-mod tests {
+pub(crate) mod tests {
use super::*;
use crate::test_chain::TestChain;
use futures::{
@@ -117,10 +117,10 @@ mod tests {
SinkExt,
};
- struct TestEnvironment {
- runtime_version_rx: UnboundedReceiver<RuntimeVersion>,
- slept_tx: UnboundedSender<()>,
- aborted_tx: UnboundedSender<()>,
+ pub struct TestEnvironment {
+ pub runtime_version_rx: UnboundedReceiver<RuntimeVersion>,
+ pub slept_tx: UnboundedSender<()>,
+ pub aborted_tx: UnboundedSender<()>,
}
#[async_trait]
--
GitLab