istanbul
Last updated
Was this helpful?
Last updated
Was this helpful?
The following API method provide access to the IBFT consensus engine.
istanbul_candidates
Returns the current candidates which the node tries to vote in or out.
Parameters
None
Returns
result
: map of strings to booleans - current candidates map
curl HTTP request
JSON result
geth console request
geth console result
istanbul_discard
Drops a currently running candidate, stopping further votes from being cast either for or against the candidate.
Parameters
address
: string - address of the candidate
Returns
result
: null
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the public addresses whose seals are included in the specified block number. This means that they participated in the consensus for this block and attested to its validity.
blockNumber
: number - (optional) block number to retrieve; defaults to current block
result
: object - result object with the following fields:
number
: number - retrieved block's number
hash
: string - retrieved block's hash
author
: string - address of the block proposer
committers
: array of strings - list of all addresses whose seal appears in this block
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the public addresses whose seals are included in the specified block number. This means that they participated in the consensus for this block and attested to its validity.
blockHash
: string - hash of the block to retrieve (required)
result
: object - result object with the following fields:
number
: number - retrieved block's number
hash
: string - retrieved block's hash
author
: string - address of the block proposer
committers
: array of strings - list of all addresses whose seal appears in this block
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the state snapshot at the specified block number.
blockNumber
: number or string - (optional) integer representing a block number or the string tag latest
(the last block mined); defaults to latest
result
: object - snapshot object
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the state snapshot at the specified block hash.
blockHash
: string - block hash
result
: object - snapshot object
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the list of authorized validators at the specified block number.
blockNumber
: number or string - (optional) integer representing a block number or the string tag latest
(the last block mined); defaults to latest
result
: array of strings - list of validator addresses
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the list of authorized validators at the specified block hash.
blockHash
: string - block hash
result
: array of strings - list of validator addresses
curl HTTP request
JSON result
geth console request
geth console result
Indicates if this node is the validator for the specified block number.
blockNumber
: number - (optional) block number; defaults to latest block number
result
: boolean - true
if this node is the validator for the given blockNumber
, otherwise false
curl HTTP request
JSON result
geth console request
geth console result
Retrieves the public address that is used to sign proposals, which is derived from the node's nodekey
.
None
result
: string - node's public signing address
curl HTTP request
JSON result
geth console request
geth console result
Injects a new authorization candidate that the validator attempts to push through. If a majority of the validators vote the candidate in/out, the candidate is added/removed in the validator set.
address
: string - address of candidate
auth
: boolean - true
votes the candidate in and false
votes out
result
: null
curl HTTP request
JSON result
geth console request
geth console result
Returns the signing status of blocks for the specified block range.
startBlockNumber
: number - start block number
endBlockNumber
: number - end block number
If the start block and end block numbers are not provided, the status of the last 64 blocks is returned.
result
: object - result object with the following fields:
numBlocks
: number - number of blocks for which sealer activity is retrieved
sealerActivity
: map of strings to numbers - key is the validator and value is the number of blocks sealed by the validator
curl HTTP request
JSON result
geth console request
geth console result
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns