Added doc on default APIs and enabled non-default APIs (#498)

Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
pull/2/head
MadelineMurray 6 years ago committed by GitHub
parent 6399421a2a
commit db575c5033
  1. 9
      docs/Reference/JSON-RPC-API-Methods.md
  2. 2
      docs/Reference/Pantheon-CLI-Syntax.md
  3. 9
      docs/Reference/Using-JSON-RPC-API.md

@ -10,6 +10,9 @@ 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.
### admin_peers
Returns networking information about connected remote nodes.
@ -1687,6 +1690,9 @@ 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.
### debug_metrics
!!!note
@ -1870,6 +1876,9 @@ 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.
### miner_start
Starts the CPU mining process. To start mining, a miner coinbase must have been previously specified using the [`--miner-coinbase`](../Reference/Pantheon-CLI-Syntax.md#miner-coinbase) command line option.

@ -413,7 +413,7 @@ The default is 127.0.0.1:8545.
Comma-separated APIs to enable on the JSON-RPC channel.
When you use this option, the `--rpc-enabled` option must also be specified.
The available API options are: `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `DEBUG`, and `MINER`.
The available API options are: `ADMIN`, `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `DEBUG`, and `MINER`.
The default is: `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`.
!!!note

@ -70,6 +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
The `ETH`, `NET`, `WEB3`, `CLIQUE`, and `IBFT` APIs are enabled by default.
Use the [`--rpc-api` option](Pantheon-CLI-Syntax.md#rpc-api) to enable the `ADMIN`, `DEBUG`, and `MINER` APIs.
!!!note
:construction: IBFT is not currently supported. Support for IBFT is in active development.
### Block Parameter
When you make requests that might have different results depending on the block accessed,

Loading…
Cancel
Save