Struct ValidatorKeys 

pub struct ValidatorKeys { /* private fields */ }

The ordered set of validator public keys authorized to sign a block.

A block header commits to the ValidatorKeys authorized to sign the next block. A block’s signatures are verified positionally against the validator set committed to by its parent: the signature in slot i is checked against the key at index i in this set.

The number of validators is not fixed by the protocol: a chain may run with a single validator and grow its validator set over time by rotating in a larger ValidatorKeys set (see ProposedBlock::with_next_validator_keys), up to ValidatorKeys::MAX keys. The set holds at least one key, kept in a canonical order (sorted by their serialized bytes) so that the ValidatorKeys::commitment is independent of the order in which the keys were provided.

Implementations

impl ValidatorKeys

pub const MAX: usize = 5

The maximum number of validator keys in a set.

pub fn new(keys: Vec<PublicKey>) -> Result<ValidatorKeys, ValidatorKeysError>

Returns a new ValidatorKeys from the provided public keys.

The keys are sorted into a canonical order by their serialized bytes.

Errors

Returns an error if:

• keys is empty;
• keys contains more than ValidatorKeys::MAX keys;
• the set contains duplicate keys.

pub fn as_keys(&self) -> &[PublicKey]

Returns the validator public keys in canonical order.

pub fn len(&self) -> usize

Returns the number of validator keys in the set.

pub fn is_empty(&self) -> bool

Returns false, as a validator set always contains at least one key.

pub fn commitment(&self) -> Word

Returns a commitment to the validator set.

The commitment is a sequential hash of the per-key commitments in canonical order, and is committed to by the BlockHeader as a single word. Since the hash covers every key, the commitment also implicitly binds the number of validators.

Trait Implementations

impl Clone for ValidatorKeys

fn clone(&self) -> ValidatorKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatorKeys

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

Formats the value using the given formatter.

impl Deserializable for ValidatorKeys

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

where R: ByteReader,

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 ValidatorKeys

impl PartialEq for ValidatorKeys

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

Equality operator ==.

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

Inequality operator !=.

impl Serializable for ValidatorKeys

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

where W: ByteWriter,

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 ValidatorKeys