Crate sp_beefy

Primitives for BEEFY protocol.

The crate contains shared data types used by BEEFY protocol and documentation (in a form of code) for building a BEEFY light client.

BEEFY is a gadget that runs alongside another finality gadget (for instance GRANDPA). For simplicity (and the initially intended use case) the documentation says GRANDPA in places where a more abstract “Finality Gadget” term could be used, but there is no reason why BEEFY wouldn’t run with some other finality scheme. BEEFY validator set is supposed to be tracking the Finality Gadget validator set, but note that it will use a different set of keys. For Polkadot use case we plan to use secp256k1 for BEEFY, while GRANDPA uses ed25519.

Modules

• crypto
  BEEFY cryptographic types
• known_payloads
  Registry of all known BeefyPayloadId.
• mmr
  BEEFY + MMR utilties.
• witness
  Primitives for light, 2-phase interactive verification protocol.

Structs

• Commitment
  A commitment signed by GRANDPA validators as part of BEEFY protocol.
• Payload
  A BEEFY payload type allowing for future extensibility of adding additional kinds of payloads.
• SignedCommitment
  A commitment with matching GRANDPA validators’ signatures.
• ValidatorSet
  A set of BEEFY authorities, a.k.a. validators.
• VoteMessage
  BEEFY vote message.

Enums

• ConsensusLog
  A consensus log item for BEEFY.
• VersionedFinalityProof
  A SignedCommitment with a version number.

Constants

• BEEFY_ENGINE_ID
  The ConsensusEngineId of BEEFY.
• GENESIS_AUTHORITY_SET_ID
  Authority set id starts with zero at BEEFY pallet genesis.
• KEY_TYPE
  Key type for BEEFY module.

Traits

• BeefyApi
  API necessary for BEEFY voters.
• BeefyAuthorityId
  Trait representing BEEFY authority id.
• BeefyVerify
  Means of verification for a BEEFY authority signature.
• OnNewValidatorSet
  New BEEFY validator set notification hook.
• PayloadProvider
  Trait for custom BEEFY payload providers.

Type Definitions

• AuthorityIndex
  The index of an authority.
• BeefyPayloadId
  Id of different payloads in the crate::Commitment data.
• MmrRootHash
  The type used to represent an MMR root hash.
• ValidatorSetId
  A typedef for validator set id.