Node
This is a resource for interacting with the node
endpoint provided by the Lisk public API.
Each of the following methods can be accessed via the node
property of an APIClient
instance.
getConstants
This returns all current constants data on the system. For example, the Lisk epoch time and version.
Parameters
options
: Please see the options in the following link: Core API documentation.
getStatus
This returns all the current status data of the node.
Parameters
options
: Please see the options in the following link: Core API documentation.
getForgingStatus
Please take note: This is a private endpoint ONLY authorized to whitelisted IPs. |
This responds with the forging status of a delegate on a node.
Parameters
options
: Please see the options in the following link: Core API documentation.
updateForgingStatus
Please take note: This is a private endpoint ONLY authorized to whitelisted IPs. |
After inputting the correct password and publicKey, forging will be enabled or disabled for the delegate of this particular node. The password can be generated locally by encrypting your passphrase, either by using Lisk Commander or with Lisk Elements.
Parameters
options
: Please see the options in the following link: Core API documentation.
getTransactions
By specifying the state of the transactions, this outputs a list of unprocessed transactions matching this state.
Parameters
state
: One of unprocessed
, unconfirmed
or unsigned
.
options
: Please see the options in the following link: Core API documentation.