evidence

Documentation

Index

• Constants
• func RegisterMessages(cdc *amino.Codec)
• func RegisterMockEvidences()
• type ErrEvidenceAlreadyStored
  • func (e ErrEvidenceAlreadyStored) Error() string
• type ErrInvalidEvidence
  • func (e ErrInvalidEvidence) Error() string
• type Info
• type ListMessage
  • func (m *ListMessage) String() string
  • func (m *ListMessage) ValidateBasic() error
• type Message
• type PeerState
• type Pool
  • func NewPool(stateDB, evidenceDB dbm.DB) *Pool
  • func (evpool *Pool) AddEvidence(evidence types.Evidence) error
  • func (evpool *Pool) EvidenceFront() *clist.CElement
  • func (evpool *Pool) EvidenceWaitChan() <-chan struct{}
  • func (evpool *Pool) IsCommitted(evidence types.Evidence) bool
  • func (evpool *Pool) MarkEvidenceAsCommitted(height int64, lastBlockTime time.Time, evidence []types.Evidence)
  • func (evpool *Pool) PendingEvidence(maxNum int64) []types.Evidence
  • func (evpool *Pool) PriorityEvidence() []types.Evidence
  • func (evpool *Pool) SetLogger(l log.Logger)
  • func (evpool *Pool) State() sm.State
  • func (evpool *Pool) Update(block *types.Block, state sm.State)
• type Reactor
  • func NewReactor(evpool *Pool) *Reactor
  • func (evR *Reactor) AddPeer(peer p2p.Peer)
  • func (evR *Reactor) GetChannels() []*p2p.ChannelDescriptor
  • func (evR *Reactor) Receive(chID byte, src p2p.Peer, msgBytes []byte)
  • func (evR *Reactor) SetEventBus(b *types.EventBus)
  • func (evR *Reactor) SetLogger(l log.Logger)
• type Store
  • func NewStore(db dbm.DB) *Store
  • func (store *Store) AddNewEvidence(evidence types.Evidence, priority int64) (bool, error)
  • func (store *Store) GetInfo(height int64, hash []byte) Info
  • func (store *Store) Has(evidence types.Evidence) bool
  • func (store *Store) MarkEvidenceAsBroadcasted(evidence types.Evidence)
  • func (store *Store) MarkEvidenceAsCommitted(evidence types.Evidence)
  • func (store *Store) PendingEvidence(maxNum int64) (evidence []types.Evidence)
  • func (store *Store) PriorityEvidence() (evidence []types.Evidence)

Constants

const (
	EvidenceChannel = byte(0x38)
)

Functions

func RegisterMessages

func RegisterMessages(cdc *amino.Codec)

func RegisterMockEvidences

func RegisterMockEvidences()

For testing purposes only

Types

type ErrEvidenceAlreadyStored

type ErrEvidenceAlreadyStored struct{}

ErrEvidenceAlreadyStored indicates that the evidence has already been stored in the evidence db

func (ErrEvidenceAlreadyStored) Error

func (e ErrEvidenceAlreadyStored) Error() string

type ErrInvalidEvidence

type ErrInvalidEvidence struct {
	Reason error
}

ErrInvalidEvidence returns when evidence failed to validate

func (ErrInvalidEvidence) Error

func (e ErrInvalidEvidence) Error() string

type Info

type Info struct {
	Committed bool
	Priority  int64
	Evidence  types.Evidence
}

type ListMessage

type ListMessage struct {
	Evidence []types.Evidence
}

ListMessage contains a list of evidence.

func (*ListMessage) String

func (m *ListMessage) String() string

String returns a string representation of the ListMessage.

func (*ListMessage) ValidateBasic

func (m *ListMessage) ValidateBasic() error

ValidateBasic performs basic validation.

type Message

type Message interface {
	ValidateBasic() error
}

Message is a message sent or received by the Reactor.

type PeerState

type PeerState interface {
	GetHeight() int64
}

PeerState describes the state of a peer.

type Pool

type Pool struct {
	// contains filtered or unexported fields
}

Pool maintains a pool of valid evidence in an Store.

func NewPool

func NewPool(stateDB, evidenceDB dbm.DB) *Pool

func (*Pool) AddEvidence

func (evpool *Pool) AddEvidence(evidence types.Evidence) error

AddEvidence checks the evidence is valid and adds it to the pool.

func (*Pool) EvidenceFront

func (evpool *Pool) EvidenceFront() *clist.CElement

func (*Pool) EvidenceWaitChan

func (evpool *Pool) EvidenceWaitChan() <-chan struct{}

func (*Pool) IsCommitted

func (evpool *Pool) IsCommitted(evidence types.Evidence) bool

IsCommitted returns true if we have already seen this exact evidence and it is already marked as committed.

func (*Pool) MarkEvidenceAsCommitted

func (evpool *Pool) MarkEvidenceAsCommitted(height int64, lastBlockTime time.Time, evidence []types.Evidence)

MarkEvidenceAsCommitted marks all the evidence as committed and removes it from the queue.

func (*Pool) PendingEvidence

func (evpool *Pool) PendingEvidence(maxNum int64) []types.Evidence

PendingEvidence returns up to maxNum uncommitted evidence. If maxNum is -1, all evidence is returned.

func (*Pool) PriorityEvidence

func (evpool *Pool) PriorityEvidence() []types.Evidence

PriorityEvidence returns the priority evidence.

func (*Pool) SetLogger

func (evpool *Pool) SetLogger(l log.Logger)

SetLogger sets the Logger.

func (*Pool) State

func (evpool *Pool) State() sm.State

State returns the current state of the evpool.

func (*Pool) Update

func (evpool *Pool) Update(block *types.Block, state sm.State)

Update loads the latest

type Reactor

type Reactor struct {
	p2p.BaseReactor
	// contains filtered or unexported fields
}

Reactor handles evpool evidence broadcasting amongst peers.

func NewReactor

func NewReactor(evpool *Pool) *Reactor

NewReactor returns a new Reactor with the given config and evpool.

func (*Reactor) AddPeer

func (evR *Reactor) AddPeer(peer p2p.Peer)

AddPeer implements Reactor.

func (*Reactor) GetChannels

func (evR *Reactor) GetChannels() []*p2p.ChannelDescriptor

GetChannels implements Reactor. It returns the list of channels for this reactor.

func (*Reactor) Receive

func (evR *Reactor) Receive(chID byte, src p2p.Peer, msgBytes []byte)

Receive implements Reactor. It adds any received evidence to the evpool.

func (*Reactor) SetEventBus

func (evR *Reactor) SetEventBus(b *types.EventBus)

SetEventBus implements events.Eventable.

func (*Reactor) SetLogger

func (evR *Reactor) SetLogger(l log.Logger)

SetLogger sets the Logger on the reactor and the underlying Evidence.

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store is a store of all the evidence we've seen, including evidence that has been committed, evidence that has been verified but not broadcast, and evidence that has been broadcast but not yet committed.

func NewStore

func NewStore(db dbm.DB) *Store

func (*Store) AddNewEvidence

func (store *Store) AddNewEvidence(evidence types.Evidence, priority int64) (bool, error)

AddNewEvidence adds the given evidence to the database. It returns false if the evidence is already stored.

func (*Store) GetInfo

func (store *Store) GetInfo(height int64, hash []byte) Info

GetInfo fetches the Info with the given height and hash. If not found, ei.Evidence is nil.

func (*Store) Has

func (store *Store) Has(evidence types.Evidence) bool

Has checks if the evidence is already stored

func (*Store) MarkEvidenceAsBroadcasted

func (store *Store) MarkEvidenceAsBroadcasted(evidence types.Evidence)

MarkEvidenceAsBroadcasted removes evidence from Outqueue.

func (*Store) MarkEvidenceAsCommitted

func (store *Store) MarkEvidenceAsCommitted(evidence types.Evidence)

MarkEvidenceAsCommitted removes evidence from pending and outqueue and sets the state to committed.

func (*Store) PendingEvidence

func (store *Store) PendingEvidence(maxNum int64) (evidence []types.Evidence)

PendingEvidence returns up to maxNum known, uncommitted evidence. If maxNum is -1, all evidence is returned.

func (*Store) PriorityEvidence

func (store *Store) PriorityEvidence() (evidence []types.Evidence)

PriorityEvidence returns the evidence from the outqueue, sorted by highest priority.