Struct KernelConfig 

pub struct KernelConfig { /* private fields */ }

The configuration of one of the protocol’s kernels.

A kernel is identified by the root of its executable procedure together with the set of procedures it exposes through its API. Both are needed by other kernels: the batch kernel verifies transaction proofs against the transaction kernel’s main_proc, while the exposed procedure roots are what users may invoke.

kernel_procs is the set of kernel procedures exposed via index-based invocation, which is different from KernelDescriptor::proc_hashes, which is the set of statically invocable kernel procedures (e.g. exec_kernel_proc).

Implementations

impl KernelConfig

pub const MAX_NUM_KERNEL_PROCEDURES: usize = KernelDescriptor::MAX_NUM_PROCEDURES

The maximum number of procedures that can be exported from a kernel.

pub fn new( main_proc: Word, kernel_procs: Vec<Word>, ) -> Result<Self, ProtocolConfigError>

Creates a new KernelConfig from the provided inputs.

Errors

Returns an error if kernel_procs contains more than Self::MAX_NUM_KERNEL_PROCEDURES procedure roots.

pub fn main_proc(&self) -> Word

Returns the root of the executable kernel procedure.

pub fn kernel_procs(&self) -> &[Word]

Returns the roots of the procedures exposed by the kernel API.

pub fn num_kernel_procs(&self) -> u8

Returns the roots of the procedures exposed by the kernel API.

pub fn kernel_procs_elements(&self) -> &[Felt]

Returns the sequential hash of the exposed kernel procedure roots.

pub fn kernel_procs_commitment(&self) -> Word

Returns the sequential hash of the exposed kernel procedure roots.

pub fn to_commitment(&self) -> Word

Returns a commitment to this kernel configuration.

pub fn to_elements(&self) -> Vec<Felt>

Returns the preimage of KernelConfig::to_commitment as a sequence of field elements.

Trait Implementations

impl Clone for KernelConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KernelConfig

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

Formats the value using the given formatter.

impl Deserializable for KernelConfig

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl Eq for KernelConfig

impl PartialEq for KernelConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serializable for KernelConfig

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl StructuralPartialEq for KernelConfig