Struct snarkvm_debug::prelude::state_path::StatePath

pub struct StatePath<N>where
    N: Network,
{ /* private fields */ }

Expand description

The state path proves existence of the transition leaf to either a global or local state root.

Implementations§

impl<N> StatePath<N>
where N: Network,

pub fn verify( &self, is_global: bool, local_state_root: Field<N> ) -> Result<(), Error>

Checks if the state path is valid.

Parameters

local_state_root is the local transaction root for the current execution.
is_global is a boolean indicating whether this is a global or local state root.

Diagram

The [[ ]] notation is used to denote public inputs.


 [[ global_state_root ]]
          |
     block_path
         |
    block_hash := Hash( previous_block_hash || header_root )
                                                    |
                                               header_path
                                                   |
                                              header_leaf
                                                  |
                                           transactions_path          [[ local_state_root ]]
                                                 |                               |
                                              (true) ------ is_global ------ (false)
                                                                |
                                                         transaction_id
                                                               |
                                                       transaction_path
                                                              |
                                                      transaction_leaf
                                                             |
                                                     transition_id := Hash( transition_root || tcm )
                                                                                 |
                                                                          transition_path
                                                                                |
                                                                         transition_leaf

impl<N> StatePath<N>
where N: Network,

pub fn new_local( global_state_root: <N as Network>::StateRoot, local_state_root: <N as Network>::TransactionID, transaction_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::TransactionPath::{constant#0}>, transaction_leaf: TransactionLeaf<N>, transition_root: Field<N>, tcm: Field<N>, transition_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::TransitionPath::{constant#0}>, transition_leaf: TransitionLeaf<N> ) -> Result<StatePath<N>, Error>

Initializes a new instance of StatePath.

pub fn from( global_state_root: <N as Network>::StateRoot, block_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::BlockPath::{constant#0}>, block_hash: <N as Network>::BlockHash, previous_block_hash: <N as Network>::BlockHash, header_root: Field<N>, header_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::HeaderPath::{constant#0}>, header_leaf: HeaderLeaf<N>, transactions_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::TransactionsPath::{constant#0}>, transaction_id: <N as Network>::TransactionID, transaction_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::TransactionPath::{constant#0}>, transaction_leaf: TransactionLeaf<N>, transition_root: Field<N>, tcm: Field<N>, transition_path: MerklePath<N, snarkvm_console_program::::state_path::configuration::TransitionPath::{constant#0}>, transition_leaf: TransitionLeaf<N> ) -> StatePath<N>

Initializes a new instance of StatePath.

pub const fn global_state_root(&self) -> <N as Network>::StateRoot

Returns the global state root.

pub const fn block_path( &self ) -> &MerklePath<N, snarkvm_console_program::::state_path::configuration::BlockPath::{constant#0}>

Returns the block path.

pub const fn block_hash(&self) -> <N as Network>::BlockHash

Returns the block hash.

pub const fn previous_block_hash(&self) -> <N as Network>::BlockHash

Returns the previous block hash.

pub const fn header_root(&self) -> &Field<N>

Returns the block header root.

pub const fn header_path( &self ) -> &MerklePath<N, snarkvm_console_program::::state_path::configuration::HeaderPath::{constant#0}>

Returns the header path.

pub const fn header_leaf(&self) -> &HeaderLeaf<N>

Returns the header leaf.

pub const fn transactions_path( &self ) -> &MerklePath<N, snarkvm_console_program::::state_path::configuration::TransactionsPath::{constant#0}>

Returns the transactions path.

pub const fn transaction_id(&self) -> &<N as Network>::TransactionID

Returns the transaction ID.

pub const fn transaction_path( &self ) -> &MerklePath<N, snarkvm_console_program::::state_path::configuration::TransactionPath::{constant#0}>

Returns the Merkle path for the transaction leaf.

pub const fn transaction_leaf(&self) -> &TransactionLeaf<N>

Returns the transaction leaf.

pub const fn transition_root(&self) -> &Field<N>

Returns the transition root.

pub const fn tcm(&self) -> &Field<N>

Returns the transition commitment.

pub const fn transition_path( &self ) -> &MerklePath<N, snarkvm_console_program::::state_path::configuration::TransitionPath::{constant#0}>

Returns the Merkle path for the transition leaf.

pub const fn transition_leaf(&self) -> &TransitionLeaf<N>

Returns the transition leaf.

Trait Implementations§

impl<N> Clone for StatePath<N>
where N: Clone + Network, <N as Network>::StateRoot: Clone, <N as Network>::BlockHash: Clone, <N as Network>::TransactionID: Clone,

fn clone(&self) -> StatePath<N>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<N> Debug for StatePath<N>
where N: Network,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

impl<'de, N> Deserialize<'de> for StatePath<N>
where N: Network,

fn deserialize<D>( deserializer: D ) -> Result<StatePath<N>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserializes the state path from a string or bytes.

impl<N> Display for StatePath<N>
where N: Network,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Writes the state path as a bech32m string.

impl<N> FromBytes for StatePath<N>
where N: Network,

fn read_le<R>(reader: R) -> Result<StatePath<N>, Error>
where R: Read,

Reads the path from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>
where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N> FromStr for StatePath<N>
where N: Network,

fn from_str( state_path: &str ) -> Result<StatePath<N>, <StatePath<N> as FromStr>::Err>

Reads in the state path string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Parser for StatePath<N>
where N: Network,

fn parse(string: &str) -> Result<(&str, StatePath<N>), Err<VerboseError<&str>>>

Parses a string into the state path.

impl<N> PartialEq for StatePath<N>
where N: PartialEq + Network, <N as Network>::StateRoot: PartialEq, <N as Network>::BlockHash: PartialEq, <N as Network>::TransactionID: PartialEq,

fn eq(&self, other: &StatePath<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> Serialize for StatePath<N>
where N: Network,

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serializes the state path into string or bytes.

impl<N> ToBytes for StatePath<N>
where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>
where W: Write,

Writes the path to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>
where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> Eq for StatePath<N>
where N: Eq + Network, <N as Network>::StateRoot: Eq, <N as Network>::BlockHash: Eq, <N as Network>::TransactionID: Eq,

impl<N> StructuralEq for StatePath<N>
where N: Network,

impl<N> StructuralPartialEq for StatePath<N>
where N: Network,

Auto Trait Implementations§

impl<N> RefUnwindSafe for StatePath<N>
where N: RefUnwindSafe, <N as Network>::BlockHash: RefUnwindSafe, <N as Environment>::Field: RefUnwindSafe, <N as Network>::StateRoot: RefUnwindSafe, <N as Network>::TransactionID: RefUnwindSafe,

impl<N> Send for StatePath<N>

impl<N> Sync for StatePath<N>

impl<N> Unpin for StatePath<N>
where N: Unpin, <N as Network>::BlockHash: Unpin, <N as Environment>::Field: Unpin, <N as Network>::StateRoot: Unpin, <N as Network>::TransactionID: Unpin,

impl<N> UnwindSafe for StatePath<N>
where N: UnwindSafe, <N as Network>::BlockHash: UnwindSafe, <N as Environment>::Field: UnwindSafe, <N as Network>::StateRoot: UnwindSafe, <N as Network>::TransactionID: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<'de, T> DeserializeExt<'de> for T
where T: DeserializeOwned,

fn take_from_value<D>( value: &mut Value, field: &str ) -> Result<T, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,