Documentation
¶
Index ¶
- Constants
- Variables
- func ApprovalHandler(c echo.Context) error
- func DiagnosticBranchesHandler(c echo.Context) (err error)
- func DiagnosticInvalidBranchesHandler(c echo.Context) (err error)
- func DiagnosticLazyBookedBranchesHandler(c echo.Context) (err error)
- func DiagnosticMessagesHandler(c echo.Context) (err error)
- func DiagnosticMessagesOnlyFirstWeakReferencesHandler(c echo.Context) (err error)
- func DiagnosticMessagesRankHandler(c echo.Context) (err error)
- func DiagnosticUTXODAGHandler(c echo.Context) (err error)
- func MissingHandler(c echo.Context) error
- func OrphanageHandler(c echo.Context) error
- func PastconeHandler(c echo.Context) error
- type ApprovalResponse
- type ByArrival
- type ByIssuance
- type BySolid
- type DiagnosticBranchInfo
- type DiagnosticMessagesInfo
- type DiagnosticUTXODAGInfo
- type MissingResponse
- type MsgApproval
- type MsgInfo
- type MsgInfoOrphanage
- type OrphanageResponse
- type PastconeRequest
- type PastconeResponse
Constants ¶
const (
// CfgExportPath the directory where exported files sit.
CfgExportPath = "webapi.exportPath"
)
Variables ¶
var DiagnosticBranchesTableDescription = []string{
"ID",
"ConflictSet",
"IssuanceTime",
"SolidTime",
"OpinionFormedTime",
"Liked",
"MonotonicallyLiked",
"InclusionState",
"Finalized",
"LazyBooked",
"TransactionLiked",
}
DiagnosticBranchesTableDescription holds the description of the diagnostic Branches.
var DiagnosticMessagesTableDescription = []string{
"ID",
"IssuerID",
"IssuerPublicKey",
"IssuanceTime",
"ArrivalTime",
"SolidTime",
"ScheduledTime",
"BookedTime",
"OpinionFormedTime",
"StrongParents",
"WeakParents",
"StrongApprovers",
"WeakApprovers",
"BranchID",
"InclusionState",
"Scheduled",
"Booked",
"Eligible",
"Invalid",
"Rank",
"IsPastMarker",
"PastMarkers",
"PMHI",
"PMLI",
"FutureMarkers",
"FMHI",
"FMLI",
"PayloadType",
"TransactionID",
}
DiagnosticMessagesTableDescription holds the description of the diagnostic messages.
var DiagnosticUTXODAGTableDescription = []string{
"ID",
"IssuanceTime",
"SolidTime",
"OpinionFormedTime",
"AccessManaPledgeID",
"ConsensusManaPledgeID",
"Inputs",
"Outputs",
"Attachments",
"BranchID",
"BranchLiked",
"BranchMonotonicallyLiked",
"Conflicting",
"InclusionState",
"Finalized",
"LazyBooked",
"Liked",
}
DiagnosticUTXODAGTableDescription holds the description of the diagnostic UTXODAG.
var TableDescription = []string{
"nodeID",
"MsgID",
"MsgIssuerID",
"MsgIssuanceTime",
"MsgArrivalTime",
"MsgSolidTime",
"ByIssuanceMsgID",
"ByIssuanceMsgIssuerID",
"ByIssuanceMsgIssuanceTime",
"ByIssuanceMsgArrivalTime",
"ByIssuanceMsgSolidTime",
"ByArrivalMsgID",
"ByArrivalMsgIssuerID",
"ByArrivalMsgIssuanceTime",
"ByArrivalMsgArrivalTime",
"ByArrivalMsgSolidTime",
"BySolidMsgID",
"BySolidMsgIssuerID",
"BySolidMsgIssuanceTime",
"BySolidMsgArrivalTime",
"BySolidMsgSolidTime",
}
TableDescription holds the description of the First Approval analysis table.
var TableDescriptionOrphanage = []string{
"MsgID",
"MsgIssuerID",
"MsgIssuanceTime",
"MsgArrivalTime",
"MsgSolidTime",
"MsgApprovedBy",
}
TableDescriptionOrphanage holds the description of the First Approval analysis table.
Functions ¶
func ApprovalHandler ¶ added in v0.3.6
ApprovalHandler runs the approval analysis.
func DiagnosticBranchesHandler ¶ added in v0.5.3
DiagnosticBranchesHandler runs the diagnostic over the Tangle.
func DiagnosticInvalidBranchesHandler ¶ added in v0.5.3
DiagnosticInvalidBranchesHandler runs the diagnostic over the Tangle.
func DiagnosticLazyBookedBranchesHandler ¶ added in v0.5.3
DiagnosticLazyBookedBranchesHandler runs the diagnostic over the Tangle.
func DiagnosticMessagesHandler ¶ added in v0.5.3
DiagnosticMessagesHandler runs the diagnostic over the Tangle.
func DiagnosticMessagesOnlyFirstWeakReferencesHandler ¶ added in v0.5.3
DiagnosticMessagesOnlyFirstWeakReferencesHandler runs the diagnostic over the Tangle.
func DiagnosticMessagesRankHandler ¶ added in v0.5.3
DiagnosticMessagesRankHandler runs the diagnostic over the Tangle for messages with rank >= of the given rank parameter.
func DiagnosticUTXODAGHandler ¶ added in v0.5.3
DiagnosticUTXODAGHandler runs the diagnostic over the Tangle.
func MissingHandler ¶
MissingHandler process missing requests.
func OrphanageHandler ¶ added in v0.4.1
OrphanageHandler runs the orphanage analysis.
func PastconeHandler ¶
PastconeHandler process a pastcone request.
Types ¶
type ApprovalResponse ¶ added in v0.3.6
type ApprovalResponse struct {
Err error `json:"error,omitempty"`
}
ApprovalResponse is the HTTP response.
type ByArrival ¶ added in v0.3.6
type ByArrival []MsgInfo
ByArrival defines a slice of MsgInfo sortable by arrival time.
type ByIssuance ¶ added in v0.3.6
type ByIssuance []MsgInfo
ByIssuance defines a slice of MsgInfo sortable by timestamp issuance.
func (ByIssuance) Len ¶ added in v0.3.6
func (a ByIssuance) Len() int
func (ByIssuance) Less ¶ added in v0.3.6
func (a ByIssuance) Less(i, j int) bool
func (ByIssuance) Swap ¶ added in v0.3.6
func (a ByIssuance) Swap(i, j int)
type BySolid ¶ added in v0.3.6
type BySolid []MsgInfo
BySolid defines a slice of MsgInfo sortable by solid time.
type DiagnosticBranchInfo ¶ added in v0.5.3
type DiagnosticBranchInfo struct {
ID string
ConflictSet []string
IssuanceTimestamp time.Time
SolidTime time.Time
OpinionFormedTime time.Time
Liked bool
MonotonicallyLiked bool
InclusionState string
Finalized bool
LazyBooked bool
TransactionLiked bool
}
DiagnosticBranchInfo holds the information of a branch.
type DiagnosticMessagesInfo ¶ added in v0.5.3
type DiagnosticMessagesInfo struct {
ID string
IssuerID string
IssuerPublicKey string
IssuanceTimestamp time.Time
ArrivalTime time.Time
SolidTime time.Time
ScheduledTime time.Time
BookedTime time.Time
OpinionFormedTime time.Time
StrongParents tangle.MessageIDs
WeakParents tangle.MessageIDs
StrongApprovers tangle.MessageIDs
WeakApprovers tangle.MessageIDs
BranchID string
InclusionState string
Scheduled bool
Booked bool
Eligible bool
Invalid bool
Rank uint64
IsPastMarker bool
PastMarkers string // PastMarkers
PMHI uint64 // PastMarkers Highest Index
PMLI uint64 // PastMarkers Lowest Index
FutureMarkers string // FutureMarkers
FMHI uint64 // FutureMarkers Highest Index
FMLI uint64 // FutureMarkers Lowest Index
PayloadType string
TransactionID string
}
DiagnosticMessagesInfo holds the information of a message.
type DiagnosticUTXODAGInfo ¶ added in v0.5.3
type DiagnosticUTXODAGInfo struct {
// transaction essence
ID string
IssuanceTimestamp time.Time
SolidTime time.Time
OpinionFormedTime time.Time
AccessManaPledgeID string
ConsensusManaPledgeID string
Inputs ledgerstate.Inputs
Outputs ledgerstate.Outputs
// attachments
Attachments []string
// transaction metadata
BranchID string
BranchLiked bool
BranchMonotonicallyLiked bool
Conflicting bool
InclusionState string
Finalized bool
LazyBooked bool
Liked bool
}
DiagnosticUTXODAGInfo holds the information of a UTXO.
type MissingResponse ¶
type MissingResponse struct {
IDs []string `json:"ids,omitempty"`
Count int `json:"count,omitempty"`
}
MissingResponse is the HTTP response containing all the missing messages and their count.
type MsgApproval ¶ added in v0.3.6
type MsgApproval struct {
NodeID string
Msg MsgInfo
FirstApproverByIssuance MsgInfo
FirstApproverByArrival MsgInfo
FirstApproverBySolid MsgInfo
}
MsgApproval holds the information of the first approval by issucane, arrival and solid time.
type MsgInfo ¶ added in v0.3.6
type MsgInfo struct {
MsgID string
MsgIssuerID string
MsgIssuanceTimestamp time.Time
MsgArrivalTime time.Time
MsgSolidTime time.Time
}
MsgInfo holds the information of a message.
type MsgInfoOrphanage ¶ added in v0.4.1
type MsgInfoOrphanage struct {
MsgID tangle.MessageID
MsgIssuerID ed25519.PublicKey
MsgIssuanceTimestamp time.Time
MsgArrivalTime time.Time
MsgSolidTime time.Time
MsgApprovedBy bool
}
MsgInfoOrphanage holds the information of a message.
type OrphanageResponse ¶ added in v0.4.1
type OrphanageResponse struct {
Err string `json:"error,omitempty"`
}
OrphanageResponse is the HTTP response.
type PastconeRequest ¶
type PastconeRequest struct {
ID string `json:"id"`
}
PastconeRequest holds the message id to query.
type PastconeResponse ¶
type PastconeResponse struct {
Exist bool `json:"exist,omitempty"`
PastConeSize int `json:"pastConeSize,omitempty"`
Error string `json:"error,omitempty"`
}
PastconeResponse is the HTTP response containing the number of messages in the past cone and if all messages of the past cone exist on the node.
Source Files