Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

modules

package

Go to main page

Versions in this module

v0

v0.5.0

Oct 27, 2025

Changes in this version

+ func GetModuleUntyped(name string) (m any, ok bool)

+ func ListModules() map[string][]string

+ type Acceptor interface

+ Accept func(hotstuff.Command) bool

+ Proposed func(hotstuff.Command)

+ type BlockChain interface

+ Extends func(block, target *hotstuff.Block) bool

+ Get func(hotstuff.Hash) (*hotstuff.Block, bool)

+ LocalGet func(hotstuff.Hash) (*hotstuff.Block, bool)

+ PruneToHeight func(height hotstuff.View) (forkedBlocks []*hotstuff.Block)

+ Store func(*hotstuff.Block)

type Builder

+ func (b *Builder) Add(modules ...any)

+ func (b *Builder) Options() *Options

+ type CommandQueue interface

+ Get func(ctx context.Context) (cmd hotstuff.Command, ok bool)

+ type Configuration interface

+ Fetch func(ctx context.Context, hash hotstuff.Hash) (block *hotstuff.Block, ok bool)

+ Len func() int

+ Propose func(proposal hotstuff.ProposeMsg)

+ QuorumSize func() int

+ Replica func(hotstuff.ID) (replica Replica, ok bool)

+ Replicas func() map[hotstuff.ID]Replica

+ SubConfig func(ids []hotstuff.ID) (sub Configuration, err error)

+ Timeout func(msg hotstuff.TimeoutMsg)

+ type Consensus interface

+ ChainLength func() int

+ CommittedBlock func() *hotstuff.Block

+ Propose func(cert hotstuff.SyncInfo)

+ StopVoting func(view hotstuff.View)

+ type Core struct

+ func (mods *Core) Get(pointers ...any)

+ func (mods Core) TryGet(ptr any) bool

+ type Crypto interface

+ CreateAggregateQC func(view hotstuff.View, timeouts []hotstuff.TimeoutMsg) (aggQC hotstuff.AggregateQC, err error)

+ CreatePartialCert func(block *hotstuff.Block) (cert hotstuff.PartialCert, err error)

+ CreateQuorumCert func(block *hotstuff.Block, signatures []hotstuff.PartialCert) (cert hotstuff.QuorumCert, err error)

+ CreateTimeoutCert func(view hotstuff.View, timeouts []hotstuff.TimeoutMsg) (cert hotstuff.TimeoutCert, err error)

+ VerifyAggregateQC func(aggQC hotstuff.AggregateQC) (highQC hotstuff.QuorumCert, ok bool)

+ VerifyPartialCert func(cert hotstuff.PartialCert) bool

+ VerifyQuorumCert func(qc hotstuff.QuorumCert) bool

+ VerifyTimeoutCert func(tc hotstuff.TimeoutCert) bool

+ type CryptoBase interface

+ BatchVerify func(signature hotstuff.QuorumSignature, batch map[hotstuff.ID][]byte) bool

+ Combine func(signatures ...hotstuff.QuorumSignature) (signature hotstuff.QuorumSignature, err error)

+ Sign func(message []byte) (signature hotstuff.QuorumSignature, err error)

+ Verify func(signature hotstuff.QuorumSignature, message []byte) bool

+ type Executor interface

+ Exec func(cmd hotstuff.Command)

+ type ExecutorExt interface

+ Exec func(block *hotstuff.Block)

+ func ExtendedExecutor(executor Executor) ExecutorExt

+ type ForkHandler interface

+ Fork func(cmd hotstuff.Command)

+ type ForkHandlerExt interface

+ Fork func(block *hotstuff.Block)

+ func ExtendedForkHandler(forkHandler ForkHandler) ForkHandlerExt

+ type Kauri interface

+ Begin func(s hotstuff.PartialCert, p hotstuff.ProposeMsg)

+ type LeaderRotation interface

+ GetLeader func(hotstuff.View) hotstuff.ID

+ type OptionID uint64

+ func NewOption() OptionID

+ type Options struct

+ func (opts *Options) ConnectionMetadata() map[string]string

+ func (opts *Options) Get(id OptionID) any

+ func (opts *Options) ID() hotstuff.ID

+ func (opts *Options) PrivateKey() hotstuff.PrivateKey

+ func (opts *Options) Set(id OptionID, value any)

+ func (opts *Options) SetConnectionMetadata(key string, value string)

+ func (opts *Options) SetSharedRandomSeed(seed int64)

+ func (opts *Options) SetShouldUseAggQC()

+ func (opts *Options) SetShouldUseTree()

+ func (opts *Options) SetShouldVerifyVotesSync()

+ func (opts *Options) SetTree(t tree.Tree)

+ func (opts *Options) SharedRandomSeed() int64

+ func (opts *Options) ShouldUseAggQC() bool

+ func (opts *Options) ShouldUseTree() bool

+ func (opts *Options) ShouldVerifyVotesSync() bool

+ func (opts *Options) Tree() tree.Tree

+ type Replica interface

+ ID func() hotstuff.ID

+ Metadata func() map[string]string

+ NewView func(hotstuff.SyncInfo)

+ PublicKey func() hotstuff.PublicKey

+ Vote func(cert hotstuff.PartialCert)

+ type Synchronizer interface

+ AdvanceView func(hotstuff.SyncInfo)

+ HighQC func() hotstuff.QuorumCert

+ Start func(context.Context)

+ View func() hotstuff.View

v0.4.0

Dec 6, 2021

Changes in this version

+ func GetModule(name string, out interface{}) bool

+ func RegisterModule(name string, constructor interface{})

type Modules

+ func (mods Modules) EventLoop() *eventloop.EventLoop

v0.3.1

Aug 29, 2021

v0.3.0

Aug 27, 2021

Changes in this version

+ type Builder struct

+ func NewBuilder(id hotstuff.ID) Builder

+ func (b *Builder) Build() *Modules

+ func (b *Builder) Register(modules ...interface{})

+ type MetricsLogger interface

+ Log func(proto.Message)

+ func NewJSONLogger(wr io.Writer) (MetricsLogger, error)

+ func NopLogger() MetricsLogger

+ type Module interface

+ InitModule func(mods *Modules)

+ type Modules struct

+ func (mod Modules) ID() hotstuff.ID

+ func (mod Modules) Logger() logging.Logger

+ func (mod Modules) MetricsEventLoop() *eventloop.EventLoop

+ func (mod Modules) MetricsLogger() MetricsLogger