mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-06 21:58:06 +00:00
Benjamin Kampmann
bd652793db
* Move transaction pool to primitives * move backend, errors into primitives * remove unused client depencies * Move rpc-api into primitives * Move peerset back to client * Move rpc/api back to client, move palette/support/rpc into utils * move support-rpc into subfolder * move system-rpc into utils * move transaction-pool and -graph back into client * fix broken imports * Clean up test primitives * Make support test utils independent of frame * remove unnecessary node dependencies from service * Reactivate dependency script: - only enforce the now achieved status quo will remain - allow for primitives to depend on /client for now without failing - more discriptive error message so people understand, what it wants - minor fix to differentiative between ../client and /client (which may be a subfolder) - don't allow this to fail anylonger. * fix doc comment * 'Should not' rather than 'must not'. * Revert unwanted dependency changes * fix faulty import * fixup derive_more version * fix wrong import path
106 lines
3.8 KiB
Rust
106 lines
3.8 KiB
Rust
// Copyright 2017-2019 Parity Technologies (UK) Ltd.
|
|
// This file is part of Substrate.
|
|
|
|
// Substrate 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.
|
|
|
|
// Substrate 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 Substrate. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Substrate Client and associated logic.
|
|
//!
|
|
//! The [`Client`] is one of the most important components of Substrate. It mainly comprises two
|
|
//! parts:
|
|
//!
|
|
//! - A database containing the blocks and chain state, generally referred to as
|
|
//! the [`Backend`](backend::Backend).
|
|
//! - A runtime environment, generally referred to as the [`Executor`](CallExecutor).
|
|
//!
|
|
//! # Initialization
|
|
//!
|
|
//! Creating a [`Client`] is done by calling the `new` method and passing to it a
|
|
//! [`Backend`](backend::Backend) and an [`Executor`](CallExecutor).
|
|
//!
|
|
//! The former is typically provided by the `substrate-client-db` crate.
|
|
//!
|
|
//! The latter typically requires passing one of:
|
|
//!
|
|
//! - A [`LocalCallExecutor`] running the runtime locally.
|
|
//! - A [`RemoteCallExecutor`](light::call_executor::RemoteCallExecutor) that will ask a
|
|
//! third-party to perform the executions.
|
|
//! - A [`RemoteOrLocalCallExecutor`](light::call_executor::RemoteOrLocalCallExecutor), combination
|
|
//! of the two.
|
|
//!
|
|
//! Additionally, the fourth generic parameter of the `Client` is a marker type representing
|
|
//! the ways in which the runtime can interface with the outside. Any code that builds a `Client`
|
|
//! is responsible for putting the right marker.
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! ```
|
|
//! use std::sync::Arc;
|
|
//! use substrate_client::{Client, in_mem::Backend, LocalCallExecutor};
|
|
//! use primitives::Blake2Hasher;
|
|
//! use sr_primitives::{StorageOverlay, ChildrenStorageOverlay};
|
|
//! use executor::{NativeExecutor, WasmExecutionMethod};
|
|
//!
|
|
//! // In this example, we're using the `Block` and `RuntimeApi` types from the
|
|
//! // `substrate-test-runtime-client` crate. These types are automatically generated when
|
|
//! // compiling a runtime. In a typical use-case, these types would have been to be generated
|
|
//! // from your runtime.
|
|
//! use test_client::{LocalExecutor, runtime::Block, runtime::RuntimeApi};
|
|
//!
|
|
//! let backend = Arc::new(Backend::<Block, Blake2Hasher>::new());
|
|
//! let client = Client::<_, _, _, RuntimeApi>::new(
|
|
//! backend.clone(),
|
|
//! LocalCallExecutor::new(
|
|
//! backend.clone(),
|
|
//! NativeExecutor::<LocalExecutor>::new(WasmExecutionMethod::Interpreted, None),
|
|
//! ),
|
|
//! // This parameter provides the storage for the chain genesis.
|
|
//! <(StorageOverlay, ChildrenStorageOverlay)>::default(),
|
|
//! Default::default(),
|
|
//! Default::default(),
|
|
//! );
|
|
//! ```
|
|
//!
|
|
|
|
#![warn(missing_docs)]
|
|
#![recursion_limit="128"]
|
|
|
|
pub mod cht;
|
|
pub mod in_mem;
|
|
pub mod genesis;
|
|
pub mod light;
|
|
pub mod leaves;
|
|
mod call_executor;
|
|
mod client;
|
|
|
|
pub use client_api::{
|
|
blockchain,
|
|
blockchain::well_known_cache_keys,
|
|
blockchain::Info as ChainInfo,
|
|
notifications::{StorageEventStream, StorageChangeSet},
|
|
call_executor::CallExecutor,
|
|
utils,
|
|
};
|
|
pub use crate::{
|
|
call_executor::LocalCallExecutor,
|
|
client::{
|
|
new_with_backend,
|
|
new_in_mem,
|
|
BlockBody, ImportNotifications, FinalityNotifications, BlockchainEvents,
|
|
BlockImportNotification, Client, ClientInfo, ExecutionStrategies, FinalityNotification,
|
|
LongestChain, BlockOf, ProvideUncles, ForkBlocks, apply_aux,
|
|
},
|
|
leaves::LeafSet,
|
|
};
|
|
pub use state_machine::{ExecutionStrategy, StorageProof};
|