Updated to reflect CLIQUE and IBFT methods no longer enabled by default (#666)

Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
This commit is contained in:
MadelineMurray
2019-01-29 11:37:56 +10:00
committed by GitHub
parent 5333876eb9
commit ace391be11
4 changed files with 30 additions and 14 deletions

View File

@@ -3,6 +3,8 @@ path: blob/master/config/src/main/resources/
source: rinkeby.json
<!--- END of page meta data -->
*[vanity data]: Signers can include anything they like as vanity data.
# Clique
Pantheon implements the Clique Proof-of-Authority (PoA) consensus protocol. Clique is used by the
@@ -49,9 +51,10 @@ command line option. To start a node on a Clique private network, use the
To propose adding or removing signers using the JSON-RPC methods, enable the HTTP interface
using [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) or WebSockets interface using
[`--rpc-ws-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-enabled). If also using the
[`--rpc-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-api)
or [`--ws-api`](../Reference/Pantheon-CLI-Syntax.md#ws-api) options, include `CLIQUE`.
[`--rpc-ws-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-enabled).
The Clique API methods are not enabled by default. To enable, specify the [`--rpc-http-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-api) option and include `CLIQUE`.
The JSON-RPC methods to add or remove signers are:
@@ -93,4 +96,3 @@ Existing proposals remain in effect and signers re-add their vote the next time
Define the number of blocks between epoch transitions in the genesis file.
*[vanity data]: Signers can include anything they like as vanity data.

View File

@@ -80,8 +80,10 @@ To start a node on an IBFT 2.0 private network, use the [`--genesis-file`](../Re
To propose adding or removing validators using the JSON-RPC methods, enable the HTTP interface
using [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) or WebSockets interface using
[`--rpc-ws-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-enabled). If also using the [`--rpc-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-api)
or [`--ws-api`](../Reference/Pantheon-CLI-Syntax.md#ws-api) options, include `IBFT`.
[`--rpc-ws-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-enabled).
The IBFT API methods are not enabled by default. To enable, specify the [`--rpc-http-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-api) option and include `IBFT`.
The JSON-RPC methods to add or remove validators are:

View File

@@ -11,7 +11,8 @@ The following lists the Pantheon JSON-RPC API commands:
## Admin Methods
!!! note
The `ADMIN` API is not enabled by default. Use the [`--rpc-api` option](Pantheon-CLI-Syntax.md#rpc-api) to enable the `ADMIN` API.
The `ADMIN` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](Pantheon-CLI-Syntax.md#rpc-ws-api) options to enable the `ADMIN` API methods.
### admin_peers
@@ -1525,6 +1526,10 @@ None
## Clique Methods
!!! note
The `CLIQUE` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](Pantheon-CLI-Syntax.md#rpc-ws-api) options to enable the `CLIQUE` API methods.
### clique_discard
Discards a proposal to add or remove a signer with the specified address.
@@ -1680,7 +1685,8 @@ If the boolean value is `true`, the proposal is to add a signer. If `false`, the
## Debug Methods
!!! note
The `DEBUG` API is not enabled by default. Use the [`--rpc-api` option](Pantheon-CLI-Syntax.md#rpc-api) to enable the `DEBUG` API.
The `DEBUG` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](Pantheon-CLI-Syntax.md#rpc-ws-api) options to enable the `DEBUG` API methods.
### debug_metrics
@@ -1866,7 +1872,8 @@ Reruns the transaction with the same state as when the transaction was executed.
## Miner Methods
!!! note
The `MINER` API is not enabled by default. Use the [`--rpc-api option`](Pantheon-CLI-Syntax.md#rpc-api) to enable the `MINER` API.
The `MINER` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](Pantheon-CLI-Syntax.md#rpc-ws-api) options to enable the `MINER` API methods.
### miner_start
@@ -1931,6 +1938,10 @@ None
!!! note
IBFT 2.0 is under development and will be available in v1.0.
!!! note
The `IBFT` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](Pantheon-CLI-Syntax.md#rpc-ws-api) options to enable the `IBFT` API methods.
### ibft_discardValidatorVote
Discards a proposal to [add or remove a validator](../Consensus-Protocols/IBFT.md#adding-and-removing-validators) with the specified address.

View File

@@ -70,14 +70,15 @@ Send individual requests as a JSON data package at each prompt:
The [RPC Pub/Sub methods](../Using-Pantheon/RPC-PubSub.md) can also be used over WebSockets.
### APIs Enabled by Default
### API Methods Enabled by Default
The `ETH`, `NET`, `WEB3`, `CLIQUE`, and `IBFT` APIs are enabled by default.
The `ETH`, `NET`, and `WEB3` API methods are enabled by default.
Use the [`--rpc-api` option](Pantheon-CLI-Syntax.md#rpc-api) to enable the `ADMIN`, `DEBUG`, and `MINER` APIs.
Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) or [`--rpc-ws-api`](Pantheon-CLI-Syntax.md#rpc-ws-api)
options to enable the `ADMIN` ,`CLIQUE`,`DEBUG`, `IBFT` and `MINER` API methods.
!!! note
IBFT 2.0 and Permissioning are under development and will be available in v1.0.
!!! note
IBFT 2.0 is under development and will be available in v1.0.
### Block Parameter