Reorganising the repository - external renames and moves (#4074)

* Adding first rough ouline of the repository structure * Remove old CI stuff * add title * formatting fixes * move node-exits job's script to scripts dir * Move docs into subdir * move to bin * move maintainence scripts, configs and helpers into its own dir * add .local to ignore * move core->client * start up 'test' area * move test client * move test runtime * make test move compile * Add dependencies rule enforcement. * Fix indexing. * Update docs to reflect latest changes * Moving /srml->/paint * update docs * move client/sr-* -> primitives/ * clean old readme * remove old broken code in rhd * update lock * Step 1. * starting to untangle client * Fix after merge. * start splitting out client interfaces * move children and blockchain interfaces * Move trie and state-machine to primitives. * Fix WASM builds. * fixing broken imports * more interface moves * move backend and light to interfaces * move CallExecutor * move cli off client * moving around more interfaces * re-add consensus crates into the mix * fix subkey path * relieve client from executor * starting to pull out client from grandpa * move is_decendent_of out of client * grandpa still depends on client directly * lemme tests pass * rename srml->paint * Make it compile. * rename interfaces->client-api * Move keyring to primitives. * fixup libp2p dep * fix broken use * allow dependency enforcement to fail * move fork-tree * Moving wasm-builder * make env * move build-script-utils * fixup broken crate depdencies and names * fix imports for authority discovery * fix typo * update cargo.lock * fixing imports * Fix paths and add missing crates * re-add missing crates
2026-06-17 02:01:02 +00:00 · 2019-11-14 21:51:17 +01:00
parent becc3b0a4f
commit 60e5011c72
809 changed files with 7801 additions and 6464 deletions
@@ -0,0 +1,105 @@
+// 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),
+//! 		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::{
+	error,
+	blockchain,
+	blockchain::well_known_cache_keys,
+	blockchain::Info as ChainInfo,
+	notifications::{StorageEventStream, StorageChangeSet},
+	call_executor::CallExecutor,
+	utils,
+};
+pub use crate::call_executor::LocalCallExecutor;
+pub use crate::client::{
+	new_with_backend,
+	new_in_mem,
+	BlockBody, ImportNotifications, FinalityNotifications, BlockchainEvents,
+	BlockImportNotification, Client, ClientInfo, ExecutionStrategies, FinalityNotification,
+	LongestChain, BlockOf, ProvideUncles, ForkBlocks, apply_aux,
+};
+pub use state_machine::{ExecutionStrategy, StorageProof};
+pub use crate::leaves::LeafSet;