npm
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NetworkApi

Network API

This module provides methods about the network itself

Hierarchy

  • NetworkApi

Index

Properties

Properties

getBlockchainStatus

getBlockchainStatus: function

Get the blockchain status.

returns

The Blockchain Status

Type declaration

getMiningInfo

getMiningInfo: function

Get the mining information.

returns

The Mining Information

Type declaration

getNetworkInfo

getNetworkInfo: function

Get detailed information about the Networks constants/settings.

returns

The Network Information

Type declaration

getPeer

getPeer: function

Get a peer by a given IP address

param

The peer's address

returns

The Peer

Type declaration

    • (address: string): Promise<Peer>

    • Parameters

      • address: string

      Returns Promise<Peer>

getPeers

getPeers: function

Get a list of peers

param

Only return active peers (default: true)

returns

The Peer Address List

Type declaration

getServerStatus

getServerStatus: function

Get the state of the server node and network. Note: This request is pretty slow and might needs several seconds until reply.

returns

The server Status

Type declaration

getSuggestedFees

getSuggestedFees: function

Get the current suggested fees

returns

The Suggested Fees

Type declaration

getTime

getTime: function

Get the current blockchain timestamp in seconds since Genesis Block

returns

timestamp in seconds since Genesis Block

Type declaration