sc_hop/lib.rs
1// Copyright (C) Parity Technologies (UK) Ltd.
2// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
3
4// This program 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// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
16
17//! # `sc-hop` — Hand-Off Protocol
18//!
19//! Node-level ephemeral disk-backed data pool for Substrate collators, with an
20//! RPC for submit/claim/ack, best-effort on-chain promotion, per-account rate
21//! limiting, and graceful degradation when the runtime lacks `HopRuntimeApi`.
22//!
23//! See the crate [`README`] for the design overview, integration guide, CLI
24//! flags, RPC reference, and error codes.
25//!
26//! [`README`]: https://github.com/paritytech/polkadot-sdk/blob/master/substrate/client/hop/README.md
27
28pub mod cli;
29pub mod metrics;
30pub mod pool;
31pub mod promotion;
32pub mod rate_limit;
33pub mod rpc;
34pub mod runtime_api;
35pub mod types;
36
37// Convenience re-exports for common use cases
38pub use cli::HopParams;
39pub use metrics::HopMetrics;
40pub use pool::HopDataPool;
41pub use promotion::{build_maintenance_task, HopMaintenanceTask};
42pub use rate_limit::{RateLimitConfig, RateLimiter};
43pub use rpc::{HopApiServer, HopRpcServer};
44pub use types::{
45 HopBlockNumber, HopEntryMeta, HopError, HopHash, PoolStatus, SenderId, SubmitResult,
46};