Struct sp1_core::air::PublicValues

#[repr(C)]
pub struct PublicValues<W, T> {
    pub committed_value_digest: [W; 8],
    pub deferred_proofs_digest: [T; 8],
    pub start_pc: T,
    pub next_pc: T,
    pub exit_code: T,
    pub shard: T,
    pub execution_shard: T,
    pub previous_init_addr_bits: [T; 32],
    pub last_init_addr_bits: [T; 32],
    pub previous_finalize_addr_bits: [T; 32],
    pub last_finalize_addr_bits: [T; 32],
}

The PublicValues struct is used to store all of a shard proof’s public values.

Fields

committed_value_digest: [W; 8]

The hash of all the bytes that the guest program has written to public values.

deferred_proofs_digest: [T; 8]

The hash of all deferred proofs that have been witnessed in the VM. It will be rebuilt in recursive verification as the proofs get verified. The hash itself is a rolling poseidon2 hash of each proof+vkey hash and the previous hash which is initially zero.

start_pc: T

The shard’s start program counter.

next_pc: T

The expected start program counter for the next shard.

exit_code: T

The exit code of the program. Only valid if halt has been executed.

shard: T

The shard number.

execution_shard: T

The execution shard number.

previous_init_addr_bits: [T; 32]

The bits of the largest address that is witnessed for initialization in the previous shard.

last_init_addr_bits: [T; 32]

The largest address that is witnessed for initialization in the current shard.

previous_finalize_addr_bits: [T; 32]

The bits of the largest address that is witnessed for finalization in the previous shard.

last_finalize_addr_bits: [T; 32]

The bits of the largest address that is witnessed for finalization in the current shard.

Implementations

impl PublicValues<u32, u32>

pub fn to_vec<F: AbstractField>(&self) -> Vec<F>

Convert the public values into a vector of field elements. This function will pad the vector to the maximum number of public values.

pub fn reset(&self) -> Self

impl<F: PrimeField32> PublicValues<Word<F>, F>

pub fn commit_digest_bytes(&self) -> Vec<u8>

Returns the commit digest as a vector of little-endian bytes.

Trait Implementations

impl<T: Clone> Borrow<PublicValues<Word<T>, T>> for [T]

fn borrow(&self) -> &PublicValues<Word<T>, T>

Immutably borrows from an owned value.

impl<T: Clone> BorrowMut<PublicValues<Word<T>, T>> for [T]

fn borrow_mut(&mut self) -> &mut PublicValues<Word<T>, T>

Mutably borrows from an owned value.

impl<W: Clone, T: Clone> Clone for PublicValues<W, T>

fn clone(&self) -> PublicValues<W, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug, T: Debug> Debug for PublicValues<W, T>

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

Formats the value using the given formatter.

impl<W: Default, T: Default> Default for PublicValues<W, T>

fn default() -> PublicValues<W, T>

Returns the “default value” for a type.

impl<'de, W, T> Deserialize<'de> for PublicValues<W, T>

where W: Deserialize<'de>, T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: AbstractField> From<PublicValues<u32, u32>> for PublicValues<Word<F>, F>

fn from(value: PublicValues<u32, u32>) -> Self

Converts to this type from the input type.

impl<W, T> Serialize for PublicValues<W, T>

where W: Serialize, T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<W: Copy, T: Copy> Copy for PublicValues<W, T>