snowman

type Config ¶

type Config struct {
	common.AllGetsServer

	Ctx                 *snow.ConsensusContext
	VM                  block.ChainVM
	Sender              common.Sender
	Validators          validators.Manager
	ConnectedValidators tracker.Peers
	Params              snowball.Parameters
	Consensus           snowman.Consensus
	PartialSync         bool
}

Config wraps all the parameters needed for a snowman engine

type Engine ¶

type Engine interface {
	common.Engine
	block.Getter
}

Engine describes the events that can occur to a Snowman instance.

The engine is used to fetch, order, and decide on the fate of blocks. This engine runs the leaderless version of the Snowman consensus protocol. Therefore, the liveness of this protocol tolerant to O(sqrt(n)) Byzantine Nodes where n is the number of nodes in the network. Therefore, this protocol should only be run in a Crash Fault Tolerant environment, or in an environment where lose of liveness and manual intervention is tolerable.

func New(config Config) (Engine, error)

func TraceEngine(engine Engine, tracer trace.Tracer) Engine

type EngineTest ¶ added in v1.10.9

type EngineTest struct {
	common.EngineTest

	CantGetBlock bool
	GetBlockF    func(context.Context, ids.ID) (snowman.Block, error)
}

EngineTest is a test engine

func (e *EngineTest) Default(cant bool)

func (e *EngineTest) GetBlock(ctx context.Context, blkID ids.ID) (snowman.Block, error)

type Transitive ¶

type Transitive struct {
	Config

	// list of NoOpsHandler for messages dropped by engine
	common.StateSummaryFrontierHandler
	common.AcceptedStateSummaryHandler
	common.AcceptedFrontierHandler
	common.AcceptedHandler
	common.AncestorsHandler
	common.AppHandler
	validators.Connector
	// contains filtered or unexported fields
}

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

func (t *Transitive) Chits(ctx context.Context, nodeID ids.NodeID, requestID uint32, preferredID ids.ID, preferredIDAtHeight ids.ID, acceptedID ids.ID) error

func (t *Transitive) Context() *snow.ConsensusContext

func (t *Transitive) GetBlock(ctx context.Context, blkID ids.ID) (snowman.Block, error)

func (t *Transitive) GetFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

func (t *Transitive) Gossip(ctx context.Context) error

func (*Transitive) Halt(context.Context)

func (t *Transitive) HealthCheck(ctx context.Context) (interface{}, error)

func (m *Transitive) Initialize(namespace string, reg prometheus.Registerer) error

func (t *Transitive) Notify(ctx context.Context, msg common.Message) error

func (t *Transitive) PullQuery(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkID ids.ID, requestedHeight uint64) error

func (t *Transitive) PushQuery(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkBytes []byte, requestedHeight uint64) error

func (t *Transitive) Put(ctx context.Context, nodeID ids.NodeID, requestID uint32, blkBytes []byte) error

func (t *Transitive) QueryFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

func (t *Transitive) Shutdown(ctx context.Context) error

func (t *Transitive) Start(ctx context.Context, startReqID uint32) error

func (*Transitive) Timeout(context.Context) error