referrerpolicy=no-referrer-when-downgrade
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

// Copyright 2019-2021 Parity Technologies (UK) Ltd.
// This file is part of Parity Bridges Common.

// Parity Bridges Common 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.

// Parity Bridges Common 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 Parity Bridges Common.  If not, see <http://www.gnu.org/licenses/>.

//! Tools to interact with Substrate node using RPC methods.

#![warn(missing_docs)]

mod chain;
mod client;
mod error;
mod sync_header;
mod transaction_tracker;

pub mod calls;
pub mod guard;
pub mod metrics;
pub mod test_chain;

use std::time::Duration;

pub use crate::{
	chain::{
		AccountKeyPairOf, BlockWithJustification, CallOf, Chain, ChainWithBalances,
		ChainWithGrandpa, ChainWithMessages, ChainWithRuntimeVersion, ChainWithTransactions,
		ChainWithUtilityPallet, FullRuntimeUtilityPallet, MockedRuntimeUtilityPallet, Parachain,
		RelayChain, SignParam, SignedBlockOf, TransactionStatusOf, UnsignedTransaction,
		UtilityPallet,
	},
	client::{
		is_ancient_block, rpc_with_caching as new, ChainRuntimeVersion, Client,
		OpaqueGrandpaAuthoritiesSet, RpcWithCachingClient, SimpleRuntimeVersion, StreamDescription,
		Subscription, ANCIENT_BLOCK_THRESHOLD,
	},
	error::{Error, Result},
	sync_header::SyncHeader,
	transaction_tracker::TransactionTracker,
};
pub use bp_runtime::{
	AccountIdOf, AccountPublicOf, BalanceOf, BlockNumberOf, Chain as ChainBase, HashOf, HeaderIdOf,
	HeaderOf, NonceOf, Parachain as ParachainBase, SignatureOf, TransactionEra, TransactionEraOf,
	UnderlyingChainProvider,
};

/// Substrate-over-websocket connection params.
#[derive(Debug, Clone)]
pub struct ConnectionParams {
	/// Websocket endpoint URL. Overrides all other URL components (`host`, `port`, `path` and
	/// `secure`).
	pub uri: Option<String>,
	/// Websocket server host name.
	pub host: String,
	/// Websocket server TCP port.
	pub port: u16,
	/// Websocket endpoint path at server.
	pub path: Option<String>,
	/// Use secure websocket connection.
	pub secure: bool,
	/// Defined chain runtime version
	pub chain_runtime_version: ChainRuntimeVersion,
}

impl Default for ConnectionParams {
	fn default() -> Self {
		ConnectionParams {
			uri: None,
			host: "localhost".into(),
			port: 9944,
			path: None,
			secure: false,
			chain_runtime_version: ChainRuntimeVersion::Auto,
		}
	}
}

/// Returns stall timeout for relay loop.
///
/// Relay considers himself stalled if he has submitted transaction to the node, but it has not
/// been mined for this period.
pub fn transaction_stall_timeout(
	mortality_period: Option<u32>,
	average_block_interval: Duration,
	default_stall_timeout: Duration,
) -> Duration {
	// 1 extra block for transaction to reach the pool && 1 for relayer to awake after it is mined
	mortality_period
		.map(|mortality_period| average_block_interval.saturating_mul(mortality_period + 1 + 1))
		.unwrap_or(default_stall_timeout)
}