Info API Methods

Info API returns basic info about the node

The API provides the following functions and endpoints:

• /info
• /healthz

Client lib APIs:

• Info()

/info

Returns basic info about the node.

Parameters

None.

Examples

cURL

curl --location 'http://localhost:8080/info'

Client lib - Info

Information of a node can be retrieved via Info() (*jsonmodels.InfoResponse, error)

info, err := goshimAPI.Info()
if err != nil {
    // return error
}

// will print the response
fmt.Println(string(info))

Response example

{
  "version": "v0.6.2",
  "networkVersion": 30,
  "tangleTime": {
    "blockID": "6ndfmfogpH9H8C9X9Fbb7Jmuf8RJHQgSjsHNPdKUUhoJ",
    "time": 1621879864032595415,
    "synced": true
  },
  "identityID": "D9SPFofAGhA5V9QRDngc1E8qG9bTrnATmpZMdoyRiBoW",
  "identityIDShort": "XBgY5DsUPng",
  "publicKey": "9DB3j9cWYSuEEtkvanrzqkzCQMdH1FGv3TawJdVbDxkd",
  "solidBlockCount": 74088,
  "totalBlockCount": 74088,
  "enabledPlugins": [
    "Activity",
    "AnalysisClient",
    "AutoPeering",
    "Banner",
    "CLI",
    "Clock",
    "Config",
    "Consensus",
    "DRNG",
    "Dashboard",
    "Database",
    "Gossip",
    "GracefulShutdown",
    "Logger",
    "Mana",
    "ManaRefresher",
    "ManualPeering",
    "BlockLayer",
    "Metrics",
    "NetworkDelay",
    "PoW",
    "PortCheck",
    "Profiling",
    "Prometheus",
    "RemoteLog",
    "RemoteLogMetrics",
    "WebAPI",
    "WebAPIDRNGEndpoint",
    "WebAPIManaEndpoint",
    "WebAPIWeightProviderEndpoint",
    "WebAPIAutoPeeringEndpoint",
    "WebAPIDataEndpoint",
    "WebAPIFaucetEndpoint",
    "WebAPIHealthzEndpoint",
    "WebAPIInfoEndpoint",
    "WebAPILedgerstateEndpoint",
    "WebAPIBlockEndpoint",
    "WebAPIToolsEndpoint",
    "snapshot"
  ],
  "disabledPlugins": [
    "AnalysisDashboard",
    "AnalysisServer",
    "Faucet",
    "ManaEventLogger",
    "Spammer",
    "TXStream"
  ],
  "mana": {
    "access": 1,
    "accessTimestamp": "2021-05-24T20:11:05.451224937+02:00",
    "consensus": 10439991680906,
    "consensusTimestamp": "2021-05-24T20:11:05.451228137+02:00"
  },
  "manaDelegationAddress": "1HMQic52dz3xLY2aeDXcDhX53LgbsHghdfD8eGXR1qVHy",
  "mana_decay": 0.00003209,
  "scheduler": {
    "running": true,
    "rate": "5ms",
    "nodeQueueSizes": {}
  },
  "rateSetter": {
    "rate": 20000,
    "size": 0
  }
}

Results

Return field	Type	Description
version	String	Version of GoShimmer.
networkVersion	uint32	Network Version of the autopeering.
tangleTime	TangleTime	TangleTime sync status
identityID	string	Identity ID of the node encoded in base58.
identityIDShort	string	Identity ID of the node encoded in base58 and truncated to its first 8 bytes.
publicKey	string	Public key of the node encoded in base58
blockRequestQueueSize	int	The number of blocks a node is trying to request from neighbors.
solidBlockCount	int	The number of solid blocks in the node's database.
totalBlockCount	int	The number of blocks in the node's database.
enabledPlugins	[]string	List of enabled plugins.
disabledPlugins	[]string	List if disabled plugins.
mana	Mana	Mana values.
manaDelegationAddress	string	Mana Delegation Address.
mana_decay	float64	The decay coefficient of bm2.
scheduler	Scheduler	Scheduler is the scheduler used.
rateSetter	RateSetter	RateSetter is the rate setter used.
error	string	Error block. Omitted if success.

• Type TangleTime

field	Type	Description
blockID	string	ID of the last confirmed block.
time	int64	Issue timestamp of the last confirmed block.
synced	bool	Flag indicating whether node is in sync.

• Type Scheduler

field	Type	Description
running	bool	Flag indicating whether Scheduler has started.
rate	string	Rate of the scheduler.
nodeQueueSizes	map[string]int	The size for each node queue.

• Type RateSetter

field	Type	Description
rate	float64	The rate of the rate setter..
size	int	The size of the issuing queue.

• Type Mana

field	Type	Description
access	float64	Access mana assigned to the node.
accessTimestamp	time.Time	Time when the access mana was calculated.
consensus	float64	Consensus mana assigned to the node.
consensusTimestamp	time.Time	Time when the consensus mana was calculated.

/healthz

Returns HTTP code 200 if everything is running correctly.

Parameters

None.

Examples

cURL

curl --location 'http://localhost:8080/healthz'

Client lib

This method is not available in client lib

Results

Empty response with HTTP 200 success code if everything is running correctly. Error block is returned if failed.