committee

Documentation

Index

• Variables
• type Handler
  • func NewHandler(keys key.Keys, p user.Provisioners, seed []byte) *Handler
  • func (b *Handler) AmMember(round uint64, step uint8, maxSize int) bool
  • func (b *Handler) Committee(round uint64, step uint8, maxSize int) user.VotingCommittee
  • func (b *Handler) CommitteeSize(round uint64, maxSize int) int
  • func (b *Handler) IsMember(pubKeyBLS []byte, round uint64, step uint8, maxSize int) bool
  • func (b *Handler) Seed() []byte
  • func (b *Handler) VotesFor(pubKeyBLS []byte, round uint64, step uint8, maxSize int) int

Variables

var PregenerationAmount uint8 = 1

PregenerationAmount is the size of a pregenerated committee.

Types

type Handler

type Handler struct {
	key.Keys
	Provisioners user.Provisioners
	Committees   []user.VotingCommittee
	// contains filtered or unexported fields
}

Handler is injected in the consensus components that work with the various committee. It generates and maintains a list of active and valid committee members and handle the votes.

func NewHandler

func NewHandler(keys key.Keys, p user.Provisioners, seed []byte) *Handler

NewHandler creates a new committee.Handler by instantiating the committee slice, setting the keys and setting the Provisioner set.

func (*Handler) AmMember

func (b *Handler) AmMember(round uint64, step uint8, maxSize int) bool

AmMember checks if we are part of the committee for a given round and step.

func (*Handler) Committee

func (b *Handler) Committee(round uint64, step uint8, maxSize int) user.VotingCommittee

Committee returns a VotingCommittee for a given round and step.

func (*Handler) CommitteeSize

func (b *Handler) CommitteeSize(round uint64, maxSize int) int

CommitteeSize returns the size of a VotingCommittee, depending on how many provisioners are in the set.

func (*Handler) IsMember

func (b *Handler) IsMember(pubKeyBLS []byte, round uint64, step uint8, maxSize int) bool

IsMember checks if a provisioner with a given BLS public key is part of the committee for a given round and step.

func (*Handler) Seed

func (b *Handler) Seed() []byte

Seed returns seed value.

func (*Handler) VotesFor

func (b *Handler) VotesFor(pubKeyBLS []byte, round uint64, step uint8, maxSize int) int

VotesFor returns the amount of votes for a public key for a given round and step.