sc_rpc_spec_v2/chain_head/
mod.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Substrate chain head API.
20//!
21//! # Note
22//!
23//! Methods are prefixed by `chainHead`.
24
25#[cfg(test)]
26pub mod test_utils;
27#[cfg(test)]
28mod tests;
29
30pub mod api;
31pub mod chain_head;
32pub mod error;
33pub mod event;
34
35mod chain_head_follow;
36mod chain_head_storage;
37mod subscription;
38
39pub use api::ChainHeadApiServer;
40pub use chain_head::{ChainHead, ChainHeadConfig};
41pub use event::{
42	BestBlockChanged, ErrorEvent, Finalized, FollowEvent, Initialized, NewBlock, RuntimeEvent,
43	RuntimeVersionEvent,
44};
45
46/// Follow event sender.
47pub(crate) type FollowEventSender<Hash> = futures::channel::mpsc::Sender<FollowEvent<Hash>>;
48/// Follow event receiver.
49pub(crate) type FollowEventReceiver<Hash> = futures::channel::mpsc::Receiver<FollowEvent<Hash>>;
50/// Follow event send error.
51pub(crate) type FollowEventSendError = futures::channel::mpsc::SendError;
sc_rpc_spec_v2/chain_head/mod.rs

sc_rpc_spec_v2/chain_head/
mod.rs
