Expand description
Tools to interact with Substrate node using RPC methods.
Modules§
- calls
- Basic runtime calls.
- guard
- Pallet provides a set of guard functions that are running in background threads and are aborting process if some condition fails.
- metrics
- Contains several Substrate-specific metrics that may be exposed by relay.
- test_
chain - Pallet provides a set of guard functions that are running in background threads and are aborting process if some condition fails. Test chain implementation to use in tests.
Structs§
- Connection
Params - Substrate-over-websocket connection params.
- Full
Runtime Utility Pallet - Structure that implements
UtilityPalletProvider
based on a full runtime. - Mocked
Runtime Utility Pallet - Structure that implements
UtilityPalletProvider
based on a call conversion. - Sign
Param - Sign transaction parameters
- Simple
Runtime Version - A simple runtime version. It only includes the
spec_version
andtransaction_version
. - Stream
Description - Structure describing a stream.
- Subscription
- Subscription to some chain events.
- Sync
Header - Generic wrapper for
sp_runtime::traits::Header
based headers, that implementsfinality_relay::SourceHeader
and may be used in headers sync directly. - Transaction
Tracker - Substrate transaction tracker implementation.
- Unsigned
Transaction - Transaction before it is signed.
Enums§
- Chain
Runtime Version - Chain runtime version in client
- Error
- Errors that can occur only when interacting with a Substrate node through RPC.
- Transaction
Era - Era of specific transaction.
Constants§
- ANCIENT_
BLOCK_ THRESHOLD - The difference between best block number and number of its ancestor, that is enough for us to consider that ancestor an “ancient” block with dropped state.
Traits§
- Block
With Justification - Block with justification.
- Chain
- Substrate-based chain from minimal relay-client point of view.
- Chain
Base - Minimal Substrate-based chain representation that may be used from no_std environment.
- Chain
With Balances - Substrate-based chain with
AccountData
generic argument offrame_system::AccountInfo
set to thepallet_balances::AccountData<Balance>
. - Chain
With Grandpa - Substrate-based chain that is using direct GRANDPA finality from minimal relay-client point of view.
- Chain
With Messages - Substrate-based chain with messaging support from minimal relay-client point of view.
- Chain
With Rewards - Substrate-based chain with bridge relayers pallet as a reward ledger.
- Chain
With Runtime Version - Bridge-supported network definition.
- Chain
With Transactions - Substrate-based chain transactions signing scheme.
- Chain
With Utility Pallet - Substrate-based chain that uses
pallet-utility
. - Client
- Relay uses the
Client
to communicate with the node, connected to Substrate chainC
. - Parachain
- Substrate-based parachain from minimal relay-client point of view.
- Parachain
Base - Minimal parachain representation that may be used from no_std environment.
- Relay
Chain - Substrate-based relay chain that supports parachains.
- Underlying
Chain Provider - A trait that provides the type of the underlying chain.
- Utility
Pallet - Trait that provides functionality defined inside
pallet-utility
Functions§
- is_
ancient_ block - Returns
true
if we think that the state is already discarded for given block. - new
- Creates new RPC client with caching support.
- transaction_
stall_ timeout - Returns stall timeout for relay loop.
Type Aliases§
- Account
IdOf - Account id type used by the chain.
- Account
KeyPair Of - Account key pair used by transactions signing scheme.
- Account
Public Of - Account public type used by the chain.
- Balance
Of - Balance type used by the chain.
- Block
Number Of - Block number used by the chain.
- CallOf
- Call type used by the chain.
- HashOf
- Hash type used by the chain.
- Header
IdOf - Header id used by the chain.
- Header
Of - Header type used by the chain.
- NonceOf
- Transaction nonce type used by the chain.
- Opaque
Grandpa Authorities Set - Opaque GRANDPA authorities set.
- Result
- Result type used by Substrate client.
- RpcWith
Caching Client - Type of RPC client with caching support.
- Signature
Of - Signature type used by the chain.
- Signed
Block Of - Signed block type of given chain.
- Transaction
EraOf - Transaction era used by the chain.
- Transaction
Status Of - Transaction status of the chain.