Struct sp_state_machine::Ext

pub struct Ext<'a, H, B>where
    H: Hasher,
    B: 'a + Backend<H>,{
    pub id: u16,
    /* private fields */
}

Wraps a read-only backend, call executor, and current overlayed changes.

Fields

id: u16

Pseudo-unique id used for tracing.

Implementations

impl<'a, H, B> Ext<'a, H, B>where
    H: Hasher,
    B: Backend<H>,

pub fn new(
    overlay: &'a mut OverlayedChanges,
    storage_transaction_cache: &'a mut StorageTransactionCache<B::Transaction, H>,
    backend: &'a B,
    extensions: Option<&'a mut Extensions>
) -> Self

Create a new Ext from overlayed changes and read-only backend

Examples found in repository

src/testing.rs (lines 69-74)

	pub fn ext(&mut self) -> Ext<H, InMemoryBackend<H>> {
		Ext::new(
			&mut self.overlay,
			&mut self.storage_transaction_cache,
			&self.backend,
			Some(&mut self.extensions),
		)
	}

	/// Create a new instance of `TestExternalities` with storage.
	pub fn new(storage: Storage) -> Self {
		Self::new_with_code_and_state(&[], storage, Default::default())
	}

	/// Create a new instance of `TestExternalities` with storage for a given state version.
	pub fn new_with_state_version(storage: Storage, state_version: StateVersion) -> Self {
		Self::new_with_code_and_state(&[], storage, state_version)
	}

	/// New empty test externalities.
	pub fn new_empty() -> Self {
		Self::new_with_code_and_state(&[], Storage::default(), Default::default())
	}

	/// Create a new instance of `TestExternalities` with code and storage.
	pub fn new_with_code(code: &[u8], storage: Storage) -> Self {
		Self::new_with_code_and_state(code, storage, Default::default())
	}

	/// Create a new instance of `TestExternalities` with code and storage for a given state
	/// version.
	pub fn new_with_code_and_state(
		code: &[u8],
		mut storage: Storage,
		state_version: StateVersion,
	) -> Self {
		assert!(storage.top.keys().all(|key| !is_child_storage_key(key)));

		storage.top.insert(CODE.to_vec(), code.to_vec());

		let mut extensions = Extensions::default();
		extensions.register(TaskExecutorExt::new(TaskExecutor::new()));

		let offchain_db = TestPersistentOffchainDB::new();

		let backend = (storage, state_version).into();

		TestExternalities {
			overlay: OverlayedChanges::default(),
			offchain_db,
			extensions,
			backend,
			storage_transaction_cache: Default::default(),
			state_version,
		}
	}

	/// Returns the overlayed changes.
	pub fn overlayed_changes(&self) -> &OverlayedChanges {
		&self.overlay
	}

	/// Move offchain changes from overlay to the persistent store.
	pub fn persist_offchain_overlay(&mut self) {
		self.offchain_db.apply_offchain_changes(self.overlay.offchain_drain_committed());
	}

	/// A shared reference type around the offchain worker storage.
	pub fn offchain_db(&self) -> TestPersistentOffchainDB {
		self.offchain_db.clone()
	}

	/// Insert key/value into backend
	pub fn insert(&mut self, k: StorageKey, v: StorageValue) {
		self.backend.insert(vec![(None, vec![(k, Some(v))])], self.state_version);
	}

	/// Insert key/value into backend.
	///
	/// This only supports inserting keys in child tries.
	pub fn insert_child(&mut self, c: sp_core::storage::ChildInfo, k: StorageKey, v: StorageValue) {
		self.backend.insert(vec![(Some(c), vec![(k, Some(v))])], self.state_version);
	}

	/// Registers the given extension for this instance.
	pub fn register_extension<E: Any + Extension>(&mut self, ext: E) {
		self.extensions.register(ext);
	}

	/// Return a new backend with all pending changes.
	///
	/// In contrast to [`commit_all`](Self::commit_all) this will not panic if there are open
	/// transactions.
	pub fn as_backend(&self) -> InMemoryBackend<H> {
		let top: Vec<_> =
			self.overlay.changes().map(|(k, v)| (k.clone(), v.value().cloned())).collect();
		let mut transaction = vec![(None, top)];

		for (child_changes, child_info) in self.overlay.children() {
			transaction.push((
				Some(child_info.clone()),
				child_changes.map(|(k, v)| (k.clone(), v.value().cloned())).collect(),
			))
		}

		self.backend.update(transaction, self.state_version)
	}

	/// Commit all pending changes to the underlying backend.
	///
	/// # Panic
	///
	/// This will panic if there are still open transactions.
	pub fn commit_all(&mut self) -> Result<(), String> {
		let changes = self.overlay.drain_storage_changes::<_, _>(
			&self.backend,
			&mut Default::default(),
			self.state_version,
		)?;

		self.backend
			.apply_transaction(changes.transaction_storage_root, changes.transaction);
		Ok(())
	}

	/// Execute the given closure while `self` is set as externalities.
	///
	/// Returns the result of the given closure.
	pub fn execute_with<R>(&mut self, execute: impl FnOnce() -> R) -> R {
		let mut ext = self.ext();
		sp_externalities::set_and_run_with_externalities(&mut ext, execute)
	}

	/// Execute the given closure while `self`, with `proving_backend` as backend, is set as
	/// externalities.
	///
	/// This implementation will wipe the proof recorded in between calls. Consecutive calls will
	/// get their own proof from scratch.
	pub fn execute_and_prove<R>(&mut self, execute: impl FnOnce() -> R) -> (R, StorageProof) {
		let proving_backend = TrieBackendBuilder::wrap(&self.backend)
			.with_recorder(Default::default())
			.build();
		let mut proving_ext = Ext::new(
			&mut self.overlay,
			&mut self.storage_transaction_cache,
			&proving_backend,
			Some(&mut self.extensions),
		);

		let outcome = sp_externalities::set_and_run_with_externalities(&mut proving_ext, execute);
		let proof = proving_backend.extract_proof().expect("Failed to extract storage proof");

		(outcome, proof)
	}

src/lib.rs (line 392)

		fn execute_aux(&mut self, use_native: bool) -> (CallResult<Exec::Error>, bool) {
			let mut cache = StorageTransactionCache::default();

			let cache = match self.storage_transaction_cache.as_mut() {
				Some(cache) => cache,
				None => &mut cache,
			};

			self.overlay
				.enter_runtime()
				.expect("StateMachine is never called from the runtime; qed");

			let mut ext = Ext::new(self.overlay, cache, self.backend, Some(&mut self.extensions));

			let ext_id = ext.id;

			trace!(
				target: "state",
				ext_id = %HexDisplay::from(&ext_id.to_le_bytes()),
				method = %self.method,
				parent_hash = %self.parent_hash.map(|h| format!("{:?}", h)).unwrap_or_else(|| String::from("None")),
				input = ?HexDisplay::from(&self.call_data),
				"Call",
			);

			let (result, was_native) = self.exec.call(
				&mut ext,
				self.runtime_code,
				self.method,
				self.call_data,
				use_native,
			);

			self.overlay
				.exit_runtime()
				.expect("Runtime is not able to call this function in the overlay; qed");

			trace!(
				target: "state",
				ext_id = %HexDisplay::from(&ext_id.to_le_bytes()),
				?was_native,
				?result,
				"Return",
			);

			(result, was_native)
		}

Trait Implementations

impl<'a, H, B> ExtensionStore for Ext<'a, H, B>where
    H: Hasher,
    B: 'a + Backend<H>,

fn extension_by_type_id(&mut self, type_id: TypeId) -> Option<&mut dyn Any>

Tries to find a registered extension by the given type_id and returns it as a &mut dyn Any.

fn register_extension_with_type_id(
    &mut self,
    type_id: TypeId,
    extension: Box<dyn Extension>
) -> Result<(), Error>

Register extension extension with specified type_id.

fn deregister_extension_by_type_id(
    &mut self,
    type_id: TypeId
) -> Result<(), Error>

Deregister extension with specified ‘type_id’ and drop it.

impl<'a, H, B> Externalities for Ext<'a, H, B>where
    H: Hasher,
    H::Out: Ord + 'static + Codec,
    B: Backend<H>,

fn storage_renew_transaction_index(&mut self, index: u32, hash: &[u8])

Renew existing piece of data storage.

fn set_offchain_storage(&mut self, key: &[u8], value: Option<&[u8]>)

Write a key value pair to the offchain storage database.

fn storage(&self, key: &[u8]) -> Option<StorageValue>

Read runtime storage.

fn storage_hash(&self, key: &[u8]) -> Option<Vec<u8>>

Get storage value hash.

fn child_storage(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Option<StorageValue>

Read child runtime storage.

fn child_storage_hash(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Option<Vec<u8>>

Get child storage value hash.

fn exists_storage(&self, key: &[u8]) -> bool

Whether a storage entry exists.

fn exists_child_storage(&self, child_info: &ChildInfo, key: &[u8]) -> bool

Whether a child storage entry exists.

fn next_storage_key(&self, key: &[u8]) -> Option<StorageKey>

Returns the key immediately following the given key, if it exists.

fn next_child_storage_key(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Option<StorageKey>

Returns the key immediately following the given key, if it exists, in child storage.

fn place_storage(&mut self, key: StorageKey, value: Option<StorageValue>)

Set or clear a storage entry (key) of current contract being called (effective immediately).

fn place_child_storage(
    &mut self,
    child_info: &ChildInfo,
    key: StorageKey,
    value: Option<StorageValue>
)

Set or clear a child storage entry.

fn kill_child_storage(
    &mut self,
    child_info: &ChildInfo,
    maybe_limit: Option<u32>,
    maybe_cursor: Option<&[u8]>
) -> MultiRemovalResults

Clear an entire child storage.

fn clear_prefix(
    &mut self,
    prefix: &[u8],
    maybe_limit: Option<u32>,
    maybe_cursor: Option<&[u8]>
) -> MultiRemovalResults

Clear storage entries which keys are start with the given prefix.

fn clear_child_prefix(
    &mut self,
    child_info: &ChildInfo,
    prefix: &[u8],
    maybe_limit: Option<u32>,
    maybe_cursor: Option<&[u8]>
) -> MultiRemovalResults

Clear child storage entries which keys are start with the given prefix.

fn storage_append(&mut self, key: Vec<u8>, value: Vec<u8>)

Append storage item.

fn storage_root(&mut self, state_version: StateVersion) -> Vec<u8>

Get the trie root of the current storage map.

fn child_storage_root(
    &mut self,
    child_info: &ChildInfo,
    state_version: StateVersion
) -> Vec<u8>

Get the trie root of a child storage map.

fn storage_index_transaction(&mut self, index: u32, hash: &[u8], size: u32)

Index specified transaction slice and store it.

fn storage_start_transaction(&mut self)

Start a new nested transaction.

fn storage_rollback_transaction(&mut self) -> Result<(), ()>

Rollback the last transaction started by storage_start_transaction.

fn storage_commit_transaction(&mut self) -> Result<(), ()>

Commit the last transaction started by storage_start_transaction.

fn wipe(&mut self)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn commit(&mut self)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn read_write_count(&self) -> (u32, u32, u32, u32)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn reset_read_write_count(&mut self)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn get_whitelist(&self) -> Vec<TrackedStorageKey>

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn set_whitelist(&mut self, new: Vec<TrackedStorageKey>)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn proof_size(&self) -> Option<u32>

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn get_read_and_written_keys(&self) -> Vec<(Vec<u8>, u32, u32, bool)>

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Benchmarking related functionality and shouldn’t be used anywhere else! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

fn set_storage(&mut self, key: Vec<u8, Global>, value: Vec<u8, Global>)

Set storage entry key of current contract being called (effective immediately).

fn set_child_storage(
    &mut self,
    child_info: &ChildInfo,
    key: Vec<u8, Global>,
    value: Vec<u8, Global>
)

Set child storage entry key of current contract being called (effective immediately).

fn clear_storage(&mut self, key: &[u8])

Clear a storage entry (key) of current contract being called (effective immediately).

fn clear_child_storage(&mut self, child_info: &ChildInfo, key: &[u8])

Clear a child storage entry (key) of current contract being called (effective immediately).