Struct ChainManager

pub struct ChainManager {

    pub ownership: ChainOwnership,
    pub seed: u64,
    pub distribution: Option<WeightedAliasIndex<u64>>,
    pub fallback_distribution: Option<WeightedAliasIndex<u64>>,
    pub proposed: Option<BlockProposal>,
    pub locked: Option<Certificate>,
    pub timeout: Option<Certificate>,
    pub pending: Option<Vote>,
    pub timeout_vote: Option<Vote>,
    pub fallback_vote: Option<Vote>,
    pub round_timeout: Option<Timestamp>,
    pub current_round: Round,
    pub fallback_owners: BTreeMap<Owner, (PublicKey, u64)>,
    pub pending_blobs: BTreeMap<BlobId, Blob>,
}

The state of the certification process for a chain’s next block.

Fields

ownership: ChainOwnership

The public keys, weights and types of the chain’s owners.

seed: u64

The seed for the pseudo-random number generator that determines the round leaders.

distribution: Option<WeightedAliasIndex<u64>>

The probability distribution for choosing a round leader.

fallback_distribution: Option<WeightedAliasIndex<u64>>

The probability distribution for choosing a fallback round leader.

proposed: Option<BlockProposal>

Highest-round authenticated block that we have received and checked. If there are multiple proposals in the same round, this contains only the first one.

locked: Option<Certificate>

Latest validated proposal that we have voted to confirm (or would have, if we are not a validator).

timeout: Option<Certificate>

Latest leader timeout certificate we have received.

pending: Option<Vote>

Latest vote we have cast, to validate or confirm.

timeout_vote: Option<Vote>

Latest timeout vote we cast.

fallback_vote: Option<Vote>

Fallback vote we cast.

round_timeout: Option<Timestamp>

The time after which we are ready to sign a timeout certificate for the current round.

current_round: Round

The lowest round where we can still vote to validate or confirm a block. This is the round to which the timeout applies.

Having a leader timeout certificate in any given round causes the next one to become current. Seeing a validated block certificate or a valid proposal in any round causes that round to become current, unless a higher one already is.

fallback_owners: BTreeMap<Owner, (PublicKey, u64)>

The owners that take over in fallback mode.

pending_blobs: BTreeMap<BlobId, Blob>

These are blobs belonging to proposed or validated blocks that have not been confirmed yet.

Implementations

impl ChainManager

pub fn reset<'a>( &mut self, ownership: &ChainOwnership, height: BlockHeight, local_time: Timestamp, fallback_owners: impl Iterator<Item = (PublicKey, u64)> + 'a, ) -> Result<(), ChainError>

Replaces self with a new chain manager.

pub fn pending(&self) -> Option<&Vote>

Returns the most recent vote we cast.

pub fn check_proposed_block( &self, proposal: &BlockProposal, ) -> Result<Outcome, ChainError>

Verifies the safety of a proposed block with respect to voting rules.

pub fn vote_timeout( &mut self, chain_id: ChainId, height: BlockHeight, epoch: Epoch, key_pair: Option<&KeyPair>, local_time: Timestamp, ) -> bool

Checks if the current round has timed out, and signs a Timeout.

pub fn vote_fallback( &mut self, chain_id: ChainId, height: BlockHeight, epoch: Epoch, key_pair: Option<&KeyPair>, ) -> bool

Signs a Timeout certificate to switch to fallback mode.

This must only be called after verifying that the condition for fallback mode is satisfied locally.

pub fn check_validated_block( &self, certificate: &Certificate, ) -> Result<Outcome, ChainError>

Verifies that we can vote to confirm a validated block.

pub fn create_vote( &mut self, proposal: BlockProposal, outcome: BlockExecutionOutcome, key_pair: Option<&KeyPair>, local_time: Timestamp, )

Signs a vote to validate the proposed block.

pub fn create_final_vote( &mut self, certificate: Certificate, key_pair: Option<&KeyPair>, local_time: Timestamp, )

Signs a vote to confirm the validated block.

pub fn handle_timeout_certificate( &mut self, certificate: Certificate, local_time: Timestamp, )

Updates the round number and timer if the timeout certificate is from a higher round than any known certificate.

pub fn verify_owner(&self, proposal: &BlockProposal) -> Option<PublicKey>

Returns the public key of the block proposal’s signer, if they are a valid owner and allowed to propose a block in the proposal’s round.

Trait Implementations

impl Clone for ChainManager

fn clone(&self) -> ChainManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainManager

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

Formats the value using the given formatter.

impl Default for ChainManager

fn default() -> ChainManager

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChainManager

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChainManager, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl InputType for ChainManager

type RawValueType = ChainManager

The raw type used for validator.

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

fn parse( value: Option<ConstValue>, ) -> Result<ChainManager, InputValueError<ChainManager>>

Parse from Value. None represents undefined.

fn to_value(&self) -> ConstValue

Convert to a Value for introspection.

fn as_raw_value(&self) -> Option<&<ChainManager as InputType>::RawValueType>

Returns a reference to the raw value.

fn qualified_type_name() -> String

Qualified typename.

impl OutputType for ChainManager

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

async fn resolve( &self, _: &ContextBase<'_, &Positioned<SelectionSet>>, _field: &Positioned<Field>, ) -> Result<ConstValue, ServerError>

Resolve an output value to async_graphql::Value.

fn qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name

impl ScalarType for ChainManager

fn parse( value: ConstValue, ) -> Result<ChainManager, InputValueError<ChainManager>>

Parse a scalar value.

fn to_value(&self) -> ConstValue

Convert the scalar to Value.

fn is_valid(_value: &ConstValue) -> bool

Checks for a valid scalar value.

impl Serialize for ChainManager

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.