hashgraph

package
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 28, 2019 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	/*
		ROOT_DEPTH determines how many RootEvents are included in the Root.Past
		map. It is preferable not to make ROOT_DEPTH configurable because if
		peers use diffent values, they will produce different Roots, different
		Frames, and different Blocks. Perhaps this parameter should be tied to
		the number of Peers rather than hard-coded.
	*/
	ROOT_DEPTH = 10

	/*
		COIN_ROUND_FREQ defines the frequency of coin rounds. The value 4 is
		arbitrary. Do something smarter.
	*/
	COIN_ROUND_FREQ = float64(4)
)

Variables

This section is empty.

Functions

func DummyInternalCommitCallback added in v0.4.1 

func DummyInternalCommitCallback(b *Block) error

DummyInternalCommitCallback is used for testing

Types

type BadgerStore 

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

func NewBadgerStore 

func NewBadgerStore(cacheSize int, path string) (*BadgerStore, error)

NewBadgerStore opens an existing database or creates a new one if nothing is found in path.

func (*BadgerStore) AddConsensusEvent 

func (s *BadgerStore) AddConsensusEvent(event *Event) error

func (*BadgerStore) AddParticipant added in v0.4.1 

func (s *BadgerStore) AddParticipant(p *peers.Peer) error

func (*BadgerStore) CacheSize 

func (s *BadgerStore) CacheSize() int

func (*BadgerStore) Close 

func (s *BadgerStore) Close() error

func (*BadgerStore) ConsensusEvents 

func (s *BadgerStore) ConsensusEvents() []string

func (*BadgerStore) ConsensusEventsCount 

func (s *BadgerStore) ConsensusEventsCount() int

func (*BadgerStore) GetBlock 

func (s *BadgerStore) GetBlock(rr int) (*Block, error)

func (*BadgerStore) GetEvent 

func (s *BadgerStore) GetEvent(key string) (*Event, error)

func (*BadgerStore) GetFrame 

func (s *BadgerStore) GetFrame(rr int) (*Frame, error)

func (*BadgerStore) GetFuturePeerSets added in v0.4.1 

func (s *BadgerStore) GetFuturePeerSets(baseRound int) (map[int][]*peers.Peer, error)

func (*BadgerStore) GetPeerSet added in v0.4.1 

func (s *BadgerStore) GetPeerSet(round int) (peerSet *peers.PeerSet, err error)

func (*BadgerStore) GetRoot 

func (s *BadgerStore) GetRoot(participant string) (*Root, error)

func (*BadgerStore) GetRound 

func (s *BadgerStore) GetRound(r int) (*RoundInfo, error)

func (*BadgerStore) KnownEvents 

func (s *BadgerStore) KnownEvents() map[uint32]int

func (*BadgerStore) LastBlockIndex 

func (s *BadgerStore) LastBlockIndex() int

func (*BadgerStore) LastConsensusEventFrom 

func (s *BadgerStore) LastConsensusEventFrom(participant string) (last string, isRoot bool, err error)

func (*BadgerStore) LastEventFrom 

func (s *BadgerStore) LastEventFrom(participant string) (last string, isRoot bool, err error)

func (*BadgerStore) LastRound 

func (s *BadgerStore) LastRound() int

func (*BadgerStore) NeedBoostrap 

func (s *BadgerStore) NeedBoostrap() bool

func (*BadgerStore) ParticipantEvent 

func (s *BadgerStore) ParticipantEvent(participant string, index int) (string, error)

func (*BadgerStore) ParticipantEvents 

func (s *BadgerStore) ParticipantEvents(participant string, skip int) ([]string, error)

func (*BadgerStore) RepertoireByID added in v0.4.1 

func (s *BadgerStore) RepertoireByID() map[uint32]*peers.Peer

func (*BadgerStore) RepertoireByPubKey added in v0.4.1 

func (s *BadgerStore) RepertoireByPubKey() map[string]*peers.Peer

func (*BadgerStore) Reset 

func (s *BadgerStore) Reset(frame *Frame) error

func (*BadgerStore) RootsBySelfParent 

func (s *BadgerStore) RootsBySelfParent() map[string]*Root

func (*BadgerStore) RoundEvents 

func (s *BadgerStore) RoundEvents(r int) int

func (*BadgerStore) RoundWitnesses 

func (s *BadgerStore) RoundWitnesses(r int) []string

func (*BadgerStore) SetBlock 

func (s *BadgerStore) SetBlock(block *Block) error

func (*BadgerStore) SetEvent 

func (s *BadgerStore) SetEvent(event *Event) error

func (*BadgerStore) SetFrame 

func (s *BadgerStore) SetFrame(frame *Frame) error

func (*BadgerStore) SetPeerSet added in v0.4.1 

func (s *BadgerStore) SetPeerSet(round int, peerSet *peers.PeerSet) error

func (*BadgerStore) SetRound 

func (s *BadgerStore) SetRound(r int, round *RoundInfo) error

func (*BadgerStore) StorePath 

func (s *BadgerStore) StorePath() string

type Block 

type Block struct {
	Body       BlockBody
	Signatures map[string]string // [validator hex] => signature
	// contains filtered or unexported fields
}

func NewBlock 

func NewBlock(blockIndex,
	roundReceived int,
	frameHash []byte,
	peerSlice []*peers.Peer,
	txs [][]byte) *Block

func NewBlockFromFrame 

func NewBlockFromFrame(blockIndex int, frame *Frame) (*Block, error)

func (*Block) AppendTransactions 

func (b *Block) AppendTransactions(txs [][]byte)

func (*Block) FrameHash 

func (b *Block) FrameHash() []byte

func (*Block) GetSignature 

func (b *Block) GetSignature(validator string) (res BlockSignature, err error)

func (*Block) GetSignatures 

func (b *Block) GetSignatures() []BlockSignature

func (*Block) Hash 

func (b *Block) Hash() ([]byte, error)

func (*Block) Hex 

func (b *Block) Hex() string

func (*Block) Index 

func (b *Block) Index() int

func (*Block) Marshal 

func (b *Block) Marshal() ([]byte, error)

func (*Block) PeersHash added in v0.4.1 

func (b *Block) PeersHash() []byte

func (*Block) RoundReceived 

func (b *Block) RoundReceived() int

func (*Block) SetSignature 

func (b *Block) SetSignature(bs BlockSignature) error

func (*Block) Sign 

func (b *Block) Sign(privKey *ecdsa.PrivateKey) (bs BlockSignature, err error)

func (*Block) StateHash 

func (b *Block) StateHash() []byte

func (*Block) Transactions 

func (b *Block) Transactions() [][]byte

func (*Block) Unmarshal 

func (b *Block) Unmarshal(data []byte) error

func (*Block) Verify 

func (b *Block) Verify(sig BlockSignature) (bool, error)

type BlockBody 

type BlockBody struct {
	Index         int
	RoundReceived int
	StateHash     []byte
	FrameHash     []byte
	PeersHash     []byte
	Transactions  [][]byte
}

func (*BlockBody) Hash 

func (bb *BlockBody) Hash() ([]byte, error)

func (*BlockBody) Marshal 

func (bb *BlockBody) Marshal() ([]byte, error)

json encoding of body only

func (*BlockBody) Unmarshal 

func (bb *BlockBody) Unmarshal(data []byte) error

type BlockSignature 

type BlockSignature struct {
	Validator []byte
	Index     int //Block Index
	Signature string
}

func (*BlockSignature) Key added in v0.4.1 

func (bs *BlockSignature) Key() string

func (*BlockSignature) Marshal 

func (bs *BlockSignature) Marshal() ([]byte, error)

func (*BlockSignature) ToWire 

func (bs *BlockSignature) ToWire() WireBlockSignature

func (*BlockSignature) Unmarshal 

func (bs *BlockSignature) Unmarshal(data []byte) error

func (*BlockSignature) ValidatorHex 

func (bs *BlockSignature) ValidatorHex() string

type ByLamportTimestamp 

type ByLamportTimestamp []*Event

ByLamportTimestamp implements sort.Interface for []Event based on the lamportTimestamp field. THIS IS A TOTAL ORDER

func (ByLamportTimestamp) Len 

func (a ByLamportTimestamp) Len() int

func (ByLamportTimestamp) Less 

func (a ByLamportTimestamp) Less(i, j int) bool

func (ByLamportTimestamp) Swap 

func (a ByLamportTimestamp) Swap(i, j int)

type ByTopologicalOrder 

type ByTopologicalOrder []*Event

ByTopologicalOrder implements sort.Interface for []Event based on the topologicalIndex field. THIS IS A PARTIAL ORDER

func (ByTopologicalOrder) Len 

func (a ByTopologicalOrder) Len() int

func (ByTopologicalOrder) Less 

func (a ByTopologicalOrder) Less(i, j int) bool

func (ByTopologicalOrder) Swap 

func (a ByTopologicalOrder) Swap(i, j int)

type CoordinatesMap added in v0.4.1 

type CoordinatesMap map[string]EventCoordinates

func NewCoordinatesMap added in v0.4.1 

func NewCoordinatesMap() CoordinatesMap

func (CoordinatesMap) Copy added in v0.4.1 

func (c CoordinatesMap) Copy() CoordinatesMap

type Event 

type Event struct {
	Body      EventBody
	Signature string //creator's digital signature of body
	// contains filtered or unexported fields
}

func NewEvent 

func NewEvent(transactions [][]byte,
	blockSignatures []BlockSignature,
	parents []string,
	creator []byte,
	index int) *Event

func (*Event) BlockSignatures 

func (e *Event) BlockSignatures() []BlockSignature

func (*Event) Creator 

func (e *Event) Creator() string

func (*Event) GetRound added in v0.4.1 

func (e *Event) GetRound() *int

func (*Event) Hash 

func (e *Event) Hash() ([]byte, error)

sha256 hash of body

func (*Event) Hex 

func (e *Event) Hex() string

func (*Event) Index 

func (e *Event) Index() int

func (*Event) IsLoaded 

func (e *Event) IsLoaded() bool

True if Event contains a payload or is the initial Event of its creator

func (*Event) Marshal 

func (e *Event) Marshal() ([]byte, error)

json encoding of body and signature

func (*Event) OtherParent 

func (e *Event) OtherParent() string

func (*Event) SelfParent 

func (e *Event) SelfParent() string

func (*Event) SetLamportTimestamp 

func (e *Event) SetLamportTimestamp(t int)

func (*Event) SetRound 

func (e *Event) SetRound(r int)

func (*Event) SetRoundReceived 

func (e *Event) SetRoundReceived(rr int)

func (*Event) SetWireInfo 

func (e *Event) SetWireInfo(selfParentIndex int,
	otherParentCreatorID uint32,
	otherParentIndex int,
	creatorID uint32)

func (*Event) Sign 

func (e *Event) Sign(privKey *ecdsa.PrivateKey) error

ecdsa sig

func (*Event) ToWire 

func (e *Event) ToWire() WireEvent

func (*Event) Transactions 

func (e *Event) Transactions() [][]byte

func (*Event) Unmarshal 

func (e *Event) Unmarshal(data []byte) error

func (*Event) Verify 

func (e *Event) Verify() (bool, error)

func (*Event) WireBlockSignatures 

func (e *Event) WireBlockSignatures() []WireBlockSignature

type EventBody 

type EventBody struct {
	Transactions    [][]byte         //the payload
	Parents         []string         //hashes of the event's parents, self-parent first
	Creator         []byte           //creator's public key
	Index           int              //index in the sequence of events created by Creator
	BlockSignatures []BlockSignature //list of Block signatures signed by the Event's Creator ONLY
	// contains filtered or unexported fields
}

func (*EventBody) Hash 

func (e *EventBody) Hash() ([]byte, error)

func (*EventBody) Marshal 

func (e *EventBody) Marshal() ([]byte, error)

json encoding of body only

func (*EventBody) Unmarshal 

func (e *EventBody) Unmarshal(data []byte) error

type EventCoordinates 

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

type Frame 

type Frame struct {
	Round          int //RoundReceived
	Peers          []*peers.Peer
	Roots          map[string]*Root
	Events         []*Event              //Event with RoundReceived = Round
	FuturePeerSets map[int][]*peers.Peer //[round] => Peers
}

func (*Frame) Hash 

func (f *Frame) Hash() ([]byte, error)

func (*Frame) Marshal 

func (f *Frame) Marshal() ([]byte, error)

json encoding of Frame

func (*Frame) Unmarshal 

func (f *Frame) Unmarshal(data []byte) error

type Hashgraph 

type Hashgraph struct {
	Store               Store               //store of Events, Rounds, and Blocks
	UndeterminedEvents  []string            //[index] => hash . FIFO queue of Events whose consensus order is not yet determined
	PendingRounds       *PendingRoundsCache //FIFO queue of Rounds which have not attained consensus yet
	PendingSignatures   *SigPool            //Pool of Block signatures that need to be processed (matched with Blocks)
	LastConsensusRound  *int                //index of last consensus round
	FirstConsensusRound *int                //index of first consensus round (only used in tests)
	AnchorBlock         *int                //index of last block with enough signatures

	LastCommitedRoundEvents int //number of events in round before LastConsensusRound
	ConsensusTransactions   int //number of consensus transactions
	PendingLoadedEvents     int //number of loaded events that are not yet committed
	// contains filtered or unexported fields
}

Hashgraph is a DAG of Events. It also contains methods to extract a consensus order of Events and map them onto a blockchain.

func NewHashgraph 

func NewHashgraph(store Store, commitCallback InternalCommitCallback, logger *logrus.Entry) *Hashgraph

NewHashgraph instantiates a Hashgraph with an underlying data store and a commit callback

func (*Hashgraph) Bootstrap 

func (h *Hashgraph) Bootstrap() error

Bootstrap loads all Events from the Store's DB (if there is one) and feeds them to the Hashgraph (in topological order) for consensus ordering. After this method call, the Hashgraph should be in a state coherent with the 'tip' of the Hashgraph

func (*Hashgraph) CheckBlock 

func (h *Hashgraph) CheckBlock(block *Block, peerSet *peers.PeerSet) error

CheckBlock returns an error if the Block does not contain valid signatures from MORE than 1/3 of participants

func (*Hashgraph) DecideFame 

func (h *Hashgraph) DecideFame() error

DecideFame decides if witnesses are famous

func (*Hashgraph) DecideRoundReceived 

func (h *Hashgraph) DecideRoundReceived() error

DecideRoundReceived assigns a RoundReceived to undetermined events when they reach consensus

func (*Hashgraph) DivideRounds 

func (h *Hashgraph) DivideRounds() error

DivideRounds assigns a Round and LamportTimestamp to Events, and flags them as witnesses if necessary. Pushes Rounds in the PendingRounds queue if necessary.

func (*Hashgraph) GetAnchorBlockWithFrame 

func (h *Hashgraph) GetAnchorBlockWithFrame() (*Block, *Frame, error)

GetAnchorBlockWithFrame returns the AnchorBlock and the corresponding Frame. This can be used as a base to Reset a Hashgraph

func (*Hashgraph) GetFrame 

func (h *Hashgraph) GetFrame(roundReceived int) (*Frame, error)

GetFrame computes the Frame corresponding to a RoundReceived.

func (*Hashgraph) Init added in v0.4.1 

func (h *Hashgraph) Init(peerSet *peers.PeerSet) error

Init sets the initial PeerSet, which also creates the corresponding Roots and updates the Repertoire.

func (*Hashgraph) InsertEvent 

func (h *Hashgraph) InsertEvent(event *Event, setWireInfo bool) error

InsertEvent attempts to insert an Event in the DAG. It verifies the signature, checks the ancestors are known, and prevents the introduction of forks.

func (*Hashgraph) InsertEventAndRunConsensus added in v0.4.1 

func (h *Hashgraph) InsertEventAndRunConsensus(event *Event, setWireInfo bool) error

InsertEventAndRunConsensus inserts an Event in the Hashgraph and call the consensus methods.

func (*Hashgraph) ProcessDecidedRounds 

func (h *Hashgraph) ProcessDecidedRounds() error

ProcessDecidedRounds takes Rounds whose witnesses are decided, computes the corresponding Frames, maps them into Blocks, and commits the Blocks via the commit channel

func (*Hashgraph) ProcessSigPool 

func (h *Hashgraph) ProcessSigPool() error

ProcessSigPool runs through the SignaturePool and tries to map a Signature to a known Block. If a Signature is valid, it is appended to the block and removed from the SignaturePool. The function also updates the AnchorBlock if necessary.

func (*Hashgraph) ReadWireInfo 

func (h *Hashgraph) ReadWireInfo(wevent WireEvent) (*Event, error)

ReadWireInfo converts a WireEvent to an Event by replacing int IDs with the corresponding public keys.

func (*Hashgraph) Reset 

func (h *Hashgraph) Reset(block *Block, frame *Frame) error

Reset clears the Hashgraph and resets it from a new base.

func (*Hashgraph) SetAnchorBlock added in v0.4.1 

func (h *Hashgraph) SetAnchorBlock(block *Block) error

SetAnchorBlock sets the AnchorBlock index if the proposed block has collected enough signatures (+1/3) and is above the current AnchorBlock. The AnchorBlock is the latest Block that collected +1/3 signatures from validators. It is used in FastForward responses when a node wants to sync to the top of the hashgraph.

type InmemStore 

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

func NewInmemStore 

func NewInmemStore(cacheSize int) *InmemStore

func (*InmemStore) AddConsensusEvent 

func (s *InmemStore) AddConsensusEvent(event *Event) error

func (*InmemStore) AddParticipant added in v0.4.1 

func (s *InmemStore) AddParticipant(p *peers.Peer) error

func (*InmemStore) CacheSize 

func (s *InmemStore) CacheSize() int

func (*InmemStore) Close 

func (s *InmemStore) Close() error

func (*InmemStore) ConsensusEvents 

func (s *InmemStore) ConsensusEvents() []string

func (*InmemStore) ConsensusEventsCount 

func (s *InmemStore) ConsensusEventsCount() int

func (*InmemStore) GetBlock 

func (s *InmemStore) GetBlock(index int) (*Block, error)

func (*InmemStore) GetEvent 

func (s *InmemStore) GetEvent(key string) (*Event, error)

func (*InmemStore) GetFrame 

func (s *InmemStore) GetFrame(index int) (*Frame, error)

func (*InmemStore) GetFuturePeerSets added in v0.4.1 

func (s *InmemStore) GetFuturePeerSets(baseRound int) (map[int][]*peers.Peer, error)

func (*InmemStore) GetPeerSet added in v0.4.1 

func (s *InmemStore) GetPeerSet(round int) (*peers.PeerSet, error)

func (*InmemStore) GetRoot 

func (s *InmemStore) GetRoot(participant string) (*Root, error)

func (*InmemStore) GetRound 

func (s *InmemStore) GetRound(r int) (*RoundInfo, error)

func (*InmemStore) KnownEvents 

func (s *InmemStore) KnownEvents() map[uint32]int

func (*InmemStore) LastBlockIndex 

func (s *InmemStore) LastBlockIndex() int

func (*InmemStore) LastConsensusEventFrom 

func (s *InmemStore) LastConsensusEventFrom(participant string) (last string, isRoot bool, err error)

func (*InmemStore) LastEventFrom 

func (s *InmemStore) LastEventFrom(participant string) (last string, isRoot bool, err error)

func (*InmemStore) LastRound 

func (s *InmemStore) LastRound() int

func (*InmemStore) NeedBoostrap 

func (s *InmemStore) NeedBoostrap() bool

func (*InmemStore) ParticipantEvent 

func (s *InmemStore) ParticipantEvent(participant string, index int) (string, error)

func (*InmemStore) ParticipantEvents 

func (s *InmemStore) ParticipantEvents(participant string, skip int) ([]string, error)

func (*InmemStore) RepertoireByID added in v0.4.1 

func (s *InmemStore) RepertoireByID() map[uint32]*peers.Peer

func (*InmemStore) RepertoireByPubKey added in v0.4.1 

func (s *InmemStore) RepertoireByPubKey() map[string]*peers.Peer

func (*InmemStore) Reset 

func (s *InmemStore) Reset(frame *Frame) error

func (*InmemStore) RootsBySelfParent 

func (s *InmemStore) RootsBySelfParent() map[string]*Root

func (*InmemStore) RoundEvents 

func (s *InmemStore) RoundEvents(r int) int

func (*InmemStore) RoundWitnesses 

func (s *InmemStore) RoundWitnesses(r int) []string

func (*InmemStore) SetBlock 

func (s *InmemStore) SetBlock(block *Block) error

func (*InmemStore) SetEvent 

func (s *InmemStore) SetEvent(event *Event) error

func (*InmemStore) SetFrame 

func (s *InmemStore) SetFrame(frame *Frame) error

func (*InmemStore) SetPeerSet added in v0.4.1 

func (s *InmemStore) SetPeerSet(round int, peerSet *peers.PeerSet) error

SetPeerSet updates the peerSetCache, participantEventsCache, rootsCache, and Repertoire.

func (*InmemStore) SetRound 

func (s *InmemStore) SetRound(r int, round *RoundInfo) error

func (*InmemStore) StorePath 

func (s *InmemStore) StorePath() string

type InternalCommitCallback added in v0.4.1 

type InternalCommitCallback func(*Block) error

InternalCommitCallback is called by the Hashgraph to commit a Block. The InternalCommitCallback will likely itself call the ProxyCommitCallback. We add a layer of indirection because processing the CommitResponse should be handled by the Core object, not the hashgraph; the hashgraph only knows if there was an error or not.

type Key 

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

func (Key) ToString 

func (k Key) ToString() string

type OrderedPendingRounds added in v0.4.1 

type OrderedPendingRounds []*PendingRound

func (OrderedPendingRounds) Len added in v0.4.1 

func (a OrderedPendingRounds) Len() int

func (OrderedPendingRounds) Less added in v0.4.1 

func (a OrderedPendingRounds) Less(i, j int) bool

func (OrderedPendingRounds) Swap added in v0.4.1 

func (a OrderedPendingRounds) Swap(i, j int)

type ParticipantEventsCache 

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

func NewParticipantEventsCache 

func NewParticipantEventsCache(size int) *ParticipantEventsCache

func (*ParticipantEventsCache) AddPeer added in v0.4.1 

func (pec *ParticipantEventsCache) AddPeer(peer *peers.Peer) error

func (*ParticipantEventsCache) Get 

func (pec *ParticipantEventsCache) Get(participant string, skipIndex int) ([]string, error)

Get returns participant events with index > skip

func (*ParticipantEventsCache) GetItem 

func (pec *ParticipantEventsCache) GetItem(participant string, index int) (string, error)

func (*ParticipantEventsCache) GetLast 

func (pec *ParticipantEventsCache) GetLast(participant string) (string, error)

func (*ParticipantEventsCache) Known 

func (pec *ParticipantEventsCache) Known() map[uint32]int

returns [participant id] => lastKnownIndex

func (*ParticipantEventsCache) Set 

func (pec *ParticipantEventsCache) Set(participant string, hash string, index int) error

type PeerSetCache added in v0.4.1 

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

func NewPeerSetCache added in v0.4.1 

func NewPeerSetCache() *PeerSetCache

func (*PeerSetCache) Get added in v0.4.1 

func (c *PeerSetCache) Get(round int) (*peers.PeerSet, error)

func (*PeerSetCache) GetFuture added in v0.4.1 

func (c *PeerSetCache) GetFuture(baseRound int) (map[int][]*peers.Peer, error)

func (*PeerSetCache) Set added in v0.4.1 

func (c *PeerSetCache) Set(round int, peerSet *peers.PeerSet) error

type PendingRound added in v0.4.1 

type PendingRound struct {
	Index   int
	Decided bool
}

type PendingRoundsCache added in v0.4.1 

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

func NewPendingRoundsCache added in v0.4.1 

func NewPendingRoundsCache() *PendingRoundsCache

func (*PendingRoundsCache) Clean added in v0.4.1 

func (c *PendingRoundsCache) Clean(processedRounds []int)

func (*PendingRoundsCache) GetOrderedPendingRounds added in v0.4.1 

func (c *PendingRoundsCache) GetOrderedPendingRounds() OrderedPendingRounds

func (*PendingRoundsCache) Queued added in v0.4.1 

func (c *PendingRoundsCache) Queued(round int) bool

func (*PendingRoundsCache) Set added in v0.4.1 

func (c *PendingRoundsCache) Set(pendingRound *PendingRound)

func (*PendingRoundsCache) Update added in v0.4.1 

func (c *PendingRoundsCache) Update(decidedRounds []int)

type Root 

type Root struct {
	Head        string
	Past        map[string]RootEvent
	Precomputed map[string]RootEvent
	// contains filtered or unexported fields
}

Root forms a base on top of which a participant's Events can be inserted. It contains the SelfParent of the first descendant of the Root, the pre-computed Round and Lamport values of Events attached to the Root (cf Frame), as well as other Events, that are referenced by future Events but are "below" the Frame. The Others field is necessary when the other-parent of a Frame Event is not contained in the Frame, because it is not permitted to insert an Event in the Hashgraph if both its parents are not known.

func NewBaseRoot 

func NewBaseRoot(creatorID uint32) *Root

NewBaseRoot initializes a Root object for a fresh Hashgraph.

func NewRoot added in v0.4.1 

func NewRoot(head RootEvent) *Root

NewRoot initializes a new Root with a head.

func (*Root) GetHead added in v0.4.1 

func (root *Root) GetHead() RootEvent

GetHead returns the Root's top RootEvent

func (*Root) Init added in v0.4.1 

func (root *Root) Init()

Init populates the private lookup maps

func (*Root) Insert added in v0.4.1 

func (root *Root) Insert(re RootEvent)

Insert adds a RootEvent to Past and updates lookup maps

func (*Root) Marshal 

func (root *Root) Marshal() ([]byte, error)

The JSON encoding of a Root must be DETERMINISTIC because it is itself included in the JSON encoding of a Frame. The difficulty is that Roots contain go maps for which one should not expect a de facto order of entries; so we cannot use the builtin JSON codec. Instead, we are using a third party library (ugorji/codec) that enables deterministic encoding of golang maps.

func (*Root) PastByIndex added in v0.4.1 

func (root *Root) PastByIndex(index int) (RootEvent, bool)

PastByIndex attempts to retrieve a Past Event given its index instead of its Hash.

func (*Root) Unmarshal 

func (root *Root) Unmarshal(data []byte) error

Unmarshal decodes data into a Root object and calls Init to populate the private lookup maps

type RootEvent 

type RootEvent struct {
	Hash             string
	CreatorID        uint32
	Index            int
	Round            int
	LamportTimestamp int
}

RootEvent contains enough information about an Event to insert its direct descendant in a reset Hashgraph.

func NewBaseRootEvent 

func NewBaseRootEvent(creatorID uint32) RootEvent

NewBaseRootEvent creates a RootEvent corresponding to the the very beginning of a Hashgraph.

type RoundEvent 

type RoundEvent struct {
	Witness bool
	Famous  Trilean
}

type RoundInfo 

type RoundInfo struct {
	CreatedEvents  map[string]RoundEvent
	ReceivedEvents []string
	// contains filtered or unexported fields
}

func NewRoundInfo 

func NewRoundInfo() *RoundInfo

func (*RoundInfo) AddCreatedEvent added in v0.4.1 

func (r *RoundInfo) AddCreatedEvent(x string, witness bool)

func (*RoundInfo) AddReceivedEvent added in v0.4.1 

func (r *RoundInfo) AddReceivedEvent(x string)

func (*RoundInfo) FamousWitnesses 

func (r *RoundInfo) FamousWitnesses() []string

return famous witnesses

func (*RoundInfo) IsDecided 

func (r *RoundInfo) IsDecided(witness string) bool

func (*RoundInfo) IsQueued added in v0.4.1 

func (r *RoundInfo) IsQueued() bool

func (*RoundInfo) Marshal 

func (r *RoundInfo) Marshal() ([]byte, error)

func (*RoundInfo) SetFame 

func (r *RoundInfo) SetFame(x string, f bool)

func (*RoundInfo) Unmarshal 

func (r *RoundInfo) Unmarshal(data []byte) error

func (*RoundInfo) Witnesses 

func (r *RoundInfo) Witnesses() []string

return witnesses

func (*RoundInfo) WitnessesDecided 

func (r *RoundInfo) WitnessesDecided(peerSet *peers.PeerSet) bool

WitnessesDecided returns true if a super-majority of witnesses are decided, and there are no undecided witnesses. Our algorithm relies on the fact that a witness that is not yet known when a super-majority of witnesses are already decided, has no chance of ever being famous. Once a Round is decided it stays decided, even if new witnesses are added after it was first decided.

type SigPool added in v0.4.1 

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

func NewSigPool added in v0.4.1 

func NewSigPool() *SigPool

func (*SigPool) Add added in v0.4.1 

func (sp *SigPool) Add(blockSignature BlockSignature)

func (*SigPool) Items added in v0.4.1 

func (sp *SigPool) Items() map[string]BlockSignature

func (*SigPool) Len added in v0.4.1 

func (sp *SigPool) Len() int

func (*SigPool) Remove added in v0.4.1 

func (sp *SigPool) Remove(key string)

func (*SigPool) RemoveSlice added in v0.4.1 

func (sp *SigPool) RemoveSlice(sigs []BlockSignature)

func (*SigPool) Slice added in v0.4.1 

func (sp *SigPool) Slice() []BlockSignature

type Store 

type Store interface {
	CacheSize() int
	GetPeerSet(int) (*peers.PeerSet, error)
	SetPeerSet(int, *peers.PeerSet) error
	GetFuturePeerSets(int) (map[int][]*peers.Peer, error)
	AddParticipant(*peers.Peer) error
	RepertoireByPubKey() map[string]*peers.Peer
	RepertoireByID() map[uint32]*peers.Peer
	RootsBySelfParent() map[string]*Root
	GetEvent(string) (*Event, error)
	SetEvent(*Event) error
	ParticipantEvents(string, int) ([]string, error)
	ParticipantEvent(string, int) (string, error)
	LastEventFrom(string) (string, bool, error)
	LastConsensusEventFrom(string) (string, bool, error)
	KnownEvents() map[uint32]int
	ConsensusEvents() []string
	ConsensusEventsCount() int
	AddConsensusEvent(*Event) error
	GetRound(int) (*RoundInfo, error)
	SetRound(int, *RoundInfo) error
	LastRound() int
	RoundWitnesses(int) []string
	RoundEvents(int) int
	GetRoot(string) (*Root, error)
	GetBlock(int) (*Block, error)
	SetBlock(*Block) error
	LastBlockIndex() int
	GetFrame(int) (*Frame, error)
	SetFrame(*Frame) error
	Reset(*Frame) error
	Close() error
	NeedBoostrap() bool // Was the store loaded from existing db
	StorePath() string
}

type TreKey added in v0.4.1 

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

func (TreKey) ToString added in v0.4.1 

func (k TreKey) ToString() string

type Trilean 

type Trilean int
const (
	Undefined Trilean = iota
	True
	False
)

func (Trilean) String 

func (t Trilean) String() string

type WireBlockSignature 

type WireBlockSignature struct {
	Index     int
	Signature string
}

type WireBody 

type WireBody struct {
	Transactions    [][]byte
	BlockSignatures []WireBlockSignature

	CreatorID            uint32
	OtherParentCreatorID uint32
	Index                int
	SelfParentIndex      int
	OtherParentIndex     int
}

type WireEvent 

type WireEvent struct {
	Body      WireBody
	Signature string
}

func (*WireEvent) BlockSignatures 

func (we *WireEvent) BlockSignatures(validator []byte) []BlockSignature

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.