odyssey

Documentation

Index

• type TestVertex
  • func (v *TestVertex) Bytes() []byte
  • func (v *TestVertex) Height() (uint64, error)
  • func (v *TestVertex) Parents() ([]Vertex, error)
  • func (v *TestVertex) Txs(context.Context) ([]snowstorm.Tx, error)
• type Vertex

Types

type TestVertex

type TestVertex struct {
	choices.TestDecidable

	ParentsV    []Vertex
	ParentsErrV error
	HeightV     uint64
	HeightErrV  error
	TxsV        []snowstorm.Tx
	TxsErrV     error
	BytesV      []byte
}

TestVertex is a useful test vertex

func (*TestVertex) Bytes

func (v *TestVertex) Bytes() []byte

func (*TestVertex) Height

func (v *TestVertex) Height() (uint64, error)

func (*TestVertex) Parents

func (v *TestVertex) Parents() ([]Vertex, error)

func (*TestVertex) Txs

func (v *TestVertex) Txs(context.Context) ([]snowstorm.Tx, error)

type Vertex

type Vertex interface {
	choices.Decidable

	// Returns the vertices this vertex depends on
	Parents() ([]Vertex, error)

	// Returns the height of this vertex. A vertex's height is defined by one
	// greater than the maximum height of the parents.
	Height() (uint64, error)

	// Returns a series of state transitions to be performed on acceptance
	Txs(context.Context) ([]snowstorm.Tx, error)

	// Returns the binary representation of this vertex
	Bytes() []byte
}

Vertex is a collection of multiple transactions tied to other vertices

Note: Verify is not part of this interface because bootstrapping uses IDs to verify the vertex is valid.