Cumulus changes version 2 (#2313)

* ensure imbalances are properly accounted for (#2183) * ensure imbalances are properly accounted for * bump runtime version * Update node/runtime/src/lib.rs * implement contract events (#2161) * implement contract events * update runtime * renaming * update test code hash * improve complexity details * add deposit event base cost * add test * Revert "add deposit event base cost" This reverts commit 58ec010c0f4f4f0e16935ad41da32aedd17a8c57. * update test * Revert "update test" This reverts commit 6fe61a593ccf0d41f09a0b97472b28ed8751a999. * Revert "Revert "add deposit event base cost"" This reverts commit 145e8a9bac15313a4c380aa66b94fd4d36fa3f6d. * Fix format a bit * Replace Vec<u8> with [u8; 32] for contract storage key (#2184) * Replace Vec<u8> with [u8; 32] for contract storage key * Read storage keys from sandbox memory into fixed size buffer * Increment `impl_version` * Remove redundant Ok(()) and explicitly specify StorageKey buffer type (#2188) * Switch to `derive(Encode, Decode)` for `Call` (#2178) * Add some tests * More tests * Switch to `derive(Encode, Decode)` for `Call` * Update lock files * Simplify the macro cases * Cache changes trie config in db storage (#2170) * cache changes trie config in db storage * Update core/client/db/src/lib.rs Co-Authored-By: svyatonik <svyatonik@gmail.com> * Update core/client/db/src/lib.rs Co-Authored-By: svyatonik <svyatonik@gmail.com> * Fix version check for renamed runtime api methods (#2190) * Add feature to disable including the test-runtime wasm blob * Enable `std` feature for `consensus_authorities` * Implement `skip_initialize_block` and `initialize_block` for runtime api * Add test and fixes bug * Begin to implement support for passing the `ProofRecorder` * Make sure proof generation works as intended * Fixes tests * Make `BlockBuilder` generate proofs on request. * Adds `TestClientBuilder` to simplify creating a test client * Add `include-wasm-blob` to `test-client` as well * Make `test-client` compile without including the wasm file * Disable more stuff in test-client without wasm * Reorganize the re-exports * Use correct bounds * Update docs * Update core/client/src/block_builder/block_builder.rs Co-Authored-By: bkchr <bkchr@users.noreply.github.com> * Extend test to actually generated proof * Switch to enum for `skip_initialize_block` * Some wasm files updates
2026-04-27 02:17:58 +00:00 · 2019-04-29 16:55:20 +02:00
parent bb9746c798
commit bad3ce4e17
27 changed files with 800 additions and 267 deletions
@@ -57,9 +57,21 @@ const CHANGED_IN_ATTRIBUTE: &str = "changed_in";
 ///
 /// Is used when a trait method was renamed.
 const RENAMED_ATTRIBUTE: &str = "renamed";
+/// The `skip_initialize_block` attribute.
+///
+/// Is used when a trait method does not require that the block is initialized
+/// before being called.
+const SKIP_INITIALIZE_BLOCK_ATTRIBUTE: &str = "skip_initialize_block";
+/// The `initialize_block` attribute.
+///
+/// A trait method tagged with this attribute, initializes the runtime at
+/// certain block.
+const INITIALIZE_BLOCK_ATTRIBUTE: &str = "initialize_block";
 /// All attributes that we support in the declaration of a runtime api trait.
 const SUPPORTED_ATTRIBUTE_NAMES: &[&str] = &[
-	CORE_TRAIT_ATTRIBUTE, API_VERSION_ATTRIBUTE, CHANGED_IN_ATTRIBUTE, RENAMED_ATTRIBUTE
+	CORE_TRAIT_ATTRIBUTE, API_VERSION_ATTRIBUTE, CHANGED_IN_ATTRIBUTE,
+	RENAMED_ATTRIBUTE, SKIP_INITIALIZE_BLOCK_ATTRIBUTE,
+	INITIALIZE_BLOCK_ATTRIBUTE,
 ];

 /// The structure used for parsing the runtime api declarations.
@@ -338,7 +350,12 @@ fn generate_call_api_at_calls(decl: &ItemTrait) -> Result<TokenStream> {

 		if attrs.contains_key(RENAMED_ATTRIBUTE) && attrs.contains_key(CHANGED_IN_ATTRIBUTE) {
 			return Err(Error::new(
-				fn_.span(), format!("`{}` and `{}` are not supported at once.", RENAMED_ATTRIBUTE, CHANGED_IN_ATTRIBUTE)
+				fn_.span(),
+				format!(
+					"`{}` and `{}` are not supported at once.",
+					RENAMED_ATTRIBUTE,
+					CHANGED_IN_ATTRIBUTE
+				)
 			));
 		}

@@ -347,6 +364,15 @@ fn generate_call_api_at_calls(decl: &ItemTrait) -> Result<TokenStream> {
 			continue;
 		}

+		let skip_initialize_block = attrs.contains_key(SKIP_INITIALIZE_BLOCK_ATTRIBUTE);
+		let update_initialized_block = if attrs.contains_key(INITIALIZE_BLOCK_ATTRIBUTE) {
+			quote!(
+				|| *initialized_block.borrow_mut() = Some(*at)
+			)
+		} else {
+			quote!(|| ())
+		};
+
 		// Parse the renamed attributes.
 		let mut renames = Vec::new();
 		if let Some((_, a)) = attrs
@@ -375,43 +401,63 @@ fn generate_call_api_at_calls(decl: &ItemTrait) -> Result<TokenStream> {
 				NC: FnOnce() -> ::std::result::Result<R, &'static str> + ::std::panic::UnwindSafe,
 				Block: #crate_::runtime_api::BlockT,
 				T: #crate_::runtime_api::CallRuntimeAt<Block>,
+				C: #crate_::runtime_api::Core<Block>,
 			>(
 				call_runtime_at: &T,
+				core_api: &C,
 				at: &#crate_::runtime_api::BlockId<Block>,
 				args: Vec<u8>,
-				changes: &mut #crate_::runtime_api::OverlayedChanges,
-				initialized_block: &mut Option<#crate_::runtime_api::BlockId<Block>>,
+				changes: &std::cell::RefCell<#crate_::runtime_api::OverlayedChanges>,
+				initialized_block: &std::cell::RefCell<Option<#crate_::runtime_api::BlockId<Block>>>,
 				native_call: Option<NC>,
 				context: #crate_::runtime_api::ExecutionContext,
+				recorder: &Option<std::rc::Rc<std::cell::RefCell<#crate_::runtime_api::ProofRecorder<Block>>>>,
 			) -> #crate_::error::Result<#crate_::runtime_api::NativeOrEncoded<R>> {
 				let version = call_runtime_at.runtime_version_at(at)?;
+				use #crate_::runtime_api::InitializeBlock;
+				let initialize_block = if #skip_initialize_block {
+					InitializeBlock::Skip
+				} else {
+					InitializeBlock::Do(&initialized_block)
+				};
+				let update_initialized_block = #update_initialized_block;

 				#(
 					// Check if we need to call the function by an old name.
 					if version.apis.iter().any(|(s, v)| {
 						s == &ID && *v < #versions
 					}) {
-						return call_runtime_at.call_api_at::<R, fn() -> _>(
+						let ret = call_runtime_at.call_api_at::<R, fn() -> _, _>(
+							core_api,
 							at,
 							#old_names,
 							args,
 							changes,
-							initialized_block,
+							initialize_block,
 							None,
-							context
-						);
+							context,
+							recorder,
+						)?;
+
+						update_initialized_block();
+						return Ok(ret);
 					}
 				)*

-				call_runtime_at.call_api_at(
+				let ret = call_runtime_at.call_api_at(
+					core_api,
 					at,
 					#trait_fn_name,
 					args,
 					changes,
-					initialized_block,
+					initialize_block,
 					native_call,
-					context
-				)
+					context,
+					recorder,
+				)?;
+
+				update_initialized_block();
+				Ok(ret)
 			}
 		));
 	}
@@ -263,9 +263,10 @@ fn generate_runtime_api_base_structures(impls: &[ItemImpl]) -> Result<TokenStrea
 		#[cfg(any(feature = "std", test))]
 		pub struct RuntimeApiImpl<C: #crate_::runtime_api::CallRuntimeAt<#block> + 'static> {
 			call: &'static C,
-			commit_on_success: ::std::cell::RefCell<bool>,
-			initialized_block: ::std::cell::RefCell<Option<#block_id>>,
-			changes: ::std::cell::RefCell<#crate_::runtime_api::OverlayedChanges>,
+			commit_on_success: std::cell::RefCell<bool>,
+			initialized_block: std::cell::RefCell<Option<#block_id>>,
+			changes: std::cell::RefCell<#crate_::runtime_api::OverlayedChanges>,
+			recorder: Option<std::rc::Rc<std::cell::RefCell<#crate_::runtime_api::ProofRecorder<#block>>>>,
 		}

 		// `RuntimeApi` itself is not threadsafe. However, an instance is only available in a
@@ -299,6 +300,22 @@ fn generate_runtime_api_base_structures(impls: &[ItemImpl]) -> Result<TokenStrea
 			) -> #crate_::error::Result<#crate_::runtime_api::RuntimeVersion> {
 				self.call.runtime_version_at(at)
 			}
+
+			fn record_proof(&mut self) {
+				self.recorder = Some(Default::default());
+			}
+
+			fn extract_proof(&mut self) -> Option<Vec<Vec<u8>>> {
+				self.recorder
+					.take()
+					.map(|r| {
+						r.borrow_mut()
+							.drain()
+							.into_iter()
+							.map(|n| n.data.to_vec())
+							.collect()
+					})
+			}
 		}

 		#[cfg(any(feature = "std", test))]
@@ -315,6 +332,7 @@ fn generate_runtime_api_base_structures(impls: &[ItemImpl]) -> Result<TokenStrea
 					commit_on_success: true.into(),
 					initialized_block: None.into(),
 					changes: Default::default(),
+					recorder: Default::default(),
 				}.into()
 			}
 		}
@@ -325,9 +343,11 @@ fn generate_runtime_api_base_structures(impls: &[ItemImpl]) -> Result<TokenStrea
 				R: #crate_::runtime_api::Encode + #crate_::runtime_api::Decode + PartialEq,
 				F: FnOnce(
 					&C,
-					&mut #crate_::runtime_api::OverlayedChanges,
-					&mut Option<#crate_::runtime_api::BlockId<#block>>,
-				) -> #crate_::error::Result<#crate_::runtime_api::NativeOrEncoded<R>>
+					&Self,
+					&std::cell::RefCell<#crate_::runtime_api::OverlayedChanges>,
+					&std::cell::RefCell<Option<#crate_::runtime_api::BlockId<#block>>>,
+					&Option<std::rc::Rc<std::cell::RefCell<#crate_::runtime_api::ProofRecorder<#block>>>>,
+				) -> #crate_::error::Result<#crate_::runtime_api::NativeOrEncoded<R>>,
 			>(
 				&self,
 				call_api_at: F,
@@ -335,8 +355,10 @@ fn generate_runtime_api_base_structures(impls: &[ItemImpl]) -> Result<TokenStrea
 				let res = unsafe {
 					call_api_at(
 						&self.call,
-						&mut *self.changes.borrow_mut(),
-						&mut *self.initialized_block.borrow_mut()
+						self,
+						&self.changes,
+						&self.initialized_block,
+						&self.recorder,
 					)
 				};

@@ -479,9 +501,10 @@ impl<'a> Fold for ApiRuntimeImplToApiRuntimeApiImpl<'a> {
 					#( #error )*

 					self.call_api_at(
-						|call_runtime_at, changes, initialized_block| {
+						|call_runtime_at, core_api, changes, initialized_block, recorder| {
 							#runtime_mod_path #call_api_at_call(
 								call_runtime_at,
+								core_api,
 								at,
 								params_encoded,
 								changes,
@@ -493,6 +516,7 @@ impl<'a> Fold for ApiRuntimeImplToApiRuntimeApiImpl<'a> {
 									)
 								}),
 								context,
+								recorder,
 							)
 						}
 					)