Documentation
¶
Index ¶
Constants ¶
View Source
const ( RouteValidators = "/validators" RouteBlockMetadata = "/blocks/:" + api.ParameterBlockID + "/metadata" RouteChainManagerAllChainsDot = "/all-chains" RouteChainManagerAllChainsRendered = "/all-chains/rendered" RouteCommitmentBySlotBlockIDs = "/commitments/by-slot/:" + api.ParameterSlot + "/blocks" RouteCommitmentBySlotTransactionIDs = "/commitments/by-slot/:" + api.ParameterSlot + "/transactions" )
Variables ¶
View Source
var (
Component *app.Component
)
View Source
var ParamsDebugAPI = &ParametersDebugAPI{}
ParamsDebugAPI is the default configuration parameters for the DebugAPI component.
Functions ¶
This section is empty.
Types ¶
type BlockChangesResponse ¶
type BlockMetadataResponse ¶
type BlockMetadataResponse struct {
// BlockID The hex encoded block ID of the block.
BlockID string `json:"blockId"`
// StrongParents are the strong parents of the block.
StrongParents []string `json:"strongParents"`
// WeakParents are the weak parents of the block.
WeakParents []string `json:"weakParents"`
// ShallowLikeParents are the shallow like parents of the block.
ShallowLikeParents []string `json:"shallowLikeParents"`
Solid bool `json:"solid"`
Invalid bool `json:"invalid"`
Booked bool `json:"booked"`
PreAccepted bool `json:"preAccepted"`
Accepted bool `json:"accepted"`
PreConfirmed bool `json:"preConfirmed"`
Confirmed bool `json:"confirmed"`
Witnesses []string `json:"witnesses"`
// spenderIDs are the all spenderIDs of the block inherited from the parents + payloadSpenderIDs.
SpenderIDs []iotago.TransactionID `json:"spenderIDs"`
// payloadSpenderIDs are the spenderIDs of the block's payload (in case it is a transaction, otherwise empty).
PayloadSpenderIDs []iotago.TransactionID `json:"payloadSpenderIDs"`
String string `json:"string"`
}
func BlockMetadataResponseFromBlock ¶
func BlockMetadataResponseFromBlock(block *blocks.Block) *BlockMetadataResponse
type ParametersDebugAPI ¶
type ParametersDebugAPI struct {
// Enabled whether the DebugAPI component is enabled.
Enabled bool `default:"false" usage:"whether the DebugAPI component is enabled"`
Database struct {
Path string `default:"testnet/debug" usage:"the path to the database folder"`
MaxOpenDBs int `default:"2" usage:"maximum number of open database instances"`
Granularity int64 `default:"100" usage:"how many slots should be contained in a single DB instance"`
Pruning struct {
Threshold uint64 `default:"1" usage:"how many epochs should be retained"`
}
} `name:"db"`
}
ParametersDebugAPI contains the definition of configuration parameters used by the debug API.
type TransactionsChangesResponse ¶
type TransactionsChangesResponse struct {
// The index of the requested commitment.
Index iotago.SlotIndex `json:"index"`
// The transactions that got included in this slot.
IncludedTransactions []string `json:"includedTransactions"`
// The mutations root of the slot.
MutationsRoot string `json:"mutationsRoot"`
}
Click to show internal directories.
Click to hide internal directories.