ucon

package

Go to main page

Versions in this module

v1

v1.0.0

Jan 14, 2021

Changes in this version

type Server

+ func (s *Server) CurrentYouParams() *params.YouParams

v0

v0.10.2

Oct 12, 2020

Changes in this version

type MessageHandler

+ func (mh *MessageHandler) UpdateAllowedFutureMsgTime(t time.Duration)

v0.10.1

Oct 11, 2020

v0.10.0

Sep 16, 2020

v0.9.9

Jun 22, 2020

v0.9.8

Jun 2, 2020

v0.9.7

May 31, 2020

v0.9.6

May 20, 2020

Changes in this version

type Server

+ func (s *Server) Pause() error

+ func (s *Server) Resume() error

type TimerManager

+ func (tm *TimerManager) Pause()

v0.9.5

May 20, 2020

Changes in this version

+ const CertValProportionThreshold

+ const DefaultMsgTimerProportion

+ const DefaultStartVoteProportion

+ const MaxCachedMsgsCount

+ const MaxMsgsSingleInterval

+ const MsgNameBlock

+ const MsgNameCert

+ const MsgNameNext

+ const MsgNamePrecommit

+ const MsgNamePrevote

+ const MsgNamePriority

+ const OutdateFaultTolerance

+ const PriorityMsgSize

+ const RoundIndexHashLength

+ const UConStepCertificate

+ const UConStepPrecommit

+ const UConStepPrevote

+ const UConStepProposal

+ const UConStepStart

+ const ValidatorProportionThreshold

+ const VoteMsgSize

+ const VrfHashSizeInBits

+ var ErrInvalidConsensusData = errors.New("invalid consensus data")

+ var ErrInvalidConsensusMsg = errors.New("invalid consensus message")

+ func AddrTypeKey(address common.Address, voteType VoteType, index uint8) []byte

+ func CompareCommonHash(p1, p2 common.Hash) int

+ func ComputeSeed(sk vrf.PrivateKey, round *big.Int, roundIndex uint32, preSeed common.Hash) (seed common.Hash, proof []byte)

+ func Encode(val interface{}) ([]byte, error)

+ func GenerateEmptyBlock(parent *types.Block, sk *ecdsa.PrivateKey) *types.Block

+ func GetInfoFromHash(h RoundIndexHash) (uint64, uint32)

+ func GetSignatureAddress(data []byte, sig []byte) (common.Address, error)

+ func GetSignaturePublicKey(data []byte, sig []byte) (*ecdsa.PublicKey, error)

+ func GetVoteFromBool(vote bool) uint32

+ func MakeM(seed common.Hash, role uint32, index uint32) []byte

+ func MessageCodeToString(code MsgType) string

+ func MillionSecond(time time.Time) int64

+ func OppositeValidatorType(kind params.ValidatorKind) params.ValidatorKind

+ func OverThreshold(count uint32, threshold uint64, isPos bool) bool

+ func PrepareConsensusData(header *types.Header, data *BlockConsensusData) ([]byte, error)

+ func ProbabilityForLimitedSampleing(communitySize int64, threshold float64, k uint32) float64

+ func ProbabilityForSampleing(threshold float64, k uint32) float64

+ func ProbabilityForViolateCondition1(honest, threshold, portion float64) float64

+ func Sign(key *ecdsa.PrivateKey, data []byte) ([]byte, error)

+ func VerifySignature(vote *VoteItem, address common.Address) bool

+ func VoteTypeToString(voteType VoteType) string

+ func VrfComputePriority(hash common.Hash, j uint32) common.Hash

+ func VrfSortition(sk vrf.PrivateKey, seed common.Hash, index uint32, role uint32, ...) (common.Hash, []byte, uint32)

+ func VrfVerifyPriority(pk vrf.PublicKey, seed common.Hash, index uint32, role uint32, proof []byte, ...) (bool, error)

+ func VrfVerifySortition(pk vrf.PublicKey, seed common.Hash, index uint32, role uint32, proof []byte, ...) (bool, error)

+ type AddrVoteStatus struct

+ DoubleVoted bool

+ Hash common.Hash

+ Signature []byte

+ type AddrVoteType uint8

+ type AddressMap map[common.Address]*AddressMsgInfo

+ type AddressMsgInfo struct

+ type AddressMsgs struct

+ func NewAddressMsgs() *AddressMsgs

+ func (am *AddressMsgs) NewAddressMsg(ev ReceivedMsgEvent, validatorKind params.ValidatorKind, ...) (oldOver, futureOver, isValid bool)

+ type BlockConsensusData struct

+ CertValThreshold uint64

+ Priority common.Hash

+ ProposerThreshold uint64

+ Round *big.Int

+ RoundIndex uint32

+ Seed common.Hash

+ Signature []byte

+ SortitionProof []byte

+ SubUsers uint32

+ ValidatorThreshold uint64

+ func ExtractConsensusData(header *types.Header) (*BlockConsensusData, error)

+ func GetConsensusDataFromHeader(header *types.Header) (*BlockConsensusData, error)

+ func (data *BlockConsensusData) GetPublicKey() (*ecdsa.PublicKey, error)

+ func (data *BlockConsensusData) IsValidRound() (bool, error)

+ func (data *BlockConsensusData) IsValidSeed() (bool, error)

+ func (data *BlockConsensusData) IsValidTime() (bool, error)

+ func (data *BlockConsensusData) SetSignature(key *ecdsa.PrivateKey) error

+ type BlockHashWithMaxPriorityFn func(round *big.Int, roundIndex uint32) (common.Hash, common.Hash, bool)

+ type BlockHashWithVotes struct

+ BlockHash common.Hash

+ Priority common.Hash

+ Round *big.Int

+ RoundIndex uint32

+ Timestamp uint64

+ Vote *SingleVote

+ type BlockProposalEvent struct

+ Block *types.Block

+ type BlsVerifier struct

+ func NewBlsVerifier(mgr bls.BlsManager) *BlsVerifier

+ func (v *BlsVerifier) AggregateSignatures(rawSigs [][]byte) (aggregatedSig []byte, err error)

+ func (v *BlsVerifier) GetBlsPubKey(bspubKey []byte) (bls.PublicKey, error)

+ func (v *BlsVerifier) GetBlsSig(sig []byte) (bls.Signature, error)

+ func (v *BlsVerifier) GetVrfPubKey(bspubKey []byte) (*ecdsa.PublicKey, error)

+ func (v *BlsVerifier) PackVotes(ev CommitEvent, backType params.LookBackType) (*UconValidators, error)

+ func (v *BlsVerifier) RecoverSignerInfo(vs *state.Validators, vote *SingleVote) (signer *state.Validator, pk bls.PublicKey, vrfpk *ecdsa.PublicKey, err error)

+ type CachedBlockMessage struct

+ func (m *CachedBlockMessage) GetContext() (*big.Int, uint32)

+ func (m *CachedBlockMessage) Hash() common.Hash

+ type CachedMessage interface

+ GetContext func() (*big.Int, uint32)

+ Hash func() common.Hash

+ type CachedMsgMgr struct

+ func InitCachedMessages() *CachedMsgMgr

+ func (c *CachedMsgMgr) Clear(round uint64, roundIndex uint32)

+ func (c *CachedMsgMgr) GetMessages(round uint64, roundIndex uint32, code MsgType) CachedMsgs

+ func (c *CachedMsgMgr) NewMessage(msg CachedMessage, code MsgType, addr common.Address, timestamp time.Time)

+ func (c *CachedMsgMgr) RemoveMessages(round uint64, roundIndex uint32, code MsgType)

+ type CachedMsgs []CachedMessage

+ type CachedPriorityMessage struct

+ func (m *CachedPriorityMessage) GetContext() (*big.Int, uint32)

+ func (m *CachedPriorityMessage) Hash() common.Hash

+ type CachedVotesMessage struct

+ VotesData *BlockHashWithVotes

+ func (m *CachedVotesMessage) GetContext() (*big.Int, uint32)

+ func (m *CachedVotesMessage) Hash() common.Hash

+ type CommitEvent struct

+ Block *types.Block

+ ChamberCerts VotesInfoForBlockHash

+ ChamberPrecommits VotesInfoForBlockHash

+ HousePrecommits VotesInfoForBlockHash

+ Round *big.Int

+ RoundIndex uint32

+ type ConsensusCommon struct

+ BlockHash common.Hash

+ ParentHash common.Hash

+ Priority common.Hash

+ Round *big.Int

+ RoundIndex uint32

+ SortitionProof []byte

+ Step uint32

+ SubUsers uint32

+ Timestamp uint64

+ type ContextChangeEvent struct

+ Certificate bool

+ Round *big.Int

+ RoundIndex uint32

+ Step uint32

+ type DatabaseDeleter interface

+ Delete func(key []byte) error

+ type DatabaseReader interface

+ Get func(key []byte) ([]byte, error)

+ Has func(key []byte) (bool, error)

+ type DatabaseWriter interface

+ Put func(key []byte, value []byte) error

+ type GetBlockInCacheFn func(blockHash common.Hash, priority common.Hash) *types.Block

+ type GetCurrentParamsFn func() *params.CaravelParams

+ type GetLookBackValidatorFn func(round *big.Int, addr common.Address, lbType params.LookBackType) (*state.Validator, bool)

+ type InvalidMsgMaker struct

+ func (m *InvalidMsgMaker) DecodeFailedMsg() []byte

+ func (m *InvalidMsgMaker) DecodePayloadFailed() []byte

+ func (m *InvalidMsgMaker) EmptyRound() []byte

+ func (m *InvalidMsgMaker) InvalidAddress() []byte

+ func (m *InvalidMsgMaker) InvalidSignature() []byte

+ func (m *InvalidMsgMaker) InvalidSize() []byte

+ func (m *InvalidMsgMaker) InvalidVoteMsg() []byte

+ type IsValidatorFn func(round *big.Int, roundIndex uint32, step uint32, lbType params.LookBackType) (bool, *StepView)

+ type LookBackMgr interface

+ CurrentCaravelParams func() *params.CaravelParams

+ GetLookBackVldReader func(cp *params.CaravelParams, num *big.Int, lbType params.LookBackType) (state.ValidatorReader, error)

+ type MarkedBlockInfo struct

+ Block *types.Block

+ BlockHash common.Hash

+ Priority common.Hash

+ Round *big.Int

+ RoundIndex uint32

+ type Message struct

+ Code MsgType

+ Payload []byte

+ Signature []byte

+ func Decode(b []byte) (*Message, error)

+ func (m *Message) DecodePayload(val interface{}) error

+ func (m *Message) DecodeRLP(s *rlp.Stream) error

+ func (m *Message) Encode() ([]byte, error)

+ func (m *Message) EncodeNoSig() ([]byte, error)

+ func (m *Message) EncodeRLP(w io.Writer) error

+ func (m *Message) PayloadHash() common.Hash

+ type MessageEvent struct

+ Code string

+ Payload []byte

+ Round *big.Int

+ type MessageHandler struct

+ func NewMessageHandler(rawSk *ecdsa.PrivateKey, eventMux *event.TypeMux, ...) *MessageHandler

+ func (mh *MessageHandler) HandleMsg(data []byte, receivedAt time.Time) error

+ func (mh *MessageHandler) Start()

+ func (mh *MessageHandler) Stop()

+ type MsgReceivedStatus uint8

+ type MsgType uint8

+ func StringToMessageCode(code string) MsgType

+ func VoteTypeToMsgCode(voteType VoteType) MsgType

+ type OverThresholdFn func(voteType VoteType, count uint32) bool

+ type PriorityForRound map[common.Hash]common.Hash

+ type PriorityManager struct

+ func NewPriorityMgr() *PriorityManager

+ type PriorityMsgEvent struct

+ Msg *CachedPriorityMessage

+ type ProcessPriorityMsg func(msg *CachedPriorityMessage, status MsgReceivedStatus) (error, bool)

+ type ProcessProposedBlockMsg func(msg *CachedBlockMessage, status MsgReceivedStatus) (error, bool)

+ type ProcessReceivedMsgFn func(event ReceivedMsgEvent) (error, bool)

+ type ProcessStepFn func(step uint32)

+ type ProcessTimeoutFn func(round *big.Int, roundIndex uint32)

+ type ProcessVoteMsg func(ev VoteMsgEvent, status MsgReceivedStatus) (error, bool)

+ type Proposal struct

+ func NewProposal(eventMux *event.TypeMux, verifyFn VerifyPriorityFn, startVoteFn StartVoteFn) *Proposal

+ func (p *Proposal) Start()

+ func (p *Proposal) Stop()

+ type ProposedBlockMsgEvent struct

+ Msg *CachedBlockMessage

+ type ReceivedMsgEvent struct

+ Addr common.Address

+ ReceivedAt time.Time

+ Round *big.Int

+ RoundIndex uint32

+ SendAt uint64

+ type RoundIndexChangeEvent struct

+ BlockHash common.Hash

+ Priority common.Hash

+ Round *big.Int

+ RoundIndex uint32

+ type RoundIndexHash [RoundIndexHashLength]byte

+ func GenerateRoundIndexHash(round uint64, index uint32) RoundIndexHash

+ func (h *RoundIndexHash) SetBytes(b []byte)

+ type SendMessageEvent struct

+ Code MsgType

+ Payload []byte

+ Round *big.Int

+ type Server struct

+ func NewVRFServer(db youdb.Database) (*Server, error)

+ func (s *Server) Author(header *types.Header) (common.Address, error)

+ func (s *Server) CertificateParams(round *big.Int) (*params.CaravelParams, error)

+ func (s *Server) CheckValidatorVotes(chain consensus.ChainReader, header *types.Header) (map[common.Address]bool, error)

+ func (s *Server) CompareBlocks(blockA *types.Block, blockB *types.Block) int

+ func (s *Server) CurrentCaravelParams() *params.CaravelParams

+ func (s *Server) Finalize(chain consensus.ChainReader, header *types.Header, statedb *state.StateDB, ...)

+ func (s *Server) FinalizeAndAssemble(chain consensus.ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, error)

+ func (s *Server) GetLookBackBlockHash(cp *params.CaravelParams, num *big.Int, lbType params.LookBackType) (common.Hash, error)

+ func (s *Server) GetLookBackBlockNumber(cp *params.CaravelParams, num *big.Int, lbType params.LookBackType) *big.Int

+ func (s *Server) GetLookBackValidator(round *big.Int, addr common.Address, lbType params.LookBackType) (*state.Validator, bool)

+ func (s *Server) GetLookBackVldReader(cp *params.CaravelParams, num *big.Int, lbType params.LookBackType) (state.ValidatorReader, error)

+ func (s *Server) GetValMainAddress() common.Address

+ func (s *Server) GetValidatorAddrs(chain consensus.ChainReader, header *types.Header) (*params.YouParams, *UconValidators, []common.Address, []common.Address, error)

+ func (s *Server) GetValidatorByAddress(blockHash common.Hash, addr common.Address) *state.Validator

+ func (s *Server) HandleMsg(data []byte, receivedAt time.Time) error

+ func (s *Server) NewChainHead(block *types.Block)

+ func (s *Server) NextRound(ev RoundIndexChangeEvent) error

+ func (s *Server) Prepare(chain consensus.ChainReader, header *types.Header) error

+ func (s *Server) Seal(chain consensus.ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)

+ func (s *Server) SetValKey(sk *ecdsa.PrivateKey, blsKeyBytes []byte) (err error)

+ func (s *Server) StartMining(chain consensus.ChainReader, inserter consensus.MineInserter, ...) error

+ func (s *Server) StartNewRound(newRound bool) error

+ func (s *Server) Stop() error

+ func (s *Server) TotalStakeOfKind(blockHash common.Hash, kind params.ValidatorKind) *big.Int

+ func (s *Server) UpdateContextForNewBlock(block *types.Block) error

+ func (s *Server) ValidatorsNumOfKind(blockHash common.Hash, kind params.ValidatorKind) uint64

+ func (s *Server) VerifyAcHeader(chain consensus.ChainReader, acHeader *types.Header, ...) error

+ func (s *Server) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error

+ func (s *Server) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)

+ func (s *Server) VerifySeal(chain consensus.ChainReader, header *types.Header) error

+ func (s *Server) VerifySideChainHeader(cp *params.CaravelParams, seedHeader *types.Header, ...) error

+ type SingleVote struct

+ Proof []byte

+ Signature []byte

+ VoterIdx uint32

+ Votes uint32

+ type SortitionData struct

+ Proof []byte

+ Round *big.Int

+ RoundIndex uint32

+ Step uint32

+ Votes uint32

+ type SortitionManager struct

+ func NewSortitionManager(vrfSk vrf.PrivateKey, getStake getStakeFn, getLookBackSeed getLookBackSeedFn, ...) *SortitionManager

+ func (sm *SortitionManager) ClearStepView(round *big.Int)

+ func (sm *SortitionManager) GetStepView(round *big.Int, roundIndex uint32, step uint32) *StepView

+ func (sm *SortitionManager) NewStepView(round *big.Int, roundIndex uint32, step uint32, stepview *StepView)

+ type StartVoteFn func(round *big.Int, roundIndex uint32) bool

+ type StepView struct

+ Priority common.Hash

+ SeedValue common.Hash

+ SortitionProof []byte

+ SubUsers uint32

+ Threshold uint64

+ ValidatorType params.ValidatorKind

+ type StepViews map[uint32]*StepView

+ func NewStepViews() StepViews

+ type TimerManager struct

+ func NewTimerManager(timeoutFn ProcessTimeoutFn, stepFn ProcessStepFn) *TimerManager

+ func (tm *TimerManager) NewAddressMsg(ev ReceivedMsgEvent, validatorKind params.ValidatorKind, ...) bool

+ func (tm *TimerManager) Start()

+ func (tm *TimerManager) Stop()

+ type TransferMessageEvent struct

+ Code MsgType

+ Payload []byte

+ PayloadHash common.Hash

+ Round *big.Int

+ type TypedCacheMsgs struct

+ func NewTypedCacheMsgs() *TypedCacheMsgs

+ func (m *TypedCacheMsgs) Clear(round uint64, roundIndex uint32)

+ func (m *TypedCacheMsgs) GetMessages(round uint64, roundIndex uint32) CachedMsgs

+ func (m *TypedCacheMsgs) NewMessage(msg CachedMessage)

+ func (m *TypedCacheMsgs) RemoveMessages(round uint64, roundIndex uint32)

+ type UconValidators struct

+ CCAggrSig []byte

+ ChamberCerts []SingleVote

+ ChamberCommitters []SingleVote

+ HouseCommitters []SingleVote

+ MCAggrSig []byte

+ RoundIndex uint32

+ SCAggrSig []byte

+ func ExtractUconValidators(h *types.Header, backType params.LookBackType) (*UconValidators, error)

+ func NewUconValidators(ev CommitEvent, backType params.LookBackType) *UconValidators

+ func (uc *UconValidators) ValidatorsToByte() ([]byte, error)

+ type UpdateExistedHeaderEvent struct

+ BlockHash common.Hash

+ ChamberPrecommits VotesInfoForBlockHash

+ HousePrecommits VotesInfoForBlockHash

+ Round *big.Int

+ RoundIndex uint32

+ type VerifyPriorityFn func(pubkey *ecdsa.PublicKey, data *ConsensusCommon) error

+ type VerifySortitionFn func(pubKey *ecdsa.PublicKey, data *SortitionData, lbType params.LookBackType) error

+ type VoteBLSMgr struct

+ Verifier *BlsVerifier

+ func NewVoteBLSMgr(rawSk *ecdsa.PrivateKey, blsSk bls.SecretKey) *VoteBLSMgr

+ func (vb *VoteBLSMgr) RecoverSignerInfo(vs *state.Validators, vote *SingleVote) (signer *state.Validator, pk bls.PublicKey, vrfpk *ecdsa.PublicKey, err error)

+ func (vb *VoteBLSMgr) SetLookBackMgr(lbmgr LookBackMgr)

+ func (vb *VoteBLSMgr) SignVote(voteType VoteType, voteInfo *SingleVote, payload []byte) error

+ type VoteDB struct

+ func NewVoteDB(db youdb.Database, rawSk *ecdsa.PrivateKey) *VoteDB

+ func (v *VoteDB) ExistVoteData(voteType VoteType, round *big.Int, roundIndex uint32) bool

+ func (v *VoteDB) Stop()

+ func (v *VoteDB) UpdateContext(round *big.Int, roundIndex uint32)

+ func (v *VoteDB) UpdateVoteData(voteType VoteType, round *big.Int, roundIndex uint32) error

+ type VoteItem struct

+ Addr common.Address

+ Round *big.Int

+ RoundIndex uint32

+ Signature []byte

+ VoteType VoteType

+ func ReadVoteData(db youdb.Database, address common.Address, voteType VoteType, index uint8) *VoteItem

+ type VoteMsgEvent struct

+ Msg *CachedVotesMessage

+ VType VoteType

+ type VoteSta struct

+ func NewVoteSta(vtype VoteType) *VoteSta

+ type VoteStatus struct

+ type VoteType uint8

+ const Certificate

+ const NextIndex

+ const Precommit

+ const Prevote

+ const Propose

+ const VoteNone

+ func MsgCodeToVoteType(msgCode MsgType) VoteType

+ type Voter struct

+ func NewVoter(db youdb.Database, rawSk *ecdsa.PrivateKey, blsSk bls.SecretKey, ...) *Voter

+ func (v *Voter) PackVotes(ev CommitEvent, backType params.LookBackType) (*UconValidators, error)

+ func (v *Voter) RecoverSignerInfo(vs *state.Validators, vote *SingleVote) (signer *state.Validator, pk bls.PublicKey, vrfpk *ecdsa.PublicKey, err error)

+ func (v *Voter) SetLookBackMgr(lbmgr LookBackMgr)

+ func (v *Voter) Start(lbmgr LookBackMgr)

+ func (v *Voter) Stop()

+ type VotesInfoForBlockHash map[common.Address]*SingleVote

+ func NewVotesInfoForBlockHash() VotesInfoForBlockHash

+ type VotesManager struct

+ func NewVotesManager() *VotesManager

+ type VotesWrapper struct

+ func NewVotesWrapper() *VotesWrapper

+ type VotesWrapperList struct

+ func NewVotesWrapperList() *VotesWrapperList

+ func (v *VotesWrapperList) GetWrapper(round *big.Int, roundIndex uint32) *VotesWrapper

+ func (v *VotesWrapperList) NewWrapper(round *big.Int, roundIndex uint32) *VotesWrapper

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL