Struct ZkStorage

pub struct ZkStorage<S: MerkleProofSpec> { /* private fields */ }

A Storage implementation designed to be used inside the zkVM.

Implementations

impl<S: MerkleProofSpec> ZkStorage<S>

pub fn new() -> Self

Creates a new ZkStorage instance. Identical to Default::default.

Trait Implementations

impl<S: MerkleProofSpec> Clone for ZkStorage<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Default + MerkleProofSpec> Default for ZkStorage<S>

where S::Hasher: Default,

fn default() -> ZkStorage<S>

Returns the “default value” for a type.

impl<S: MerkleProofSpec> Storage for ZkStorage<S>

type Witness = <S as MerkleProofSpec>::Witness

The witness type for this storage instance.

type RuntimeConfig = ()

The runtime config for this storage instance.

type Proof = SparseMerkleProof<<S as MerkleProofSpec>::Hasher>

A cryptographic proof that a particular key has a particular value, or is absent.

type StateUpdate = ()

State update that will be committed to the database.

type Root = RootHash

A cryptographic commitment to the contents of this storage

fn with_config(_config: Self::RuntimeConfig) -> Result<Self, Error>

Creates a new instance of this Storage type, with some configuration options.

fn get( &self, _key: &StorageKey, witness: &Self::Witness, ) -> Option<StorageValue>

Returns the value corresponding to the key or None if key is absent.

fn compute_state_update( &self, state_accesses: OrderedReadsAndWrites, witness: &Self::Witness, ) -> Result<(Self::Root, Self::StateUpdate), Error>

Calculates new state root but does not commit any changes to the database.

fn commit( &self, _node_batch: &Self::StateUpdate, _accessory_writes: &OrderedReadsAndWrites, )

Commits state changes to the database.

fn is_empty(&self) -> bool

Indicates if storage is empty or not. Useful during initialization.

fn open_proof( state_root: Self::Root, state_proof: StorageProof<Self::Proof>, ) -> Result<(StorageKey, Option<StorageValue>), Error>

Opens a storage access proof and validates it against a state root. It returns a result with the opened leaf (key, value) pair in case of success.

fn get_accessory(&self, _key: &StorageKey) -> Option<StorageValue>

Returns the value corresponding to the key or None if key is absent.

fn validate_and_commit( &self, state_accesses: OrderedReadsAndWrites, witness: &Self::Witness, ) -> Result<Self::Root, Error>

Validate all of the storage accesses in a particular cache log, returning the new state root after applying all writes. This function is equivalent to calling: self.compute_state_update & self.commit

fn validate_and_commit_with_accessory_update( &self, state_accesses: OrderedReadsAndWrites, witness: &Self::Witness, accessory_update: &OrderedReadsAndWrites, ) -> Result<Self::Root, Error>

A version of Storage::validate_and_commit that allows for “accessory” non-JMT updates. See sov_db::NativeDB for more information about accessory state.