Installation and usage of the platform
REST API: information about a consensus algorithm in use¶
The methods of the consensus
group are provided to obtain information about the consensus algorithm used.
GET consensus/algo¶
The method returns the name of the consensus algorithm used.
Response example:
GET consensus/settings¶
The method returns the parameters of the consensus algorithm used, specified in the node configuration file.
Response example:
GET consensus/minersAtHeight/{height}¶
The method returns the queue of miners at {height}
.
This method is only available when PoA or CFT consensus algorithm is used.
The method verifies if the passed height value is greater than 0 and less than the current blockchain height.
Response example:
GET consensus/miners/{timestamp}¶
The method returns the queue of miners for {timestamp}
(specified in Unix Timestamp format, in milliseconds).
This method is available when using the PoA consensus algorithm.
Response example:
GET consensus/bannedMiners/{height}¶
The method returns the list of banned miners at {height}
.
This method is only available when PoA or CFT consensus algorithm is used.
The method verifies if the passed height value is greater than 0 and less than the current blockchain height.
Response example:
GET consensus/basetarget/{signature}¶
The method returns the basetarget value of block creation by its {signature}
. The method is available when using the PoS consensus algorithm.
GET consensus/basetarget¶
The method returns the basetarget value of current block creation. The method is available when using the PoS consensus algorithm.
GET consensus/generatingbalance/{address}¶
The method returns the generating balance available for the node whose address or alias is passed as {address}
, including the funds leased to the participant.
This method is only available when using the PoS consensus algorithm.
GET consensus/generationsignature/{signature}¶
The method returns the generating signature value of block creation by its {signature}
. The method is available when using the PoS consensus algorithm.
GET consensus/generationsignature¶
The method returns the generating signature value of current block creation. The method is available when using the PoS consensus algorithm.