substrate_relay_helper/cli/
relay_headers.rs

1// Copyright 2019-2021 Parity Technologies (UK) Ltd.
2// This file is part of Parity Bridges Common.
3
4// Parity Bridges Common is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// Parity Bridges Common is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with Parity Bridges Common.  If not, see <http://www.gnu.org/licenses/>.
16
17//! Primitives for exposing the headers relaying functionality in the CLI.
18
19use async_trait::async_trait;
20use clap::Parser;
21
22use relay_utils::{
23	metrics::{GlobalMetrics, StandaloneMetric},
24	UniqueSaturatedInto,
25};
26
27use crate::{
28	cli::{bridge::*, chain_schema::*, PrometheusParams},
29	finality::SubstrateFinalitySyncPipeline,
30	HeadersToRelay,
31};
32use relay_substrate_client::Client;
33
34/// Chain headers relaying params.
35#[derive(Parser)]
36pub struct RelayHeadersParams {
37	/// If passed, only mandatory headers (headers that are changing the GRANDPA authorities set)
38	/// are relayed.
39	#[arg(long)]
40	only_mandatory_headers: bool,
41	/// If passed, only free headers (mandatory and every Nth header, if configured in runtime)
42	/// are relayed. Overrides `only_mandatory_headers`.
43	#[arg(long)]
44	only_free_headers: bool,
45	#[command(flatten)]
46	source: SourceConnectionParams,
47	#[command(flatten)]
48	target: TargetConnectionParams,
49	#[command(flatten)]
50	target_sign: TargetSigningParams,
51	#[command(flatten)]
52	prometheus_params: PrometheusParams,
53}
54
55/// Single header relaying params.
56#[derive(Parser)]
57pub struct RelayHeaderParams {
58	#[command(flatten)]
59	source: SourceConnectionParams,
60	#[command(flatten)]
61	target: TargetConnectionParams,
62	#[command(flatten)]
63	target_sign: TargetSigningParams,
64	/// Number of the source chain header that we want to relay. It must have a persistent
65	/// storage proof at the [`Self::source`] node, otherwise the command will fail.
66	#[arg(long)]
67	number: u128,
68}
69
70impl RelayHeadersParams {
71	fn headers_to_relay(&self) -> HeadersToRelay {
72		match (self.only_mandatory_headers, self.only_free_headers) {
73			(_, true) => HeadersToRelay::Free,
74			(true, false) => HeadersToRelay::Mandatory,
75			_ => HeadersToRelay::All,
76		}
77	}
78}
79
80/// Trait used for relaying headers between 2 chains.
81#[async_trait]
82pub trait HeadersRelayer: RelayToRelayHeadersCliBridge {
83	/// Relay headers.
84	async fn relay_headers(data: RelayHeadersParams) -> anyhow::Result<()> {
85		let headers_to_relay = data.headers_to_relay();
86		let source_client = data.source.into_client::<Self::Source>().await?;
87		let target_client = data.target.into_client::<Self::Target>().await?;
88		let target_transactions_mortality = data.target_sign.target_transactions_mortality;
89		let target_sign = data.target_sign.to_keypair::<Self::Target>()?;
90
91		let metrics_params: relay_utils::metrics::MetricsParams =
92			data.prometheus_params.into_metrics_params()?;
93		GlobalMetrics::new()?.register_and_spawn(&metrics_params.registry)?;
94
95		let target_transactions_params = crate::TransactionParams {
96			signer: target_sign,
97			mortality: target_transactions_mortality,
98		};
99
100		Self::Finality::start_relay_guards(&target_client, target_client.can_start_version_guard())
101			.await?;
102
103		crate::finality::run::<Self::Finality>(
104			source_client,
105			target_client,
106			headers_to_relay,
107			target_transactions_params,
108			metrics_params,
109		)
110		.await
111	}
112
113	/// Relay single header. No checks are made to ensure that transaction will succeed.
114	async fn relay_header(data: RelayHeaderParams) -> anyhow::Result<()> {
115		let source_client = data.source.into_client::<Self::Source>().await?;
116		let target_client = data.target.into_client::<Self::Target>().await?;
117		let target_transactions_mortality = data.target_sign.target_transactions_mortality;
118		let target_sign = data.target_sign.to_keypair::<Self::Target>()?;
119
120		crate::finality::relay_single_header::<Self::Finality>(
121			source_client,
122			target_client,
123			crate::TransactionParams {
124				signer: target_sign,
125				mortality: target_transactions_mortality,
126			},
127			data.number.unique_saturated_into(),
128		)
129		.await
130	}
131}
substrate_relay_helper/cli/relay_headers.rs

substrate_relay_helper/cli/
relay_headers.rs
