Trait Sandbox

pub trait Sandbox {
    type Runtime: Config;

    // Required methods
    fn execute_with<T>(&mut self, execute: impl FnOnce() -> T) -> T;
    fn dry_run<T>(&mut self, action: impl FnOnce(&mut Self) -> T) -> T;
    fn register_extension<E: Any + Extension>(&mut self, ext: E);
    fn default_actor() -> AccountIdFor<Self::Runtime>;
    fn get_metadata() -> RuntimeMetadataPrefixed;
    fn convert_account_to_origin(
        account: AccountIdFor<Self::Runtime>,
    ) -> <<Self::Runtime as Config>::RuntimeCall as Dispatchable>::RuntimeOrigin;
    fn take_snapshot(&mut self) -> Snapshot;
    fn restore_snapshot(&mut self, snapshot: Snapshot);

    // Provided methods
    fn initialize_block(
        _height: BlockNumberFor<Self::Runtime>,
        _parent_hash: <Self::Runtime as Config>::Hash,
    ) { ... }
    fn finalize_block(
        _height: BlockNumberFor<Self::Runtime>,
    ) -> <Self::Runtime as Config>::Hash { ... }
    fn default_gas_limit() -> Weight { ... }
}

Sandbox defines the API of a sandboxed runtime.

Required Associated Types

type Runtime: Config

The runtime associated with the sandbox.

Required Methods

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

Execute the given externalities.

fn dry_run<T>(&mut self, action: impl FnOnce(&mut Self) -> T) -> T

Dry run an action without modifying the storage.

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

Register an extension.

fn default_actor() -> AccountIdFor<Self::Runtime>

Default actor for the sandbox.

fn get_metadata() -> RuntimeMetadataPrefixed

Metadata of the runtime.

fn convert_account_to_origin( account: AccountIdFor<Self::Runtime>, ) -> <<Self::Runtime as Config>::RuntimeCall as Dispatchable>::RuntimeOrigin

Convert an account to a call origin.

fn take_snapshot(&mut self) -> Snapshot

Take a snapshot of the storage.

fn restore_snapshot(&mut self, snapshot: Snapshot)

Restore the storage from the given snapshot.

Provided Methods

fn initialize_block( _height: BlockNumberFor<Self::Runtime>, _parent_hash: <Self::Runtime as Config>::Hash, )

Initialize a new block at particular height.

fn finalize_block( _height: BlockNumberFor<Self::Runtime>, ) -> <Self::Runtime as Config>::Hash

Finalize a block at particular height.

fn default_gas_limit() -> Weight

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Sandbox for DefaultSandbox

type Runtime = DefaultSandboxRuntime