vote

Documentation

Index

• type Backend
• type VoteBox
• type VoteJournal
  • func NewVoteJournal(filePath string) (*VoteJournal, error)
  • func (journal *VoteJournal) ReadVote(index uint64) (*types.VoteEnvelope, error)
  • func (journal *VoteJournal) WriteVote(voteMessage *types.VoteEnvelope) error
• type VoteManager
  • func NewVoteManager(eth Backend, chain *core.BlockChain, pool *VotePool, ...) (*VoteManager, error)
  • func (voteManager *VoteManager) UnderRules(header *types.Header) (bool, uint64, common.Hash)
• type VotePool
  • func NewVotePool(chain *core.BlockChain, engine consensus.PoSA) *VotePool
  • func (pool *VotePool) FetchVoteByBlockHash(blockHash common.Hash) []*types.VoteEnvelope
  • func (pool *VotePool) GetVotes() []*types.VoteEnvelope
  • func (pool *VotePool) PutVote(vote *types.VoteEnvelope)
  • func (pool *VotePool) SubscribeNewVoteEvent(ch chan<- core.NewVoteEvent) event.Subscription
• type VoteSigner
  • func NewVoteSigner(blsPasswordPath, blsWalletPath string) (*VoteSigner, error)
  • func (signer *VoteSigner) SignVote(vote *types.VoteEnvelope) error

Types

type Backend

type Backend interface {
	IsMining() bool
	EventMux() *event.TypeMux
}

Backend wraps all methods required for voting.

type VoteBox

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

type VoteJournal

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

func NewVoteJournal

func NewVoteJournal(filePath string) (*VoteJournal, error)

func (*VoteJournal) ReadVote

func (journal *VoteJournal) ReadVote(index uint64) (*types.VoteEnvelope, error)

func (*VoteJournal) WriteVote

func (journal *VoteJournal) WriteVote(voteMessage *types.VoteEnvelope) error

type VoteManager

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

VoteManager will handle the vote produced by self.

func NewVoteManager

func NewVoteManager(eth Backend, chain *core.BlockChain, pool *VotePool, journalPath, blsPasswordPath, blsWalletPath string, engine consensus.PoSA) (*VoteManager, error)

func (*VoteManager) UnderRules

func (voteManager *VoteManager) UnderRules(header *types.Header) (bool, uint64, common.Hash)

UnderRules checks if the produced header under the following rules: A validator must not publish two distinct votes for the same height. (Rule 1) A validator must not vote within the span of its other votes . (Rule 2) Validators always vote for their canonical chain’s latest block. (Rule 3)

type VotePool

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

func NewVotePool

func NewVotePool(chain *core.BlockChain, engine consensus.PoSA) *VotePool

func (*VotePool) FetchVoteByBlockHash

func (pool *VotePool) FetchVoteByBlockHash(blockHash common.Hash) []*types.VoteEnvelope

func (*VotePool) GetVotes

func (pool *VotePool) GetVotes() []*types.VoteEnvelope

GetVotes as batch.

func (*VotePool) PutVote

func (pool *VotePool) PutVote(vote *types.VoteEnvelope)

func (*VotePool) SubscribeNewVoteEvent

func (pool *VotePool) SubscribeNewVoteEvent(ch chan<- core.NewVoteEvent) event.Subscription

type VoteSigner

type VoteSigner struct {
	PubKey [48]byte
	// contains filtered or unexported fields
}

func NewVoteSigner

func NewVoteSigner(blsPasswordPath, blsWalletPath string) (*VoteSigner, error)

func (*VoteSigner) SignVote

func (signer *VoteSigner) SignVote(vote *types.VoteEnvelope) error