Trait sp_core::traits::Externalities[−][src]

pub trait Externalities: ExtensionStore {
    pub fn set_offchain_storage(&mut self, key: &[u8], value: Option<&[u8]>);
    pub fn storage(&self, key: &[u8]) -> Option<Vec<u8, Global>>;
    pub fn storage_hash(&self, key: &[u8]) -> Option<Vec<u8, Global>>;
    pub fn child_storage_hash(
        &self, 
        child_info: &ChildInfo, 
        key: &[u8]
    ) -> Option<Vec<u8, Global>>;
    pub fn child_storage(
        &self, 
        child_info: &ChildInfo, 
        key: &[u8]
    ) -> Option<Vec<u8, Global>>;
    pub fn next_storage_key(&self, key: &[u8]) -> Option<Vec<u8, Global>>;
    pub fn next_child_storage_key(
        &self, 
        child_info: &ChildInfo, 
        key: &[u8]
    ) -> Option<Vec<u8, Global>>;
    pub fn kill_child_storage(
        &mut self, 
        child_info: &ChildInfo, 
        limit: Option<u32>
    ) -> bool;
    pub fn clear_prefix(&mut self, prefix: &[u8]);
    pub fn clear_child_prefix(&mut self, child_info: &ChildInfo, prefix: &[u8]);
    pub fn place_storage(
        &mut self, 
        key: Vec<u8, Global>, 
        value: Option<Vec<u8, Global>>
    );
    pub fn place_child_storage(
        &mut self, 
        child_info: &ChildInfo, 
        key: Vec<u8, Global>, 
        value: Option<Vec<u8, Global>>
    );
    pub fn storage_root(&mut self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, Global>
impl Write for Vec<u8, Global>;
    pub fn child_storage_root(
        &mut self, 
        child_info: &ChildInfo
    ) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, Global>
impl Write for Vec<u8, Global>;
    pub fn storage_append(
        &mut self, 
        key: Vec<u8, Global>, 
        value: Vec<u8, Global>
    );
    pub fn storage_changes_root(
        &mut self, 
        parent: &[u8]
    ) -> Result<Option<Vec<u8, Global>>, ()>;
    pub fn storage_start_transaction(&mut self);
    pub fn storage_rollback_transaction(&mut self) -> Result<(), ()>;
    pub fn storage_commit_transaction(&mut self) -> Result<(), ()>;
    pub fn wipe(&mut self);
    pub fn commit(&mut self);
    pub fn read_write_count(&self) -> (u32, u32, u32, u32);
    pub fn reset_read_write_count(&mut self);
    pub fn get_whitelist(&self) -> Vec<TrackedStorageKey, Global>ⓘNotable traits for Vec<u8, Global>
impl Write for Vec<u8, Global>;
    pub fn set_whitelist(&mut self, new: Vec<TrackedStorageKey, Global>);

    pub fn set_storage(&mut self, key: Vec<u8, Global>, value: Vec<u8, Global>) { ... }
    pub fn set_child_storage(
        &mut self, 
        child_info: &ChildInfo, 
        key: Vec<u8, Global>, 
        value: Vec<u8, Global>
    ) { ... }
    pub fn clear_storage(&mut self, key: &[u8]) { ... }
    pub fn clear_child_storage(&mut self, child_info: &ChildInfo, key: &[u8]) { ... }
    pub fn exists_storage(&self, key: &[u8]) -> bool { ... }
    pub fn exists_child_storage(
        &self, 
        child_info: &ChildInfo, 
        key: &[u8]
    ) -> bool { ... }
}

The Substrate externalities.

Provides access to the storage and to other registered extensions.

Required methods

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

Write a key value pair to the offchain storage database.

`pub fn storage(&self, key: &[u8]) -> Option<Vec<u8, Global>>`[src]

Read runtime storage.

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

Get storage value hash.

This may be optimized for large values.

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

Get child storage value hash.

This may be optimized for large values.

Returns an Option that holds the SCALE encoded hash.

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

Read child runtime storage.

Returns an Option that holds the SCALE encoded hash.

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

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

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

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

`pub fn kill_child_storage( &mut self, child_info: &ChildInfo, limit: Option<u32> ) -> bool`[src]

Clear an entire child storage.

Deletes all keys from the overlay and up to limit keys from the backend. No limit is applied if limit is None. Returns true if the child trie was removed completely and false if there are remaining keys after the function returns.

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.

`pub fn clear_prefix(&mut self, prefix: &[u8])`[src]

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

`pub fn clear_child_prefix(&mut self, child_info: &ChildInfo, prefix: &[u8])`[src]

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

`pub fn place_storage( &mut self, key: Vec<u8, Global>, value: Option<Vec<u8, Global>> )`[src]

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

`pub fn place_child_storage( &mut self, child_info: &ChildInfo, key: Vec<u8, Global>, value: Option<Vec<u8, Global>> )`[src]

Set or clear a child storage entry.

`pub fn storage_root(&mut self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, Global> impl Write for Vec<u8, Global>`[src]

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.

`pub fn child_storage_root(&mut self, child_info: &ChildInfo) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, Global> impl Write for Vec<u8, Global>`[src]

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.

`pub fn storage_append(&mut self, key: Vec<u8, Global>, value: Vec<u8, Global>)`[src]

Append storage item.

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

`pub fn storage_changes_root( &mut self, parent: &[u8] ) -> Result<Option<Vec<u8, Global>>, ()>`[src]

Get the changes trie root of the current storage overlay at a block with given parent.

parent expects a SCALE encoded hash.

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

`pub fn storage_start_transaction(&mut self)`[src]

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.

`pub fn storage_rollback_transaction(&mut self) -> Result<(), ()>`[src]

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.

`pub fn storage_commit_transaction(&mut self) -> Result<(), ()>`[src]

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.