vertex

Documentation

Index

• Variables
• func IsSortedAndUniqueHashOf(bytesSlice [][]byte) bool
• func SortHashOf(bytesSlice [][]byte)
• type Builder
• type DAGVM
• type Heap
  • func NewHeap() Heap
• type Manager
• type Parser
• type StatelessVertex
  • func Build(chainID ids.ID, height uint64, epoch uint32, parentIDs []ids.ID, txs [][]byte, ...) (StatelessVertex, error)
  • func Parse(vertex []byte) (StatelessVertex, error)
• type Storage
• type TestBuilder
  • func (b *TestBuilder) Build(epoch uint32, parentIDs []ids.ID, txs []snowstorm.Tx, restrictions []ids.ID) (avalanche.Vertex, error)
  • func (b *TestBuilder) Default(cant bool)
• type TestManager
  • func NewTestManager(t *testing.T) *TestManager
  • func (m *TestManager) Default(cant bool)
• type TestParser
  • func (p *TestParser) Default(cant bool)
  • func (p *TestParser) Parse(b []byte) (avalanche.Vertex, error)
• type TestStorage
  • func (s *TestStorage) Default(cant bool)
  • func (s *TestStorage) Edge() []ids.ID
  • func (s *TestStorage) Get(id ids.ID) (avalanche.Vertex, error)
• type TestVM
  • func (vm *TestVM) Default(cant bool)
  • func (vm *TestVM) Get(txID ids.ID) (snowstorm.Tx, error)
  • func (vm *TestVM) Parse(b []byte) (snowstorm.Tx, error)
  • func (vm *TestVM) Pending() []snowstorm.Tx

Variables

var (
	Codec codec.Manager
)

Functions

func IsSortedAndUniqueHashOf

func IsSortedAndUniqueHashOf(bytesSlice [][]byte) bool

func SortHashOf

func SortHashOf(bytesSlice [][]byte)

Types

type Builder

type Builder interface {
	// Build a new vertex from the contents of a vertex
	Build(
		epoch uint32,
		parentIDs []ids.ID,
		txs []snowstorm.Tx,
		restrictions []ids.ID,
	) (avalanche.Vertex, error)
}

Builder builds a vertex given a set of parentIDs and transactions.

type DAGVM

type DAGVM interface {
	common.VM

	// Return any transactions that have not been sent to consensus yet
	Pending() []snowstorm.Tx

	// Convert a stream of bytes to a transaction or return an error
	Parse(tx []byte) (snowstorm.Tx, error)

	// Retrieve a transaction that was submitted previously
	Get(ids.ID) (snowstorm.Tx, error)
}

DAGVM defines the minimum functionality that an avalanche VM must implement

type Heap

type Heap interface {
	// Empty the heap.
	Clear()

	// Add the provided vertex to the heap. Vertices are de-duplicated, returns
	// true if the vertex was added, false if it was dropped.
	Push(avalanche.Vertex) bool

	// Remove the top vertex. Assumes that there is at least one element.
	Pop() avalanche.Vertex

	// Returns if a vertex with the provided ID is currently in the heap.
	Contains(ids.ID) bool

	// Returns the number of vertices in the heap.
	Len() int
}

Heap defines the functionality of a heap of vertices with unique VertexIDs ordered by height

func NewHeap

func NewHeap() Heap

NewHeap returns an empty Heap

type Manager

type Manager interface {
	Builder
	Parser
	Storage
}

Manager defines all the vertex related functionality that is required by the consensus engine.

type Parser

type Parser interface {
	// Parse a vertex from a slice of bytes
	Parse(vertex []byte) (avalanche.Vertex, error)
}

Parser parses bytes into a vertex.

type StatelessVertex

type StatelessVertex interface {
	verify.Verifiable
	ID() ids.ID
	Bytes() []byte

	Version() uint16
	ChainID() ids.ID
	Height() uint64
	Epoch() uint32
	ParentIDs() []ids.ID
	Txs() [][]byte
	Restrictions() []ids.ID
}

func Build

func Build(
	chainID ids.ID,
	height uint64,
	epoch uint32,
	parentIDs []ids.ID,
	txs [][]byte,
	restrictions []ids.ID,
) (StatelessVertex, error)

Build a new stateless vertex from the contents of a vertex

func Parse

func Parse(vertex []byte) (StatelessVertex, error)

Parse the provided vertex bytes into a stateless vertex

type Storage

type Storage interface {
	// Get a vertex by its hash from storage.
	Get(vtxID ids.ID) (avalanche.Vertex, error)

	// Edge returns a list of accepted vertex IDs with no accepted children.
	Edge() (vtxIDs []ids.ID)
}

Storage defines the persistent storage that is required by the consensus engine.

type TestBuilder

type TestBuilder struct {
	T         *testing.T
	CantBuild bool
	BuildF    func(
		epoch uint32,
		parentIDs []ids.ID,
		txs []snowstorm.Tx,
		restrictions []ids.ID,
	) (avalanche.Vertex, error)
}

func (*TestBuilder) Build

func (b *TestBuilder) Build(
	epoch uint32,
	parentIDs []ids.ID,
	txs []snowstorm.Tx,
	restrictions []ids.ID,
) (avalanche.Vertex, error)

func (*TestBuilder) Default

func (b *TestBuilder) Default(cant bool)

type TestManager

type TestManager struct {
	TestBuilder
	TestParser
	TestStorage
}

func NewTestManager

func NewTestManager(t *testing.T) *TestManager

func (*TestManager) Default

func (m *TestManager) Default(cant bool)

type TestParser

type TestParser struct {
	T         *testing.T
	CantParse bool
	ParseF    func([]byte) (avalanche.Vertex, error)
}

func (*TestParser) Default

func (p *TestParser) Default(cant bool)

func (*TestParser) Parse

func (p *TestParser) Parse(b []byte) (avalanche.Vertex, error)

type TestStorage

type TestStorage struct {
	T                 *testing.T
	CantGet, CantEdge bool
	GetF              func(ids.ID) (avalanche.Vertex, error)
	EdgeF             func() []ids.ID
}

func (*TestStorage) Default

func (s *TestStorage) Default(cant bool)

func (*TestStorage) Edge

func (s *TestStorage) Edge() []ids.ID

func (*TestStorage) Get

func (s *TestStorage) Get(id ids.ID) (avalanche.Vertex, error)

type TestVM

type TestVM struct {
	common.TestVM

	CantPending, CantParse, CantGet bool

	PendingF func() []snowstorm.Tx
	ParseF   func([]byte) (snowstorm.Tx, error)
	GetF     func(ids.ID) (snowstorm.Tx, error)
}

func (*TestVM) Default

func (vm *TestVM) Default(cant bool)

func (*TestVM) Get

func (vm *TestVM) Get(txID ids.ID) (snowstorm.Tx, error)

func (*TestVM) Parse

func (vm *TestVM) Parse(b []byte) (snowstorm.Tx, error)

func (*TestVM) Pending

func (vm *TestVM) Pending() []snowstorm.Tx