Documentation
¶
Index ¶
- func NewConsensus(ctx context.Context, conf *Config, bcState state.Facade, ...) consensus.Consensus
- type ConcreteMediator
- func (m *ConcreteMediator) OnBlockAnnounce(from consensus.Consensus)
- func (m *ConcreteMediator) OnPublishProposal(from consensus.Consensus, prop *proposal.Proposal)
- func (m *ConcreteMediator) OnPublishVote(from consensus.Consensus, vte *vote.Vote)
- func (m *ConcreteMediator) Register(cons consensus.Consensus)
- type Config
- type ConfigError
- type InvalidJustificationError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ConcreteMediator ¶
type ConcreteMediator struct {
// contains filtered or unexported fields
}
ConcreteMediator struct.
func (*ConcreteMediator) OnBlockAnnounce ¶
func (m *ConcreteMediator) OnBlockAnnounce(from consensus.Consensus)
func (*ConcreteMediator) OnPublishProposal ¶
func (m *ConcreteMediator) OnPublishProposal(from consensus.Consensus, prop *proposal.Proposal)
func (*ConcreteMediator) OnPublishVote ¶
func (m *ConcreteMediator) OnPublishVote(from consensus.Consensus, vte *vote.Vote)
func (*ConcreteMediator) Register ¶
func (m *ConcreteMediator) Register(cons consensus.Consensus)
Register a new Consensus instance to the mediator.
type Config ¶
type Config struct {
ChangeProposerTimeout time.Duration `toml:"-"`
ChangeProposerDelta time.Duration `toml:"-"`
QueryVoteTimeout time.Duration `toml:"-"`
MinimumAvailabilityScore float64 `toml:"-"`
}
Config defines parameters for the consensusv2 algorithm.
func DefaultConfig ¶
func DefaultConfig() *Config
func (*Config) BasicCheck ¶
BasicCheck performs basic checks on the configuration.
type ConfigError ¶
type ConfigError struct {
Reason string
}
ConfigError is returned when the config is not valid with a descriptive Reason message.
func (ConfigError) Error ¶
func (e ConfigError) Error() string
type InvalidJustificationError ¶
type InvalidJustificationError struct {
Reason string
}
InvalidJustificationError is returned when the justification for a change-proposer vote is invalid.
func (InvalidJustificationError) Error ¶
func (e InvalidJustificationError) Error() string
Source Files
¶
Click to show internal directories.
Click to hide internal directories.