mirror of https://github.com/poanetwork/quorum.git
87 lines
2.2 KiB
Markdown
87 lines
2.2 KiB
Markdown
# Istanbul RPC API
|
|
This is an up to date copy of original wiki entry located here https://github.com/getamis/go-ethereum/wiki/RPC-API
|
|
|
|
|
|
# Getting Started
|
|
1. Run Istanbul geth with `--rpcapi "istanbul"`
|
|
2. `geth attach`
|
|
|
|
## API Reference
|
|
|
|
### istanbul.candidates
|
|
Candidates returns the current candidates which the node tries to vote in or out.
|
|
```
|
|
istanbul.candidates
|
|
```
|
|
|
|
#### Returns
|
|
`map[string] boolean` - returns the current candidates map.
|
|
|
|
### istanbul.discard
|
|
Discard drops a currently running candidate, stopping the validator from casting further votes (either for or against).
|
|
```
|
|
istanbul.discard(address)
|
|
```
|
|
|
|
#### Parameters
|
|
`string` - the address of the candidate
|
|
|
|
### istanbul.getSnapshot
|
|
GetSnapshot retrieves the state snapshot at a given block.
|
|
```
|
|
istanbul.getSnapshot(blockHashOrBlockNumber)
|
|
```
|
|
|
|
#### Parameters
|
|
`String|Number` - The block number, the string "latest" or nil. nil is the same with string "latest" and means the latest block
|
|
|
|
#### Returns
|
|
`Object` - The snapshot object
|
|
|
|
### istanbul.getSnapshotAtHash
|
|
GetSnapshotAtHash retrieves the state snapshot at a given block.
|
|
```
|
|
istanbul.getSnapshotAtHash(blockHash)
|
|
```
|
|
|
|
#### Parameters
|
|
`String` - The block hash
|
|
|
|
#### Returns
|
|
`Object` - The snapshot object
|
|
|
|
### istanbul.getValidators
|
|
GetValidators retrieves the list of authorized validators at the specified block.
|
|
```
|
|
istanbul.getValidators(blockHashOrBlockNumber)
|
|
```
|
|
|
|
#### Parameters
|
|
`String|Number` - The block number, the string "latest" or nil. nil is the same with string "latest" and means the latest block
|
|
|
|
#### Returns
|
|
`[]string` - The validator address array
|
|
|
|
### istanbul.getValidatorsAtHash
|
|
GetValidatorsAtHash retrieves the list of authorized validators at the specified block.
|
|
```
|
|
istanbul.getValidatorsAtHash(blockHash)
|
|
```
|
|
|
|
#### Parameters
|
|
`String` - The block hash
|
|
|
|
#### Returns
|
|
`[]string` - The validator address array
|
|
|
|
### istanbul.propose
|
|
Propose injects a new authorization candidate that the validator will attempt to push through. If the number of vote is larger than 1/2 of validators to vote in/out, the candidate will be added/removed in validator set.
|
|
|
|
```
|
|
istanbul.propose(address, auth)
|
|
```
|
|
|
|
#### Parameters
|
|
`String` - The address of candidate
|
|
`bool` - `true` votes in and `false` votes out
|