pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-24 12:31:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow to specify multiple relay chain RPC urls for collator node (#1880)

Browse Source 
* Allow specification of multiple urls for relay chain rpc nodes

* Add pooled RPC client basics

* Add list of clients to pooled client

* Improve

* Forward requests to dispatcher

* Switch clients on error

* Implement rotation logic

* Improve subscription handling

* Error handling cleanup

* Remove retry from rpc-client

* Improve naming

* Improve documentation

* Improve `ClientManager` abstraction

* Adjust zombienet test

* Add more comments

* fmt

* Apply reviewers comments

* Extract reconnection to extra method

* Add comment to reconnection method

* Clean up some dependencies

* Fix build

* fmt

* Provide alias for cli argument

* Apply review comments

* Rename P* to Relay*

* Improve zombienet test

* fmt

* Fix zombienet sleep

* Simplify zombienet test

* Reduce log clutter and fix starting position

* Do not distribute duplicated imported and finalized blocks

* fmt

* Apply code review suggestions

* Move building of relay chain interface to `cumulus-client-service`

* Refactoring to not push back into channel

* FMT
This commit is contained in:
Sebastian Kunert
2022-12-15 11:42:07 +01:00
committed by GitHub
parent 50f212d8c0
commit 7cab12e9d2
22 changed files with 720 additions and 428 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cumulus/Cargo.lock
Generated
+13 -27
View File
@@ -379,20 +379,6 @@ version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
[[package]]
name = "backoff"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b62ddb9cb1ec0a098ad4bbf9344d0713fa193ae1a80af55febcff2627b6a00c1"
dependencies = [
"futures-core",
"getrandom 0.2.3",
"instant",
"pin-project-lite 0.2.9",
"rand 0.8.5",
"tokio",
]
[[package]] [[package]]
name = "backtrace" name = "backtrace"
version = "0.3.64" version = "0.3.64"
@@ -1797,12 +1783,16 @@ dependencies = [
"cumulus-client-consensus-common", "cumulus-client-consensus-common",
"cumulus-client-pov-recovery", "cumulus-client-pov-recovery",
"cumulus-primitives-core", "cumulus-primitives-core",
"cumulus-relay-chain-inprocess-interface",
"cumulus-relay-chain-interface", "cumulus-relay-chain-interface",
"cumulus-relay-chain-minimal-node",
"parking_lot 0.12.1", "parking_lot 0.12.1",
"polkadot-primitives", "polkadot-primitives",
"sc-client-api", "sc-client-api",
"sc-consensus", "sc-consensus",
"sc-service", "sc-service",
"sc-sysinfo",
"sc-telemetry",
"sp-api", "sp-api",
"sp-blockchain", "sp-blockchain",
"sp-consensus", "sp-consensus",
@@ -2082,6 +2072,7 @@ dependencies = [
"sp-blockchain", "sp-blockchain",
"sp-state-machine", "sp-state-machine",
"thiserror", "thiserror",
"tokio",
] ]
[[package]] [[package]]
@@ -2128,21 +2119,22 @@ name = "cumulus-relay-chain-rpc-interface"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"backoff",
"cumulus-primitives-core", "cumulus-primitives-core",
"cumulus-relay-chain-interface", "cumulus-relay-chain-interface",
"futures", "futures",
"futures-timer", "futures-timer",
"jsonrpsee", "jsonrpsee",
"lru",
"parity-scale-codec", "parity-scale-codec",
"polkadot-service", "polkadot-service",
"sc-client-api", "sc-client-api",
"sc-rpc-api", "sc-rpc-api",
"serde",
"serde_json",
"sp-api", "sp-api",
"sp-authority-discovery", "sp-authority-discovery",
"sp-consensus-babe", "sp-consensus-babe",
"sp-core", "sp-core",
"sp-runtime",
"sp-state-machine", "sp-state-machine",
"sp-storage", "sp-storage",
"tokio", "tokio",
@@ -6551,10 +6543,7 @@ dependencies = [
"cumulus-client-service", "cumulus-client-service",
"cumulus-primitives-core", "cumulus-primitives-core",
"cumulus-primitives-parachain-inherent", "cumulus-primitives-parachain-inherent",
"cumulus-relay-chain-inprocess-interface",
"cumulus-relay-chain-interface", "cumulus-relay-chain-interface",
"cumulus-relay-chain-minimal-node",
"cumulus-relay-chain-rpc-interface",
"frame-benchmarking", "frame-benchmarking",
"frame-benchmarking-cli", "frame-benchmarking-cli",
"jsonrpsee", "jsonrpsee",
@@ -7780,10 +7769,7 @@ dependencies = [
"cumulus-client-service", "cumulus-client-service",
"cumulus-primitives-core", "cumulus-primitives-core",
"cumulus-primitives-parachain-inherent", "cumulus-primitives-parachain-inherent",
"cumulus-relay-chain-inprocess-interface",
"cumulus-relay-chain-interface", "cumulus-relay-chain-interface",
"cumulus-relay-chain-minimal-node",
"cumulus-relay-chain-rpc-interface",
"frame-benchmarking", "frame-benchmarking",
"frame-benchmarking-cli", "frame-benchmarking-cli",
"futures", "futures",
@@ -10584,9 +10570,9 @@ dependencies = [
[[package]] [[package]]
name = "serde_json" name = "serde_json"
version = "1.0.85" version = "1.0.89"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e55a28e3aaef9d5ce0506d0a14dbba8054ddc7e499ef522dd8b26859ec9d4a44" checksum = "020ff22c755c2ed3f8cf162dbb41a7268d934702f3ed3631656ea597e08fc3db"
dependencies = [ dependencies = [
"itoa 1.0.4", "itoa 1.0.4",
"ryu", "ryu",
@@ -12611,7 +12597,7 @@ checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675"
dependencies = [ dependencies = [
"cfg-if", "cfg-if",
"digest 0.10.3", "digest 0.10.3",
"rand 0.8.5", "rand 0.7.3",
"static_assertions", "static_assertions",
] ]
@@ -13724,9 +13710,9 @@ dependencies = [
[[package]] [[package]]
name = "yamux" name = "yamux"
version = "0.10.1" version = "0.10.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0c0608f53c1dc0bad505d03a34bbd49fbf2ad7b51eb036123e896365532745a1" checksum = "e5d9ba232399af1783a58d8eb26f6b5006fbefe2dc9ef36bd283324792d03ea5"
dependencies = [ dependencies = [
"futures", "futures",
"log", "log",
cumulus/client/cli/src/lib.rs
+6 -4
View File
@@ -293,9 +293,11 @@ pub struct RunCmd {
/// EXPERIMENTAL: Specify an URL to a relay chain full node to communicate with. /// EXPERIMENTAL: Specify an URL to a relay chain full node to communicate with.
#[arg( #[arg(
long, long,
value_parser = validate_relay_chain_url value_parser = validate_relay_chain_url,
num_args = 0..,
alias = "relay-chain-rpc-url"
)] )]
pub relay_chain_rpc_url: Option<Url>, pub relay_chain_rpc_urls: Vec<Url>,
} }
impl RunCmd { impl RunCmd {
@@ -310,7 +312,7 @@ impl RunCmd {
/// Create [`CollatorOptions`] representing options only relevant to parachain collator nodes /// Create [`CollatorOptions`] representing options only relevant to parachain collator nodes
pub fn collator_options(&self) -> CollatorOptions { pub fn collator_options(&self) -> CollatorOptions {
CollatorOptions { relay_chain_rpc_url: self.relay_chain_rpc_url.clone() } CollatorOptions { relay_chain_rpc_urls: self.relay_chain_rpc_urls.clone() }
} }
} }
@@ -318,7 +320,7 @@ impl RunCmd {
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct CollatorOptions { pub struct CollatorOptions {
/// Location of relay chain full node /// Location of relay chain full node
pub relay_chain_rpc_url: Option<Url>, pub relay_chain_rpc_urls: Vec<Url>,
} }
/// A non-redundant version of the `RunCmd` that sets the `validator` field when the /// A non-redundant version of the `RunCmd` that sets the `validator` field when the
cumulus/client/relay-chain-interface/Cargo.toml
+1
View File
@@ -15,6 +15,7 @@ sp-blockchain = { git = "https://github.com/paritytech/substrate", branch = "mas
sp-state-machine = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-state-machine = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-client-api = { git = "https://github.com/paritytech/substrate", branch = "master" } sc-client-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
tokio = { version = "1.21.2", features = ["sync"] }
futures = "0.3.25" futures = "0.3.25"
async-trait = "0.1.59" async-trait = "0.1.59"
thiserror = "1.0.37" thiserror = "1.0.37"
cumulus/client/relay-chain-interface/src/lib.rs
+3 -3
View File
@@ -51,11 +51,11 @@ pub enum RelayChainError {
BlockchainError(#[from] sp_blockchain::Error), BlockchainError(#[from] sp_blockchain::Error),
#[error("State machine error occured: {0}")] #[error("State machine error occured: {0}")]
StateMachineError(Box<dyn sp_state_machine::Error>), StateMachineError(Box<dyn sp_state_machine::Error>),
#[error("Unable to call RPC method '{0}' due to error: {1}")] #[error("Unable to call RPC method '{0}'")]
RpcCallError(String, JsonRpcError), RpcCallError(String),
#[error("RPC Error: '{0}'")] #[error("RPC Error: '{0}'")]
JsonRpcError(#[from] JsonRpcError), JsonRpcError(#[from] JsonRpcError),
#[error("Unable to reach RpcStreamWorker: {0}")] #[error("Unable to communicate with RPC worker: {0}")]
WorkerCommunicationError(String), WorkerCommunicationError(String),
#[error("Scale codec deserialization error: {0}")] #[error("Scale codec deserialization error: {0}")]
DeserializationError(CodecError), DeserializationError(CodecError),
cumulus/client/relay-chain-minimal-node/src/blockchain_rpc_client.rs
+2 -2
View File
@@ -363,13 +363,13 @@ impl BlockChainRpcClient {
pub async fn import_notification_stream( pub async fn import_notification_stream(
&self, &self,
) -> RelayChainResult<Pin<Box<dyn Stream<Item = Header> + Send>>> { ) -> RelayChainResult<Pin<Box<dyn Stream<Item = Header> + Send>>> {
Ok(self.rpc_client.get_imported_heads_stream().await?.boxed()) Ok(self.rpc_client.get_imported_heads_stream()?.boxed())
} }
pub async fn finality_notification_stream( pub async fn finality_notification_stream(
&self, &self,
) -> RelayChainResult<Pin<Box<dyn Stream<Item = Header> + Send>>> { ) -> RelayChainResult<Pin<Box<dyn Stream<Item = Header> + Send>>> {
Ok(self.rpc_client.get_finalized_heads_stream().await?.boxed()) Ok(self.rpc_client.get_finalized_heads_stream()?.boxed())
} }
} }
cumulus/client/relay-chain-minimal-node/src/collator_overseer.rs
+16 -4
View File
@@ -223,8 +223,14 @@ async fn forward_collator_events(
f = finality.next() => { f = finality.next() => {
match f { match f {
Some(header) => { Some(header) => {
tracing::info!(target: "minimal-polkadot-node", "Received finalized block via RPC: #{} ({})", header.number, header.hash()); tracing::info!(
let block_info = BlockInfo { hash: header.hash(), parent_hash: header.parent_hash, number: header.number }; target: "minimal-polkadot-node",
"Received finalized block via RPC: #{} ({} -> {})",
header.number,
header.parent_hash,
header.hash()
);
let block_info = BlockInfo { hash: header.hash(), parent_hash: header.parent_hash, number: header.number };
handle.block_finalized(block_info).await; handle.block_finalized(block_info).await;
} }
None => return Err(RelayChainError::GenericError("Relay chain finality stream ended.".to_string())), None => return Err(RelayChainError::GenericError("Relay chain finality stream ended.".to_string())),
@@ -233,8 +239,14 @@ async fn forward_collator_events(
i = imports.next() => { i = imports.next() => {
match i { match i {
Some(header) => { Some(header) => {
tracing::info!(target: "minimal-polkadot-node", "Received imported block via RPC: #{} ({})", header.number, header.hash()); tracing::info!(
let block_info = BlockInfo { hash: header.hash(), parent_hash: header.parent_hash, number: header.number }; target: "minimal-polkadot-node",
"Received imported block via RPC: #{} ({} -> {})",
header.number,
header.parent_hash,
header.hash()
);
let block_info = BlockInfo { hash: header.hash(), parent_hash: header.parent_hash, number: header.number };
handle.block_imported(block_info).await; handle.block_imported(block_info).await;
} }
None => return Err(RelayChainError::GenericError("Relay chain import stream ended.".to_string())), None => return Err(RelayChainError::GenericError("Relay chain import stream ended.".to_string())),
cumulus/client/relay-chain-minimal-node/src/lib.rs
+1 -1
View File
@@ -85,7 +85,7 @@ fn build_authority_discovery_service<Block: BlockT>(
pub async fn build_minimal_relay_chain_node( pub async fn build_minimal_relay_chain_node(
polkadot_config: Configuration, polkadot_config: Configuration,
task_manager: &mut TaskManager, task_manager: &mut TaskManager,
relay_chain_url: Url, relay_chain_url: Vec<Url>,
) -> RelayChainResult<(Arc<(dyn RelayChainInterface + 'static)>, Option<CollatorPair>)> { ) -> RelayChainResult<(Arc<(dyn RelayChainInterface + 'static)>, Option<CollatorPair>)> {
let client = cumulus_relay_chain_rpc_interface::create_client_and_start_worker( let client = cumulus_relay_chain_rpc_interface::create_client_and_start_worker(
relay_chain_url, relay_chain_url,
cumulus/client/relay-chain-rpc-interface/Cargo.toml
+4 -3
View File
@@ -13,12 +13,11 @@ cumulus-relay-chain-interface = { path = "../relay-chain-interface" }
sp-api = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-runtime = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-consensus-babe = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-consensus-babe = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-authority-discovery = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-authority-discovery = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-state-machine = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-state-machine = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-client-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-storage = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-storage = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-client-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-rpc-api = { git = "https://github.com/paritytech/substrate", branch = "master" } sc-rpc-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
tokio = { version = "1.23.0", features = ["sync"] } tokio = { version = "1.23.0", features = ["sync"] }
@@ -29,4 +28,6 @@ jsonrpsee = { version = "0.16.2", features = ["ws-client"] }
tracing = "0.1.37" tracing = "0.1.37"
async-trait = "0.1.59" async-trait = "0.1.59"
url = "2.3.1" url = "2.3.1"
backoff = { version = "0.4.0", features = ["tokio"] } serde_json = "1.0.87"
serde = "1.0.147"
lru = "0.8.1"
cumulus/client/relay-chain-rpc-interface/src/lib.rs
+19 -18
View File
@@ -19,7 +19,7 @@ use core::time::Duration;
use cumulus_primitives_core::{ use cumulus_primitives_core::{
relay_chain::{ relay_chain::{
v2::{CommittedCandidateReceipt, OccupiedCoreAssumption, SessionIndex, ValidatorId}, v2::{CommittedCandidateReceipt, OccupiedCoreAssumption, SessionIndex, ValidatorId},
Hash as PHash, Header as PHeader, InboundHrmpMessage, Hash as RelayHash, Header as RelayHeader, InboundHrmpMessage,
}, },
InboundDownwardMessage, ParaId, PersistedValidationData, InboundDownwardMessage, ParaId, PersistedValidationData,
}; };
@@ -34,6 +34,7 @@ use std::pin::Pin;
pub use url::Url; pub use url::Url;
mod reconnecting_ws_client;
mod rpc_client; mod rpc_client;
pub use rpc_client::{create_client_and_start_worker, RelayChainRpcClient}; pub use rpc_client::{create_client_and_start_worker, RelayChainRpcClient};
@@ -58,7 +59,7 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn retrieve_dmq_contents( async fn retrieve_dmq_contents(
&self, &self,
para_id: ParaId, para_id: ParaId,
relay_parent: PHash, relay_parent: RelayHash,
) -> RelayChainResult<Vec<InboundDownwardMessage>> { ) -> RelayChainResult<Vec<InboundDownwardMessage>> {
self.rpc_client.parachain_host_dmq_contents(para_id, relay_parent).await self.rpc_client.parachain_host_dmq_contents(para_id, relay_parent).await
} }
@@ -66,7 +67,7 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn retrieve_all_inbound_hrmp_channel_contents( async fn retrieve_all_inbound_hrmp_channel_contents(
&self, &self,
para_id: ParaId, para_id: ParaId,
relay_parent: PHash, relay_parent: RelayHash,
) -> RelayChainResult<BTreeMap<ParaId, Vec<InboundHrmpMessage>>> { ) -> RelayChainResult<BTreeMap<ParaId, Vec<InboundHrmpMessage>>> {
self.rpc_client self.rpc_client
.parachain_host_inbound_hrmp_channels_contents(para_id, relay_parent) .parachain_host_inbound_hrmp_channels_contents(para_id, relay_parent)
@@ -75,7 +76,7 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn persisted_validation_data( async fn persisted_validation_data(
&self, &self,
hash: PHash, hash: RelayHash,
para_id: ParaId, para_id: ParaId,
occupied_core_assumption: OccupiedCoreAssumption, occupied_core_assumption: OccupiedCoreAssumption,
) -> RelayChainResult<Option<PersistedValidationData>> { ) -> RelayChainResult<Option<PersistedValidationData>> {
@@ -86,7 +87,7 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn candidate_pending_availability( async fn candidate_pending_availability(
&self, &self,
hash: PHash, hash: RelayHash,
para_id: ParaId, para_id: ParaId,
) -> RelayChainResult<Option<CommittedCandidateReceipt>> { ) -> RelayChainResult<Option<CommittedCandidateReceipt>> {
self.rpc_client self.rpc_client
@@ -94,31 +95,31 @@ impl RelayChainInterface for RelayChainRpcInterface {
.await .await
} }
async fn session_index_for_child(&self, hash: PHash) -> RelayChainResult<SessionIndex> { async fn session_index_for_child(&self, hash: RelayHash) -> RelayChainResult<SessionIndex> {
self.rpc_client.parachain_host_session_index_for_child(hash).await self.rpc_client.parachain_host_session_index_for_child(hash).await
} }
async fn validators(&self, block_id: PHash) -> RelayChainResult<Vec<ValidatorId>> { async fn validators(&self, block_id: RelayHash) -> RelayChainResult<Vec<ValidatorId>> {
self.rpc_client.parachain_host_validators(block_id).await self.rpc_client.parachain_host_validators(block_id).await
} }
async fn import_notification_stream( async fn import_notification_stream(
&self, &self,
) -> RelayChainResult<Pin<Box<dyn Stream<Item = PHeader> + Send>>> { ) -> RelayChainResult<Pin<Box<dyn Stream<Item = RelayHeader> + Send>>> {
let imported_headers_stream = self.rpc_client.get_imported_heads_stream().await?; let imported_headers_stream = self.rpc_client.get_imported_heads_stream()?;
Ok(imported_headers_stream.boxed()) Ok(imported_headers_stream.boxed())
} }
async fn finality_notification_stream( async fn finality_notification_stream(
&self, &self,
) -> RelayChainResult<Pin<Box<dyn Stream<Item = PHeader> + Send>>> { ) -> RelayChainResult<Pin<Box<dyn Stream<Item = RelayHeader> + Send>>> {
let imported_headers_stream = self.rpc_client.get_finalized_heads_stream().await?; let imported_headers_stream = self.rpc_client.get_finalized_heads_stream()?;
Ok(imported_headers_stream.boxed()) Ok(imported_headers_stream.boxed())
} }
async fn best_block_hash(&self) -> RelayChainResult<PHash> { async fn best_block_hash(&self) -> RelayChainResult<RelayHash> {
self.rpc_client.chain_get_head(None).await self.rpc_client.chain_get_head(None).await
} }
@@ -132,7 +133,7 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn get_storage_by_key( async fn get_storage_by_key(
&self, &self,
relay_parent: PHash, relay_parent: RelayHash,
key: &[u8], key: &[u8],
) -> RelayChainResult<Option<StorageValue>> { ) -> RelayChainResult<Option<StorageValue>> {
let storage_key = StorageKey(key.to_vec()); let storage_key = StorageKey(key.to_vec());
@@ -144,7 +145,7 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn prove_read( async fn prove_read(
&self, &self,
relay_parent: PHash, relay_parent: RelayHash,
relevant_keys: &Vec<Vec<u8>>, relevant_keys: &Vec<Vec<u8>>,
) -> RelayChainResult<StorageProof> { ) -> RelayChainResult<StorageProof> {
let cloned = relevant_keys.clone(); let cloned = relevant_keys.clone();
@@ -167,8 +168,8 @@ impl RelayChainInterface for RelayChainRpcInterface {
/// 2. Check if the block is already in chain. If yes, succeed early. /// 2. Check if the block is already in chain. If yes, succeed early.
/// 3. Wait for the block to be imported via subscription. /// 3. Wait for the block to be imported via subscription.
/// 4. If timeout is reached, we return an error. /// 4. If timeout is reached, we return an error.
async fn wait_for_block(&self, wait_for_hash: PHash) -> RelayChainResult<()> { async fn wait_for_block(&self, wait_for_hash: RelayHash) -> RelayChainResult<()> {
let mut head_stream = self.rpc_client.get_imported_heads_stream().await?; let mut head_stream = self.rpc_client.get_imported_heads_stream()?;
if self.rpc_client.chain_get_header(Some(wait_for_hash)).await?.is_some() { if self.rpc_client.chain_get_header(Some(wait_for_hash)).await?.is_some() {
return Ok(()) return Ok(())
@@ -191,8 +192,8 @@ impl RelayChainInterface for RelayChainRpcInterface {
async fn new_best_notification_stream( async fn new_best_notification_stream(
&self, &self,
) -> RelayChainResult<Pin<Box<dyn Stream<Item = PHeader> + Send>>> { ) -> RelayChainResult<Pin<Box<dyn Stream<Item = RelayHeader> + Send>>> {
let imported_headers_stream = self.rpc_client.get_best_heads_stream().await?; let imported_headers_stream = self.rpc_client.get_best_heads_stream()?;
Ok(imported_headers_stream.boxed()) Ok(imported_headers_stream.boxed())
} }
} }
cumulus/client/relay-chain-rpc-interface/src/reconnecting_ws_client.rs
+520
View File
@@ -0,0 +1,520 @@
// Copyright 2022 Parity Technologies (UK) Ltd.
// This file is part of Cumulus.
// Cumulus is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Cumulus is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Cumulus. If not, see <http://www.gnu.org/licenses/>.
use cumulus_primitives_core::relay_chain::{
BlockNumber as RelayBlockNumber, Header as RelayHeader,
};
use cumulus_relay_chain_interface::{RelayChainError, RelayChainResult};
use futures::{
channel::{
mpsc::{Receiver, Sender},
oneshot::Sender as OneshotSender,
},
future::BoxFuture,
stream::FuturesUnordered,
FutureExt, StreamExt,
};
use jsonrpsee::{
core::{
client::{Client as JsonRpcClient, ClientT, Subscription, SubscriptionClientT},
params::ArrayParams,
Error as JsonRpseeError, JsonValue,
},
rpc_params,
ws_client::WsClientBuilder,
};
use lru::LruCache;
use polkadot_service::TaskManager;
use std::{num::NonZeroUsize, sync::Arc};
use tokio::sync::mpsc::{
channel as tokio_channel, Receiver as TokioReceiver, Sender as TokioSender,
};
use url::Url;
const NOTIFICATION_CHANNEL_SIZE_LIMIT: usize = 20;
const LOG_TARGET: &str = "reconnecting-websocket-client";
/// Messages for communication between [`ReconnectingWsClient`] and [`ReconnectingWebsocketWorker`].
#[derive(Debug)]
enum RpcDispatcherMessage {
RegisterBestHeadListener(Sender<RelayHeader>),
RegisterImportListener(Sender<RelayHeader>),
RegisterFinalizationListener(Sender<RelayHeader>),
Request(String, ArrayParams, OneshotSender<Result<JsonValue, JsonRpseeError>>),
}
/// Frontend for performing websocket requests.
/// Requests and stream requests are forwarded to [`ReconnectingWebsocketWorker`].
#[derive(Debug, Clone)]
pub struct ReconnectingWsClient {
/// Channel to communicate with the RPC worker
to_worker_channel: TokioSender<RpcDispatcherMessage>,
}
impl ReconnectingWsClient {
/// Create a new websocket client frontend.
pub async fn new(urls: Vec<Url>, task_manager: &mut TaskManager) -> RelayChainResult<Self> {
tracing::debug!(target: LOG_TARGET, "Instantiating reconnecting websocket client");
let (worker, sender) = ReconnectingWebsocketWorker::new(urls).await;
task_manager
.spawn_essential_handle()
.spawn("relay-chain-rpc-worker", None, worker.run());
Ok(Self { to_worker_channel: sender })
}
}
impl ReconnectingWsClient {
/// Perform a request via websocket connection.
pub async fn request<R>(&self, method: &str, params: ArrayParams) -> Result<R, RelayChainError>
where
R: serde::de::DeserializeOwned,
{
let (tx, rx) = futures::channel::oneshot::channel();
let message = RpcDispatcherMessage::Request(method.into(), params, tx);
self.to_worker_channel.send(message).await.map_err(|err| {
RelayChainError::WorkerCommunicationError(format!(
"Unable to send message to RPC worker: {}",
err
))
})?;
let value = rx.await.map_err(|err| {
RelayChainError::WorkerCommunicationError(format!(
"Unexpected channel close on RPC worker side: {}",
err
))
})??;
serde_json::from_value(value)
.map_err(|_| RelayChainError::GenericError("Unable to deserialize value".to_string()))
}
/// Get a stream of new best relay chain headers
pub fn get_best_heads_stream(&self) -> Result<Receiver<RelayHeader>, RelayChainError> {
let (tx, rx) =
futures::channel::mpsc::channel::<RelayHeader>(NOTIFICATION_CHANNEL_SIZE_LIMIT);
self.send_register_message_to_worker(RpcDispatcherMessage::RegisterBestHeadListener(tx))?;
Ok(rx)
}
/// Get a stream of finalized relay chain headers
pub fn get_finalized_heads_stream(&self) -> Result<Receiver<RelayHeader>, RelayChainError> {
let (tx, rx) =
futures::channel::mpsc::channel::<RelayHeader>(NOTIFICATION_CHANNEL_SIZE_LIMIT);
self.send_register_message_to_worker(RpcDispatcherMessage::RegisterFinalizationListener(
tx,
))?;
Ok(rx)
}
/// Get a stream of all imported relay chain headers
pub fn get_imported_heads_stream(&self) -> Result<Receiver<RelayHeader>, RelayChainError> {
let (tx, rx) =
futures::channel::mpsc::channel::<RelayHeader>(NOTIFICATION_CHANNEL_SIZE_LIMIT);
self.send_register_message_to_worker(RpcDispatcherMessage::RegisterImportListener(tx))?;
Ok(rx)
}
fn send_register_message_to_worker(
&self,
message: RpcDispatcherMessage,
) -> Result<(), RelayChainError> {
self.to_worker_channel
.try_send(message)
.map_err(|e| RelayChainError::WorkerCommunicationError(e.to_string()))
}
}
/// Worker that should be used in combination with [`RelayChainRpcClient`]. Must be polled to distribute header notifications to listeners.
struct ReconnectingWebsocketWorker {
ws_urls: Vec<Url>,
/// Communication channel with the RPC client
client_receiver: TokioReceiver<RpcDispatcherMessage>,
/// Senders to distribute incoming header notifications to
imported_header_listeners: Vec<Sender<RelayHeader>>,
finalized_header_listeners: Vec<Sender<RelayHeader>>,
best_header_listeners: Vec<Sender<RelayHeader>>,
}
fn distribute_header(header: RelayHeader, senders: &mut Vec<Sender<RelayHeader>>) {
senders.retain_mut(|e| {
match e.try_send(header.clone()) {
// Receiver has been dropped, remove Sender from list.
Err(error) if error.is_disconnected() => false,
// Channel is full. This should not happen.
// TODO: Improve error handling here
// https://github.com/paritytech/cumulus/issues/1482
Err(error) => {
tracing::error!(target: LOG_TARGET, ?error, "Event distribution channel has reached its limit. This can lead to missed notifications.");
true
},
_ => true,
}
});
}
/// Manages the active websocket client.
/// Responsible for creating request futures, subscription streams
/// and reconnections.
#[derive(Debug)]
struct ClientManager {
urls: Vec<Url>,
active_client: Arc<JsonRpcClient>,
active_index: usize,
}
struct RelayChainSubscriptions {
import_subscription: Subscription<RelayHeader>,
finalized_subscription: Subscription<RelayHeader>,
best_subscription: Subscription<RelayHeader>,
}
/// Try to find a new RPC server to connect to.
async fn connect_next_available_rpc_server(
urls: &Vec<Url>,
starting_position: usize,
) -> Result<(usize, Arc<JsonRpcClient>), ()> {
tracing::debug!(target: LOG_TARGET, starting_position, "Connecting to RPC server.");
for (counter, url) in urls.iter().cycle().skip(starting_position).take(urls.len()).enumerate() {
let index = (starting_position + counter) % urls.len();
tracing::info!(
target: LOG_TARGET,
index,
?url,
"Trying to connect to next external relaychain node.",
);
if let Ok(ws_client) = WsClientBuilder::default().build(url).await {
return Ok((index, Arc::new(ws_client)))
};
}
Err(())
}
impl ClientManager {
pub async fn new(urls: Vec<Url>) -> Result<Self, ()> {
if urls.is_empty() {
return Err(())
}
let active_client = connect_next_available_rpc_server(&urls, 0).await?;
Ok(Self { urls, active_client: active_client.1, active_index: active_client.0 })
}
pub async fn connect_to_new_rpc_server(&mut self) -> Result<(), ()> {
let new_active =
connect_next_available_rpc_server(&self.urls, self.active_index + 1).await?;
self.active_client = new_active.1;
self.active_index = new_active.0;
Ok(())
}
async fn get_subscriptions(&self) -> Result<RelayChainSubscriptions, JsonRpseeError> {
let import_subscription = self
.active_client
.subscribe::<RelayHeader, _>(
"chain_subscribeAllHeads",
rpc_params![],
"chain_unsubscribeAllHeads",
)
.await
.map_err(|e| {
tracing::error!(
target: LOG_TARGET,
?e,
"Unable to open `chain_subscribeAllHeads` subscription."
);
e
})?;
let best_subscription = self
.active_client
.subscribe::<RelayHeader, _>(
"chain_subscribeNewHeads",
rpc_params![],
"chain_unsubscribeNewHeads",
)
.await
.map_err(|e| {
tracing::error!(
target: LOG_TARGET,
?e,
"Unable to open `chain_subscribeNewHeads` subscription."
);
e
})?;
let finalized_subscription = self
.active_client
.subscribe::<RelayHeader, _>(
"chain_subscribeFinalizedHeads",
rpc_params![],
"chain_unsubscribeFinalizedHeads",
)
.await
.map_err(|e| {
tracing::error!(
target: LOG_TARGET,
?e,
"Unable to open `chain_subscribeFinalizedHeads` subscription."
);
e
})?;
Ok(RelayChainSubscriptions {
import_subscription,
best_subscription,
finalized_subscription,
})
}
/// Create a request future that performs an RPC request and sends the results to the caller.
/// In case of a dead websocket connection, it returns the original request parameters to
/// enable retries.
fn create_request(
&self,
method: String,
params: ArrayParams,
response_sender: OneshotSender<Result<JsonValue, JsonRpseeError>>,
) -> BoxFuture<'static, Result<(), RpcDispatcherMessage>> {
let future_client = self.active_client.clone();
async move {
let resp = future_client.request(&method, params.clone()).await;
// We should only return the original request in case
// the websocket connection is dead and requires a restart.
// Other errors should be forwarded to the request caller.
if let Err(JsonRpseeError::RestartNeeded(_)) = resp {
return Err(RpcDispatcherMessage::Request(method, params, response_sender))
}
if let Err(err) = response_sender.send(resp) {
tracing::debug!(
target: LOG_TARGET,
?err,
"Recipient no longer interested in request result"
);
}
Ok(())
}
.boxed()
}
}
enum ConnectionStatus {
Connected,
ReconnectRequired(Option<RpcDispatcherMessage>),
}
impl ReconnectingWebsocketWorker {
/// Create new worker. Returns the worker and a channel to register new listeners.
async fn new(
urls: Vec<Url>,
) -> (ReconnectingWebsocketWorker, TokioSender<RpcDispatcherMessage>) {
let (tx, rx) = tokio_channel(100);
let worker = ReconnectingWebsocketWorker {
ws_urls: urls,
client_receiver: rx,
imported_header_listeners: Vec::new(),
finalized_header_listeners: Vec::new(),
best_header_listeners: Vec::new(),
};
(worker, tx)
}
/// Reconnect via [`ClientManager`] and provide new notification streams.
async fn handle_reconnect(
&mut self,
client_manager: &mut ClientManager,
pending_requests: &mut FuturesUnordered<
BoxFuture<'static, Result<(), RpcDispatcherMessage>>,
>,
first_failed_request: Option<RpcDispatcherMessage>,
) -> Result<RelayChainSubscriptions, String> {
let mut requests_to_retry = Vec::new();
if let Some(req @ RpcDispatcherMessage::Request(_, _, _)) = first_failed_request {
requests_to_retry.push(req);
}
// At this point, all pending requests will return an error since the
// websocket connection is dead. So draining the pending requests should be fast.
while !pending_requests.is_empty() {
if let Some(Err(req)) = pending_requests.next().await {
requests_to_retry.push(req);
}
}
if client_manager.connect_to_new_rpc_server().await.is_err() {
return Err(format!("Unable to find valid external RPC server, shutting down."))
};
for item in requests_to_retry.into_iter() {
if let RpcDispatcherMessage::Request(method, params, response_sender) = item {
pending_requests.push(client_manager.create_request(
method,
params,
response_sender,
));
};
}
client_manager.get_subscriptions().await.map_err(|e| {
format!("Not able to create streams from newly connected RPC server, shutting down. err: {:?}", e)
})
}
/// Run this worker to drive notification streams.
/// The worker does the following:
/// - Listen for [`RpcDispatcherMessage`], perform requests and register new listeners for the notification streams
/// - Distribute incoming import, best head and finalization notifications to registered listeners.
/// If an error occurs during sending, the receiver has been closed and we remove the sender from the list.
/// - Find a new valid RPC server to connect to in case the websocket connection is terminated.
/// If the worker is not able to connec to an RPC server from the list, the worker shuts down.
async fn run(mut self) {
let mut pending_requests = FuturesUnordered::new();
let urls = std::mem::take(&mut self.ws_urls);
let Ok(mut client_manager) = ClientManager::new(urls).await else {
tracing::error!(target: LOG_TARGET, "No valid RPC url found. Stopping RPC worker.");
return;
};
let Ok(mut subscriptions) = client_manager.get_subscriptions().await else {
tracing::error!(target: LOG_TARGET, "Unable to fetch subscriptions on initial connection.");
return;
};
let mut imported_blocks_cache =
LruCache::new(NonZeroUsize::new(40).expect("40 is nonzero; qed."));
let mut should_reconnect = ConnectionStatus::Connected;
let mut last_seen_finalized_num: RelayBlockNumber = 0;
loop {
// This branch is taken if the websocket connection to the current RPC server is closed.
if let ConnectionStatus::ReconnectRequired(maybe_failed_request) = should_reconnect {
match self
.handle_reconnect(
&mut client_manager,
&mut pending_requests,
maybe_failed_request,
)
.await
{
Ok(new_subscriptions) => {
subscriptions = new_subscriptions;
},
Err(message) => {
tracing::error!(
target: LOG_TARGET,
message,
"Unable to reconnect, stopping worker."
);
return
},
}
should_reconnect = ConnectionStatus::Connected;
}
tokio::select! {
evt = self.client_receiver.recv() => match evt {
Some(RpcDispatcherMessage::RegisterBestHeadListener(tx)) => {
self.best_header_listeners.push(tx);
},
Some(RpcDispatcherMessage::RegisterImportListener(tx)) => {
self.imported_header_listeners.push(tx)
},
Some(RpcDispatcherMessage::RegisterFinalizationListener(tx)) => {
self.finalized_header_listeners.push(tx)
},
Some(RpcDispatcherMessage::Request(method, params, response_sender)) => {
pending_requests.push(client_manager.create_request(method, params, response_sender));
},
None => {
tracing::error!(target: LOG_TARGET, "RPC client receiver closed. Stopping RPC Worker.");
return;
}
},
should_retry = pending_requests.next(), if !pending_requests.is_empty() => {
if let Some(Err(req)) = should_retry {
should_reconnect = ConnectionStatus::ReconnectRequired(Some(req));
}
},
import_event = subscriptions.import_subscription.next() => {
match import_event {
Some(Ok(header)) => {
let hash = header.hash();
if imported_blocks_cache.contains(&hash) {
tracing::debug!(
target: LOG_TARGET,
number = header.number,
?hash,
"Duplicate imported block header. This might happen after switching to a new RPC node. Skipping distribution."
);
continue;
}
imported_blocks_cache.put(hash, ());
distribute_header(header, &mut self.imported_header_listeners);
},
None => {
tracing::error!(target: LOG_TARGET, "Subscription closed.");
should_reconnect = ConnectionStatus::ReconnectRequired(None);
},
Some(Err(error)) => {
tracing::error!(target: LOG_TARGET, ?error, "Error in RPC subscription.");
should_reconnect = ConnectionStatus::ReconnectRequired(None);
},
}
},
best_header_event = subscriptions.best_subscription.next() => {
match best_header_event {
Some(Ok(header)) => distribute_header(header, &mut self.best_header_listeners),
None => {
tracing::error!(target: LOG_TARGET, "Subscription closed.");
should_reconnect = ConnectionStatus::ReconnectRequired(None);
},
Some(Err(error)) => {
tracing::error!(target: LOG_TARGET, ?error, "Error in RPC subscription.");
should_reconnect = ConnectionStatus::ReconnectRequired(None);
},
}
}
finalized_event = subscriptions.finalized_subscription.next() => {
match finalized_event {
Some(Ok(header)) if header.number > last_seen_finalized_num => {
last_seen_finalized_num = header.number;
distribute_header(header, &mut self.finalized_header_listeners);
},
Some(Ok(header)) => {
tracing::debug!(
target: LOG_TARGET,
number = header.number,
last_seen_finalized_num,
"Duplicate finalized block header. This might happen after switching to a new RPC node. Skipping distribution."
);
},
None => {
tracing::error!(target: LOG_TARGET, "Subscription closed.");
should_reconnect = ConnectionStatus::ReconnectRequired(None);
},
Some(Err(error)) => {
tracing::error!(target: LOG_TARGET, ?error, "Error in RPC subscription.");
should_reconnect = ConnectionStatus::ReconnectRequired(None);
},
}
}
}
}
}
}
cumulus/client/relay-chain-rpc-interface/src/rpc_client.rs
+62 -292
View File
@@ -14,7 +14,7 @@
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with Cumulus. If not, see <http://www.gnu.org/licenses/>. // along with Cumulus. If not, see <http://www.gnu.org/licenses/>.
use backoff::{future::retry_notify, ExponentialBackoff}; use crate::reconnecting_ws_client::ReconnectingWsClient;
use cumulus_primitives_core::{ use cumulus_primitives_core::{
relay_chain::{ relay_chain::{
v2::{ v2::{
@@ -23,211 +23,49 @@ use cumulus_primitives_core::{
PvfCheckStatement, ScrapedOnChainVotes, SessionIndex, SessionInfo, ValidationCode, PvfCheckStatement, ScrapedOnChainVotes, SessionIndex, SessionInfo, ValidationCode,
ValidationCodeHash, ValidatorId, ValidatorIndex, ValidatorSignature, ValidationCodeHash, ValidatorId, ValidatorIndex, ValidatorSignature,
}, },
CandidateHash, Hash as PHash, Header as PHeader, InboundHrmpMessage, CandidateHash, Hash as RelayHash, Header as RelayHeader, InboundHrmpMessage,
}, },
InboundDownwardMessage, ParaId, PersistedValidationData, InboundDownwardMessage, ParaId, PersistedValidationData,
}; };
use cumulus_relay_chain_interface::{RelayChainError, RelayChainResult}; use cumulus_relay_chain_interface::{RelayChainError, RelayChainResult};
use futures::{ use futures::channel::mpsc::Receiver;
channel::mpsc::{Receiver, Sender}, use jsonrpsee::{core::params::ArrayParams, rpc_params};
StreamExt,
};
use jsonrpsee::{
core::{
client::{Client as JsonRpcClient, ClientT, Subscription, SubscriptionClientT},
params::ArrayParams,
Error as JsonRpseeError,
},
rpc_params,
ws_client::WsClientBuilder,
};
use parity_scale_codec::{Decode, Encode}; use parity_scale_codec::{Decode, Encode};
use polkadot_service::{BlockNumber, TaskManager}; use polkadot_service::{BlockNumber, TaskManager};
use sc_client_api::StorageData; use sc_client_api::StorageData;
use sc_rpc_api::{state::ReadProof, system::Health}; use sc_rpc_api::{state::ReadProof, system::Health};
use serde::de::DeserializeOwned;
use sp_api::RuntimeVersion; use sp_api::RuntimeVersion;
use sp_consensus_babe::Epoch; use sp_consensus_babe::Epoch;
use sp_core::sp_std::collections::btree_map::BTreeMap; use sp_core::sp_std::collections::btree_map::BTreeMap;
use sp_runtime::DeserializeOwned;
use sp_storage::StorageKey; use sp_storage::StorageKey;
use std::sync::Arc;
use tokio::sync::mpsc::{
channel as tokio_channel, Receiver as TokioReceiver, Sender as TokioSender,
};
pub use url::Url; pub use url::Url;
const LOG_TARGET: &str = "relay-chain-rpc-client"; const LOG_TARGET: &str = "relay-chain-rpc-client";
const NOTIFICATION_CHANNEL_SIZE_LIMIT: usize = 20;
/// Client that maps RPC methods and deserializes results /// Client that maps RPC methods and deserializes results
#[derive(Clone)] #[derive(Clone)]
pub struct RelayChainRpcClient { pub struct RelayChainRpcClient {
/// Websocket client to make calls /// Websocket client to make calls
ws_client: Arc<JsonRpcClient>, ws_client: ReconnectingWsClient,
/// Retry strategy that should be used for requests and subscriptions
retry_strategy: ExponentialBackoff,
/// Channel to communicate with the RPC worker
to_worker_channel: TokioSender<NotificationRegisterMessage>,
}
/// Worker messages to register new notification listeners
#[derive(Clone, Debug)]
pub enum NotificationRegisterMessage {
RegisterBestHeadListener(Sender<PHeader>),
RegisterImportListener(Sender<PHeader>),
RegisterFinalizationListener(Sender<PHeader>),
}
/// Worker that should be used in combination with [`RelayChainRpcClient`]. Must be polled to distribute header notifications to listeners.
struct RpcStreamWorker {
// Communication channel with the RPC client
client_receiver: TokioReceiver<NotificationRegisterMessage>,
// Senders to distribute incoming header notifications to
imported_header_listeners: Vec<Sender<PHeader>>,
finalized_header_listeners: Vec<Sender<PHeader>>,
best_header_listeners: Vec<Sender<PHeader>>,
// Incoming notification subscriptions
rpc_imported_header_subscription: Subscription<PHeader>,
rpc_finalized_header_subscription: Subscription<PHeader>,
rpc_best_header_subscription: Subscription<PHeader>,
} }
/// Entry point to create [`RelayChainRpcClient`] and start a worker that distributes notifications. /// Entry point to create [`RelayChainRpcClient`] and start a worker that distributes notifications.
pub async fn create_client_and_start_worker( pub async fn create_client_and_start_worker(
url: Url, urls: Vec<Url>,
task_manager: &mut TaskManager, task_manager: &mut TaskManager,
) -> RelayChainResult<RelayChainRpcClient> { ) -> RelayChainResult<RelayChainRpcClient> {
tracing::info!(target: LOG_TARGET, url = %url.to_string(), "Initializing RPC Client"); let ws_client = ReconnectingWsClient::new(urls, task_manager).await?;
let ws_client = WsClientBuilder::default().build(url.as_str()).await?;
let best_head_stream = RelayChainRpcClient::subscribe_new_best_heads(&ws_client).await?; let client = RelayChainRpcClient::new(ws_client).await?;
let finalized_head_stream = RelayChainRpcClient::subscribe_finalized_heads(&ws_client).await?;
let imported_head_stream = RelayChainRpcClient::subscribe_imported_heads(&ws_client).await?;
let (worker, sender) =
RpcStreamWorker::new(imported_head_stream, best_head_stream, finalized_head_stream);
let client = RelayChainRpcClient::new(ws_client, sender).await?;
task_manager
.spawn_essential_handle()
.spawn("relay-chain-rpc-worker", None, worker.run());
Ok(client) Ok(client)
} }
fn handle_event_distribution(
event: Option<Result<PHeader, JsonRpseeError>>,
senders: &mut Vec<Sender<PHeader>>,
) -> Result<(), String> {
match event {
Some(Ok(header)) => {
senders.retain_mut(|e| {
match e.try_send(header.clone()) {
// Receiver has been dropped, remove Sender from list.
Err(error) if error.is_disconnected() => false,
// Channel is full. This should not happen.
// TODO: Improve error handling here
// https://github.com/paritytech/cumulus/issues/1482
Err(error) => {
tracing::error!(target: LOG_TARGET, ?error, "Event distribution channel has reached its limit. This can lead to missed notifications.");
true
},
_ => true,
}
});
Ok(())
},
None => Err("RPC Subscription closed.".to_string()),
Some(Err(err)) => Err(format!("Error in RPC subscription: {}", err)),
}
}
impl RpcStreamWorker {
/// Create new worker. Returns the worker and a channel to register new listeners.
fn new(
import_sub: Subscription<PHeader>,
best_sub: Subscription<PHeader>,
finalized_sub: Subscription<PHeader>,
) -> (RpcStreamWorker, TokioSender<NotificationRegisterMessage>) {
let (tx, rx) = tokio_channel(100);
let worker = RpcStreamWorker {
client_receiver: rx,
imported_header_listeners: Vec::new(),
finalized_header_listeners: Vec::new(),
best_header_listeners: Vec::new(),
rpc_imported_header_subscription: import_sub,
rpc_best_header_subscription: best_sub,
rpc_finalized_header_subscription: finalized_sub,
};
(worker, tx)
}
/// Run this worker to drive notification streams.
/// The worker does two things:
/// 1. Listen for `NotificationRegisterMessage` and register new listeners for the notification streams
/// 2. Distribute incoming import, best head and finalization notifications to registered listeners.
/// If an error occurs during sending, the receiver has been closed and we remove the sender from the list.
pub async fn run(mut self) {
let mut import_sub = self.rpc_imported_header_subscription.fuse();
let mut best_head_sub = self.rpc_best_header_subscription.fuse();
let mut finalized_sub = self.rpc_finalized_header_subscription.fuse();
loop {
tokio::select! {
evt = self.client_receiver.recv() => match evt {
Some(NotificationRegisterMessage::RegisterBestHeadListener(tx)) => {
self.best_header_listeners.push(tx);
},
Some(NotificationRegisterMessage::RegisterImportListener(tx)) => {
self.imported_header_listeners.push(tx)
},
Some(NotificationRegisterMessage::RegisterFinalizationListener(tx)) => {
self.finalized_header_listeners.push(tx)
},
None => {
tracing::error!(target: LOG_TARGET, "RPC client receiver closed. Stopping RPC Worker.");
return;
}
},
import_event = import_sub.next() => {
if let Err(err) = handle_event_distribution(import_event, &mut self.imported_header_listeners) {
tracing::error!(target: LOG_TARGET, err, "Encountered error while processing imported header notification. Stopping RPC Worker.");
return;
}
},
best_header_event = best_head_sub.next() => {
if let Err(err) = handle_event_distribution(best_header_event, &mut self.best_header_listeners) {
tracing::error!(target: LOG_TARGET, err, "Encountered error while processing best header notification. Stopping RPC Worker.");
return;
}
}
finalized_event = finalized_sub.next() => {
if let Err(err) = handle_event_distribution(finalized_event, &mut self.finalized_header_listeners) {
tracing::error!(target: LOG_TARGET, err, "Encountered error while processing finalized header notification. Stopping RPC Worker.");
return;
}
}
}
}
}
}
impl RelayChainRpcClient { impl RelayChainRpcClient {
/// Initialize new RPC Client. /// Initialize new RPC Client.
async fn new( async fn new(ws_client: ReconnectingWsClient) -> RelayChainResult<Self> {
ws_client: JsonRpcClient, let client = RelayChainRpcClient { ws_client };
sender: TokioSender<NotificationRegisterMessage>,
) -> RelayChainResult<Self> {
let client = RelayChainRpcClient {
to_worker_channel: sender,
ws_client: Arc::new(ws_client),
retry_strategy: ExponentialBackoff::default(),
};
Ok(client) Ok(client)
} }
@@ -236,7 +74,7 @@ impl RelayChainRpcClient {
pub async fn call_remote_runtime_function<R: Decode>( pub async fn call_remote_runtime_function<R: Decode>(
&self, &self,
method_name: &str, method_name: &str,
hash: PHash, hash: RelayHash,
payload: Option<impl Encode>, payload: Option<impl Encode>,
) -> RelayChainResult<R> { ) -> RelayChainResult<R> {
let payload_bytes = let payload_bytes =
@@ -286,34 +124,23 @@ impl RelayChainRpcClient {
) -> Result<R, RelayChainError> ) -> Result<R, RelayChainError>
where where
R: DeserializeOwned + std::fmt::Debug, R: DeserializeOwned + std::fmt::Debug,
OR: Fn(&jsonrpsee::core::Error), OR: Fn(&RelayChainError),
{ {
retry_notify( self.ws_client.request(method, params).await.map_err(|err| {
self.retry_strategy.clone(),
|| async {
self.ws_client.request(method, params.clone()).await.map_err(|err| match err {
JsonRpseeError::Transport(_) =>
backoff::Error::Transient { err, retry_after: None },
_ => backoff::Error::Permanent(err),
})
},
|error, dur| tracing::trace!(target: LOG_TARGET, %error, ?dur, "Encountered transport error, retrying."),
)
.await
.map_err(|err| {
trace_error(&err); trace_error(&err);
RelayChainError::RpcCallError(method.to_string(), err)}) RelayChainError::RpcCallError(method.to_string())
})
} }
/// Returns information regarding the current epoch. /// Returns information regarding the current epoch.
pub async fn babe_api_current_epoch(&self, at: PHash) -> Result<Epoch, RelayChainError> { pub async fn babe_api_current_epoch(&self, at: RelayHash) -> Result<Epoch, RelayChainError> {
self.call_remote_runtime_function("BabeApi_current_epoch", at, None::<()>).await self.call_remote_runtime_function("BabeApi_current_epoch", at, None::<()>).await
} }
/// Old method to fetch v1 session info. /// Old method to fetch v1 session info.
pub async fn parachain_host_session_info_before_version_2( pub async fn parachain_host_session_info_before_version_2(
&self, &self,
at: PHash, at: RelayHash,
index: SessionIndex, index: SessionIndex,
) -> Result<Option<OldV1SessionInfo>, RelayChainError> { ) -> Result<Option<OldV1SessionInfo>, RelayChainError> {
self.call_remote_runtime_function( self.call_remote_runtime_function(
@@ -327,8 +154,8 @@ impl RelayChainRpcClient {
/// Scrape dispute relevant from on-chain, backing votes and resolved disputes. /// Scrape dispute relevant from on-chain, backing votes and resolved disputes.
pub async fn parachain_host_on_chain_votes( pub async fn parachain_host_on_chain_votes(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Option<ScrapedOnChainVotes<PHash>>, RelayChainError> { ) -> Result<Option<ScrapedOnChainVotes<RelayHash>>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_on_chain_votes", at, None::<()>) self.call_remote_runtime_function("ParachainHost_on_chain_votes", at, None::<()>)
.await .await
} }
@@ -336,7 +163,7 @@ impl RelayChainRpcClient {
/// Returns code hashes of PVFs that require pre-checking by validators in the active set. /// Returns code hashes of PVFs that require pre-checking by validators in the active set.
pub async fn parachain_host_pvfs_require_precheck( pub async fn parachain_host_pvfs_require_precheck(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Vec<ValidationCodeHash>, RelayChainError> { ) -> Result<Vec<ValidationCodeHash>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_pvfs_require_precheck", at, None::<()>) self.call_remote_runtime_function("ParachainHost_pvfs_require_precheck", at, None::<()>)
.await .await
@@ -345,7 +172,7 @@ impl RelayChainRpcClient {
/// Submits a PVF pre-checking statement into the transaction pool. /// Submits a PVF pre-checking statement into the transaction pool.
pub async fn parachain_host_submit_pvf_check_statement( pub async fn parachain_host_submit_pvf_check_statement(
&self, &self,
at: PHash, at: RelayHash,
stmt: PvfCheckStatement, stmt: PvfCheckStatement,
signature: ValidatorSignature, signature: ValidatorSignature,
) -> Result<(), RelayChainError> { ) -> Result<(), RelayChainError> {
@@ -371,9 +198,9 @@ impl RelayChainRpcClient {
pub async fn state_get_read_proof( pub async fn state_get_read_proof(
&self, &self,
storage_keys: Vec<StorageKey>, storage_keys: Vec<StorageKey>,
at: Option<PHash>, at: Option<RelayHash>,
) -> Result<ReadProof<PHash>, RelayChainError> { ) -> Result<ReadProof<RelayHash>, RelayChainError> {
let params = rpc_params!(storage_keys, at); let params = rpc_params![storage_keys, at];
self.request("state_getReadProof", params).await self.request("state_getReadProof", params).await
} }
@@ -381,17 +208,17 @@ impl RelayChainRpcClient {
pub async fn state_get_storage( pub async fn state_get_storage(
&self, &self,
storage_key: StorageKey, storage_key: StorageKey,
at: Option<PHash>, at: Option<RelayHash>,
) -> Result<Option<StorageData>, RelayChainError> { ) -> Result<Option<StorageData>, RelayChainError> {
let params = rpc_params!(storage_key, at); let params = rpc_params![storage_key, at];
self.request("state_getStorage", params).await self.request("state_getStorage", params).await
} }
/// Get hash of the n-th block in the canon chain. /// Get hash of the n-th block in the canon chain.
/// ///
/// By default returns latest block hash. /// By default returns latest block hash.
pub async fn chain_get_head(&self, at: Option<u64>) -> Result<PHash, RelayChainError> { pub async fn chain_get_head(&self, at: Option<u64>) -> Result<RelayHash, RelayChainError> {
let params = rpc_params!(at); let params = rpc_params![at];
self.request("chain_getHead", params).await self.request("chain_getHead", params).await
} }
@@ -400,7 +227,7 @@ impl RelayChainRpcClient {
/// should be the successor of the number of the block. /// should be the successor of the number of the block.
pub async fn parachain_host_validator_groups( pub async fn parachain_host_validator_groups(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<(Vec<Vec<ValidatorIndex>>, GroupRotationInfo), RelayChainError> { ) -> Result<(Vec<Vec<ValidatorIndex>>, GroupRotationInfo), RelayChainError> {
self.call_remote_runtime_function("ParachainHost_validator_groups", at, None::<()>) self.call_remote_runtime_function("ParachainHost_validator_groups", at, None::<()>)
.await .await
@@ -409,7 +236,7 @@ impl RelayChainRpcClient {
/// Get a vector of events concerning candidates that occurred within a block. /// Get a vector of events concerning candidates that occurred within a block.
pub async fn parachain_host_candidate_events( pub async fn parachain_host_candidate_events(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Vec<CandidateEvent>, RelayChainError> { ) -> Result<Vec<CandidateEvent>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_candidate_events", at, None::<()>) self.call_remote_runtime_function("ParachainHost_candidate_events", at, None::<()>)
.await .await
@@ -418,7 +245,7 @@ impl RelayChainRpcClient {
/// Checks if the given validation outputs pass the acceptance criteria. /// Checks if the given validation outputs pass the acceptance criteria.
pub async fn parachain_host_check_validation_outputs( pub async fn parachain_host_check_validation_outputs(
&self, &self,
at: PHash, at: RelayHash,
para_id: ParaId, para_id: ParaId,
outputs: CandidateCommitments, outputs: CandidateCommitments,
) -> Result<bool, RelayChainError> { ) -> Result<bool, RelayChainError> {
@@ -435,9 +262,9 @@ impl RelayChainRpcClient {
/// data hash against an expected one and yields `None` if they're not equal. /// data hash against an expected one and yields `None` if they're not equal.
pub async fn parachain_host_assumed_validation_data( pub async fn parachain_host_assumed_validation_data(
&self, &self,
at: PHash, at: RelayHash,
para_id: ParaId, para_id: ParaId,
expected_hash: PHash, expected_hash: RelayHash,
) -> Result<Option<(PersistedValidationData, ValidationCodeHash)>, RelayChainError> { ) -> Result<Option<(PersistedValidationData, ValidationCodeHash)>, RelayChainError> {
self.call_remote_runtime_function( self.call_remote_runtime_function(
"ParachainHost_persisted_assumed_validation_data", "ParachainHost_persisted_assumed_validation_data",
@@ -448,7 +275,7 @@ impl RelayChainRpcClient {
} }
/// Get hash of last finalized block. /// Get hash of last finalized block.
pub async fn chain_get_finalized_head(&self) -> Result<PHash, RelayChainError> { pub async fn chain_get_finalized_head(&self) -> Result<RelayHash, RelayChainError> {
self.request("chain_getFinalizedHead", rpc_params![]).await self.request("chain_getFinalizedHead", rpc_params![]).await
} }
@@ -456,8 +283,8 @@ impl RelayChainRpcClient {
pub async fn chain_get_block_hash( pub async fn chain_get_block_hash(
&self, &self,
block_number: Option<polkadot_service::BlockNumber>, block_number: Option<polkadot_service::BlockNumber>,
) -> Result<Option<PHash>, RelayChainError> { ) -> Result<Option<RelayHash>, RelayChainError> {
let params = rpc_params!(block_number); let params = rpc_params![block_number];
self.request("chain_getBlockHash", params).await self.request("chain_getBlockHash", params).await
} }
@@ -468,7 +295,7 @@ impl RelayChainRpcClient {
/// and the para already occupies a core. /// and the para already occupies a core.
pub async fn parachain_host_persisted_validation_data( pub async fn parachain_host_persisted_validation_data(
&self, &self,
at: PHash, at: RelayHash,
para_id: ParaId, para_id: ParaId,
occupied_core_assumption: OccupiedCoreAssumption, occupied_core_assumption: OccupiedCoreAssumption,
) -> Result<Option<PersistedValidationData>, RelayChainError> { ) -> Result<Option<PersistedValidationData>, RelayChainError> {
@@ -483,7 +310,7 @@ impl RelayChainRpcClient {
/// Get the validation code from its hash. /// Get the validation code from its hash.
pub async fn parachain_host_validation_code_by_hash( pub async fn parachain_host_validation_code_by_hash(
&self, &self,
at: PHash, at: RelayHash,
validation_code_hash: ValidationCodeHash, validation_code_hash: ValidationCodeHash,
) -> Result<Option<ValidationCode>, RelayChainError> { ) -> Result<Option<ValidationCode>, RelayChainError> {
self.call_remote_runtime_function( self.call_remote_runtime_function(
@@ -498,15 +325,15 @@ impl RelayChainRpcClient {
/// Cores are either free or occupied. Free cores can have paras assigned to them. /// Cores are either free or occupied. Free cores can have paras assigned to them.
pub async fn parachain_host_availability_cores( pub async fn parachain_host_availability_cores(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Vec<CoreState<PHash, BlockNumber>>, RelayChainError> { ) -> Result<Vec<CoreState<RelayHash, BlockNumber>>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_availability_cores", at, None::<()>) self.call_remote_runtime_function("ParachainHost_availability_cores", at, None::<()>)
.await .await
} }
/// Get runtime version /// Get runtime version
pub async fn runtime_version(&self, at: PHash) -> Result<RuntimeVersion, RelayChainError> { pub async fn runtime_version(&self, at: RelayHash) -> Result<RuntimeVersion, RelayChainError> {
let params = rpc_params!(at); let params = rpc_params![at];
self.request("state_getRuntimeVersion", params).await self.request("state_getRuntimeVersion", params).await
} }
@@ -514,7 +341,7 @@ impl RelayChainRpcClient {
/// This is a staging method! Do not use on production runtimes! /// This is a staging method! Do not use on production runtimes!
pub async fn parachain_host_staging_get_disputes( pub async fn parachain_host_staging_get_disputes(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Vec<(SessionIndex, CandidateHash, DisputeState<BlockNumber>)>, RelayChainError> { ) -> Result<Vec<(SessionIndex, CandidateHash, DisputeState<BlockNumber>)>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_staging_get_disputes", at, None::<()>) self.call_remote_runtime_function("ParachainHost_staging_get_disputes", at, None::<()>)
.await .await
@@ -522,7 +349,7 @@ impl RelayChainRpcClient {
pub async fn authority_discovery_authorities( pub async fn authority_discovery_authorities(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Vec<sp_authority_discovery::AuthorityId>, RelayChainError> { ) -> Result<Vec<sp_authority_discovery::AuthorityId>, RelayChainError> {
self.call_remote_runtime_function("AuthorityDiscoveryApi_authorities", at, None::<()>) self.call_remote_runtime_function("AuthorityDiscoveryApi_authorities", at, None::<()>)
.await .await
@@ -534,7 +361,7 @@ impl RelayChainRpcClient {
/// and the para already occupies a core. /// and the para already occupies a core.
pub async fn parachain_host_validation_code( pub async fn parachain_host_validation_code(
&self, &self,
at: PHash, at: RelayHash,
para_id: ParaId, para_id: ParaId,
occupied_core_assumption: OccupiedCoreAssumption, occupied_core_assumption: OccupiedCoreAssumption,
) -> Result<Option<ValidationCode>, RelayChainError> { ) -> Result<Option<ValidationCode>, RelayChainError> {
@@ -549,7 +376,7 @@ impl RelayChainRpcClient {
/// Fetch the hash of the validation code used by a para, making the given `OccupiedCoreAssumption`. /// Fetch the hash of the validation code used by a para, making the given `OccupiedCoreAssumption`.
pub async fn parachain_host_validation_code_hash( pub async fn parachain_host_validation_code_hash(
&self, &self,
at: PHash, at: RelayHash,
para_id: ParaId, para_id: ParaId,
occupied_core_assumption: OccupiedCoreAssumption, occupied_core_assumption: OccupiedCoreAssumption,
) -> Result<Option<ValidationCodeHash>, RelayChainError> { ) -> Result<Option<ValidationCodeHash>, RelayChainError> {
@@ -564,7 +391,7 @@ impl RelayChainRpcClient {
/// Get the session info for the given session, if stored. /// Get the session info for the given session, if stored.
pub async fn parachain_host_session_info( pub async fn parachain_host_session_info(
&self, &self,
at: PHash, at: RelayHash,
index: SessionIndex, index: SessionIndex,
) -> Result<Option<SessionInfo>, RelayChainError> { ) -> Result<Option<SessionInfo>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_session_info", at, Some(index)) self.call_remote_runtime_function("ParachainHost_session_info", at, Some(index))
@@ -574,9 +401,9 @@ impl RelayChainRpcClient {
/// Get header at specified hash /// Get header at specified hash
pub async fn chain_get_header( pub async fn chain_get_header(
&self, &self,
hash: Option<PHash>, hash: Option<RelayHash>,
) -> Result<Option<PHeader>, RelayChainError> { ) -> Result<Option<RelayHeader>, RelayChainError> {
let params = rpc_params!(hash); let params = rpc_params![hash];
self.request("chain_getHeader", params).await self.request("chain_getHeader", params).await
} }
@@ -584,7 +411,7 @@ impl RelayChainRpcClient {
/// assigned to occupied cores in `availability_cores` and `None` otherwise. /// assigned to occupied cores in `availability_cores` and `None` otherwise.
pub async fn parachain_host_candidate_pending_availability( pub async fn parachain_host_candidate_pending_availability(
&self, &self,
at: PHash, at: RelayHash,
para_id: ParaId, para_id: ParaId,
) -> Result<Option<CommittedCandidateReceipt>, RelayChainError> { ) -> Result<Option<CommittedCandidateReceipt>, RelayChainError> {
self.call_remote_runtime_function( self.call_remote_runtime_function(
@@ -600,7 +427,7 @@ impl RelayChainRpcClient {
/// This can be used to instantiate a `SigningContext`. /// This can be used to instantiate a `SigningContext`.
pub async fn parachain_host_session_index_for_child( pub async fn parachain_host_session_index_for_child(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<SessionIndex, RelayChainError> { ) -> Result<SessionIndex, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_session_index_for_child", at, None::<()>) self.call_remote_runtime_function("ParachainHost_session_index_for_child", at, None::<()>)
.await .await
@@ -609,7 +436,7 @@ impl RelayChainRpcClient {
/// Get the current validators. /// Get the current validators.
pub async fn parachain_host_validators( pub async fn parachain_host_validators(
&self, &self,
at: PHash, at: RelayHash,
) -> Result<Vec<ValidatorId>, RelayChainError> { ) -> Result<Vec<ValidatorId>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_validators", at, None::<()>) self.call_remote_runtime_function("ParachainHost_validators", at, None::<()>)
.await .await
@@ -620,7 +447,7 @@ impl RelayChainRpcClient {
pub async fn parachain_host_inbound_hrmp_channels_contents( pub async fn parachain_host_inbound_hrmp_channels_contents(
&self, &self,
para_id: ParaId, para_id: ParaId,
at: PHash, at: RelayHash,
) -> Result<BTreeMap<ParaId, Vec<InboundHrmpMessage>>, RelayChainError> { ) -> Result<BTreeMap<ParaId, Vec<InboundHrmpMessage>>, RelayChainError> {
self.call_remote_runtime_function( self.call_remote_runtime_function(
"ParachainHost_inbound_hrmp_channels_contents", "ParachainHost_inbound_hrmp_channels_contents",
@@ -634,81 +461,24 @@ impl RelayChainRpcClient {
pub async fn parachain_host_dmq_contents( pub async fn parachain_host_dmq_contents(
&self, &self,
para_id: ParaId, para_id: ParaId,
at: PHash, at: RelayHash,
) -> Result<Vec<InboundDownwardMessage>, RelayChainError> { ) -> Result<Vec<InboundDownwardMessage>, RelayChainError> {
self.call_remote_runtime_function("ParachainHost_dmq_contents", at, Some(para_id)) self.call_remote_runtime_function("ParachainHost_dmq_contents", at, Some(para_id))
.await .await
} }
/// Get a stream of all imported relay chain headers /// Get a stream of all imported relay chain headers
pub async fn get_imported_heads_stream(&self) -> Result<Receiver<PHeader>, RelayChainError> { pub fn get_imported_heads_stream(&self) -> Result<Receiver<RelayHeader>, RelayChainError> {
let (tx, rx) = futures::channel::mpsc::channel::<PHeader>(NOTIFICATION_CHANNEL_SIZE_LIMIT); self.ws_client.get_imported_heads_stream()
self.send_register_message_to_worker(NotificationRegisterMessage::RegisterImportListener(
tx,
))?;
Ok(rx)
} }
/// Get a stream of new best relay chain headers /// Get a stream of new best relay chain headers
pub async fn get_best_heads_stream(&self) -> Result<Receiver<PHeader>, RelayChainError> { pub fn get_best_heads_stream(&self) -> Result<Receiver<RelayHeader>, RelayChainError> {
let (tx, rx) = futures::channel::mpsc::channel::<PHeader>(NOTIFICATION_CHANNEL_SIZE_LIMIT); self.ws_client.get_best_heads_stream()
self.send_register_message_to_worker(
NotificationRegisterMessage::RegisterBestHeadListener(tx),
)?;
Ok(rx)
} }
/// Get a stream of finalized relay chain headers /// Get a stream of finalized relay chain headers
pub async fn get_finalized_heads_stream(&self) -> Result<Receiver<PHeader>, RelayChainError> { pub fn get_finalized_heads_stream(&self) -> Result<Receiver<RelayHeader>, RelayChainError> {
let (tx, rx) = futures::channel::mpsc::channel::<PHeader>(NOTIFICATION_CHANNEL_SIZE_LIMIT); self.ws_client.get_finalized_heads_stream()
self.send_register_message_to_worker(
NotificationRegisterMessage::RegisterFinalizationListener(tx),
)?;
Ok(rx)
}
fn send_register_message_to_worker(
&self,
message: NotificationRegisterMessage,
) -> Result<(), RelayChainError> {
self.to_worker_channel
.try_send(message)
.map_err(|e| RelayChainError::WorkerCommunicationError(e.to_string()))
}
async fn subscribe_imported_heads(
ws_client: &JsonRpcClient,
) -> Result<Subscription<PHeader>, RelayChainError> {
Ok(ws_client
.subscribe::<PHeader, _>(
"chain_subscribeAllHeads",
rpc_params![],
"chain_unsubscribeAllHeads",
)
.await?)
}
async fn subscribe_finalized_heads(
ws_client: &JsonRpcClient,
) -> Result<Subscription<PHeader>, RelayChainError> {
Ok(ws_client
.subscribe::<PHeader, _>(
"chain_subscribeFinalizedHeads",
rpc_params![],
"chain_unsubscribeFinalizedHeads",
)
.await?)
}
async fn subscribe_new_best_heads(
ws_client: &JsonRpcClient,
) -> Result<Subscription<PHeader>, RelayChainError> {
Ok(ws_client
.subscribe::<PHeader, _>(
"chain_subscribeNewHeads",
rpc_params![],
"chain_unsubscribeFinalizedHeads",
)
.await?)
} }
} }
cumulus/client/service/Cargo.toml
+4
View File
@@ -11,6 +11,8 @@ parking_lot = "0.12.1"
sc-client-api = { git = "https://github.com/paritytech/substrate", branch = "master" } sc-client-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-consensus = { git = "https://github.com/paritytech/substrate", branch = "master" } sc-consensus = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-service = { git = "https://github.com/paritytech/substrate", branch = "master" } sc-service = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-sysinfo = { git = "https://github.com/paritytech/substrate", branch = "master" }
sc-telemetry = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-api = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-blockchain = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-blockchain = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-consensus = { git = "https://github.com/paritytech/substrate", branch = "master" } sp-consensus = { git = "https://github.com/paritytech/substrate", branch = "master" }
@@ -27,3 +29,5 @@ cumulus-client-consensus-common = { path = "../consensus/common" }
cumulus-client-pov-recovery = { path = "../pov-recovery" } cumulus-client-pov-recovery = { path = "../pov-recovery" }
cumulus-primitives-core = { path = "../../primitives/core" } cumulus-primitives-core = { path = "../../primitives/core" }
cumulus-relay-chain-interface = { path = "../relay-chain-interface" } cumulus-relay-chain-interface = { path = "../relay-chain-interface" }
cumulus-relay-chain-inprocess-interface = { path = "../relay-chain-inprocess-interface" }
cumulus-relay-chain-minimal-node = { path = "../relay-chain-minimal-node" }
cumulus/client/service/src/lib.rs
+34 -1
View File
@@ -18,15 +18,19 @@
//! //!
//! Provides functions for starting a collator node or a normal full node. //! Provides functions for starting a collator node or a normal full node.
use cumulus_client_cli::CollatorOptions;
use cumulus_client_consensus_common::ParachainConsensus; use cumulus_client_consensus_common::ParachainConsensus;
use cumulus_primitives_core::{CollectCollationInfo, ParaId}; use cumulus_primitives_core::{CollectCollationInfo, ParaId};
use cumulus_relay_chain_interface::RelayChainInterface; use cumulus_relay_chain_inprocess_interface::build_inprocess_relay_chain;
use cumulus_relay_chain_interface::{RelayChainInterface, RelayChainResult};
use cumulus_relay_chain_minimal_node::build_minimal_relay_chain_node;
use polkadot_primitives::v2::CollatorPair; use polkadot_primitives::v2::CollatorPair;
use sc_client_api::{ use sc_client_api::{
Backend as BackendT, BlockBackend, BlockchainEvents, Finalizer, UsageProvider, Backend as BackendT, BlockBackend, BlockchainEvents, Finalizer, UsageProvider,
}; };
use sc_consensus::{import_queue::ImportQueueService, BlockImport}; use sc_consensus::{import_queue::ImportQueueService, BlockImport};
use sc_service::{Configuration, TaskManager}; use sc_service::{Configuration, TaskManager};
use sc_telemetry::TelemetryWorkerHandle;
use sp_api::ProvideRuntimeApi; use sp_api::ProvideRuntimeApi;
use sp_blockchain::HeaderBackend; use sp_blockchain::HeaderBackend;
use sp_core::traits::SpawnNamed; use sp_core::traits::SpawnNamed;
@@ -217,3 +221,32 @@ pub fn prepare_node_config(mut parachain_config: Configuration) -> Configuration
parachain_config parachain_config
} }
/// Build a relay chain interface.
/// Will return a minimal relay chain node with RPC
/// client or an inprocess node, based on the [`CollatorOptions`] passed in.
pub async fn build_relay_chain_interface(
polkadot_config: Configuration,
parachain_config: &Configuration,
telemetry_worker_handle: Option<TelemetryWorkerHandle>,
task_manager: &mut TaskManager,
collator_options: CollatorOptions,
hwbench: Option<sc_sysinfo::HwBench>,
) -> RelayChainResult<(Arc<(dyn RelayChainInterface + 'static)>, Option<CollatorPair>)> {
if !collator_options.relay_chain_rpc_urls.is_empty() {
build_minimal_relay_chain_node(
polkadot_config,
task_manager,
collator_options.relay_chain_rpc_urls,
)
.await
} else {
build_inprocess_relay_chain(
polkadot_config,
parachain_config,
telemetry_worker_handle,
task_manager,
hwbench,
)
}
}
cumulus/parachain-template/node/Cargo.toml
-3
View File
@@ -67,10 +67,7 @@ cumulus-client-network = { path = "../../client/network" }
cumulus-client-service = { path = "../../client/service" } cumulus-client-service = { path = "../../client/service" }
cumulus-primitives-core = { path = "../../primitives/core" } cumulus-primitives-core = { path = "../../primitives/core" }
cumulus-primitives-parachain-inherent = { path = "../../primitives/parachain-inherent" } cumulus-primitives-parachain-inherent = { path = "../../primitives/parachain-inherent" }
cumulus-relay-chain-inprocess-interface = { path = "../../client/relay-chain-inprocess-interface" }
cumulus-relay-chain-interface = { path = "../../client/relay-chain-interface" } cumulus-relay-chain-interface = { path = "../../client/relay-chain-interface" }
cumulus-relay-chain-rpc-interface = { path = "../../client/relay-chain-rpc-interface" }
cumulus-relay-chain-minimal-node = { path = "../../client/relay-chain-minimal-node" }
[build-dependencies] [build-dependencies]
substrate-build-script-utils = { git = "https://github.com/paritytech/substrate", branch = "master" } substrate-build-script-utils = { git = "https://github.com/paritytech/substrate", branch = "master" }
cumulus/parachain-template/node/src/command.rs
+1 -1
View File
@@ -288,7 +288,7 @@ pub fn run() -> Result<()> {
info!("Parachain genesis state: {}", genesis_state); info!("Parachain genesis state: {}", genesis_state);
info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" }); info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" });
if collator_options.relay_chain_rpc_url.is_some() && cli.relay_chain_args.len() > 0 { if !collator_options.relay_chain_rpc_urls.is_empty() && cli.relay_chain_args.len() > 0 {
warn!("Detected relay chain node arguments together with --relay-chain-rpc-url. This command starts a minimal Polkadot node that only uses a network-related subset of all relay chain CLI options."); warn!("Detected relay chain node arguments together with --relay-chain-rpc-url. This command starts a minimal Polkadot node that only uses a network-related subset of all relay chain CLI options.");
} }
cumulus/parachain-template/node/src/service.rs
+3 -27
View File
@@ -14,12 +14,11 @@ use cumulus_client_consensus_common::{
}; };
use cumulus_client_network::BlockAnnounceValidator; use cumulus_client_network::BlockAnnounceValidator;
use cumulus_client_service::{ use cumulus_client_service::{
prepare_node_config, start_collator, start_full_node, StartCollatorParams, StartFullNodeParams, build_relay_chain_interface, prepare_node_config, start_collator, start_full_node,
StartCollatorParams, StartFullNodeParams,
}; };
use cumulus_primitives_core::ParaId; use cumulus_primitives_core::ParaId;
use cumulus_relay_chain_inprocess_interface::build_inprocess_relay_chain; use cumulus_relay_chain_interface::{RelayChainError, RelayChainInterface};
use cumulus_relay_chain_interface::{RelayChainError, RelayChainInterface, RelayChainResult};
use cumulus_relay_chain_minimal_node::build_minimal_relay_chain_node;
// Substrate Imports // Substrate Imports
use sc_consensus::ImportQueue; use sc_consensus::ImportQueue;
@@ -31,8 +30,6 @@ use sc_telemetry::{Telemetry, TelemetryHandle, TelemetryWorker, TelemetryWorkerH
use sp_keystore::SyncCryptoStorePtr; use sp_keystore::SyncCryptoStorePtr;
use substrate_prometheus_endpoint::Registry; use substrate_prometheus_endpoint::Registry;
use polkadot_service::CollatorPair;
/// Native executor type. /// Native executor type.
pub struct ParachainNativeExecutor; pub struct ParachainNativeExecutor;
@@ -136,27 +133,6 @@ pub fn new_partial(
}) })
} }
async fn build_relay_chain_interface(
polkadot_config: Configuration,
parachain_config: &Configuration,
telemetry_worker_handle: Option<TelemetryWorkerHandle>,
task_manager: &mut TaskManager,
collator_options: CollatorOptions,
hwbench: Option<sc_sysinfo::HwBench>,
) -> RelayChainResult<(Arc<(dyn RelayChainInterface + 'static)>, Option<CollatorPair>)> {
match collator_options.relay_chain_rpc_url {
Some(relay_chain_url) =>
build_minimal_relay_chain_node(polkadot_config, task_manager, relay_chain_url).await,
None => build_inprocess_relay_chain(
polkadot_config,
parachain_config,
telemetry_worker_handle,
task_manager,
hwbench,
),
}
}
/// Start a node with the given parachain `Configuration` and relay chain `Configuration`. /// Start a node with the given parachain `Configuration` and relay chain `Configuration`.
/// ///
/// This is the actual implementation that is abstract over the executor and the runtime api. /// This is the actual implementation that is abstract over the executor and the runtime api.
cumulus/polkadot-parachain/Cargo.toml
-3
View File
@@ -88,9 +88,6 @@ cumulus-client-network = { path = "../client/network" }
cumulus-primitives-core = { path = "../primitives/core" } cumulus-primitives-core = { path = "../primitives/core" }
cumulus-primitives-parachain-inherent = { path = "../primitives/parachain-inherent" } cumulus-primitives-parachain-inherent = { path = "../primitives/parachain-inherent" }
cumulus-relay-chain-interface = { path = "../client/relay-chain-interface" } cumulus-relay-chain-interface = { path = "../client/relay-chain-interface" }
cumulus-relay-chain-inprocess-interface = { path = "../client/relay-chain-inprocess-interface" }
cumulus-relay-chain-rpc-interface = { path = "../client/relay-chain-rpc-interface" }
cumulus-relay-chain-minimal-node = { path = "../client/relay-chain-minimal-node" }
[build-dependencies] [build-dependencies]
substrate-build-script-utils = { git = "https://github.com/paritytech/substrate", branch = "master" } substrate-build-script-utils = { git = "https://github.com/paritytech/substrate", branch = "master" }
cumulus/polkadot-parachain/src/command.rs
+1 -1
View File
@@ -791,7 +791,7 @@ pub fn run() -> Result<()> {
info!("Parachain genesis state: {}", genesis_state); info!("Parachain genesis state: {}", genesis_state);
info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" }); info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" });
if collator_options.relay_chain_rpc_url.is_some() && cli.relaychain_args.len() > 0 { if !collator_options.relay_chain_rpc_urls.is_empty() && cli.relaychain_args.len() > 0 {
warn!("Detected relay chain node arguments together with --relay-chain-rpc-url. This command starts a minimal Polkadot node that only uses a network-related subset of all relay chain CLI options."); warn!("Detected relay chain node arguments together with --relay-chain-rpc-url. This command starts a minimal Polkadot node that only uses a network-related subset of all relay chain CLI options.");
} }
cumulus/polkadot-parachain/src/service.rs
+3 -26
View File
@@ -22,16 +22,14 @@ use cumulus_client_consensus_common::{
}; };
use cumulus_client_network::BlockAnnounceValidator; use cumulus_client_network::BlockAnnounceValidator;
use cumulus_client_service::{ use cumulus_client_service::{
prepare_node_config, start_collator, start_full_node, StartCollatorParams, StartFullNodeParams, build_relay_chain_interface, prepare_node_config, start_collator, start_full_node,
StartCollatorParams, StartFullNodeParams,
}; };
use cumulus_primitives_core::{ use cumulus_primitives_core::{
relay_chain::v2::{Hash as PHash, PersistedValidationData}, relay_chain::v2::{Hash as PHash, PersistedValidationData},
ParaId, ParaId,
}; };
use cumulus_relay_chain_inprocess_interface::build_inprocess_relay_chain; use cumulus_relay_chain_interface::{RelayChainError, RelayChainInterface};
use cumulus_relay_chain_interface::{RelayChainError, RelayChainInterface, RelayChainResult};
use cumulus_relay_chain_minimal_node::build_minimal_relay_chain_node;
use polkadot_service::CollatorPair;
use sp_core::Pair; use sp_core::Pair;
use jsonrpsee::RpcModule; use jsonrpsee::RpcModule;
@@ -301,27 +299,6 @@ where
Ok(params) Ok(params)
} }
async fn build_relay_chain_interface(
polkadot_config: Configuration,
parachain_config: &Configuration,
telemetry_worker_handle: Option<TelemetryWorkerHandle>,
task_manager: &mut TaskManager,
collator_options: CollatorOptions,
hwbench: Option<sc_sysinfo::HwBench>,
) -> RelayChainResult<(Arc<(dyn RelayChainInterface + 'static)>, Option<CollatorPair>)> {
match collator_options.relay_chain_rpc_url {
Some(relay_chain_url) =>
build_minimal_relay_chain_node(polkadot_config, task_manager, relay_chain_url).await,
None => build_inprocess_relay_chain(
polkadot_config,
parachain_config,
telemetry_worker_handle,
task_manager,
hwbench,
),
}
}
/// Start a shell node with the given parachain `Configuration` and relay chain `Configuration`. /// Start a shell node with the given parachain `Configuration` and relay chain `Configuration`.
/// ///
/// This is the actual implementation that is abstract over the executor and the runtime api for shell nodes. /// This is the actual implementation that is abstract over the executor and the runtime api for shell nodes.
cumulus/test/service/src/lib.rs
+13 -9
View File
@@ -190,10 +190,14 @@ async fn build_relay_chain_interface(
collator_options: CollatorOptions, collator_options: CollatorOptions,
task_manager: &mut TaskManager, task_manager: &mut TaskManager,
) -> RelayChainResult<Arc<dyn RelayChainInterface + 'static>> { ) -> RelayChainResult<Arc<dyn RelayChainInterface + 'static>> {
if let Some(relay_chain_url) = collator_options.relay_chain_rpc_url { if !collator_options.relay_chain_rpc_urls.is_empty() {
return build_minimal_relay_chain_node(relay_chain_config, task_manager, relay_chain_url) return build_minimal_relay_chain_node(
.await relay_chain_config,
.map(|r| r.0) task_manager,
collator_options.relay_chain_rpc_urls,
)
.await
.map(|r| r.0)
} }
let relay_chain_full_node = polkadot_test_service::new_full( let relay_chain_full_node = polkadot_test_service::new_full(
@@ -429,7 +433,7 @@ pub struct TestNodeBuilder {
storage_update_func_parachain: Option<Box<dyn Fn()>>, storage_update_func_parachain: Option<Box<dyn Fn()>>,
storage_update_func_relay_chain: Option<Box<dyn Fn()>>, storage_update_func_relay_chain: Option<Box<dyn Fn()>>,
consensus: Consensus, consensus: Consensus,
relay_chain_full_node_url: Option<Url>, relay_chain_full_node_url: Vec<Url>,
} }
impl TestNodeBuilder { impl TestNodeBuilder {
@@ -451,7 +455,7 @@ impl TestNodeBuilder {
storage_update_func_parachain: None, storage_update_func_parachain: None,
storage_update_func_relay_chain: None, storage_update_func_relay_chain: None,
consensus: Consensus::RelayChain, consensus: Consensus::RelayChain,
relay_chain_full_node_url: None, relay_chain_full_node_url: vec![],
} }
} }
@@ -545,7 +549,7 @@ impl TestNodeBuilder {
/// Connect to full node via RPC. /// Connect to full node via RPC.
pub fn use_external_relay_chain_node_at_url(mut self, network_address: Url) -> Self { pub fn use_external_relay_chain_node_at_url(mut self, network_address: Url) -> Self {
self.relay_chain_full_node_url = Some(network_address); self.relay_chain_full_node_url = vec![network_address];
self self
} }
@@ -554,7 +558,7 @@ impl TestNodeBuilder {
let mut localhost_url = let mut localhost_url =
Url::parse("ws://localhost").expect("Should be able to parse localhost Url"); Url::parse("ws://localhost").expect("Should be able to parse localhost Url");
localhost_url.set_port(Some(port)).expect("Should be able to set port"); localhost_url.set_port(Some(port)).expect("Should be able to set port");
self.relay_chain_full_node_url = Some(localhost_url); self.relay_chain_full_node_url = vec![localhost_url];
self self
} }
@@ -580,7 +584,7 @@ impl TestNodeBuilder {
); );
let collator_options = let collator_options =
CollatorOptions { relay_chain_rpc_url: self.relay_chain_full_node_url }; CollatorOptions { relay_chain_rpc_urls: self.relay_chain_full_node_url };
relay_chain_config.network.node_name = relay_chain_config.network.node_name =
format!("{} (relay chain)", relay_chain_config.network.node_name); format!("{} (relay chain)", relay_chain_config.network.node_name);
cumulus/zombienet/tests/0006-rpc_collator_builds_blocks.feature
+8 -1
View File
@@ -7,11 +7,18 @@ bob: is up
charlie: is up charlie: is up
one: is up one: is up
two: is up two: is up
three: is up
dave: is up dave: is up
eve: is up eve: is up
alice: parachain 2000 is registered within 225 seconds alice: parachain 2000 is registered within 225 seconds
alice: parachain 2000 block height is at least 10 within 250 seconds alice: parachain 2000 block height is at least 10 within 250 seconds
dave: reports block height is at least 12 within 250 seconds
eve: reports block height is at least 12 within 250 seconds eve: reports block height is at least 12 within 250 seconds
dave: reports block height is at least 12 within 250 seconds
one: restart after 1 seconds
dave: reports block height is at least 20 within 200 seconds
two: restart after 1 seconds
three: restart after 20 seconds
dave: is up
dave: reports block height is at least 30 within 200 seconds
cumulus/zombienet/tests/0006-rpc_collator_builds_blocks.toml
+6 -2
View File
@@ -25,6 +25,10 @@ chain = "rococo-local"
name = "two" name = "two"
validator = false validator = false
[[relaychain.nodes]]
name = "three"
validator = false
[[parachains]] [[parachains]]
id = 2000 id = 2000
cumulus_based = true cumulus_based = true
@@ -35,7 +39,7 @@ cumulus_based = true
validator = true validator = true
image = "{{COL_IMAGE}}" image = "{{COL_IMAGE}}"
command = "test-parachain" command = "test-parachain"
args = ["-lparachain=debug,blockchain-rpc-client=debug", "--relay-chain-rpc-url {{'one'|zombie('wsUri')}}", "-- --bootnodes {{'one'|zombie('multiAddress')}}"] args = ["-lparachain=trace,blockchain-rpc-client=debug", "--relay-chain-rpc-urls {{'one'|zombie('wsUri')}} {{'two'|zombie('wsUri')}} {{'three'|zombie('wsUri')}}", "-- --bootnodes {{'one'|zombie('multiAddress')}} {{'two'|zombie('multiAddress')}} {{'three'|zombie('multiAddress')}}"]
# run eve as parachain full node # run eve as parachain full node
[[parachains.collators]] [[parachains.collators]]
@@ -43,4 +47,4 @@ cumulus_based = true
validator = true validator = true
image = "{{COL_IMAGE}}" image = "{{COL_IMAGE}}"
command = "test-parachain" command = "test-parachain"
args = ["-lparachain=debug,blockchain-rpc-client=debug", "--relay-chain-rpc-url {{'two'|zombie('wsUri')}}", "-- --bootnodes {{'two'|zombie('multiAddress')}}"] args = ["-lparachain=trace,blockchain-rpc-client=debug", "--relay-chain-rpc-urls {{'one'|zombie('wsUri')}} {{'two'|zombie('wsUri')}} {{'three'|zombie('wsUri')}}", "-- --bootnodes {{'one'|zombie('multiAddress')}} {{'two'|zombie('multiAddress')}} {{'three'|zombie('multiAddress')}}"]