snowman

Documentation

Index

• Variables
• type Block
• type Consensus
  • func Trace(consensus Consensus, tracer trace.Tracer) Consensus
• type Factory
• type OracleBlock
• type Topological
  • func (ts *Topological) Add(blk Block) error
  • func (ts *Topological) HealthCheck(context.Context) (interface{}, error)
  • func (ts *Topological) Initialize(ctx *snow.ConsensusContext, params snowball.Parameters, lastAcceptedID ids.ID, ...) error
  • func (ts *Topological) IsPreferred(blkID ids.ID) bool
  • func (ts *Topological) LastAccepted() (ids.ID, uint64)
  • func (ts *Topological) NumProcessing() int
  • func (ts *Topological) Preference() ids.ID
  • func (ts *Topological) PreferenceAtHeight(height uint64) (ids.ID, bool)
  • func (ts *Topological) Processing(blkID ids.ID) bool
  • func (ts *Topological) RecordPoll(ctx context.Context, voteBag bag.Bag[ids.ID]) error
• type TopologicalFactory
  • func (TopologicalFactory) New() Consensus

Variables

var ErrNotOracle = errors.New("block isn't an oracle")

Types

type Block

type Block interface {
	snow.Decidable

	// Parent returns the ID of this block's parent.
	Parent() ids.ID

	// Verify that the state transition this block would make if accepted is
	// valid. If the state transition is invalid, a non-nil error should be
	// returned.
	//
	// It is guaranteed that the Parent has been successfully verified.
	//
	// If nil is returned, it is guaranteed that either Accept or Reject will be
	// called on this block, unless the VM is shut down.
	Verify(context.Context) error

	// Bytes returns the binary representation of this block.
	//
	// This is used for sending blocks to peers. The bytes should be able to be
	// parsed into the same block on another node.
	Bytes() []byte

	// Height returns the height of this block in the chain.
	Height() uint64

	// Time this block was proposed at. This value should be consistent across
	// all nodes. If this block hasn't been successfully verified, any value can
	// be returned. If this block is the last accepted block, the timestamp must
	// be returned correctly. Otherwise, accepted blocks can return any value.
	Timestamp() time.Time
}

Block is a possible decision that dictates the next canonical block.

Blocks are guaranteed to be Verified, Accepted, and Rejected in topological order. Specifically, if Verify is called, then the parent has already been verified. If Accept is called, then the parent has already been accepted. If Reject is called, the parent has already been accepted or rejected.

If the status of the block is Unknown, ID is assumed to be able to be called. If the status of the block is Accepted or Rejected; Parent, Verify, Accept, and Reject will never be called.

type Consensus

type Consensus interface {
	health.Checker

	// Takes in the context, snowball parameters, and the last accepted block.
	Initialize(
		ctx *snow.ConsensusContext,
		params snowball.Parameters,
		lastAcceptedID ids.ID,
		lastAcceptedHeight uint64,
		lastAcceptedTime time.Time,
	) error

	// Returns the number of blocks processing
	NumProcessing() int

	// Add a new block.
	//
	// Add should not be called multiple times with the same block.
	// The parent block should either be the last accepted block or processing.
	//
	// Returns if a critical error has occurred.
	Add(Block) error

	// Processing returns true if the block ID is currently processing.
	Processing(ids.ID) bool

	// IsPreferred returns true if the block ID is preferred. Only the last
	// accepted block and processing blocks are considered preferred.
	IsPreferred(ids.ID) bool

	// Returns the ID and height of the last accepted decision.
	LastAccepted() (ids.ID, uint64)

	// Returns the ID of the tail of the strongly preferred sequence of
	// decisions.
	Preference() ids.ID

	// Returns the ID of the strongly preferred decision with the provided
	// height. Only the last accepted decision and processing decisions are
	// tracked.
	PreferenceAtHeight(height uint64) (ids.ID, bool)

	// RecordPoll collects the results of a network poll. Assumes all decisions
	// have been previously added. Returns if a critical error has occurred.
	RecordPoll(context.Context, bag.Bag[ids.ID]) error
}

Consensus represents a general snowman instance that can be used directly to process a series of dependent operations.

func Trace

func Trace(consensus Consensus, tracer trace.Tracer) Consensus

type Factory

type Factory interface {
	New() Consensus
}

Factory returns new instances of Consensus

type OracleBlock

type OracleBlock interface {
	// Options returns the possible children of this block in the order this
	// validator prefers the blocks.
	Options(context.Context) ([2]Block, error)
}

OracleBlock is a block that only has two valid children. The children should be returned in preferential order.

This ordering does not need to be deterministically created from the chain state.

type Topological

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

Topological implements the Snowman interface by using a tree tracking the strongly preferred branch. This tree structure amortizes network polls to vote on more than just the next block.

func (*Topological) Add

func (ts *Topological) Add(blk Block) error

func (*Topological) HealthCheck

func (ts *Topological) HealthCheck(context.Context) (interface{}, error)

HealthCheck returns information about the consensus health.

func (*Topological) Initialize

func (ts *Topological) Initialize(
	ctx *snow.ConsensusContext,
	params snowball.Parameters,
	lastAcceptedID ids.ID,
	lastAcceptedHeight uint64,
	lastAcceptedTime time.Time,
) error

func (*Topological) IsPreferred

func (ts *Topological) IsPreferred(blkID ids.ID) bool

func (*Topological) LastAccepted

func (ts *Topological) LastAccepted() (ids.ID, uint64)

func (*Topological) NumProcessing

func (ts *Topological) NumProcessing() int

func (*Topological) Preference

func (ts *Topological) Preference() ids.ID

func (*Topological) PreferenceAtHeight

func (ts *Topological) PreferenceAtHeight(height uint64) (ids.ID, bool)

func (*Topological) Processing

func (ts *Topological) Processing(blkID ids.ID) bool

func (*Topological) RecordPoll

func (ts *Topological) RecordPoll(ctx context.Context, voteBag bag.Bag[ids.ID]) error

The votes bag contains at most K votes for blocks in the tree. If there is a vote for a block that isn't in the tree, the vote is dropped.

Votes are propagated transitively towards the genesis. All blocks in the tree that result in at least Alpha votes will record the poll on their children. Every other block will have an unsuccessful poll registered.

After collecting which blocks should be voted on, the polls are registered and blocks are accepted/rejected as needed. The preference is then updated to equal the leaf on the preferred branch.

To optimize the theoretical complexity of the vote propagation, a topological sort is done over the blocks that are reachable from the provided votes. During the sort, votes are pushed towards the genesis. To prevent interating over all blocks that had unsuccessful polls, we set a flag on the block to know that any future traversal through that block should register an unsuccessful poll on that block and every descendant block.

The complexity of this function is: - Runtime = 4 * |live set| + |votes| - Space = 2 * |live set| + |votes|

type TopologicalFactory

type TopologicalFactory struct{}

TopologicalFactory implements Factory by returning a topological struct

func (TopologicalFactory) New

func (TopologicalFactory) New() Consensus