urts

Documentation

Index

• Variables
• type ParametersTipsel

Variables

var ParamsTipsel = &ParametersTipsel{}

var (
	Plugin *app.Plugin
)

Types

type ParametersTipsel

type ParametersTipsel struct {
	// Enabled defines whether the tipselection plugin is enabled.
	Enabled bool `default:"true" usage:"whether the tipselection plugin is enabled"`

	// the config group used for the non-lazy tip-pool
	NonLazy struct {
		// Defines the maximum amount of current tips for which "CfgTipSelMaxReferencedTipAge"
		// and "CfgTipSelMaxChildren" are checked. if the amount of tips exceeds this limit,
		// referenced tips get removed directly to reduce the amount of tips in the network.
		RetentionRulesTipsLimit int `default:"100" usage:"the maximum number of current tips for which the retention rules are checked (non-lazy)"`
		// Defines the maximum time a tip remains in the tip pool
		// after it was referenced by the first block.
		MaxReferencedTipAge time.Duration `default:"3s" usage:"the maximum time a tip remains in the tip pool after it was referenced by the first block (non-lazy)"`
		// Defines the maximum amount of references by other blocks
		// before the tip is removed from the tip pool.
		MaxChildren uint32 `default:"30" usage:"the maximum amount of references by other blocks before the tip is removed from the tip pool (non-lazy)"`
	}

	// the config group used for the semi-lazy tip-pool
	SemiLazy struct {
		// Defines the maximum amount of current tips for which "CfgTipSelMaxReferencedTipAge"
		// and "CfgTipSelMaxChildren" are checked. if the amount of tips exceeds this limit,
		// referenced tips get removed directly to reduce the amount of tips in the network.
		RetentionRulesTipsLimit int `default:"20" usage:"the maximum number of current tips for which the retention rules are checked (semi-lazy)"`
		// Defines the maximum time a tip remains in the tip pool
		// after it was referenced by the first block.
		MaxReferencedTipAge time.Duration `default:"3s" usage:"the maximum time a tip remains in the tip pool after it was referenced by the first block (semi-lazy)"`
		// Defines the maximum amount of references by other blocks
		// before the tip is removed from the tip pool.
		MaxChildren uint32 `default:"2" usage:"the maximum amount of references by other blocks before the tip is removed from the tip pool (semi-lazy)"`
	}
}

ParametersTipsel contains the definition of the parameters used by Tipselection.