debug

Documentation

Index

• Constants
• Variables
• type ParametersDebug

Constants

const (
	// RouteDebugSolidifier is the debug route to manually trigger the solidifier.
	// POST triggers the solidifier.
	RouteDebugSolidifier = "/solidifier"

	// RouteDebugOutputs is the debug route for getting all output IDs.
	// GET returns the outputIDs for all outputs.
	RouteDebugOutputs = "/outputs"

	// RouteDebugOutputsUnspent is the debug route for getting all unspent output IDs.
	// GET returns the outputIDs for all unspent outputs.
	RouteDebugOutputsUnspent = "/outputs/unspent"

	// RouteDebugOutputsSpent is the debug route for getting all spent output IDs.
	// GET returns the outputIDs for all spent outputs.
	RouteDebugOutputsSpent = "/outputs/spent"

	// RouteDebugMilestoneDiffs is the debug route for getting a milestone diff by it's milestoneIndex.
	// GET returns the utxo diff (new outputs & spents) for the milestone index.
	RouteDebugMilestoneDiffs = "/ms-diff/:" + restapipkg.ParameterMilestoneIndex

	// RouteDebugRequests is the debug route for getting all pending requests.
	// GET returns a list of all pending requests.
	RouteDebugRequests = "/requests"

	// RouteDebugBlockCone is the debug route for traversing a cone of a block.
	// it traverses the parents of a block until they reference an older milestone than the start block.
	// GET returns the path of this traversal and the "entry points".
	RouteDebugBlockCone = "/block-cones/:" + restapipkg.ParameterBlockID
)

const (

	// QueryParameterOutputType is used to filter for a certain output type.
	QueryParameterOutputType = "type"
)

Variables

var (
	Component *app.Component
)

var ParamsDebug = &ParametersDebug{}

Types

type ParametersDebug

type ParametersDebug struct {
	// Enabled defines whether the debug plugin is enabled.
	Enabled bool `default:"false" usage:"whether the debug plugin is enabled"`
}

ParametersDebug contains the definition of the parameters used by the debug plugin.