sc_rpc_spec_v2/bitswap/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 bitswap RPC API.
20//!
21//! Provides methods for retrieving indexed transaction data by CID:
22//! - `bitswap_unstable_get` โ single CID, returns the chunk or a top-level error. `bitswap_v1_get`
23//! is registered as an alias during the migration to `unstable_`.
24//! - `bitswap_unstable_stream` โ subscription that emits per-CID outcomes (tagged `streamItem` /
25//! `streamItemError`) as they are looked up, followed by a `streamDone` end-of-stream marker.
26//! - `bitswap_unstable_unstream` โ cancel an active `bitswap_unstable_stream` subscription.
27
28#[cfg(test)]
29mod tests;
30
31pub mod api;
32pub mod bitswap;
33pub mod error;
34
35pub use api::BitswapApiServer;
36pub use bitswap::Bitswap;