consensus

Documentation

Index

• func CheckBlockCertificationRequest(req CertRequestVerifier, luc *types.UnicityCertificate) error
• type CertReqReason
• type CertRequestVerifier
• type IRChangeRequest
• type Option
  • func WithStorage(db keyvaluedb.KeyValueDB) Option
• type Optional
  • func LoadConf(opts []Option) (*Optional, error)
• type Parameters
  • func NewConsensusParams(genesisRoot *genesis.GenesisRootRecord) *Parameters

Functions

func CheckBlockCertificationRequest

func CheckBlockCertificationRequest(req CertRequestVerifier, luc *types.UnicityCertificate) error

Types

type CertReqReason

type CertReqReason uint8

const (
	Quorum CertReqReason = iota
	QuorumNotPossible
)

type CertRequestVerifier

type CertRequestVerifier interface {
	IRRound() uint64
	IRPreviousHash() []byte
	RootRound() uint64
}

type IRChangeRequest

type IRChangeRequest struct {
	SystemIdentifier types.SystemID
	Reason           CertReqReason
	Requests         []*certification.BlockCertificationRequest
}

type Option

type Option func(c *Optional)

func WithStorage

func WithStorage(db keyvaluedb.KeyValueDB) Option

type Optional

type Optional struct {
	Storage keyvaluedb.KeyValueDB
}

Optional are common optional parameters for consensus managers

func LoadConf

func LoadConf(opts []Option) (*Optional, error)

type Parameters

type Parameters struct {
	BlockRate          time.Duration // also known as T3
	LocalTimeout       time.Duration
	ConsensusThreshold uint32
	HashAlgorithm      gocrypto.Hash
}

Parameters are basic consensus parameters that need to be the same in all root validators. Extracted from root genesis where all validators in the root cluster must have signed them to signal agreement

func NewConsensusParams

func NewConsensusParams(genesisRoot *genesis.GenesisRootRecord) *Parameters

NewConsensusParams extract common consensus parameters from genesis