Trait sc_client_api::backend::StateBackend
source · pub trait StateBackend<H>: Debugwhere
H: Hasher,{
type Error: Error;
type TrieBackendStorage: TrieBackendStorage<H>;
type RawIter: StorageIterator<H, Backend = Self, Error = Self::Error>;
Show 24 methods
// Required methods
fn storage(
&self,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>;
fn storage_hash(
&self,
key: &[u8]
) -> Result<Option<<H as Hasher>::Out>, Self::Error>;
fn child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>;
fn child_storage_hash(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<<H as Hasher>::Out>, Self::Error>;
fn next_storage_key(
&self,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>;
fn next_child_storage_key(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>;
fn storage_root<'a>(
&self,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
state_version: StateVersion
) -> (<H as Hasher>::Out, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)
where <H as Hasher>::Out: Ord;
fn child_storage_root<'a>(
&self,
child_info: &ChildInfo,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
state_version: StateVersion
) -> (<H as Hasher>::Out, bool, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)
where <H as Hasher>::Out: Ord;
fn raw_iter(&self, args: IterArgs<'_>) -> Result<Self::RawIter, Self::Error>;
fn register_overlay_stats(&self, _stats: &StateMachineStats);
fn usage_info(&self) -> UsageInfo;
// Provided methods
fn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error> { ... }
fn exists_child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<bool, Self::Error> { ... }
fn pairs<'a>(
&'a self,
args: IterArgs<'_>
) -> Result<PairsIter<'a, H, Self::RawIter>, Self::Error> { ... }
fn keys<'a>(
&'a self,
args: IterArgs<'_>
) -> Result<KeysIter<'a, H, Self::RawIter>, Self::Error> { ... }
fn full_storage_root<'a>(
&self,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
child_deltas: impl Iterator<Item = (&'a ChildInfo, impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>)>,
state_version: StateVersion
) -> (<H as Hasher>::Out, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)
where <H as Hasher>::Out: Ord + Encode { ... }
fn wipe(&self) -> Result<(), Self::Error> { ... }
fn commit(
&self,
_: <H as Hasher>::Out,
_: MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>,
_: Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>,
_: Vec<(Vec<u8, Global>, Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>), Global>
) -> Result<(), Self::Error> { ... }
fn read_write_count(&self) -> (u32, u32, u32, u32) { ... }
fn reset_read_write_count(&self) { ... }
fn get_whitelist(&self) -> Vec<TrackedStorageKey, Global> { ... }
fn set_whitelist(&self, _: Vec<TrackedStorageKey, Global>) { ... }
fn proof_size(&self) -> Option<u32> { ... }
fn get_read_and_written_keys(
&self
) -> Vec<(Vec<u8, Global>, u32, u32, bool), Global> { ... }
}
Expand description
A state backend is used to read state data and can have changes committed to it.
The clone operation (if implemented) should be cheap.
Required Associated Types§
sourcetype TrieBackendStorage: TrieBackendStorage<H>
type TrieBackendStorage: TrieBackendStorage<H>
Type of trie backend storage.
sourcetype RawIter: StorageIterator<H, Backend = Self, Error = Self::Error>
type RawIter: StorageIterator<H, Backend = Self, Error = Self::Error>
Type of the raw storage iterator.
Required Methods§
sourcefn storage(&self, key: &[u8]) -> Result<Option<Vec<u8, Global>>, Self::Error>
fn storage(&self, key: &[u8]) -> Result<Option<Vec<u8, Global>>, Self::Error>
Get keyed storage or None if there is nothing associated.
sourcefn storage_hash(
&self,
key: &[u8]
) -> Result<Option<<H as Hasher>::Out>, Self::Error>
fn storage_hash( &self, key: &[u8] ) -> Result<Option<<H as Hasher>::Out>, Self::Error>
Get keyed storage value hash or None if there is nothing associated.
sourcefn child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>
fn child_storage( &self, child_info: &ChildInfo, key: &[u8] ) -> Result<Option<Vec<u8, Global>>, Self::Error>
Get keyed child storage or None if there is nothing associated.
sourcefn child_storage_hash(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<<H as Hasher>::Out>, Self::Error>
fn child_storage_hash( &self, child_info: &ChildInfo, key: &[u8] ) -> Result<Option<<H as Hasher>::Out>, Self::Error>
Get child keyed storage value hash or None if there is nothing associated.
sourcefn next_storage_key(
&self,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>
fn next_storage_key( &self, key: &[u8] ) -> Result<Option<Vec<u8, Global>>, Self::Error>
Return the next key in storage in lexicographic order or None
if there is no value.
sourcefn next_child_storage_key(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<Vec<u8, Global>>, Self::Error>
fn next_child_storage_key( &self, child_info: &ChildInfo, key: &[u8] ) -> Result<Option<Vec<u8, Global>>, Self::Error>
Return the next key in child storage in lexicographic order or None
if there is no value.
sourcefn storage_root<'a>(
&self,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
state_version: StateVersion
) -> (<H as Hasher>::Out, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)where
<H as Hasher>::Out: Ord,
fn storage_root<'a>( &self, delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>, state_version: StateVersion ) -> (<H as Hasher>::Out, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)where <H as Hasher>::Out: Ord,
Calculate the storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. Does not include child storage updates.
sourcefn child_storage_root<'a>(
&self,
child_info: &ChildInfo,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
state_version: StateVersion
) -> (<H as Hasher>::Out, bool, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)where
<H as Hasher>::Out: Ord,
fn child_storage_root<'a>( &self, child_info: &ChildInfo, delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>, state_version: StateVersion ) -> (<H as Hasher>::Out, bool, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)where <H as Hasher>::Out: Ord,
Calculate the child storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. The second argument is true if child storage root equals default storage root.
sourcefn raw_iter(&self, args: IterArgs<'_>) -> Result<Self::RawIter, Self::Error>
fn raw_iter(&self, args: IterArgs<'_>) -> Result<Self::RawIter, Self::Error>
Returns a lifetimeless raw storage iterator.
sourcefn register_overlay_stats(&self, _stats: &StateMachineStats)
fn register_overlay_stats(&self, _stats: &StateMachineStats)
Register stats from overlay of state machine.
By default nothing is registered.
sourcefn usage_info(&self) -> UsageInfo
fn usage_info(&self) -> UsageInfo
Query backend usage statistics (i/o, memory)
Not all implementations are expected to be able to do this. In the case when they don’t, empty statistics is returned.
Provided Methods§
sourcefn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error>
fn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error>
true if a key exists in storage.
sourcefn exists_child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<bool, Self::Error>
fn exists_child_storage( &self, child_info: &ChildInfo, key: &[u8] ) -> Result<bool, Self::Error>
true if a key exists in child storage.
sourcefn pairs<'a>(
&'a self,
args: IterArgs<'_>
) -> Result<PairsIter<'a, H, Self::RawIter>, Self::Error>
fn pairs<'a>( &'a self, args: IterArgs<'_> ) -> Result<PairsIter<'a, H, Self::RawIter>, Self::Error>
Get an iterator over key/value pairs.
sourcefn keys<'a>(
&'a self,
args: IterArgs<'_>
) -> Result<KeysIter<'a, H, Self::RawIter>, Self::Error>
fn keys<'a>( &'a self, args: IterArgs<'_> ) -> Result<KeysIter<'a, H, Self::RawIter>, Self::Error>
Get an iterator over keys.
sourcefn full_storage_root<'a>(
&self,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
child_deltas: impl Iterator<Item = (&'a ChildInfo, impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>)>,
state_version: StateVersion
) -> (<H as Hasher>::Out, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)where
<H as Hasher>::Out: Ord + Encode,
fn full_storage_root<'a>( &self, delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>, child_deltas: impl Iterator<Item = (&'a ChildInfo, impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>)>, state_version: StateVersion ) -> (<H as Hasher>::Out, MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>)where <H as Hasher>::Out: Ord + Encode,
Calculate the storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. Does include child storage updates.
sourcefn commit(
&self,
_: <H as Hasher>::Out,
_: MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>,
_: Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>,
_: Vec<(Vec<u8, Global>, Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>), Global>
) -> Result<(), Self::Error>
fn commit( &self, _: <H as Hasher>::Out, _: MemoryDB<H, PrefixedKey<H>, Vec<u8, Global>>, _: Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>, _: Vec<(Vec<u8, Global>, Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>), Global> ) -> Result<(), Self::Error>
Commit given transaction to storage.
sourcefn reset_read_write_count(&self)
fn reset_read_write_count(&self)
Get the read/write count of the db
sourcefn get_whitelist(&self) -> Vec<TrackedStorageKey, Global>
fn get_whitelist(&self) -> Vec<TrackedStorageKey, Global>
Get the whitelist for tracking db reads/writes
sourcefn set_whitelist(&self, _: Vec<TrackedStorageKey, Global>)
fn set_whitelist(&self, _: Vec<TrackedStorageKey, Global>)
Update the whitelist for tracking db reads/writes
sourcefn proof_size(&self) -> Option<u32>
fn proof_size(&self) -> Option<u32>
Estimate proof size