Documentation
¶
Index ¶
Constants ¶
View Source
const PluginName = "WebAPI info Endpoint"
PluginName is the name of the web API info endpoint plugin.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Beacon ¶ added in v0.2.2
type Beacon struct {
PublicKey string `json:"public_key"`
MsgID string `json:"msg_id"`
SentTime int64 `json:"sent_time"`
Synced bool `json:"synced"`
}
Beacon contains a sync beacons detailed status.
type Response ¶
type Response struct {
// version of GoShimmer
Version string `json:"version,omitempty"`
// whether the node is synchronized
Synced bool `json:"synced"`
// sync beacons status
Beacons []Beacon `json:"beacons"`
// identity ID of the node encoded in base58 and truncated to its first 8 bytes
IdentityID string `json:"identityID,omitempty"`
// public key of the node encoded in base58
PublicKey string `json:"publicKey,omitempty"`
// MessageRequestQueueSize is the number of messages a node is trying to request from neighbors.
MessageRequestQueueSize int `json:"messageRequestQueueSize,omitempty"`
// SolidMessageCount is the number of solid messages in the node's database.
SolidMessageCount int `json:"solidMessageCount,omitempty"`
// TotalMessageCount is the number of messages in the node's database.
TotalMessageCount int `json:"totalMessageCount,omitempty"`
// list of enabled plugins
EnabledPlugins []string `json:"enabledPlugins,omitempty"`
// list if disabled plugins
DisabledPlugins []string `json:"disabledPlugins,omitempty"`
// error of the response
Error string `json:"error,omitempty"`
}
Response holds the response of the GET request.
Click to show internal directories.
Click to hide internal directories.