Struct NextProtocolConfig 

pub struct NextProtocolConfig { /* private fields */ }

A protocol upgrade that is scheduled but not yet in effect.

Committing to an upgrade ahead of time lets clients that come online before effective_from learn about it and update before the switch happens, instead of being blocked once it does.

Implementations

impl NextProtocolConfig

pub fn new( effective_from: BlockNumber, protocol_config: Word, ) -> Result<Self, ProtocolConfigError>

Creates a new NextProtocolConfig from the provided inputs.

Errors

Returns an error if effective_from is BlockNumber::GENESIS. The genesis block defines the initial configuration, so no upgrade can become effective at it, and on-chain the genesis block number is the encoding of “no upgrade scheduled”.

pub fn effective_from(&self) -> BlockNumber

Returns the number of the first block for which the new configuration is in effect.

pub fn protocol_config(&self) -> Word

Returns the commitment to the ProtocolConfig that becomes effective.

pub fn to_commitment(&self) -> Word

Returns a commitment to this scheduled upgrade.

A block header without a scheduled upgrade commits to Word::empty, which this commitment can never collide with because effective_from is never zero.

Trait Implementations

impl Clone for NextProtocolConfig

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 NextProtocolConfig

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

Formats the value using the given formatter.

impl Deserializable for NextProtocolConfig

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 NextProtocolConfig

impl PartialEq for NextProtocolConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serializable for NextProtocolConfig

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 NextProtocolConfig