tipselection

Documentation

Index

• Variables
• func WalkerStatsCaller(handler interface{}, params ...interface{})
• type TipSelStats
  • func SelectTips(depth uint, reference *trinary.Hash) ([]trinary.Hash, *TipSelStats, error)

Variables

var ErrDepthTooHigh = errors.New("depth is too high")

var ErrMilestoneNotFound = errors.New("milestone not found")

var ErrNodeNotSynced = errors.New("node is not synchronized")

var ErrReferenceNotConsistent = errors.New("reference transaction is not consistent")

var ErrReferenceNotValid = errors.New("reference transaction is not valid")

var Events = tipselevents{
	TipSelPerformed: events.NewEvent(WalkerStatsCaller),
}

var PLUGIN = node.NewPlugin("Tip-Sel", node.Enabled, configure, run)

Functions

func WalkerStatsCaller

func WalkerStatsCaller(handler interface{}, params ...interface{})

Types

type TipSelStats

type TipSelStats struct {
	// The duration of the tip-selection for both walks.
	Duration time.Duration `json:"duration"`
	// The entry point of the tip-selection.
	EntryPoint trinary.Hash `json:"entry_point"`
	// The optional supplied reference transaction hash.
	Reference *trinary.Hash `json:"reference"`
	// The used depth for the tip-selection.
	Depth uint64 `json:"depth"`
	// The amount of steps taken, respectively transactions walked towards the present of the graph.
	StepsTaken uint64 `json:"steps_taken"`
	// The amount of steps jumped, meaning approvers selected without validating, as they were
	// walked/validated into by the previous walk.
	StepsJumped uint64 `json:"steps_jumped"`
	// The amount of transactions which were evaluated.
	Evaluated uint64 `json:"evaluated"`
	// Represents the cache hit ration for every call to belowMaxDepth globally over all tip-selections.
	GlobalBelowMaxDepthCacheHitRatio float64 `json:"global_below_max_depth_cache_hit_ratio"`
}

func SelectTips

func SelectTips(depth uint, reference *trinary.Hash) ([]trinary.Hash, *TipSelStats, error)