Istanbul

For more details about the Istanbul JSON-RPC APIs

Source:

Methods

(inner) candidates() → {Object}

Source:
Returns:

The current candidates map

Type
Object

(inner) discard(address)

Source:
Parameters:
Name Type Description
address String

the address of the candidate

(inner) getSignersFromBlock(blockNumber) → {Object}

Source:
Parameters:
Name Type Description
blockNumber Number

The block number to retrieve

Returns:
Type
Object

(inner) getSignersFromBlockByHash(blockHash) → {Object}

Source:
Parameters:
Name Type Description
blockHash String

The hash of the block to retrieve

Returns:
Type
Object

(inner) getSnapshot(blockHashOrBlockNumber) → {Object}

Source:
Parameters:
Name Type Description
blockHashOrBlockNumber String | Number

The block number, the string “latest” or nil. nil is the same with string “latest” and means the latest block

Returns:

The snapshot object

Type
Object

(inner) getSnapshotAtHash(blockHash) → {Object}

Source:
Parameters:
Name Type Description
blockHash String

The block hash

Returns:

The snapshot object

Type
Object

(inner) getValidators(blockHashOrBlockNumber) → {Array.<String>}

Source:
Parameters:
Name Type Description
blockHashOrBlockNumber String | Number

The block number, the string “latest” or nil. nil is the same with string “latest” and means the latest block

Returns:

The validator address array

Type
Array.<String>

(inner) getValidatorsAtHash(blockHash) → {Array.<String>}

Source:
Parameters:
Name Type Description
blockHash String

The block hash

Returns:

The validator address array

Type
Array.<String>

(inner) isValidator(blockNumber) → {Boolean}

Source:
Parameters:
Name Type Description
blockNumber Number

block number

Returns:

validator status of this node for the given blockNumber.

Type
Boolean

(inner) nodeAddress() → {String}

Source:
Returns:

The nodes public signing address

Type
String

(inner) status(startBlockNumber, endBlockNumber) → {Object}

Source:
Parameters:
Name Type Description
startBlockNumber Number

start block number

endBlockNumber Number

end block number

Returns:
Type
Object