Implement runtime api client side directly in the runtime (#1094)

* Move `initialise_block` into `Core` trait as it is crucial calling the API functions * Switch to first version of new runtime API implementation * Fixes bug in tests * Reenable asserts * Directly use the `TestAPI` in the tests * Start improving the api traits :100644 100644 898aadc7 49217199 M Cargo.lock :100644 100644 61570436 465ed664 M core/client/src/backend.rs :100644 100644 5d0c886b 64d710fd M core/client/src/block_builder.rs :100644 100644 c447855e 5ecbe474 M core/client/src/client.rs :100644 100644 139cef13 f90dbf3d M core/client/src/error.rs :100644 100644 2800c503 3298e66a M core/client/src/runtime_api.rs :100644 100644 affa1c5c 809b08bc M core/primitives/src/lib.rs :100644 100644 2877dfa9 d5547413 M core/sr-api/Cargo.toml :100644 100644 9a49784d 6a625a03 M core/sr-api/src/lib.rs :100644 100644 7c28e1c7 a1a444a9 M core/sr-primitives/src/traits.rs :100644 100644 2e113ab6 dcc01a6d M srml/metadata/Cargo.toml :100644 100644 ea722a70 0809531a M srml/metadata/src/lib.rs * Refactoring * Move `sr-api` into client and more refactoring * Fixes tests * Some documentation and cleanup * Fixes compilation after rebase * More refactoring and more documentation * Makes `substrate-client` compilable on `wasm` On `wasm` it basically just exports the runtime api stuff. * Fixes grumbles * Updates wasm files after rebasing the master * Remove TODO comment * Remove whitespaces * Fixes after rebasing master * Another rebase, another fix commit
2026-06-30 23:37:24 +00:00 · 2018-11-13 13:33:28 +01:00
parent 6e3c56c135
commit 9063d1acae
51 changed files with 2993 additions and 777 deletions
@@ -0,0 +1,40 @@
+// Copyright 2018 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/>.
+
+//! The runtime api for building blocks.
+
+use runtime_primitives::{traits::Block as BlockT, ApplyResult};
+use rstd::vec::Vec;
+
+decl_runtime_apis! {
+	/// The `BlockBuilder` api trait that provides required functions for building a block for a runtime.
+	pub trait BlockBuilder<Block: BlockT> {
+		/// The runtime api for building blocks./// Apply the given extrinsics.
+		fn apply_extrinsic(extrinsic: <Block as BlockT>::Extrinsic) -> ApplyResult;
+		/// Finish the current block.
+		fn finalise_block() -> <Block as BlockT>::Header;
+		/// Generate inherent extrinsics.
+		fn inherent_extrinsics<InherentExtrinsic, UncheckedExtrinsic>(
+			inherent: InherentExtrinsic
+		) -> Vec<UncheckedExtrinsic>;
+		/// Check that the inherents are valid.
+		fn check_inherents<InherentData, Error>(
+			block: Block, data: InherentData
+		) -> Result<(), Error>;
+		/// Generate a random seed.
+		fn random_seed() -> <Block as BlockT>::Hash;
+	}
+}
@@ -0,0 +1,116 @@
+// Copyright 2017-2018 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/>.
+
+use super::api::BlockBuilder as BlockBuilderApi;
+use std::vec::Vec;
+use codec::Encode;
+use blockchain::HeaderBackend;
+use runtime_primitives::traits::{
+	Header as HeaderT, Hash, Block as BlockT, One, HashFor, ProvideRuntimeApi, ApiRef
+};
+use primitives::H256;
+use runtime_primitives::generic::BlockId;
+use runtime_api::Core;
+use error;
+use runtime_primitives::ApplyOutcome;
+
+/// Utility for building new (valid) blocks from a stream of extrinsics.
+pub struct BlockBuilder<'a, Block, A: ProvideRuntimeApi> where Block: BlockT {
+	header: <Block as BlockT>::Header,
+	extrinsics: Vec<<Block as BlockT>::Extrinsic>,
+	api: ApiRef<'a, A::Api>,
+	block_id: BlockId<Block>,
+}
+
+impl<'a, Block, A> BlockBuilder<'a, Block, A>
+where
+	Block: BlockT<Hash=H256>,
+	A: ProvideRuntimeApi + HeaderBackend<Block> + 'a,
+	A::Api: BlockBuilderApi<Block>,
+{
+	/// Create a new instance of builder from the given client, building on the latest block.
+	pub fn new(api: &'a A) -> error::Result<Self> {
+		api.info().and_then(|i| Self::at_block(&BlockId::Hash(i.best_hash), api))
+	}
+
+	/// Create a new instance of builder from the given client using a particular block's ID to
+	/// build upon.
+	pub fn at_block(block_id: &BlockId<Block>, api: &'a A) -> error::Result<Self> {
+		let number = api.block_number_from_id(block_id)?
+			.ok_or_else(|| error::ErrorKind::UnknownBlock(format!("{}", block_id)))?
+			+ One::one();
+
+		let parent_hash = api.block_hash_from_id(block_id)?
+			.ok_or_else(|| error::ErrorKind::UnknownBlock(format!("{}", block_id)))?;
+
+		let header = <<Block as BlockT>::Header as HeaderT>::new(
+			number,
+			Default::default(),
+			Default::default(),
+			parent_hash,
+			Default::default()
+		);
+
+		let api = api.runtime_api();
+		api.initialise_block(block_id, &header)?;
+
+		Ok(BlockBuilder {
+			header,
+			extrinsics: Vec::new(),
+			api,
+			block_id: *block_id,
+		})
+	}
+
+	/// Push onto the block's list of extrinsics. This will ensure the extrinsic
+	/// can be validly executed (by executing it); if it is invalid, it'll be returned along with
+	/// the error. Otherwise, it will return a mutable reference to self (in order to chain).
+	pub fn push(&mut self, xt: <Block as BlockT>::Extrinsic) -> error::Result<()> {
+		fn impl_push<'a, T, Block: BlockT>(
+			api: &mut ApiRef<'a, T>,
+			block_id: &BlockId<Block>,
+			xt: Block::Extrinsic,
+			extrinsics: &mut Vec<Block::Extrinsic>
+		) -> error::Result<()> where T: BlockBuilderApi<Block> {
+			api.map_api_result(|api| {
+				match api.apply_extrinsic(block_id, &xt)? {
+					Ok(ApplyOutcome::Success) | Ok(ApplyOutcome::Fail) => {
+						extrinsics.push(xt);
+						Ok(())
+					}
+					Err(e) => {
+						Err(error::ErrorKind::ApplyExtrinsicFailed(e).into())
+					}
+				}
+			})
+		}
+
+		//FIXME: Please NLL, help me!
+		impl_push(&mut self.api, &self.block_id, xt, &mut self.extrinsics)
+	}
+
+	/// Consume the builder to return a valid `Block` containing all pushed extrinsics.
+	pub fn bake(mut self) -> error::Result<Block> {
+		self.header = self.api.finalise_block(&self.block_id)?;
+
+		debug_assert_eq!(
+			self.header.extrinsics_root().clone(),
+			HashFor::<Block>::ordered_trie_root(self.extrinsics.iter().map(Encode::encode)),
+		);
+
+		Ok(<Block as BlockT>::new(self.header, self.extrinsics))
+	}
+}
@@ -0,0 +1,23 @@
+// Copyright 2018 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/>.
+
+//! Utility struct to build a block.
+
+#[cfg(feature = "std")]
+mod block_builder;
+#[cfg(feature = "std")]
+pub use self::block_builder::*;
+pub mod api;