Struct sp_state_machine::TestExternalities

pub struct TestExternalities<H>
where
    H: Hasher + 'static,
    H::Out: Codec + Ord,
{
    pub backend: InMemoryBackend<H>,
    pub extensions: Extensions,
    pub state_version: StateVersion,
    /* private fields */
}

Simple HashMap-based Externalities impl.

Fields

backend: InMemoryBackend<H>

Storage backend.

extensions: Extensions

Extensions.

state_version: StateVersion

State version to use during tests.

Implementations

impl<H> TestExternalities<H>

where H: Hasher + 'static, H::Out: Ord + 'static + Codec,

pub fn ext(&mut self) -> Ext<'_, H, InMemoryBackend<H>>

Get externalities implementation.

pub fn new(storage: Storage) -> Self

Create a new instance of TestExternalities with storage.

pub fn new_with_state_version( storage: Storage, state_version: StateVersion ) -> Self

Create a new instance of TestExternalities with storage for a given state version.

pub fn new_empty() -> Self

New empty test externalities.

pub fn new_with_code(code: &[u8], storage: Storage) -> Self

Create a new instance of TestExternalities with code and storage.

pub fn new_with_code_and_state( code: &[u8], storage: Storage, state_version: StateVersion ) -> Self

Create a new instance of TestExternalities with code and storage for a given state version.

pub fn overlayed_changes(&self) -> &OverlayedChanges<H>

Returns the overlayed changes.

pub fn persist_offchain_overlay(&mut self)

Move offchain changes from overlay to the persistent store.

pub fn offchain_db(&self) -> TestPersistentOffchainDB

A shared reference type around the offchain worker storage.

pub fn batch_insert<I>(&mut self, kvs: I)

where I: IntoIterator<Item = (StorageKey, StorageValue)>,

Batch insert key/values into backend

pub fn insert(&mut self, k: StorageKey, v: StorageValue)

Insert key/value into backend

pub fn insert_child(&mut self, c: ChildInfo, k: StorageKey, v: StorageValue)

Insert key/value into backend.

This only supports inserting keys in child tries.

pub fn register_extension<E: Any + Extension>(&mut self, ext: E)

Registers the given extension for this instance.

pub fn from_raw_snapshot( raw_storage: Vec<(Vec<u8>, (Vec<u8>, i32))>, storage_root: H::Out, state_version: StateVersion ) -> Self

Sets raw storage key/values and a root.

This can be used as a fast way to restore the storage state from a backup because the trie does not need to be computed.

pub fn into_raw_snapshot(self) -> (Vec<(Vec<u8>, (Vec<u8>, i32))>, H::Out)

Drains the underlying raw storage key/values and returns the root hash.

Useful for backing up the storage in a format that can be quickly re-loaded.

pub fn as_backend(&self) -> InMemoryBackend<H>

Return a new backend with all pending changes.

In contrast to commit_all this will not panic if there are open transactions.

pub fn commit_all(&mut self) -> Result<(), String>

Commit all pending changes to the underlying backend.

Panic

This will panic if there are still open transactions.

pub fn execute_with<R>(&mut self, execute: impl FnOnce() -> R) -> R

Execute the given closure while self is set as externalities.

Returns the result of the given closure.

pub fn execute_and_prove<R>( &mut self, execute: impl FnOnce() -> R ) -> (R, StorageProof)

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_with_safe<R>( &mut self, f: impl FnOnce() -> R + UnwindSafe ) -> Result<R, String>

Execute the given closure while self is set as externalities.

Returns the result of the given closure, if no panics occurred. Otherwise, returns Err.

Trait Implementations

impl<H: Hasher> Debug for TestExternalities<H>

where H::Out: Ord + Codec,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<H: Hasher> Default for TestExternalities<H>

where H::Out: Ord + 'static + Codec,

fn default() -> Self

Returns the “default value” for a type.

impl<H> ExtensionStore for TestExternalities<H>

where H: Hasher, H::Out: Ord + Codec,

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<H> ExternalitiesExt for TestExternalities<H>

where H: Hasher, H::Out: Ord + Codec,

fn extension<T: Any + Extension>(&mut self) -> Option<&mut T>

Tries to find a registered extension and returns a mutable reference.

fn register_extension<T: Extension>(&mut self, ext: T) -> Result<(), Error>

Register extension ext.

fn deregister_extension<T: Extension>(&mut self) -> Result<(), Error>

Deregister and drop extension of T type.

impl<H: Hasher> From<(Storage, StateVersion)> for TestExternalities<H>

where H::Out: Ord + 'static + Codec,

fn from((storage, state_version): (Storage, StateVersion)) -> Self

Converts to this type from the input type.

impl<H: Hasher> From<Storage> for TestExternalities<H>

where H::Out: Ord + 'static + Codec,

fn from(storage: Storage) -> Self

Converts to this type from the input type.

impl<H: Hasher> PartialEq for TestExternalities<H>

where H::Out: Ord + 'static + Codec,

fn eq(&self, other: &TestExternalities<H>) -> bool

This doesn’t test if they are in the same state, only if they contains the same data at this state

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.