message

Documentation

Index

• Constants
• Variables
• func ApprovalHandler(c echo.Context) error
• func MissingHandler(c echo.Context) error
• func OrphanageHandler(c echo.Context) error
• func PastconeHandler(c echo.Context) error
• type ApprovalResponse
• type ByArrival
  • func (a ByArrival) Len() int
  • func (a ByArrival) Less(i, j int) bool
  • func (a ByArrival) Swap(i, j int)
• type ByIssuance
  • func (a ByIssuance) Len() int
  • func (a ByIssuance) Less(i, j int) bool
  • func (a ByIssuance) Swap(i, j int)
• type BySolid
  • func (a BySolid) Len() int
  • func (a BySolid) Less(i, j int) bool
  • func (a BySolid) Swap(i, j int)
• 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 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

func ApprovalHandler(c echo.Context) error

ApprovalHandler runs the approval analysis.

func MissingHandler

func MissingHandler(c echo.Context) error

MissingHandler process missing requests.

func OrphanageHandler

func OrphanageHandler(c echo.Context) error

OrphanageHandler runs the orphanage analysis.

func PastconeHandler

func PastconeHandler(c echo.Context) error

PastconeHandler process a pastcone request.

Types

type ApprovalResponse

type ApprovalResponse struct {
	Err error `json:"error,omitempty"`
}

ApprovalResponse is the HTTP response.

type ByArrival

type ByArrival []MsgInfo

ByArrival defines a slice of MsgInfo sortable by arrival time.

func (ByArrival) Len

func (a ByArrival) Len() int

func (ByArrival) Less

func (a ByArrival) Less(i, j int) bool

func (ByArrival) Swap

func (a ByArrival) Swap(i, j int)

type ByIssuance

type ByIssuance []MsgInfo

ByIssuance defines a slice of MsgInfo sortable by timestamp issuance.

func (ByIssuance) Len

func (a ByIssuance) Len() int

func (ByIssuance) Less

func (a ByIssuance) Less(i, j int) bool

func (ByIssuance) Swap

func (a ByIssuance) Swap(i, j int)

type BySolid

type BySolid []MsgInfo

BySolid defines a slice of MsgInfo sortable by solid time.

func (BySolid) Len

func (a BySolid) Len() int

func (BySolid) Less

func (a BySolid) Less(i, j int) bool

func (BySolid) Swap

func (a BySolid) Swap(i, j int)

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

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

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

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

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.