avalanche

Documentation

Index

• type Config
• type Engine
• type Transitive
  • func (t *Transitive) Chits(vdr ids.ShortID, requestID uint32, votes []ids.ID) error
  • func (t *Transitive) Get(vdr ids.ShortID, requestID uint32, vtxID ids.ID) error
  • func (t *Transitive) GetAncestors(vdr ids.ShortID, requestID uint32, vtxID ids.ID) error
  • func (t *Transitive) GetFailed(vdr ids.ShortID, requestID uint32) error
  • func (t *Transitive) GetVM() common.VM
  • func (t *Transitive) GetVtx(vtxID ids.ID) (avalanche.Vertex, error)
  • func (t *Transitive) Gossip() error
  • func (t *Transitive) HealthCheck() (interface{}, error)
  • func (t *Transitive) Initialize(config Config) error
  • func (t *Transitive) Notify(msg common.Message) error
  • func (t *Transitive) PullQuery(vdr ids.ShortID, requestID uint32, vtxID ids.ID) error
  • func (t *Transitive) PushQuery(vdr ids.ShortID, requestID uint32, vtxID ids.ID, vtxBytes []byte) error
  • func (t *Transitive) Put(vdr ids.ShortID, requestID uint32, vtxID ids.ID, vtxBytes []byte) error
  • func (t *Transitive) QueryFailed(vdr ids.ShortID, requestID uint32) error
  • func (t *Transitive) Shutdown() error

Types

type Config

type Config struct {
	bootstrap.Config

	Params    avalanche.Parameters
	Consensus avalanche.Consensus
}

Config wraps all the parameters needed for an avalanche engine

type Engine

type Engine interface {
	common.Engine

	// Initialize this engine.
	Initialize(Config) error

	// GetVtx returns a vertex by its ID.
	// Returns an error if unknown.
	GetVtx(vtxID ids.ID) (avalanche.Vertex, error)
}

Engine describes the events that can occur on a consensus instance

type Transitive

type Transitive struct {
	bootstrap.Bootstrapper

	Params    avalanche.Parameters
	Consensus avalanche.Consensus
	// contains filtered or unexported fields
}

Transitive implements the Engine interface by attempting to fetch all transitive dependencies.

func (*Transitive) Chits

func (t *Transitive) Chits(vdr ids.ShortID, requestID uint32, votes []ids.ID) error

Chits implements the Engine interface

func (*Transitive) Get

func (t *Transitive) Get(vdr ids.ShortID, requestID uint32, vtxID ids.ID) error

Get implements the Engine interface

func (*Transitive) GetAncestors

func (t *Transitive) GetAncestors(vdr ids.ShortID, requestID uint32, vtxID ids.ID) error

GetAncestors implements the Engine interface

func (*Transitive) GetFailed

func (t *Transitive) GetFailed(vdr ids.ShortID, requestID uint32) error

GetFailed implements the Engine interface

func (*Transitive) GetVM

func (t *Transitive) GetVM() common.VM

func (*Transitive) GetVtx

func (t *Transitive) GetVtx(vtxID ids.ID) (avalanche.Vertex, error)

GetVtx returns a vertex by its ID. Returns database.ErrNotFound if unknown.

func (*Transitive) Gossip

func (t *Transitive) Gossip() error

Gossip implements the Engine interface

func (*Transitive) HealthCheck

func (t *Transitive) HealthCheck() (interface{}, error)

Health implements the common.Engine interface

func (*Transitive) Initialize

func (t *Transitive) Initialize(config Config) error

Initialize implements the Engine interface

func (*Transitive) Notify

func (t *Transitive) Notify(msg common.Message) error

Notify implements the Engine interface

func (*Transitive) PullQuery

func (t *Transitive) PullQuery(vdr ids.ShortID, requestID uint32, vtxID ids.ID) error

PullQuery implements the Engine interface

func (*Transitive) PushQuery

func (t *Transitive) PushQuery(vdr ids.ShortID, requestID uint32, vtxID ids.ID, vtxBytes []byte) error

PushQuery implements the Engine interface

func (*Transitive) Put

func (t *Transitive) Put(vdr ids.ShortID, requestID uint32, vtxID ids.ID, vtxBytes []byte) error

Put implements the Engine interface

func (*Transitive) QueryFailed

func (t *Transitive) QueryFailed(vdr ids.ShortID, requestID uint32) error

QueryFailed implements the Engine interface

func (*Transitive) Shutdown

func (t *Transitive) Shutdown() error

Shutdown implements the Engine interface