Trait sp_externalities::Externalities

pub trait Externalities: ExtensionStore {
    // Required methods
    fn set_offchain_storage(&mut self, key: &[u8], value: Option<&[u8]>);
    fn storage(&self, key: &[u8]) -> Option<Vec<u8>>;
    fn storage_hash(&self, key: &[u8]) -> Option<Vec<u8>>;
    fn child_storage_hash(
        &self,
        child_info: &ChildInfo,
        key: &[u8]
    ) -> Option<Vec<u8>>;
    fn child_storage(
        &self,
        child_info: &ChildInfo,
        key: &[u8]
    ) -> Option<Vec<u8>>;
    fn next_storage_key(&self, key: &[u8]) -> Option<Vec<u8>>;
    fn next_child_storage_key(
        &self,
        child_info: &ChildInfo,
        key: &[u8]
    ) -> Option<Vec<u8>>;
    fn kill_child_storage(
        &mut self,
        child_info: &ChildInfo,
        maybe_limit: Option<u32>,
        maybe_cursor: Option<&[u8]>
    ) -> MultiRemovalResults;
    fn clear_prefix(
        &mut self,
        prefix: &[u8],
        maybe_limit: Option<u32>,
        maybe_cursor: Option<&[u8]>
    ) -> MultiRemovalResults;
    fn clear_child_prefix(
        &mut self,
        child_info: &ChildInfo,
        prefix: &[u8],
        maybe_limit: Option<u32>,
        maybe_cursor: Option<&[u8]>
    ) -> MultiRemovalResults;
    fn place_storage(&mut self, key: Vec<u8>, value: Option<Vec<u8>>);
    fn place_child_storage(
        &mut self,
        child_info: &ChildInfo,
        key: Vec<u8>,
        value: Option<Vec<u8>>
    );
    fn storage_root(&mut self, state_version: StateVersion) -> Vec<u8> ;
    fn child_storage_root(
        &mut self,
        child_info: &ChildInfo,
        state_version: StateVersion
    ) -> Vec<u8> ;
    fn storage_append(&mut self, key: Vec<u8>, value: Vec<u8>);
    fn storage_start_transaction(&mut self);
    fn storage_rollback_transaction(&mut self) -> Result<(), ()>;
    fn storage_commit_transaction(&mut self) -> Result<(), ()>;
    fn wipe(&mut self);
    fn commit(&mut self);
    fn read_write_count(&self) -> (u32, u32, u32, u32);
    fn reset_read_write_count(&mut self);
    fn get_whitelist(&self) -> Vec<TrackedStorageKey>;
    fn set_whitelist(&mut self, new: Vec<TrackedStorageKey>);
    fn get_read_and_written_keys(&self) -> Vec<(Vec<u8>, u32, u32, bool)>;

    // Provided methods
    fn set_storage(&mut self, key: Vec<u8>, value: Vec<u8>) { ... }
    fn set_child_storage(
        &mut self,
        child_info: &ChildInfo,
        key: Vec<u8>,
        value: Vec<u8>
    ) { ... }
    fn clear_storage(&mut self, key: &[u8]) { ... }
    fn clear_child_storage(&mut self, child_info: &ChildInfo, key: &[u8]) { ... }
    fn exists_storage(&self, key: &[u8]) -> bool { ... }
    fn exists_child_storage(&self, child_info: &ChildInfo, key: &[u8]) -> bool { ... }
    fn storage_index_transaction(
        &mut self,
        _index: u32,
        _hash: &[u8],
        _size: u32
    ) { ... }
    fn storage_renew_transaction_index(&mut self, _index: u32, _hash: &[u8]) { ... }
    fn proof_size(&self) -> Option<u32> { ... }
}

The Substrate externalities.

Provides access to the storage and to other registered extensions.

Required Methods

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<Vec<u8>>

Read runtime storage.

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

Get storage value hash.

This may be optimized for large values.

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

Get child storage value hash.

This may be optimized for large values.

Returns an Option that holds the SCALE encoded hash.

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

Read child runtime storage.

Returns an Option that holds the SCALE encoded hash.

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

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

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

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

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

Clear an entire child storage.

Deletes all keys from the overlay and up to maybe_limit keys from the backend. No limit is applied if maybe_limit is None. Returns the cursor for the next call as Some if the child trie deletion operation is incomplete. In this case, it should be passed into the next call to avoid unaccounted iterations on the backend. Returns also the the number of keys that were removed from the backend, the number of unique keys removed in total (including from the overlay) and the number of backend iterations done.

As long as maybe_cursor is passed from the result of the previous call, then the number of iterations done will only ever be one more than the number of keys removed.

Note

An implementation is free to delete more keys than the specified limit as long as it is able to do that in constant time.

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.

maybe_limit, maybe_cursor and result works as for kill_child_storage.

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.

maybe_limit, maybe_cursor and result works as for kill_child_storage.

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

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

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

Set or clear a child storage entry.

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

Get the trie root of the current storage map.

This will also update all child storage keys in the top-level storage map.

The returned hash is defined by the Block and is SCALE encoded.

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

Get the trie root of a child storage map.

This will also update the value of the child storage keys in the top-level storage map.

If the storage root equals the default hash as defined by the trie, the key in the top-level storage map will be removed.

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

Append storage item.

This assumes specific format of the storage item. Also there is no way to undo this operation.

fn storage_start_transaction(&mut self)

Start a new nested transaction.

This allows to either commit or roll back all changes made after this call to the top changes or the default child changes. For every transaction there cam be a matching call to either storage_rollback_transaction or storage_commit_transaction. Any transactions that are still open after returning from runtime are committed automatically.

Changes made without any open transaction are committed immediately.

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

Rollback the last transaction started by storage_start_transaction.

Any changes made during that storage transaction are discarded. Returns an error when no transaction is open that can be closed.

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

Commit the last transaction started by storage_start_transaction.

Any changes made during that storage transaction are committed. Returns an error when no transaction is open that can be closed.

fn wipe(&mut self)

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

Wipes all changes from caches and the database.

The state will be reset to genesis.

fn commit(&mut self)

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

Commits all changes to the database and clears all caches.

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

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

Gets the current read/write count for the benchmarking process.

fn reset_read_write_count(&mut self)

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

Resets read/write count for the benchmarking process.

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

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

Gets the current DB tracking whitelist.

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

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

Adds new storage keys to the DB tracking whitelist.

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

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

Get all the keys that have been read or written to during the benchmark.

Provided Methods

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

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

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

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).

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 storage_index_transaction(&mut self, _index: u32, _hash: &[u8], _size: u32)

Index specified transaction slice and store it.

fn storage_renew_transaction_index(&mut self, _index: u32, _hash: &[u8])

Renew existing piece of transaction storage.

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

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

Returns estimated proof size for the state queries so far. Proof is reset on commit and wipe.

Trait Implementations

impl ExternalitiesExt for &mut dyn Externalities

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.

Implementors