Struct ProtocolConfig 

pub struct ProtocolConfig { /* private fields */ }

The configuration parameters of the protocol that are expected to change rarely over the lifetime of a chain.

A BlockHeader holds only the commitment to this config, so that rarely changing data does not take up space in every block.

Implementations

impl ProtocolConfig

pub fn new( fee_asset_id: AssetId, tx_kernel: KernelConfig, batch_kernel: KernelConfig, block_kernel: KernelConfig, proof_verification: ProofVerificationConfig, ) -> Result<Self, ProtocolConfigError>

Creates a new ProtocolConfig from the provided inputs.

Errors

Returns an error if fee_asset_id is not a fungible asset ID.

pub fn current(fee_asset_id: AssetId) -> Result<Self, ProtocolConfigError>

Creates the ProtocolConfig described by the currently linked kernels.

TODO(#3644): The batch kernel, the block kernel and the proof verification roots are placeholders until those parts of the protocol exist.

Errors

Returns an error if fee_asset_id is not a fungible asset ID.

pub fn fee_asset_id(&self) -> AssetId

Returns the ID of the asset that fees are paid in.

pub fn tx_kernel(&self) -> &KernelConfig

Returns the configuration of the transaction kernel.

pub fn batch_kernel(&self) -> &KernelConfig

Returns the configuration of the batch kernel.

pub fn block_kernel(&self) -> &KernelConfig

Returns the configuration of the block kernel.

pub fn proof_verification(&self) -> &ProofVerificationConfig

Returns the parameters defining which proofs the protocol accepts.

pub fn to_commitment(&self) -> Word

Returns the commitment to this configuration, which is what a block header commits to.

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

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

The element layout is:

[
    FEE_ASSET_ID,
    TX_KERNEL_CONFIG_COMMITMENT,
    BATCH_KERNEL_CONFIG_COMMITMENT,
    BLOCK_KERNEL_CONFIG_COMMITMENT,
    PROOF_VERIFICATION_CONFIG_COMMITMENT,
    EMPTY_WORD,
]

Trait Implementations

impl Clone for ProtocolConfig

fn clone(&self) -> ProtocolConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolConfig

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

Formats the value using the given formatter.

impl Deserializable for ProtocolConfig

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 ProtocolConfig

impl PartialEq for ProtocolConfig

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

Equality operator ==.

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

Inequality operator !=.

impl SequentialCommit for ProtocolConfig

type Commitment = Word

A type of the commitment which must be derivable from Word.

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

Returns a representation of the object as a sequence of fields elements.

fn to_commitment(&self) -> Self::Commitment

Computes the commitment to the object.

impl Serializable for ProtocolConfig

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 ProtocolConfig