Documentation ¶
Index ¶
- Constants
- Variables
- func CompareHRS(h1 int64, r1 int32, s1 cstypes.RoundStepType, h2 int64, r2 int32, ...) int
- func IsDataCorruptionError(err error) bool
- func MsgToProto(msg Message) (*tmcons.Message, error)
- func MustEncode(msg Message) []byte
- func RunReplayFile(config cfg.BaseConfig, csConfig *cfg.ConsensusConfig, console bool)
- func WALGenerateNBlocks(t *testing.T, wr io.Writer, numBlocks int) (err error)
- func WALToProto(msg WALMessage) (*tmcons.WALMessage, error)
- func WALWithNBlocks(t *testing.T, numBlocks int) (data []byte, err error)
- type BaseWAL
- func (wal *BaseWAL) FlushAndSync() error
- func (wal *BaseWAL) Group() *auto.Group
- func (wal *BaseWAL) OnStart() error
- func (wal *BaseWAL) OnStop()
- func (wal *BaseWAL) SearchForEndHeight(height int64, options *WALSearchOptions) (rd io.ReadCloser, found bool, err error)
- func (wal *BaseWAL) SetFlushInterval(i time.Duration)
- func (wal *BaseWAL) SetLogger(l log.Logger)
- func (wal *BaseWAL) Wait()
- func (wal *BaseWAL) Write(msg WALMessage) error
- func (wal *BaseWAL) WriteSync(msg WALMessage) error
- type BlockPartMessage
- type DataCorruptionError
- type EndHeightMessage
- type Handshaker
- func (h *Handshaker) Handshake(proxyApp proxy.AppConns) error
- func (h *Handshaker) NBlocks() int
- func (h *Handshaker) ReplayBlocks(state sm.State, appHash []byte, appBlockHeight int64, proxyApp proxy.AppConns) ([]byte, error)
- func (h *Handshaker) SetEventBus(eventBus types.BlockEventPublisher)
- func (h *Handshaker) SetLogger(l log.Logger)
- type HasVoteMessage
- type Message
- type Metrics
- type NewRoundStepMessage
- type NewValidBlockMessage
- type PeerState
- func (ps *PeerState) ApplyHasVoteMessage(msg *HasVoteMessage)
- func (ps *PeerState) ApplyNewRoundStepMessage(msg *NewRoundStepMessage)
- func (ps *PeerState) ApplyNewValidBlockMessage(msg *NewValidBlockMessage)
- func (ps *PeerState) ApplyProposalPOLMessage(msg *ProposalPOLMessage)
- func (ps *PeerState) ApplyVoteSetBitsMessage(msg *VoteSetBitsMessage, ourVotes *bits.BitArray)
- func (ps *PeerState) BlockPartsSent() int
- func (ps *PeerState) EnsureVoteBitArrays(height int64, numValidators int)
- func (ps *PeerState) GetHeight() int64
- func (ps *PeerState) GetRoundState() *cstypes.PeerRoundState
- func (ps *PeerState) InitProposalBlockParts(partSetHeader types.PartSetHeader)
- func (ps *PeerState) PickSendVote(votes types.VoteSetReader) bool
- func (ps *PeerState) PickVoteToSend(votes types.VoteSetReader) (vote *types.Vote, ok bool)
- func (ps *PeerState) RecordBlockPart() int
- func (ps *PeerState) RecordVote() int
- func (ps *PeerState) SetHasProposal(proposal *types.Proposal)
- func (ps *PeerState) SetHasProposalBlockPart(height int64, round int32, index int)
- func (ps *PeerState) SetHasVote(vote *types.Vote)
- func (ps *PeerState) SetLogger(logger log.Logger) *PeerState
- func (ps *PeerState) String() string
- func (ps *PeerState) StringIndented(indent string) string
- func (ps *PeerState) ToJSON() ([]byte, error)
- func (ps *PeerState) VotesSent() int
- type ProposalMessage
- type ProposalPOLMessage
- type Reactor
- func (conR *Reactor) AddPeer(peer p2p.Peer)
- func (conR *Reactor) GetChannels() []*p2p.ChannelDescriptor
- func (conR *Reactor) InitPeer(peer p2p.Peer) p2p.Peer
- func (conR *Reactor) OnStart() error
- func (conR *Reactor) OnStop()
- func (conR *Reactor) Receive(chID byte, src p2p.Peer, msgBytes []byte)
- func (conR *Reactor) RemovePeer(peer p2p.Peer, reason interface{})
- func (conR *Reactor) SetEventBus(b *types.EventBus)
- func (conR *Reactor) String() string
- func (conR *Reactor) StringIndented(indent string) string
- func (conR *Reactor) SwitchToConsensus(state sm.State, skipWAL bool)
- func (conR *Reactor) WaitSync() bool
- type ReactorOption
- type State
- func (cs *State) AddProposalBlockPart(height int64, round int32, part *types.Part, peerID p2p.ID) error
- func (cs *State) AddVote(vote *types.Vote, peerID p2p.ID) (added bool, err error)
- func (cs *State) GetLastHeight() int64
- func (cs *State) GetRoundState() *cstypes.RoundState
- func (cs *State) GetRoundStateJSON() ([]byte, error)
- func (cs *State) GetRoundStateSimpleJSON() ([]byte, error)
- func (cs *State) GetState() sm.State
- func (cs *State) GetValidators() (int64, []*types.Validator)
- func (cs *State) LoadCommit(height int64) *types.Commit
- func (cs *State) OnStart() error
- func (cs *State) OnStop()
- func (cs *State) OpenWAL(walFile string) (WAL, error)
- func (cs *State) ReplayFile(file string, console bool) error
- func (cs *State) SetEventBus(b *types.EventBus)
- func (cs *State) SetLogger(l log.Logger)
- func (cs *State) SetPrivValidator(priv types.PrivValidator)
- func (cs *State) SetProposal(proposal *types.Proposal, peerID p2p.ID) error
- func (cs *State) SetProposalAndBlock(proposal *types.Proposal, block *types.Block, parts *types.PartSet, ...) error
- func (cs *State) SetTimeoutTicker(timeoutTicker TimeoutTicker)
- func (cs *State) String() string
- func (cs *State) Wait()
- type StateOption
- type TimedWALMessage
- type TimeoutTicker
- type VoteMessage
- type VoteSetBitsMessage
- type VoteSetMaj23Message
- type WAL
- type WALDecoder
- type WALEncoder
- type WALMessage
- type WALSearchOptions
Constants ¶
const ( StateChannel = byte(0x20) DataChannel = byte(0x21) VoteChannel = byte(0x22) VoteSetBitsChannel = byte(0x23) )
const ( // MetricsSubsystem is a subsystem shared by all metrics exposed by this // package. MetricsSubsystem = "consensus" )
Variables ¶
var ( ErrPeerStateHeightRegression = errors.New("error peer state height regression") ErrPeerStateInvalidStartTime = errors.New("error peer state invalid startTime") )
var ( ErrInvalidProposalSignature = errors.New("error invalid proposal signature") ErrInvalidProposalPOLRound = errors.New("error invalid proposal POL round") ErrAddingVote = errors.New("error adding vote") ErrSignatureFoundInPastBlocks = errors.New("found signature from the same key") )
Functions ¶
func CompareHRS ¶
func CompareHRS(h1 int64, r1 int32, s1 cstypes.RoundStepType, h2 int64, r2 int32, s2 cstypes.RoundStepType) int
func IsDataCorruptionError ¶
IsDataCorruptionError returns true if data has been corrupted inside WAL.
func MsgToProto ¶ added in v0.34.0
MsgToProto takes a consensus message type and returns the proto defined consensus message
func MustEncode ¶ added in v0.34.0
MustEncode takes the reactors msg, makes it proto and marshals it this mimics `MustMarshalBinaryBare` in that is panics on error
func RunReplayFile ¶
func RunReplayFile(config cfg.BaseConfig, csConfig *cfg.ConsensusConfig, console bool)
replay the wal file
func WALGenerateNBlocks ¶
WALGenerateNBlocks generates a consensus WAL. It does this by spinning up a stripped down version of node (proxy app, event bus, consensus state) with a persistent kvstore application and special consensus wal instance (byteBufferWAL) and waits until numBlocks are created. If the node fails to produce given numBlocks, it returns an error.
func WALToProto ¶ added in v0.34.0
func WALToProto(msg WALMessage) (*tmcons.WALMessage, error)
WALToProto takes a WAL message and return a proto walMessage and error
Types ¶
type BaseWAL ¶ added in v0.33.2
type BaseWAL struct { service.BaseService // contains filtered or unexported fields }
Write ahead logger writes msgs to disk before they are processed. Can be used for crash-recovery and deterministic replay. TODO: currently the wal is overwritten during replay catchup, give it a mode so it's either reading or appending - must read to end to start appending again.
func NewWAL ¶
NewWAL returns a new write-ahead logger based on `baseWAL`, which implements WAL. It's flushed and synced to disk every 2s and once when stopped.
func (*BaseWAL) FlushAndSync ¶ added in v0.33.2
FlushAndSync flushes and fsync's the underlying group's data to disk. See auto#FlushAndSync
func (*BaseWAL) OnStop ¶ added in v0.33.2
func (wal *BaseWAL) OnStop()
Stop the underlying autofile group. Use Wait() to ensure it's finished shutting down before cleaning up files.
func (*BaseWAL) SearchForEndHeight ¶ added in v0.33.2
func (wal *BaseWAL) SearchForEndHeight( height int64, options *WALSearchOptions) (rd io.ReadCloser, found bool, err error)
SearchForEndHeight searches for the EndHeightMessage with the given height and returns an auto.GroupReader, whenever it was found or not and an error. Group reader will be nil if found equals false.
CONTRACT: caller must close group reader.
func (*BaseWAL) SetFlushInterval ¶ added in v0.33.2
SetFlushInterval allows us to override the periodic flush interval for the WAL.
func (*BaseWAL) Wait ¶ added in v0.33.2
func (wal *BaseWAL) Wait()
Wait for the underlying autofile group to finish shutting down so it's safe to cleanup files.
func (*BaseWAL) Write ¶ added in v0.33.2
func (wal *BaseWAL) Write(msg WALMessage) error
Write is called in newStep and for each receive on the peerMsgQueue and the timeoutTicker. NOTE: does not call fsync()
func (*BaseWAL) WriteSync ¶ added in v0.33.2
func (wal *BaseWAL) WriteSync(msg WALMessage) error
WriteSync is called when we receive a msg from ourselves so that we write to disk before sending signed messages. NOTE: calls fsync()
type BlockPartMessage ¶
BlockPartMessage is sent when gossipping a piece of the proposed block.
func (*BlockPartMessage) String ¶
func (m *BlockPartMessage) String() string
String returns a string representation.
func (*BlockPartMessage) ValidateBasic ¶
func (m *BlockPartMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type DataCorruptionError ¶
type DataCorruptionError struct {
// contains filtered or unexported fields
}
DataCorruptionError is an error that occures if data on disk was corrupted.
func (DataCorruptionError) Cause ¶
func (e DataCorruptionError) Cause() error
func (DataCorruptionError) Error ¶
func (e DataCorruptionError) Error() string
type EndHeightMessage ¶
type EndHeightMessage struct {
Height int64 `json:"height"`
}
EndHeightMessage marks the end of the given height inside WAL. @internal used by scripts/wal2json util.
type Handshaker ¶
type Handshaker struct {
// contains filtered or unexported fields
}
func NewHandshaker ¶
func NewHandshaker(stateStore sm.Store, state sm.State, store sm.BlockStore, genDoc *types.GenesisDoc) *Handshaker
func (*Handshaker) Handshake ¶
func (h *Handshaker) Handshake(proxyApp proxy.AppConns) error
TODO: retry the handshake/replay if it fails ?
func (*Handshaker) NBlocks ¶
func (h *Handshaker) NBlocks() int
NBlocks returns the number of blocks applied to the state.
func (*Handshaker) ReplayBlocks ¶
func (h *Handshaker) ReplayBlocks( state sm.State, appHash []byte, appBlockHeight int64, proxyApp proxy.AppConns, ) ([]byte, error)
ReplayBlocks replays all blocks since appBlockHeight and ensures the result matches the current state. Returns the final AppHash or an error.
func (*Handshaker) SetEventBus ¶
func (h *Handshaker) SetEventBus(eventBus types.BlockEventPublisher)
SetEventBus - sets the event bus for publishing block related events. If not called, it defaults to types.NopEventBus.
func (*Handshaker) SetLogger ¶
func (h *Handshaker) SetLogger(l log.Logger)
type HasVoteMessage ¶
type HasVoteMessage struct { Height int64 Round int32 Type tmproto.SignedMsgType Index int32 }
HasVoteMessage is sent to indicate that a particular vote has been received.
func (*HasVoteMessage) String ¶
func (m *HasVoteMessage) String() string
String returns a string representation.
func (*HasVoteMessage) ValidateBasic ¶
func (m *HasVoteMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type Message ¶ added in v0.33.0
type Message interface {
ValidateBasic() error
}
Message is a message that can be sent and received on the Reactor
type Metrics ¶
type Metrics struct { // Height of the chain. Height metrics.Gauge // ValidatorLastSignedHeight of a validator. ValidatorLastSignedHeight metrics.Gauge // Number of rounds. Rounds metrics.Gauge // Number of validators. Validators metrics.Gauge // Total power of all validators. ValidatorsPower metrics.Gauge // Power of a validator. ValidatorPower metrics.Gauge // Amount of blocks missed by a validator. ValidatorMissedBlocks metrics.Gauge // Number of validators who did not sign. MissingValidators metrics.Gauge // Total power of the missing validators. MissingValidatorsPower metrics.Gauge // Number of validators who tried to double sign. ByzantineValidators metrics.Gauge // Total power of the byzantine validators. ByzantineValidatorsPower metrics.Gauge // Time between this and the last block. BlockIntervalSeconds metrics.Histogram // Number of transactions. NumTxs metrics.Gauge // Size of the block. BlockSizeBytes metrics.Gauge // Total number of transactions. TotalTxs metrics.Gauge // The latest block height. CommittedHeight metrics.Gauge // Whether or not a node is fast syncing. 1 if yes, 0 if no. FastSyncing metrics.Gauge // Whether or not a node is state syncing. 1 if yes, 0 if no. StateSyncing metrics.Gauge // Number of blockparts transmitted by peer. BlockParts metrics.Counter }
Metrics contains metrics exposed by this package.
func PrometheusMetrics ¶
PrometheusMetrics returns Metrics build using Prometheus client library. Optionally, labels can be provided along with their values ("foo", "fooValue").
type NewRoundStepMessage ¶
type NewRoundStepMessage struct { Height int64 Round int32 Step cstypes.RoundStepType SecondsSinceStartTime int64 LastCommitRound int32 }
NewRoundStepMessage is sent for every step taken in the ConsensusState. For every height/round/step transition
func (*NewRoundStepMessage) String ¶
func (m *NewRoundStepMessage) String() string
String returns a string representation.
func (*NewRoundStepMessage) ValidateBasic ¶
func (m *NewRoundStepMessage) ValidateBasic() error
ValidateBasic performs basic validation.
func (*NewRoundStepMessage) ValidateHeight ¶ added in v0.34.0
func (m *NewRoundStepMessage) ValidateHeight(initialHeight int64) error
ValidateHeight validates the height given the chain's initial height.
type NewValidBlockMessage ¶
type NewValidBlockMessage struct { Height int64 Round int32 BlockPartSetHeader types.PartSetHeader BlockParts *bits.BitArray IsCommit bool }
NewValidBlockMessage is sent when a validator observes a valid block B in some round r, i.e., there is a Proposal for block B and 2/3+ prevotes for the block B in the round r. In case the block is also committed, then IsCommit flag is set to true.
func (*NewValidBlockMessage) String ¶
func (m *NewValidBlockMessage) String() string
String returns a string representation.
func (*NewValidBlockMessage) ValidateBasic ¶
func (m *NewValidBlockMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type PeerState ¶
type PeerState struct { PRS cstypes.PeerRoundState `json:"round_state"` // Exposed. Stats *peerStateStats `json:"stats"` // Exposed. // contains filtered or unexported fields }
PeerState contains the known state of a peer, including its connection and threadsafe access to its PeerRoundState. NOTE: THIS GETS DUMPED WITH rpc/core/consensus.go. Be mindful of what you Expose.
func NewPeerState ¶
NewPeerState returns a new PeerState for the given Peer
func (*PeerState) ApplyHasVoteMessage ¶
func (ps *PeerState) ApplyHasVoteMessage(msg *HasVoteMessage)
ApplyHasVoteMessage updates the peer state for the new vote.
func (*PeerState) ApplyNewRoundStepMessage ¶
func (ps *PeerState) ApplyNewRoundStepMessage(msg *NewRoundStepMessage)
ApplyNewRoundStepMessage updates the peer state for the new round.
func (*PeerState) ApplyNewValidBlockMessage ¶
func (ps *PeerState) ApplyNewValidBlockMessage(msg *NewValidBlockMessage)
ApplyNewValidBlockMessage updates the peer state for the new valid block.
func (*PeerState) ApplyProposalPOLMessage ¶
func (ps *PeerState) ApplyProposalPOLMessage(msg *ProposalPOLMessage)
ApplyProposalPOLMessage updates the peer state for the new proposal POL.
func (*PeerState) ApplyVoteSetBitsMessage ¶
func (ps *PeerState) ApplyVoteSetBitsMessage(msg *VoteSetBitsMessage, ourVotes *bits.BitArray)
ApplyVoteSetBitsMessage updates the peer state for the bit-array of votes it claims to have for the corresponding BlockID. `ourVotes` is a BitArray of votes we have for msg.BlockID NOTE: if ourVotes is nil (e.g. msg.Height < rs.Height), we conservatively overwrite ps's votes w/ msg.Votes.
func (*PeerState) BlockPartsSent ¶
BlockPartsSent returns the number of useful block parts the peer has sent us.
func (*PeerState) EnsureVoteBitArrays ¶
EnsureVoteBitArrays ensures the bit-arrays have been allocated for tracking what votes this peer has received. NOTE: It's important to make sure that numValidators actually matches what the node sees as the number of validators for height.
func (*PeerState) GetHeight ¶
GetHeight returns an atomic snapshot of the PeerRoundState's height used by the mempool to ensure peers are caught up before broadcasting new txs
func (*PeerState) GetRoundState ¶
func (ps *PeerState) GetRoundState() *cstypes.PeerRoundState
GetRoundState returns an shallow copy of the PeerRoundState. There's no point in mutating it since it won't change PeerState.
func (*PeerState) InitProposalBlockParts ¶
func (ps *PeerState) InitProposalBlockParts(partSetHeader types.PartSetHeader)
InitProposalBlockParts initializes the peer's proposal block parts header and bit array.
func (*PeerState) PickSendVote ¶
func (ps *PeerState) PickSendVote(votes types.VoteSetReader) bool
PickSendVote picks a vote and sends it to the peer. Returns true if vote was sent.
func (*PeerState) PickVoteToSend ¶
PickVoteToSend picks a vote to send to the peer. Returns true if a vote was picked. NOTE: `votes` must be the correct Size() for the Height().
func (*PeerState) RecordBlockPart ¶
RecordBlockPart increments internal block part related statistics for this peer. It returns the total number of added block parts.
func (*PeerState) RecordVote ¶
RecordVote increments internal votes related statistics for this peer. It returns the total number of added votes.
func (*PeerState) SetHasProposal ¶
SetHasProposal sets the given proposal as known for the peer.
func (*PeerState) SetHasProposalBlockPart ¶
SetHasProposalBlockPart sets the given block part index as known for the peer.
func (*PeerState) SetHasVote ¶
SetHasVote sets the given vote as known by the peer
func (*PeerState) SetLogger ¶
SetLogger allows to set a logger on the peer state. Returns the peer state itself.
func (*PeerState) StringIndented ¶
StringIndented returns a string representation of the PeerState
type ProposalMessage ¶
ProposalMessage is sent when a new block is proposed.
func (*ProposalMessage) String ¶
func (m *ProposalMessage) String() string
String returns a string representation.
func (*ProposalMessage) ValidateBasic ¶
func (m *ProposalMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type ProposalPOLMessage ¶
ProposalPOLMessage is sent when a previous proposal is re-proposed.
func (*ProposalPOLMessage) String ¶
func (m *ProposalPOLMessage) String() string
String returns a string representation.
func (*ProposalPOLMessage) ValidateBasic ¶
func (m *ProposalPOLMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type Reactor ¶ added in v0.33.0
type Reactor struct { p2p.BaseReactor // BaseService + p2p.Switch Metrics *Metrics // contains filtered or unexported fields }
Reactor defines a reactor for the consensus service.
func NewReactor ¶ added in v0.33.0
func NewReactor(consensusState *State, waitSync bool, options ...ReactorOption) *Reactor
NewReactor returns a new Reactor with the given consensusState.
func (*Reactor) AddPeer ¶ added in v0.33.0
AddPeer implements Reactor by spawning multiple gossiping goroutines for the peer.
func (*Reactor) GetChannels ¶ added in v0.33.0
func (conR *Reactor) GetChannels() []*p2p.ChannelDescriptor
GetChannels implements Reactor
func (*Reactor) InitPeer ¶ added in v0.33.0
InitPeer implements Reactor by creating a state for the peer.
func (*Reactor) OnStart ¶ added in v0.33.0
OnStart implements BaseService by subscribing to events, which later will be broadcasted to other peers and starting state if we're not in fast sync.
func (*Reactor) OnStop ¶ added in v0.33.0
func (conR *Reactor) OnStop()
OnStop implements BaseService by unsubscribing from events and stopping state.
func (*Reactor) Receive ¶ added in v0.33.0
Receive implements Reactor NOTE: We process these messages even when we're fast_syncing. Messages affect either a peer state or the consensus state. Peer state updates can happen in parallel, but processing of proposals, block parts, and votes are ordered by the receiveRoutine NOTE: blocks on consensus state for proposals, block parts, and votes
func (*Reactor) RemovePeer ¶ added in v0.33.0
RemovePeer is a noop.
func (*Reactor) SetEventBus ¶ added in v0.33.0
SetEventBus sets event bus.
func (*Reactor) String ¶ added in v0.33.0
String returns a string representation of the Reactor. NOTE: For now, it is just a hard-coded string to avoid accessing unprotected shared variables. TODO: improve!
func (*Reactor) StringIndented ¶ added in v0.33.0
StringIndented returns an indented string representation of the Reactor
func (*Reactor) SwitchToConsensus ¶ added in v0.33.0
SwitchToConsensus switches from fast_sync mode to consensus mode. It resets the state, turns off fast_sync, and starts the consensus state-machine
type ReactorOption ¶
type ReactorOption func(*Reactor)
func ReactorMetrics ¶
func ReactorMetrics(metrics *Metrics) ReactorOption
ReactorMetrics sets the metrics
type State ¶ added in v0.33.0
type State struct { service.BaseService cstypes.RoundState // contains filtered or unexported fields }
State handles execution of the consensus algorithm. It processes votes and proposals, and upon reaching agreement, commits blocks to the chain and executes them against the application. The internal state machine receives input from peers, the internal validator, and from a timer.
func NewState ¶ added in v0.33.0
func NewState( config *cfg.ConsensusConfig, state sm.State, blockExec *sm.BlockExecutor, blockStore sm.BlockStore, txNotifier txNotifier, evpool evidencePool, options ...StateOption, ) *State
NewState returns a new State.
func (*State) AddProposalBlockPart ¶ added in v0.33.0
func (cs *State) AddProposalBlockPart(height int64, round int32, part *types.Part, peerID p2p.ID) error
AddProposalBlockPart inputs a part of the proposal block.
func (*State) GetLastHeight ¶ added in v0.33.0
GetLastHeight returns the last height committed. If there were no blocks, returns 0.
func (*State) GetRoundState ¶ added in v0.33.0
func (cs *State) GetRoundState() *cstypes.RoundState
GetRoundState returns a shallow copy of the internal consensus state.
func (*State) GetRoundStateJSON ¶ added in v0.33.0
GetRoundStateJSON returns a json of RoundState.
func (*State) GetRoundStateSimpleJSON ¶ added in v0.33.0
GetRoundStateSimpleJSON returns a json of RoundStateSimple
func (*State) GetValidators ¶ added in v0.33.0
GetValidators returns a copy of the current validators.
func (*State) LoadCommit ¶ added in v0.33.0
LoadCommit loads the commit for a given height.
func (*State) OnStart ¶ added in v0.33.0
OnStart loads the latest state via the WAL, and starts the timeout and receive routines.
func (*State) OnStop ¶ added in v0.33.0
func (cs *State) OnStop()
OnStop implements service.Service.
func (*State) OpenWAL ¶ added in v0.33.0
OpenWAL opens a file to log all consensus messages and timeouts for deterministic accountability.
func (*State) ReplayFile ¶ added in v0.33.0
Replay msgs in file or start the console
func (*State) SetEventBus ¶ added in v0.33.0
SetEventBus sets event bus.
func (*State) SetPrivValidator ¶ added in v0.33.0
func (cs *State) SetPrivValidator(priv types.PrivValidator)
SetPrivValidator sets the private validator account for signing votes. It immediately requests pubkey and caches it.
func (*State) SetProposal ¶ added in v0.33.0
SetProposal inputs a proposal.
func (*State) SetProposalAndBlock ¶ added in v0.33.0
func (cs *State) SetProposalAndBlock( proposal *types.Proposal, block *types.Block, parts *types.PartSet, peerID p2p.ID, ) error
SetProposalAndBlock inputs the proposal and all block parts.
func (*State) SetTimeoutTicker ¶ added in v0.33.0
func (cs *State) SetTimeoutTicker(timeoutTicker TimeoutTicker)
SetTimeoutTicker sets the local timer. It may be useful to overwrite for testing.
type StateOption ¶
type StateOption func(*State)
StateOption sets an optional parameter on the State.
type TimedWALMessage ¶
type TimedWALMessage struct { Time time.Time `json:"time"` Msg WALMessage `json:"msg"` }
TimedWALMessage wraps WALMessage and adds Time for debugging purposes.
type TimeoutTicker ¶
type TimeoutTicker interface { Start() error Stop() error Chan() <-chan timeoutInfo // on which to receive a timeout ScheduleTimeout(ti timeoutInfo) // reset the timer SetLogger(log.Logger) }
TimeoutTicker is a timer that schedules timeouts conditional on the height/round/step in the timeoutInfo. The timeoutInfo.Duration may be non-positive.
func NewTimeoutTicker ¶
func NewTimeoutTicker() TimeoutTicker
NewTimeoutTicker returns a new TimeoutTicker.
type VoteMessage ¶
VoteMessage is sent when voting for a proposal (or lack thereof).
func (*VoteMessage) String ¶
func (m *VoteMessage) String() string
String returns a string representation.
func (*VoteMessage) ValidateBasic ¶
func (m *VoteMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type VoteSetBitsMessage ¶
type VoteSetBitsMessage struct { Height int64 Round int32 Type tmproto.SignedMsgType BlockID types.BlockID Votes *bits.BitArray }
VoteSetBitsMessage is sent to communicate the bit-array of votes seen for the BlockID.
func (*VoteSetBitsMessage) String ¶
func (m *VoteSetBitsMessage) String() string
String returns a string representation.
func (*VoteSetBitsMessage) ValidateBasic ¶
func (m *VoteSetBitsMessage) ValidateBasic() error
ValidateBasic performs basic validation.
type VoteSetMaj23Message ¶
type VoteSetMaj23Message struct { Height int64 Round int32 Type tmproto.SignedMsgType BlockID types.BlockID }
VoteSetMaj23Message is sent to indicate that a given BlockID has seen +2/3 votes.
func (*VoteSetMaj23Message) String ¶
func (m *VoteSetMaj23Message) String() string
String returns a string representation.
func (*VoteSetMaj23Message) ValidateBasic ¶
func (m *VoteSetMaj23Message) ValidateBasic() error
ValidateBasic performs basic validation.
type WAL ¶
type WAL interface { Write(WALMessage) error WriteSync(WALMessage) error FlushAndSync() error SearchForEndHeight(height int64, options *WALSearchOptions) (rd io.ReadCloser, found bool, err error) // service methods Start() error Stop() error Wait() }
WAL is an interface for any write-ahead logger.
type WALDecoder ¶
type WALDecoder struct {
// contains filtered or unexported fields
}
A WALDecoder reads and decodes custom-encoded WAL messages from an input stream. See WALEncoder for the format used.
It will also compare the checksums and make sure data size is equal to the length from the header. If that is not the case, error will be returned.
func NewWALDecoder ¶
func NewWALDecoder(rd io.Reader) *WALDecoder
NewWALDecoder returns a new decoder that reads from rd.
func (*WALDecoder) Decode ¶
func (dec *WALDecoder) Decode() (*TimedWALMessage, error)
Decode reads the next custom-encoded value from its reader and returns it.
type WALEncoder ¶
type WALEncoder struct {
// contains filtered or unexported fields
}
A WALEncoder writes custom-encoded WAL messages to an output stream.
Format: 4 bytes CRC sum + 4 bytes length + arbitrary-length value
func NewWALEncoder ¶
func NewWALEncoder(wr io.Writer) *WALEncoder
NewWALEncoder returns a new encoder that writes to wr.
func (*WALEncoder) Encode ¶
func (enc *WALEncoder) Encode(v *TimedWALMessage) error
Encode writes the custom encoding of v to the stream. It returns an error if the encoded size of v is greater than 1MB. Any error encountered during the write is also returned.
type WALMessage ¶
type WALMessage interface{}
func WALFromProto ¶ added in v0.34.0
func WALFromProto(msg *tmcons.WALMessage) (WALMessage, error)
WALFromProto takes a proto wal message and return a consensus walMessage and error
type WALSearchOptions ¶
type WALSearchOptions struct { // IgnoreDataCorruptionErrors set to true will result in skipping data corruption errors. IgnoreDataCorruptionErrors bool }
WALSearchOptions are optional arguments to SearchForEndHeight.