Module zksync_consensus_roles::validator

Validator role implementation.

Modules

• testonly
  Test-only utilities.

Structs

• AggregateSignature
  An aggregate signature from a validator.
• BlockHeader
  A block header.
• BlockNumber
  Sequential number of the block.
• ChainId
  Ethereum CHAIN_ID https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md
• CommitQC
  A Commit Quorum Certificate. It is an aggregate of signed replica Commit messages. The Quorum Certificate is supposed to be over identical messages, so we only need one message.
• Committee
  A struct that represents a set of validators. It is used to store the current validator set. We represent each validator by its validator public key.
• FinalBlock
  A block that has been finalized by the consensus protocol.
• ForkNumber
  Number of the fork. Newer fork has higher number.
• Genesis
  Genesis with cached hash.
• GenesisHash
  Hash of the genesis specification.
• GenesisRaw
  Genesis of the blockchain, unique for each blockchain instance.
• LeaderCommit
  A Commit message from a leader.
• LeaderPrepare
  A Prepare message from a leader.
• MsgHash
  Hash of a message.
• NetAddress
  A message broadcasted by a validator over the gossip network announcing its own TCP address. See schema/proto/roles/validator.proto. The NetAddress message with highest (version,timestamp) is considered to be the newest (compared lexicographically).
• Payload
  Payload of the block. Consensus algorithm does not interpret the payload (except for imposing a size limit for the payload). Proposing a payload for a new block and interpreting the payload of the finalized blocks should be implemented for the specific application of the consensus algorithm.
• PayloadHash
  Hash of the Payload.
• PrepareQC
  A quorum certificate of replica Prepare messages. Since not all Prepare messages are identical (they have different high blocks and high QCs), we need to keep the high blocks and high QCs in a map. We can still aggregate the signatures though.
• ProtocolVersion
  Version of the consensus algorithm that the validator is using. It allows to prevent misinterpretation of messages signed by validators using different versions of the binaries.
• PublicKey
  A public key for a validator.
• ReplicaCommit
  A Commit message from a replica.
• ReplicaPrepare
  A Prepare message from a replica.
• SecretKey
  A secret key for the validator role. SecretKey is put into an Arc, so that we can clone it, without copying the secret all over the RAM.
• Signature
  A signature from a validator.
• Signed
  Strongly typed signed message. WARNING: signature is not guaranteed to be valid.
• Signers
  Struct that represents a bit map of validators. We use it to compactly store which validators signed a given message.
• View
  View specification.
• ViewNumber
  A struct that represents a view number.
• WeightedValidator
  Validator representation inside a Committee.

Enums

• BlockValidationError
  Errors that can occur validating a FinalBlock received from a node.
• CommitQCAddError
  Error returned by CommitQC::add().
• CommitQCVerifyError
  Error returned by CommitQc::verify().
• ConsensusMsg
  Consensus messages.
• LeaderPrepareVerifyError
  Error returned by LeaderPrepare::verify().
• LeaderSelectionMode
  The mode used for selecting leader for a given view.
• Msg
  Generic message type for a validator.
• Phase
  An enum that represents the current phase of the consensus.
• PrepareQCAddError
  Error returned by PrepareQC::add().
• PrepareQCVerifyError
  Error returned by PrepareQC::verify().
• ReplicaCommitVerifyError
  Error returned by ReplicaCommit::verify().
• ReplicaPrepareVerifyError
  Error returned by ReplicaPrepare::verify().

Functions

• max_faulty_weight
  Calculate the maximum allowed weight for faulty replicas, for a given total weight.
• threshold
  Calculate the consensus threshold, the minimum votes’ weight for any consensus action to be valid, for a given committee total weight.

Type Aliases

• Weight
  Voting weight;