Struct KeyRegistration 

pub struct KeyRegistration { /* private fields */ }

Key Registration

Implementations

impl KeyRegistration

pub fn initialize() -> Self

Initialize an empty registration

pub fn register_by_entry(&mut self, entry: &RegistrationEntry) -> StmResult<()>

Check whether the given RegistrationEntry is already registered. Insert the new entry if all checks pass.

Error

The function fails when the entry is already registered.

pub fn register( &mut self, stake: Stake, vk_pop: &VerificationKeyProofOfPossessionForConcatenation, ) -> StmResult<()>

Registers a new signer with the given verification key proof of possession and stake. This function only works for concatenation proof system. The purpose of this function is to simplify the process for the rest of the codebase.

pub fn get_signer_index_for_registration( &self, entry: &RegistrationEntry, ) -> Option<SignerIndex>

Gets the index of a signer registration entry

pub fn get_registration_entry_for_index( &self, signer_index: &SignerIndex, ) -> StmResult<RegistrationEntry>

Get the registration entry for a given signer index.

pub fn into_merkle_tree<D: Digest + FixedOutput, L: From<RegistrationEntry> + MerkleTreeLeaf>( &self, ) -> MerkleTree<D, L>

Converts the KeyRegistration into a Merkle tree

pub fn close_registration(self) -> ClosedKeyRegistration

Closes the registration by computing the total stake registered.

Trait Implementations

impl Clone for KeyRegistration

fn clone(&self) -> KeyRegistration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyRegistration

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

Formats the value using the given formatter.

impl Default for KeyRegistration

fn default() -> KeyRegistration

Returns the “default value” for a type.

impl Ord for KeyRegistration

fn cmp(&self, other: &KeyRegistration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for KeyRegistration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for KeyRegistration

fn partial_cmp(&self, other: &KeyRegistration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for KeyRegistration

impl StructuralPartialEq for KeyRegistration