From be69db85885db2fbe6c0cee53fea63cccb65baa8 Mon Sep 17 00:00:00 2001 From: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Date: Tue, 14 May 2019 10:32:48 +1000 Subject: [PATCH] Reorganised API docs (#1441) --- docs/Configuring-Pantheon/Network-vs-Node.md | 2 +- .../Networking/Configuring-Ports.md | 2 +- .../Networking/Managing-Peers.md | 12 +-- docs/Configuring-Pantheon/Node-Keys.md | 2 +- docs/Consensus-Protocols/Clique.md | 6 +- docs/Consensus-Protocols/IBFT.md | 6 +- docs/Getting-Started/Run-Docker-Image.md | 2 +- docs/Getting-Started/Starting-Pantheon.md | 2 +- .../Authentication.md | 4 +- .../JSON-RPC-API.md | 4 +- docs/Pantheon-API/Pantheon-API.md | 42 ++++++++++ .../RPC-PubSub.md | 25 +++--- .../Using-JSON-RPC-API.md | 64 ++++---------- docs/Permissions/Local-Permissioning.md | 18 ++-- docs/Permissions/Onchain-Permissioning.md | 2 +- docs/Privacy/Privacy-Overview.md | 2 +- docs/Privacy/Privacy-Quickstart.md | 2 +- .../Privacy/Private-Transaction-Processing.md | 2 +- ...API-Methods.md => Pantheon-API-Methods.md} | 84 +++++++++---------- ...API-Objects.md => Pantheon-API-Objects.md} | 32 +++---- docs/Reference/Pantheon-CLI-Syntax.md | 18 ++-- docs/Troubleshooting/Troubleshooting.md | 2 +- docs/Tutorials/Create-IBFT-Network.md | 2 +- docs/Tutorials/Create-Permissioned-Network.md | 8 +- .../Create-Private-Clique-Network.md | 2 +- docs/Tutorials/Create-Private-Network.md | 6 +- .../Accessing-Logs-Using-JSON-RPC.md | 34 ++++---- docs/Using-Pantheon/Account-Management.md | 4 +- docs/Using-Pantheon/Events-and-Logs.md | 4 +- docs/Using-Pantheon/Mining.md | 8 +- docs/Using-Pantheon/Monitoring.md | 2 +- .../Transactions/Transaction-Pool.md | 4 +- .../Transactions/Transactions.md | 6 +- docs/index.md | 2 +- mkdocs.yml | 26 +++--- 35 files changed, 227 insertions(+), 216 deletions(-) rename docs/{JSON-RPC-API => Pantheon-API}/Authentication.md (98%) rename docs/{JSON-RPC-API => Pantheon-API}/JSON-RPC-API.md (89%) create mode 100644 docs/Pantheon-API/Pantheon-API.md rename docs/{Using-Pantheon => Pantheon-API}/RPC-PubSub.md (93%) rename docs/{JSON-RPC-API => Pantheon-API}/Using-JSON-RPC-API.md (72%) rename docs/Reference/{JSON-RPC-API-Methods.md => Pantheon-API-Methods.md} (96%) rename docs/Reference/{JSON-RPC-API-Objects.md => Pantheon-API-Objects.md} (94%) diff --git a/docs/Configuring-Pantheon/Network-vs-Node.md b/docs/Configuring-Pantheon/Network-vs-Node.md index d79a52ee9d..2dd3fb1811 100644 --- a/docs/Configuring-Pantheon/Network-vs-Node.md +++ b/docs/Configuring-Pantheon/Network-vs-Node.md @@ -9,5 +9,5 @@ Network wide settings are specified in the genesis file. Examples include `diff networks and the [consensus mechanism](../Consensus-Protocols/Overview-Consensus.md). Node settings are specified on the command line or in the [node configuration file](Using-Configuration-File.md). -For example, the [JSON-RPC API methods to enable](../Reference/JSON-RPC-API-Methods.md) or the +For example, the [JSON-RPC API methods to enable](../Reference/Pantheon-API-Methods.md) or the [data directory](../Reference/Pantheon-CLI-Syntax.md#data-path) for the node. \ No newline at end of file diff --git a/docs/Configuring-Pantheon/Networking/Configuring-Ports.md b/docs/Configuring-Pantheon/Networking/Configuring-Ports.md index 4036cd217c..a4a65132d3 100644 --- a/docs/Configuring-Pantheon/Networking/Configuring-Ports.md +++ b/docs/Configuring-Pantheon/Networking/Configuring-Ports.md @@ -22,7 +22,7 @@ The default is `30303`. ## JSON-RPC API -To enable access to the [JSON-RPC API](../../JSON-RPC-API/JSON-RPC-API.md), open the HTTP JSON-RPC and WebSockets JSON-RPC ports to the intended users +To enable access to the [JSON-RPC API](../../Pantheon-API/JSON-RPC-API.md), open the HTTP JSON-RPC and WebSockets JSON-RPC ports to the intended users of the JSON-RPC API on TCP. The [`--rpc-http-port`](../../Reference/Pantheon-CLI-Syntax.md#rpc-http-port) and [`--rpc-ws-port`](../../Reference/Pantheon-CLI-Syntax.md#rpc-ws-port) diff --git a/docs/Configuring-Pantheon/Networking/Managing-Peers.md b/docs/Configuring-Pantheon/Networking/Managing-Peers.md index 02e77b1a7b..3bc4efc355 100644 --- a/docs/Configuring-Pantheon/Networking/Managing-Peers.md +++ b/docs/Configuring-Pantheon/Networking/Managing-Peers.md @@ -31,8 +31,8 @@ To configure a network of static nodes: 1. Start Pantheon with discovery disabled using [`--discovery-enabled=false`](../../Reference/Pantheon-CLI-Syntax.md#discovery-enabled). -To modify the static peers at run time, use the [`admin_addPeer`](../../Reference/JSON-RPC-API-Methods.md#admin_addpeer) -and [`admin_removePeer`](../../Reference/JSON-RPC-API-Methods.md#admin_removepeer) JSON-RPC API methods. +To modify the static peers at run time, use the [`admin_addPeer`](../../Reference/Pantheon-API-Methods.md#admin_addpeer) +and [`admin_removePeer`](../../Reference/Pantheon-API-Methods.md#admin_removepeer) JSON-RPC API methods. !!! note Runtime modifications of static nodes are not persisted between runs. The `static-nodes.json` file @@ -42,7 +42,7 @@ and [`admin_removePeer`](../../Reference/JSON-RPC-API-Methods.md#admin_removepee use [Permissioning](../../Permissions/Permissioning-Overview.md). !!! caution - If the added peer does not appear in the peer list (returned by [`admin_peers`](../../Reference/JSON-RPC-API-Methods.md#admin_peers)), + If the added peer does not appear in the peer list (returned by [`admin_peers`](../../Reference/Pantheon-API-Methods.md#admin_peers)), check the supplied [enode URL](../Node-Keys.md#enode-url) is correct, the node is running, the node is listening for TCP connections on the endpoint, and has not reached the [maximum number of peers](#limiting-peers). @@ -66,9 +66,9 @@ and contain a JSON array of [enode URLs](../Node-Keys.md#enode-url). JSON-RPC API methods to monitor peer connections include: -* [`net_peerCount`](../../Reference/JSON-RPC-API-Methods.md#net_peercount) -* [`admin_peers`](../../Reference/JSON-RPC-API-Methods.md#admin_peers) -* [`debug_metrics`](../../Reference/JSON-RPC-API-Methods.md#debug_metrics) +* [`net_peerCount`](../../Reference/Pantheon-API-Methods.md#net_peercount) +* [`admin_peers`](../../Reference/Pantheon-API-Methods.md#admin_peers) +* [`debug_metrics`](../../Reference/Pantheon-API-Methods.md#debug_metrics) ## Node Connections diff --git a/docs/Configuring-Pantheon/Node-Keys.md b/docs/Configuring-Pantheon/Node-Keys.md index 90f4b65337..55516bce9d 100644 --- a/docs/Configuring-Pantheon/Node-Keys.md +++ b/docs/Configuring-Pantheon/Node-Keys.md @@ -40,7 +40,7 @@ Specified by the [`--p2p-host`](../Reference/Pantheon-CLI-Syntax.md#p2p-host) an The enode URL is: `enode://c35c3ec90a8a51fd5703594c6303382f3ae6b2ecb9589bab2c04b3794f2bc3fc2631dabb0c08af795787a6c004d8f532230ae6e9925cbbefb0b28b79295d615f@127.0.0.1:30303` -The enode is displayed when starting a Pantheon node and can be obtained using the [`net_enode`](../Reference/JSON-RPC-API-Methods.md#net_enode) +The enode is displayed when starting a Pantheon node and can be obtained using the [`net_enode`](../Reference/Pantheon-API-Methods.md#net_enode) JSON-RPC API method. ## Specifying a Custom Node Private Key File diff --git a/docs/Consensus-Protocols/Clique.md b/docs/Consensus-Protocols/Clique.md index e5f095e203..5b5e290db0 100644 --- a/docs/Consensus-Protocols/Clique.md +++ b/docs/Consensus-Protocols/Clique.md @@ -93,9 +93,9 @@ or [`--rpc-ws-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-api) option and i The JSON-RPC methods to add or remove signers are: -* [clique_propose](../Reference/JSON-RPC-API-Methods.md#clique_propose) -* [clique_getSigners](../Reference/JSON-RPC-API-Methods.md#clique_getsigners) -* [clique_discard](../Reference/JSON-RPC-API-Methods.md#clique_discard) +* [clique_propose](../Reference/Pantheon-API-Methods.md#clique_propose) +* [clique_getSigners](../Reference/Pantheon-API-Methods.md#clique_getsigners) +* [clique_discard](../Reference/Pantheon-API-Methods.md#clique_discard) To propose adding a signer, call `clique_propose` specifying the address of the proposed signer and `true`. !!! example "JSON-RPC clique_propose Request Example" diff --git a/docs/Consensus-Protocols/IBFT.md b/docs/Consensus-Protocols/IBFT.md index fd14bc0b46..92f04ea6b9 100644 --- a/docs/Consensus-Protocols/IBFT.md +++ b/docs/Consensus-Protocols/IBFT.md @@ -127,9 +127,9 @@ or [`--rpc-ws-api`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-api) option and i The JSON-RPC methods to add or remove validators are: -* [ibft_getPendingVotes](../Reference/JSON-RPC-API-Methods.md#ibft_getPendingVotes) -* [ibft_proposeValidatorVote](../Reference/JSON-RPC-API-Methods.md#ibft_proposeValidatorVote) -* [ibft_discardValidatorVote](../Reference/JSON-RPC-API-Methods.md#ibft_discardValidatorVote) +* [ibft_getPendingVotes](../Reference/Pantheon-API-Methods.md#ibft_getPendingVotes) +* [ibft_proposeValidatorVote](../Reference/Pantheon-API-Methods.md#ibft_proposeValidatorVote) +* [ibft_discardValidatorVote](../Reference/Pantheon-API-Methods.md#ibft_discardValidatorVote) To propose adding a validator, call `ibft_proposeValidatorVote` specifying the address of the node to be added and `true`. !!! example "JSON-RPC ibft_proposeValidatorVote Request Example" diff --git a/docs/Getting-Started/Run-Docker-Image.md b/docs/Getting-Started/Run-Docker-Image.md index e2cc82d6e8..11d0b2c02b 100644 --- a/docs/Getting-Started/Run-Docker-Image.md +++ b/docs/Getting-Started/Run-Docker-Image.md @@ -188,7 +188,7 @@ Where `myprivacypublickeyfile` is the file containing the public key and `path` ## Credentials Files -Specify a [credentials file](../JSON-RPC-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md). +Specify a [credentials file](../Pantheon-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../Pantheon-API/Authentication.md). To run Pantheon specifying a credentials file for HTTP JSON-RPC: ```bash diff --git a/docs/Getting-Started/Starting-Pantheon.md b/docs/Getting-Started/Starting-Pantheon.md index c13f80873b..9ca872c809 100644 --- a/docs/Getting-Started/Starting-Pantheon.md +++ b/docs/Getting-Started/Starting-Pantheon.md @@ -34,7 +34,7 @@ using the [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) o ## Confirm Node is Running If you have started Pantheon with the [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) option, use [cURL](https://curl.haxx.se/) to -call [JSON-RPC API methods](../Reference/JSON-RPC-API-Methods.md) to confirm the node is running. +call [JSON-RPC API methods](../Reference/Pantheon-API-Methods.md) to confirm the node is running. !!!example diff --git a/docs/JSON-RPC-API/Authentication.md b/docs/Pantheon-API/Authentication.md similarity index 98% rename from docs/JSON-RPC-API/Authentication.md rename to docs/Pantheon-API/Authentication.md index 06291ba87b..11c274cde5 100644 --- a/docs/JSON-RPC-API/Authentication.md +++ b/docs/Pantheon-API/Authentication.md @@ -1,9 +1,9 @@ -# Authentication and Authorization +# Authentication and Authorization for JSON-RPC Authentication identifies a user based on a username and password. Authorization verifies whether the user has access to the JSON-RPC method they are requesting. -Pantheon uses the username and password to authenticate users and [JWT tokens](https://jwt.io/introduction/) to authorize JSON-RPC API requests. +Pantheon uses the username and password to authenticate users and [JWT tokens](https://jwt.io/introduction/) to authorize JSON-RPC requests. !!! important Authenticated requests must be made over HTTPS. HTTPS is encrypted which prevents eavesdropping on the connection diff --git a/docs/JSON-RPC-API/JSON-RPC-API.md b/docs/Pantheon-API/JSON-RPC-API.md similarity index 89% rename from docs/JSON-RPC-API/JSON-RPC-API.md rename to docs/Pantheon-API/JSON-RPC-API.md index 1a110d5c66..6116ed7353 100644 --- a/docs/JSON-RPC-API/JSON-RPC-API.md +++ b/docs/Pantheon-API/JSON-RPC-API.md @@ -13,5 +13,5 @@ unformatted data (byte arrays, account addresses, hashes, and bytecode arrays). RPC is the remote procedure call protocol (RFC 1831). The protocol is stateless and transport agnostic in that the concepts can be used within the same process, over sockets, over HTTP, or in various message passing environments. -The Reference documentation includes the [JSON-RPC API Methods](../Reference/JSON-RPC-API-Methods.md) -and [JSON-RPC API Objects](../Reference/JSON-RPC-API-Objects.md) \ No newline at end of file +The Reference documentation includes the [JSON-RPC API Methods](../Reference/Pantheon-API-Methods.md) +and [JSON-RPC API Objects](../Reference/Pantheon-API-Objects.md) \ No newline at end of file diff --git a/docs/Pantheon-API/Pantheon-API.md b/docs/Pantheon-API/Pantheon-API.md new file mode 100644 index 0000000000..c3b24930d8 --- /dev/null +++ b/docs/Pantheon-API/Pantheon-API.md @@ -0,0 +1,42 @@ +description: Pantheon API + + +Access the [Pantheon API](../Reference/Pantheon-API-Methods.md) using: + +* [JSON-RPC over HTTP or WebSockets](Using-JSON-RPC-API.md) +* [RPC Pub/Sub over WebSockets](RPC-PubSub.md) +* GraphQL RPC over HTTP + +Information applying to JSON-RPC, RPC Pub/Sub, and GraphQL is included below. + +## Host Whitelist + +To prevent DNS rebinding, incoming HTTP requests, WebSockets connections, and GraphQL requests are only accepted from hostnames +specified using the [`--host-whitelist`](../Reference/Pantheon-CLI-Syntax.md#host-whitelist) option. +By default, `localhost` and `127.0.0.1` are accepted. + +If your application publishes RPC ports, specify the hostnames when starting Pantheon. + +!!! example + ```bash + pantheon --host-whitelist=example.com + ``` + +Specify * for `--host-whitelist` to effectively disable host protection. + +!!! caution + Specifying * for `--host-whitelist` is not recommended for production code. + +## Not Supported by Pantheon + +### Account Management + +Account management relies on private key management in the client which is not implemented by Pantheon. + +Use [`eth_sendRawTransaction`](../Reference/Pantheon-API-Methods.md#eth_sendrawtransaction) to send signed transactions; `eth_sendTransaction` is not implemented. + +Use third-party wallets for [account management](../Using-Pantheon/Account-Management.md). + +### Protocols + +Pantheon does not implement the Whisper and Swarm protocols. \ No newline at end of file diff --git a/docs/Using-Pantheon/RPC-PubSub.md b/docs/Pantheon-API/RPC-PubSub.md similarity index 93% rename from docs/Using-Pantheon/RPC-PubSub.md rename to docs/Pantheon-API/RPC-PubSub.md index b4979fc476..0b04aec7f5 100644 --- a/docs/Using-Pantheon/RPC-PubSub.md +++ b/docs/Pantheon-API/RPC-PubSub.md @@ -1,25 +1,26 @@ -description: Using RPC Pub/Sub with Pantheon Web Socket API +description: Using RPC Pub/Sub with WebSockets -# RPC Pub/Sub +# RPC Pub/Sub over WebSockets ## Introduction -Use the RPC Pub/Sub API to wait for events instead of polling for them. For example, a Dapp can subscribe to logs to be notified when a specific event has occurred. +Use RPC Pub/Sub over WebSockets to wait for events instead of polling for them. For example, a Dapp can +subscribe to logs to be notified when a specific event has occurred. -The RPC Pub/Sub methods are: +Methods specific to RPC Pub/Sub are: * `eth_subscribe` - create a subscription for specific events. * `eth_unsubscribe` - cancel a subscription. !!!important - Unlike other [JSON RPC-API methods](../Reference/JSON-RPC-API-Methods.md), + Unlike other [Pantheon API methods](../Reference/Pantheon-API-Methods.md), the RPC Pub/Sub methods cannot be called over HTTP. Use the [`--rpc-ws-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-enabled) option to enable the WebSockets JSON-RPC service. ### Using RPC Pub/Sub -The RPC Pub/Sub API is supported on [WebSockets](../JSON-RPC-API/Using-JSON-RPC-API.md#http-and-websocket-requests). +The RPC Pub/Sub API is supported on [WebSockets](../Pantheon-API/Using-JSON-RPC-API.md#http-and-websocket-requests). Use `eth_subscribe` to create subscriptions. Once subscribed, notifications are published by the API using `eth_subscription`. @@ -69,8 +70,8 @@ Use the `newHeads` parameter with `eth_subscribe` to be notified each time a blo If a chain reorganization occurs, the subscription publishes notifications for blocks in the new chain. This means the subscription can publish notifications for multiple blocks at the same height on the blockchain. -The new headers notification returns [block objects](../Reference/JSON-RPC-API-Objects.md#block-object). The -second parameter is optional. If specified, whole [transaction objects](../Reference/JSON-RPC-API-Objects.md#transaction-object) +The new headers notification returns [block objects](../Reference/Pantheon-API-Objects.md#block-object). The +second parameter is optional. If specified, whole [transaction objects](../Reference/Pantheon-API-Objects.md#transaction-object) are included in the notifications. Otherwise, the transaction hashes are included. !!!example @@ -151,19 +152,19 @@ are included in the notifications. Otherwise, the transaction hashes are include ### Logs -Use the `logs` parameter with `eth_subscribe` to be notified of [logs](Events-and-Logs.md) included in new blocks. You can +Use the `logs` parameter with `eth_subscribe` to be notified of [logs](../Using-Pantheon/Events-and-Logs.md) included in new blocks. You can specify a filter object to receive notifications only for logs matching your filter. Logs subscriptions have an filter object parameter with the following fields: - `address` - (optional) Either an address or an array of addresses. Returns only logs created from these addresses. - - `topics` - (optional) Returns only logs that match the [specified topics](Events-and-Logs.md#topic-filters). + - `topics` - (optional) Returns only logs that match the [specified topics](../Using-Pantheon/Events-and-Logs.md#topic-filters). If a chain reorganization occurs, the subscription publishes notifications for logs from the old chain -with the `removed` property in the [log object](../Reference/JSON-RPC-API-Objects.md#log-object) set to `true`. +with the `removed` property in the [log object](../Reference/Pantheon-API-Objects.md#log-object) set to `true`. This means the subscription can publish notifications for multiple logs for the same transaction. -The logs subscription returns [log objects](../Reference/JSON-RPC-API-Objects.md#log-object). +The logs subscription returns [log objects](../Reference/Pantheon-API-Objects.md#log-object). !!!example To subscribe to all logs notifications: diff --git a/docs/JSON-RPC-API/Using-JSON-RPC-API.md b/docs/Pantheon-API/Using-JSON-RPC-API.md similarity index 72% rename from docs/JSON-RPC-API/Using-JSON-RPC-API.md rename to docs/Pantheon-API/Using-JSON-RPC-API.md index 0a4ef7bd68..9044ba991e 100644 --- a/docs/JSON-RPC-API/Using-JSON-RPC-API.md +++ b/docs/Pantheon-API/Using-JSON-RPC-API.md @@ -1,23 +1,13 @@ -description: How to use Pantheon JSON-RPC API +description: How to access the Pantheon API using JSON-RPC -# Using the JSON-RPC API - -## Postman - -Use the button to import our collection of examples to [Postman](https://www.getpostman.com/). - -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/c765d7d22b055c42a510) - -## Endpoint Host and Port - -The placeholder -`` and `` represents an endpoint (IP address and port) -of the JSON-RPC service of a Pantheon node for HTTP and WebSocket requests. +# JSON-RPC over HTTP and WebSockets To enable JSON-RPC over HTTP or WebSockets, use the [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) and [`--rpc-ws-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-enabled) options. +## RPC Host + Use the [--rpc-http-host](../Reference/Pantheon-CLI-Syntax.md#rpc-http-host) and [--rpc-ws-host](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-host) options to specify the host on which the JSON-RPC listens. The default host is 127.0.0.1 for HTTP and WebSockets. @@ -27,6 +17,8 @@ Set the host to `0.0.0.0` to allow remote connections. Setting the host to 0.0.0.0 exposes the RPC connection on your node to any remote connection. In a production environment, ensure you use a firewall to avoid exposing your node to the internet. +## RPC Port + Use the [--rpc-http-port](../Reference/Pantheon-CLI-Syntax.md#rpc-http-port) and [--rpc-ws-port](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-port) options to specify the port on which the JSON-RPC listens. The default ports are: @@ -35,6 +27,13 @@ options to specify the port on which the JSON-RPC listens. The default ports are Ports must be [exposed appropriately](../Configuring-Pantheon/Networking/Managing-Peers.md#port-configuration). +## Postman + +Use the button to import our collection of examples to [Postman](https://www.getpostman.com/). + +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/c765d7d22b055c42a510) + + ## Geth Console The geth console is a REPL (Read, Evaluate, & Print Loop) Javascript console. Use JSON-RPC APIs supported by geth and @@ -51,31 +50,13 @@ To use the geth console with Pantheon: geth attach http://localhost:8545 ``` -Use the geth console to call [JSON-RPC API methods](../Reference/JSON-RPC-API-Methods.md) that geth and Pantheon share. +Use the geth console to call [JSON-RPC API methods](../Reference/Pantheon-API-Methods.md) that geth and Pantheon share. !!! example ```bash eth.syncing ``` -## Host Whitelist - -To prevent DNS rebinding, incoming HTTP requests and WebSockets connections are only accepted from hostnames -specified using the [`--host-whitelist`](../Reference/Pantheon-CLI-Syntax.md#host-whitelist) option. -By default, `localhost` and `127.0.0.1` are accepted. - -If your application publishes RPC ports, specify the hostnames when starting Pantheon. - -!!! example - ```bash - pantheon --host-whitelist=example.com - ``` - -Specify * for `--host-whitelist` to effectively disable host protection. - -!!! caution - Specifying * for `--host-whitelist` is not recommended for production code. - ## JSON-RPC Authentication [Authentication](Authentication.md) is disabled by default. @@ -122,25 +103,12 @@ options to enable the `ADMIN`, `CLIQUE`, `DEBUG`, `EEA`, `IBFT`, `MINER`, `PERM` When you make requests that might have different results depending on the block accessed, the block parameter specifies the block. -Several methods, such as [eth_getTransactionByBlockNumberAndIndex](../Reference/JSON-RPC-API-Methods.md#eth_gettransactionbyblocknumberandindex), have a block parameter. +Several methods, such as [eth_getTransactionByBlockNumberAndIndex](../Reference/Pantheon-API-Methods.md#eth_gettransactionbyblocknumberandindex), have a block parameter. The block parameter can have the following values: * `blockNumber` : `quantity` - Block number. Can be specified in hexadecimal or decimal. 0 represents the genesis block. * `earliest` : `tag` - Earliest (genesis) block. * `latest` : `tag` - Last block mined. -* `pending` : `tag` - Last block mined plus pending transactions. Use only with [eth_getTransactionCount](../Reference/JSON-RPC-API-Methods.md#eth_gettransactioncount). - -## Not Supported by Pantheon - -### Account Management - -Account management relies on private key management in the client which is not implemented by Pantheon. - -Use [`eth_sendRawTransaction`](../Reference/JSON-RPC-API-Methods.md#eth_sendrawtransaction) to send signed transactions; `eth_sendTransaction` is not implemented. - -Use third-party wallets for [account management](../Using-Pantheon/Account-Management.md). - -### Protocols +* `pending` : `tag` - Last block mined plus pending transactions. Use only with [eth_getTransactionCount](../Reference/Pantheon-API-Methods.md#eth_gettransactioncount). -Pantheon does not implement the Whisper and Swarm protocols. \ No newline at end of file diff --git a/docs/Permissions/Local-Permissioning.md b/docs/Permissions/Local-Permissioning.md index f5825318d9..9ba34bd8b4 100644 --- a/docs/Permissions/Local-Permissioning.md +++ b/docs/Permissions/Local-Permissioning.md @@ -18,16 +18,16 @@ file in the [data directory](../Reference/Pantheon-CLI-Syntax.md#data-path) for To update the nodes whitelist when the node is running, use the JSON-RPC API methods: -* [perm_addNodesToWhitelist](../Reference/JSON-RPC-API-Methods.md#perm__addnodestowhitelist) -* [perm_removeNodesFromWhitelist](../Reference/JSON-RPC-API-Methods.md#perm_removeNodesFromWhiteList) +* [perm_addNodesToWhitelist](../Reference/Pantheon-API-Methods.md#perm__addnodestowhitelist) +* [perm_removeNodesFromWhitelist](../Reference/Pantheon-API-Methods.md#perm_removeNodesFromWhiteList) Alternatively, update the [`permissions_config.toml`](#permissions-configuration-file) file directly and use the -[`perm_reloadPermissionsFromFile`](../Reference/JSON-RPC-API-Methods.md#perm_reloadpermissionsfromfile) method +[`perm_reloadPermissionsFromFile`](../Reference/Pantheon-API-Methods.md#perm_reloadpermissionsfromfile) method to update the whitelists. Updates to the permissions configuration file persist across node restarts. -To view the nodes whitelist, use the [perm_getNodesWhitelist](../Reference/JSON-RPC-API-Methods.md#perm_getNodesWhiteList) method. +To view the nodes whitelist, use the [perm_getNodesWhitelist](../Reference/Pantheon-API-Methods.md#perm_getNodesWhiteList) method. !!! note Each node has a [permissions configuration file](#permissions-configuration-file) which means nodes can have different nodes whitelists. @@ -79,7 +79,7 @@ in the [data directory](../Reference/Pantheon-CLI-Syntax.md#data-path) for the n Transactions are validated against the accounts whitelist at the following points: -1. Submitted by JSON-RPC API method [`eth_sendRawTransaction`](../Reference/JSON-RPC-API-Methods.md#eth_sendrawtransaction) +1. Submitted by JSON-RPC API method [`eth_sendRawTransaction`](../Reference/Pantheon-API-Methods.md#eth_sendrawtransaction) 1. Received via propagation from another node 1. Added to a block by a mining node @@ -110,16 +110,16 @@ can synchronise and add blocks containing transactions from accounts that are no To update the accounts whitelist when the node is running, use the JSON-RPC API methods: -* [`perm_addAccountsToWhitelist`](../Reference/JSON-RPC-API-Methods.md#perm_addAccountsToWhitelist) -* [`perm_removeAccountsFromWhitelist`](../Reference/JSON-RPC-API-Methods.md#perm_removeAccountsFromWhitelist) +* [`perm_addAccountsToWhitelist`](../Reference/Pantheon-API-Methods.md#perm_addAccountsToWhitelist) +* [`perm_removeAccountsFromWhitelist`](../Reference/Pantheon-API-Methods.md#perm_removeAccountsFromWhitelist) Alternatively, update the [`permissions_config.toml`](#permissions-configuration-file) file directly and use the -[`perm_reloadPermissionsFromFile`](../Reference/JSON-RPC-API-Methods.md#perm_reloadpermissionsfromfile) method +[`perm_reloadPermissionsFromFile`](../Reference/Pantheon-API-Methods.md#perm_reloadpermissionsfromfile) method to update the whitelists. Updates to the permissions configuration file persist across node restarts. -To view the accounts whitelist, use the [`perm_getAccountsWhitelist`](../Reference/JSON-RPC-API-Methods.md#perm_getAccountsWhitelist) method. +To view the accounts whitelist, use the [`perm_getAccountsWhitelist`](../Reference/Pantheon-API-Methods.md#perm_getAccountsWhitelist) method. ### Enabling Account Whitelisting diff --git a/docs/Permissions/Onchain-Permissioning.md b/docs/Permissions/Onchain-Permissioning.md index 7f10d72590..a0912813ef 100644 --- a/docs/Permissions/Onchain-Permissioning.md +++ b/docs/Permissions/Onchain-Permissioning.md @@ -141,7 +141,7 @@ To add or remove nodes: !!! tip If you add a running node, the node does not attempt to reconnect to the bootnode and synchronize until - peer discovery restarts. To add a whitelisted node as a peer without waiting for peer discovery to restart, use [`admin_addPeer`](../Reference/JSON-RPC-API-Methods.md#admin_addpeer). + peer discovery restarts. To add a whitelisted node as a peer without waiting for peer discovery to restart, use [`admin_addPeer`](../Reference/Pantheon-API-Methods.md#admin_addpeer). If the node is added to the whitelist before starting the node, using `admin_addPeer` is not required because peer discovery is run on node startup. diff --git a/docs/Privacy/Privacy-Overview.md b/docs/Privacy/Privacy-Overview.md index d7c7ae93e3..01aa841124 100644 --- a/docs/Privacy/Privacy-Overview.md +++ b/docs/Privacy/Privacy-Overview.md @@ -48,7 +48,7 @@ Private transactions have additional attributes to public Ethereum transactions: Pantheon and Orion nodes both have public/private key pairs identifying them. The private transaction submitted from the Pantheon node to the Orion node is signed with the Pantheon node private key. The `privateFrom` and `privateFor` attributes specified in the RLP-encoded transaction string for -[`eea_sendRawTransaction`](../Reference/JSON-RPC-API-Methods.md#eea_sendrawtransaction) are the public keys +[`eea_sendRawTransaction`](../Reference/Pantheon-API-Methods.md#eea_sendrawtransaction) are the public keys of the Orion nodes sending and receiving the transaction. !!! important diff --git a/docs/Privacy/Privacy-Quickstart.md b/docs/Privacy/Privacy-Quickstart.md index 438ac2d155..3cf4d65639 100644 --- a/docs/Privacy/Privacy-Quickstart.md +++ b/docs/Privacy/Privacy-Quickstart.md @@ -130,7 +130,7 @@ Waiting for transaction to be mined ... Get Value: 0x000000000000000000000000000000000000000000000000000000000000002a ``` -Call [`eth_getTransactionReceipt`](../Reference/JSON-RPC-API-Methods.md#eth_gettransactionreceipt) where: +Call [`eth_getTransactionReceipt`](../Reference/Pantheon-API-Methods.md#eth_gettransactionreceipt) where: * `` is the transaction hash displayed in the Event Emitter logs. * `` is the JSON-RPC HTTP service endpoint displayed when starting the network. diff --git a/docs/Privacy/Private-Transaction-Processing.md b/docs/Privacy/Private-Transaction-Processing.md index 82ca442f14..ebda2a0bf0 100644 --- a/docs/Privacy/Private-Transaction-Processing.md +++ b/docs/Privacy/Private-Transaction-Processing.md @@ -16,7 +16,7 @@ Private transactions are processed as illustrated and described below. ![Processing Private Transctions](../images/PrivateTransactionProcessing.png) -1. A private transaction is submitted using [eea_sendRawTransaction](../Reference/JSON-RPC-API-Methods.md#eea_sendrawtransaction). +1. A private transaction is submitted using [eea_sendRawTransaction](../Reference/Pantheon-API-Methods.md#eea_sendrawtransaction). The signed transaction includes transaction attributes that are specific to private transactions: * `privateFor` specifies the list of recipients diff --git a/docs/Reference/JSON-RPC-API-Methods.md b/docs/Reference/Pantheon-API-Methods.md similarity index 96% rename from docs/Reference/JSON-RPC-API-Methods.md rename to docs/Reference/Pantheon-API-Methods.md index 3f4109bf05..3ef7e95be5 100644 --- a/docs/Reference/JSON-RPC-API-Methods.md +++ b/docs/Reference/Pantheon-API-Methods.md @@ -1,7 +1,7 @@ description: Pantheon JSON-RPC API methods reference -# JSON-RPC API Methods +# Pantheon API Methods !!! attention All JSON-RPC HTTP examples use the default host and port endpoint `http://127.0.0.1:8545`. @@ -12,7 +12,7 @@ description: Pantheon JSON-RPC API methods reference ## Admin Methods !!! note - The `ADMIN` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `ADMIN` API methods are not enabled by default for JSON-RPC. 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_addPeer @@ -645,7 +645,7 @@ None Returns a list of account addresses that the client owns. !!!note - This method returns an empty object because Pantheon [does not support account management](../JSON-RPC-API/Using-JSON-RPC-API.md#account-management). + This method returns an empty object because Pantheon [does not support account management](../Pantheon-API/Using-JSON-RPC-API.md#account-management). **Parameters** @@ -710,7 +710,7 @@ Returns the account balance of the specified address. `DATA` - 20-byte account address from which to retrieve the balance. -`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -743,7 +743,7 @@ Returns the value of a storage position at a specified address. `QUANTITY` - Integer index of the storage position. -`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -776,7 +776,7 @@ Returns the number of transactions sent from a specified address. Use the `pendi `data` - 20-byte account address. -`quantity|tag` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`quantity|tag` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -834,7 +834,7 @@ Returns the number of transactions in a block matching the specified block numbe **Parameters** -`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -892,7 +892,7 @@ Returns the number of uncles in a block matching the specified block number. **Parameters** -`QUANTITY|TAG` - Integer representing either the 0-based index of the block within the blockchain, or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing either the 0-based index of the block within the blockchain, or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -923,7 +923,7 @@ Returns the code of the smart contract at the specified address. Compiled smart `DATA` - 20-byte contract address. -`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -955,7 +955,7 @@ You can interact with contracts using [eth_sendRawTransaction or eth_call](../Us To avoid exposing your private key, create signed transactions offline and send the signed transaction data using `eth_sendRawTransaction`. !!!important - Pantheon does not implement [eth_sendTransaction](../JSON-RPC-API/Using-JSON-RPC-API.md#account-management). + Pantheon does not implement [eth_sendTransaction](../Pantheon-API/Using-JSON-RPC-API.md#account-management). **Parameters** @@ -995,9 +995,9 @@ You can interact with contracts using [eth_sendRawTransaction or eth_call](../Us **Parameters** -*OBJECT* - [Transaction call object](JSON-RPC-API-Objects.md#transaction-call-object). +*OBJECT* - [Transaction call object](Pantheon-API-Objects.md#transaction-call-object). -*QUANTITY|TAG* - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +*QUANTITY|TAG* - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -1035,7 +1035,7 @@ The transaction call object parameters are the same as those for [eth_call](#eth all fields are optional. Setting a gas limit is irrelevant to the estimation process (unlike transactions, in which gas limits apply). -*OBJECT* - [Transaction call object](JSON-RPC-API-Objects.md#transaction-call-object). +*OBJECT* - [Transaction call object](Pantheon-API-Objects.md#transaction-call-object). **Returns** @@ -1100,11 +1100,11 @@ Returns information about the block by hash. `DATA` - 32-byte hash of a block. -`Boolean` - If `true`, returns the full [transaction objects](JSON-RPC-API-Objects.md#transaction-object); if `false`, returns the transaction hashes. +`Boolean` - If `true`, returns the full [transaction objects](Pantheon-API-Objects.md#transaction-object); if `false`, returns the transaction hashes. **Returns** -`result` : *OBJECT* - [Block object](JSON-RPC-API-Objects.md#block-object) , or `null` when no block is found. +`result` : *OBJECT* - [Block object](Pantheon-API-Objects.md#block-object) , or `null` when no block is found. !!! example ```bash tab="curl HTTP request" @@ -1149,13 +1149,13 @@ Returns information about a block by block number. **Parameters** -`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). -`Boolean` - If `true`, returns the full [transaction objects](JSON-RPC-API-Objects.md#transaction-object); if `false`, returns only the hashes of the transactions. +`Boolean` - If `true`, returns the full [transaction objects](Pantheon-API-Objects.md#transaction-object); if `false`, returns only the hashes of the transactions. **Returns** -`result` : *OBJECT* - [Block object](JSON-RPC-API-Objects.md#block-object) , or `null` when no block is found. +`result` : *OBJECT* - [Block object](Pantheon-API-Objects.md#block-object) , or `null` when no block is found. !!! example ```bash tab="curl HTTP request" @@ -1204,7 +1204,7 @@ Returns transaction information for the specified transaction hash. **Returns** -Object - [Transaction object](JSON-RPC-API-Objects.md#transaction-object), or `null` when no transaction is found. +Object - [Transaction object](Pantheon-API-Objects.md#transaction-object), or `null` when no transaction is found. !!! example ```bash tab="curl HTTP request" @@ -1250,7 +1250,7 @@ Returns transaction information for the specified block hash and transaction ind **Returns** -Object - [Transaction object](JSON-RPC-API-Objects.md#transaction-object), or `null` when no transaction is found. +Object - [Transaction object](Pantheon-API-Objects.md#transaction-object), or `null` when no transaction is found. !!! example ```bash tab="curl HTTP request" @@ -1290,13 +1290,13 @@ Returns transaction information for the specified block number and transaction i **Parameters** -`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`QUANTITY|TAG` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). `QUANTITY` - The transaction index position. **Returns** -Object - [Transaction object](JSON-RPC-API-Objects.md#transaction-object), or `null` when no transaction is found. +Object - [Transaction object](Pantheon-API-Objects.md#transaction-object), or `null` when no transaction is found. !!!note Your node must be synchronized to at least the block containing the transaction for the request to return it. @@ -1345,7 +1345,7 @@ Returns the receipt of a transaction by transaction hash. Receipts for pending t **Returns** -`Object` - [Transaction receipt object](JSON-RPC-API-Objects.md#transaction-receipt-object), or `null` when no receipt is found. +`Object` - [Transaction receipt object](Pantheon-API-Objects.md#transaction-receipt-object), or `null` when no receipt is found. !!! example ```bash tab="curl HTTP request" @@ -1383,7 +1383,7 @@ Creates a [log filter](../Using-Pantheon/Events-and-Logs.md). To poll for logs a **Parameters** -`Object` - [Filter options object](JSON-RPC-API-Objects.md#filter-options-object). +`Object` - [Filter options object](Pantheon-API-Objects.md#filter-options-object). !!!note `fromBlock` and `toBlock` in the filter options object default to `latest`. To obtain logs using `eth_getFilterLogs`, set `fromBlock` and `toBlock` appropriately. @@ -1514,7 +1514,7 @@ Polls the specified filter and returns an array of changes that have occurred si * For filters created with `eth_newBlockFilter`, returns block hashes. * For filters created with `eth_newPendingTransactionFilter`, returns transaction hashes. -* For filters created with `eth_newFilter`, returns [log objects](JSON-RPC-API-Objects.md#log-object). +* For filters created with `eth_newFilter`, returns [log objects](Pantheon-API-Objects.md#log-object). !!! example ```bash tab="curl HTTP request" @@ -1602,7 +1602,7 @@ Returns an array of [logs](../Using-Pantheon/Events-and-Logs.md) for the specifi **Returns** -`array` - [Log objects](JSON-RPC-API-Objects.md#log-object) +`array` - [Log objects](Pantheon-API-Objects.md#log-object) !!! example @@ -1648,11 +1648,11 @@ Returns an array of [logs](../Using-Pantheon/Events-and-Logs.md) matching a spec **Parameters** -`Object` - [Filter options object](JSON-RPC-API-Objects.md#filter-options-object) +`Object` - [Filter options object](Pantheon-API-Objects.md#filter-options-object) **Returns** -`array` - [Log objects](JSON-RPC-API-Objects.md#log-object) +`array` - [Log objects](Pantheon-API-Objects.md#log-object) !!! example The following request returns all logs for the contract at address `0x2e1f232a9439c3d459fceca0beef13acc8259dd8`. @@ -1734,7 +1734,7 @@ 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) + The `CLIQUE` API methods are not enabled by default for JSON-RPC. 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 @@ -1772,7 +1772,7 @@ Lists [signers for the specified block](../Consensus-Protocols/Clique.md#adding- **Parameters** -`quantity|tag` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`quantity|tag` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -1892,7 +1892,7 @@ If the boolean value is `true`, the proposal is to add a signer. If `false`, the ## Debug Methods !!! note - The `DEBUG` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `DEBUG` API methods are not enabled by default for JSON-RPC. 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_storageRangeAt @@ -1915,7 +1915,7 @@ Returns the contract storage for the specified range. **Returns** -`result`:`object` - [Range object](JSON-RPC-API-Objects.md#range-object) +`result`:`object` - [Range object](Pantheon-API-Objects.md#range-object) !!! example ```bash tab="curl HTTP request" @@ -2087,7 +2087,7 @@ Reruns the transaction with the same state as when the transaction was executed. **Returns** -`result`:`object` - [Trace object](JSON-RPC-API-Objects.md#trace-object). +`result`:`object` - [Trace object](Pantheon-API-Objects.md#trace-object). !!! example ```bash tab="curl HTTP request" @@ -2123,7 +2123,7 @@ Reruns the transaction with the same state as when the transaction was executed. ## Miner Methods !!! note - The `MINER` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `MINER` API methods are not enabled by default for JSON-RPC. 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 @@ -2187,7 +2187,7 @@ None ## IBFT 2.0 Methods !!! note - The `IBFT` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `IBFT` API methods are not enabled by default for JSON-RPC. 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 @@ -2292,7 +2292,7 @@ Lists the validators defined in the specified block. **Parameters** -`quantity|tag` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). +`quantity|tag` - Integer representing a block number or one of the string tags `latest`, `earliest`, or `pending`, as described in [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). **Returns** @@ -2353,7 +2353,7 @@ Proposes [adding or removing a validator](../Consensus-Protocols/IBFT.md#adding- ## Permissioning Methods !!! note - The `PERM` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `PERM` API methods are not enabled by default for JSON-RPC. 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 `PERM` API methods. ### perm_addAccountsToWhitelist @@ -2583,7 +2583,7 @@ None ## Txpool Methods !!! note - The `TXPOOL` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `TXPOOL` API methods are not enabled by default for JSON-RPC. 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 `TXPOOL` API methods. ### txpool_pantheonStatistics @@ -2667,7 +2667,7 @@ None ## EEA Methods !!! note - The `EEA` API methods are not enabled by default. Use the [`--rpc-http-api`](Pantheon-CLI-Syntax.md#rpc-http-api) + The `EEA` API methods are not enabled by default for JSON-RPC. 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 `EEA` API methods. ### eea_sendRawTransaction @@ -2726,7 +2726,7 @@ are not available. **Returns** -`Object` - [Private Transaction receipt object](JSON-RPC-API-Objects.md#private-transaction-receipt-object), or `null` if no receipt found. +`Object` - [Private Transaction receipt object](Pantheon-API-Objects.md#private-transaction-receipt-object), or `null` if no receipt found. !!! example ```bash tab="curl HTTP request" @@ -2755,7 +2755,7 @@ are not available. ### rpc_modules -Lists [enabled JSON-RPC APIs](../JSON-RPC-API/Using-JSON-RPC-API.md#api-methods-enabled-by-default) and the version of each. +Lists [enabled APIs](../Pantheon-API/Using-JSON-RPC-API.md#api-methods-enabled-by-default) and the version of each. **Parameters** @@ -2763,7 +2763,7 @@ None **Returns** -Enabled JSON-RPC APIs. +Enabled APIs. !!! example ```bash tab="curl HTTP request" diff --git a/docs/Reference/JSON-RPC-API-Objects.md b/docs/Reference/Pantheon-API-Objects.md similarity index 94% rename from docs/Reference/JSON-RPC-API-Objects.md rename to docs/Reference/Pantheon-API-Objects.md index 07f1ac99ed..677a46dbda 100644 --- a/docs/Reference/JSON-RPC-API-Objects.md +++ b/docs/Reference/Pantheon-API-Objects.md @@ -1,13 +1,13 @@ -description: Pantheon JSON-RPC API objects reference +description: Pantheon API objects reference -# JSON-RPC API Objects +# Pantheon API Objects -The following objects are parameters for or returned by JSON-RPC Methods. +The following objects are parameters for or returned by Pantheon API Methods. ## Block Object -Returned by [eth_getBlockByHash](JSON-RPC-API-Methods.md#eth_getblockbyhash) and [eth_getBlockByNumber](JSON-RPC-API-Methods.md#eth_getblockbynumber). +Returned by [eth_getBlockByHash](Pantheon-API-Methods.md#eth_getblockbyhash) and [eth_getBlockByNumber](Pantheon-API-Methods.md#eth_getblockbynumber). | Key | Type | Value | |----------------------|:---------------------:|----------------------------------------------------------------------------------------------------------------------------------| @@ -34,16 +34,16 @@ Returned by [eth_getBlockByHash](JSON-RPC-API-Methods.md#eth_getblockbyhash) and ## Filter Options Object -Parameter for [eth_newFilter](JSON-RPC-API-Methods.md#eth_newfilter) and [eth_getLogs](JSON-RPC-API-Methods.md#eth_getlogs). Used to [filter logs](../Using-Pantheon/Accessing-Logs-Using-JSON-RPC.md). +Parameter for [eth_newFilter](Pantheon-API-Methods.md#eth_newfilter) and [eth_getLogs](Pantheon-API-Methods.md#eth_getlogs). Used to [filter logs](../Using-Pantheon/Accessing-Logs-Using-JSON-RPC.md). | Key | Type | Required/Optional | Value | |---------------|:---------------------------------:|:-----------------:|---------------------------------------------------------------------------------------------------------------------------------------------| -| **fromBlock** | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). Default is `latest`. | -| **toBlock** | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../JSON-RPC-API/Using-JSON-RPC-API.md#block-parameter). Default is `latest`. | +| **fromBlock** | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). Default is `latest`. | +| **toBlock** | Quantity | Tag | Optional | Integer block number or `latest`, `pending`, `earliest`. See [Block Parameter](../Pantheon-API/Using-JSON-RPC-API.md#block-parameter). Default is `latest`. | | **address** | Data | Array | Optional | Contract address or array of addresses from which [logs](../Using-Pantheon/Events-and-Logs.md) originate. | | **topics** | Array of Data, 32 bytes each | Optional | Array of topics by which to [filter logs](../Using-Pantheon/Events-and-Logs.md#topic-filters). | -[eth_getLogs](JSON-RPC-API-Methods.md#eth_getlogs) has an additional key. +[eth_getLogs](Pantheon-API-Methods.md#eth_getlogs) has an additional key. | Key | Type | Required/Optional | Value | |------------|:-----------------:|:-----------------:|------| @@ -51,7 +51,7 @@ Parameter for [eth_newFilter](JSON-RPC-API-Methods.md#eth_newfilter) and [eth_ge ## Log Object -Returned by [eth_getFilterChanges](JSON-RPC-API-Methods.md#eth_getfilterchanges) and [transaction receipt objects](#transaction-receipt-object) can contain an array of log objects. +Returned by [eth_getFilterChanges](Pantheon-API-Methods.md#eth_getfilterchanges) and [transaction receipt objects](#transaction-receipt-object) can contain an array of log objects. | Key | Type | Value | |----------------------|-:- :------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -67,7 +67,7 @@ Returned by [eth_getFilterChanges](JSON-RPC-API-Methods.md#eth_getfilterchanges) ## Range Object -Returned by [debug_storageRangeAt](JSON-RPC-API-Methods.md#debug_storagerangeat). +Returned by [debug_storageRangeAt](Pantheon-API-Methods.md#debug_storagerangeat). | Key | Type | Value | |-----------------|:-------:|-------------------------------------------------------------------| @@ -93,7 +93,7 @@ Log information returned as part of the [Trace object](#trace-object). ## Trace Object -Returned by [debug_traceTransaction](JSON-RPC-API-Methods.md#debug_tracetransaction). +Returned by [debug_traceTransaction](Pantheon-API-Methods.md#debug_tracetransaction). | Key | Type | Value | |-----------------|:-------:|-------------------------------------------------------------------| @@ -104,7 +104,7 @@ Returned by [debug_traceTransaction](JSON-RPC-API-Methods.md#debug_tracetransact ## Transaction Object -Returned by [eth_getTransactionByHash](JSON-RPC-API-Methods.md#eth_gettransactionbyhash), [eth_getTransactionByBlockHashAndIndex](JSON-RPC-API-Methods.md#eth_gettransactionbyblockhashandindex), and [eth_getTransactionsByBlockNumberAndIndex](JSON-RPC-API-Methods.md#eth_gettransactionbyblocknumberandindex). +Returned by [eth_getTransactionByHash](Pantheon-API-Methods.md#eth_gettransactionbyhash), [eth_getTransactionByBlockHashAndIndex](Pantheon-API-Methods.md#eth_gettransactionbyblockhashandindex), and [eth_getTransactionsByBlockNumberAndIndex](Pantheon-API-Methods.md#eth_gettransactionbyblocknumberandindex). | Key | Type | Value | |----------------------|:-------------------:|----------------------------------------------------------------------------------------| @@ -125,10 +125,10 @@ Returned by [eth_getTransactionByHash](JSON-RPC-API-Methods.md#eth_gettransactio ## Transaction Call Object -Parameter for [eth_call](JSON-RPC-API-Methods.md#eth_call) and [eth_estimateGas](JSON-RPC-API-Methods.md#eth_estimategas). +Parameter for [eth_call](Pantheon-API-Methods.md#eth_call) and [eth_estimateGas](Pantheon-API-Methods.md#eth_estimategas). !!!note - All parameters are optional for [eth_estimateGas](JSON-RPC-API-Methods.md#eth_estimategas) + All parameters are optional for [eth_estimateGas](Pantheon-API-Methods.md#eth_estimategas) | Key | Type | Required/Optional | Value | |--------------|:-------------------:|:-----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -141,7 +141,7 @@ Parameter for [eth_call](JSON-RPC-API-Methods.md#eth_call) and [eth_estimateGas] ## Transaction Receipt Object -Returned by [eth_getTransactionReceipt](JSON-RPC-API-Methods.md#eth_gettransactionreceipt). +Returned by [eth_getTransactionReceipt](Pantheon-API-Methods.md#eth_gettransactionreceipt). | Key | Type | Value | |-----------------------|:--------------------:|--------------------------------------------------------------------------------------| @@ -167,7 +167,7 @@ Returned by [eth_getTransactionReceipt](JSON-RPC-API-Methods.md#eth_gettransacti ## Private Transaction Receipt Object -Returned by [eea_getTransactionReceipt](JSON-RPC-API-Methods.md#eea_gettransactionreceipt). +Returned by [eea_getTransactionReceipt](Pantheon-API-Methods.md#eea_gettransactionreceipt). | Key | Type | Value | |-----------------------|:--------------------:|--------------------------------------------------------------------------------------| diff --git a/docs/Reference/Pantheon-CLI-Syntax.md b/docs/Reference/Pantheon-CLI-Syntax.md index c7a711215d..1480812d2e 100644 --- a/docs/Reference/Pantheon-CLI-Syntax.md +++ b/docs/Reference/Pantheon-CLI-Syntax.md @@ -157,7 +157,7 @@ The path to the genesis file. host-whitelist=["medomain.com", "meotherdomain.com"] ``` -Comma-separated list of hostnames to allow [access to the JSON-RPC API](../JSON-RPC-API/Using-JSON-RPC-API.md#host-whitelist). +Comma-separated list of hostnames to allow [access to the JSON-RPC API](../Pantheon-API/Using-JSON-RPC-API.md#host-whitelist). By default, access from `localhost` and `127.0.0.1` is accepted. !!!tip @@ -355,7 +355,7 @@ Job name when in `push` mode. The default is `pantheon-client`. Account to which mining rewards are paid. You must specify a valid coinbase when you enable mining using the [`--miner-enabled`](#miner-enabled) -option or the [`miner_start`](JSON-RPC-API-Methods.md#miner_start) JSON RPC-API method. +option or the [`miner_start`](Pantheon-API-Methods.md#miner_start) JSON RPC-API method. !!!note This option is ignored in networks using [Clique](../Consensus-Protocols/Clique.md) and [IBFT 2.0](../Consensus-Protocols/IBFT.md) consensus protocols. @@ -760,7 +760,7 @@ The default is: `ETH`, `NET`, `WEB3`. rpc-http-authentication-credentials-file="/home/me/me_node/auth.toml" ``` -[Credentials file](../JSON-RPC-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md). +[Credentials file](../Pantheon-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../Pantheon-API/Authentication.md). !!!note This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#credentials-files). @@ -779,7 +779,7 @@ rpc-http-authentication-credentials-file="/home/me/me_node/auth.toml" rpc-http-authentication-enabled=true ``` -Set to `true` to require [authentication](../JSON-RPC-API/Authentication.md) for the HTTP JSON-RPC service. +Set to `true` to require [authentication](../Pantheon-API/Authentication.md) for the HTTP JSON-RPC service. ### rpc-http-cors-origins @@ -919,7 +919,7 @@ The default is: `ETH`, `NET`, `WEB3`. rpc-ws-authentication-credentials-file="/home/me/me_node/auth.toml" ``` -[Credentials file](../JSON-RPC-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md). +[Credentials file](../Pantheon-API/Authentication.md#credentials-file) for JSON-RPC API [authentication](../Pantheon-API/Authentication.md). !!!note This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#credentials-files). @@ -938,10 +938,10 @@ rpc-ws-authentication-credentials-file="/home/me/me_node/auth.toml" rpc-ws-authentication-enabled=true ``` -Set to `true` to require [authentication](../JSON-RPC-API/Authentication.md) for the WebSockets JSON-RPC service. +Set to `true` to require [authentication](../Pantheon-API/Authentication.md) for the WebSockets JSON-RPC service. !!! note - `wscat` does not support headers. [Authentication](../JSON-RPC-API/Authentication.md) requires an authentication token to be passed in the + `wscat` does not support headers. [Authentication](../Pantheon-API/Authentication.md) requires an authentication token to be passed in the request header. To use authentication with WebSockets, an app that supports headers is required. ### rpc-ws-enabled @@ -1149,8 +1149,8 @@ This command provides password related actions. ### hash -This command generates the hash of a given password. Include the hash in the [credentials file](../JSON-RPC-API/Authentication.md#credentials-file) - for JSON-RPC API [authentication](../JSON-RPC-API/Authentication.md). +This command generates the hash of a given password. Include the hash in the [credentials file](../Pantheon-API/Authentication.md#credentials-file) + for JSON-RPC API [authentication](../Pantheon-API/Authentication.md). ```bash tab="Syntax" $ pantheon password hash --password= diff --git a/docs/Troubleshooting/Troubleshooting.md b/docs/Troubleshooting/Troubleshooting.md index e4d5bfaf35..1545b7f4af 100644 --- a/docs/Troubleshooting/Troubleshooting.md +++ b/docs/Troubleshooting/Troubleshooting.md @@ -41,7 +41,7 @@ On non-mining nodes, log messages indicate blocks are being imported. 2019-05-08 20:28:31.031+10:00 | EthScheduler-Workers-0 | INFO | BlockPropagationManager | Imported #662 / 0 tx / 0 om / 0 (0.0%) gas / (0x0ead4e20123d3f1433d8dec894fcce386da4049819b24b309963ce7a8a0fcf03) in 0.000s. ``` -Use the [`eth_blockNumber`](../Reference/JSON-RPC-API-Methods.md#eth_blocknumber) JSON-RPC API method to confirm the +Use the [`eth_blockNumber`](../Reference/Pantheon-API-Methods.md#eth_blocknumber) JSON-RPC API method to confirm the block number is increasing. If blocks are not being created in [Clique](../Consensus-Protocols/Clique.md#extra-data) or [IBFT 2.0](../Consensus-Protocols/IBFT.md#extra-data) networks, diff --git a/docs/Tutorials/Create-IBFT-Network.md b/docs/Tutorials/Create-IBFT-Network.md index 5650f5dfc9..a0977b13f5 100644 --- a/docs/Tutorials/Create-IBFT-Network.md +++ b/docs/Tutorials/Create-IBFT-Network.md @@ -226,7 +226,7 @@ The command line specifies: ### 9. Confirm Private Network is Working -Start another terminal, use curl to call the JSON-RPC API [`net_peerCount`](../Reference/JSON-RPC-API-Methods.md#net_peercount) method and confirm the nodes are functioning as peers: +Start another terminal, use curl to call the JSON-RPC API [`net_peerCount`](../Reference/Pantheon-API-Methods.md#net_peercount) method and confirm the nodes are functioning as peers: ```bash curl -X POST --data '{"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":1}' localhost:8545 diff --git a/docs/Tutorials/Create-Permissioned-Network.md b/docs/Tutorials/Create-Permissioned-Network.md index 10ade723d8..e17d8f2025 100644 --- a/docs/Tutorials/Create-Permissioned-Network.md +++ b/docs/Tutorials/Create-Permissioned-Network.md @@ -222,7 +222,7 @@ The enode URL is required to update the permissions configuration file in the fo ### 8. Add Enode URLs for Nodes to Permissions Configuration File -In another terminal, use the [`perm_addNodesToWhitelist`](../Reference/JSON-RPC-API-Methods.md#perm_addnodestowhitelist) +In another terminal, use the [`perm_addNodesToWhitelist`](../Reference/Pantheon-API-Methods.md#perm_addnodestowhitelist) JSON-RPC API method to add the nodes to the permissions configuration file for each node. Replace ``, ``, and `` with the enode URL displayed when starting each node. @@ -247,7 +247,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"perm_addNodesToWhitelist","param ### 9. Add Nodes as Peers -Use the [`admin_addPeer`](../Reference/JSON-RPC-API-Methods.md#admin_addpeer) JSON-RPC API method to add +Use the [`admin_addPeer`](../Reference/Pantheon-API-Methods.md#admin_addpeer) JSON-RPC API method to add Node-1 as a peer for Node-2 and Node-3. Replace `` with the enode URL displayed when starting Node-1. @@ -276,7 +276,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"admin_addPeer","params":["` is the account to which mining rewards are to be paid. For exa JSON-RPC API methods for mining are: -* [`miner_start`](../Reference/JSON-RPC-API-Methods.md#miner_start) to start mining. -* [`miner_stop`](../Reference/JSON-RPC-API-Methods.md#miner_stop) to stop mining. -* [`eth_mining`](../Reference/JSON-RPC-API-Methods.md#eth_mining) to determine whether the client is actively mining new blocks. -* [`eth_hashrate`](../Reference/JSON-RPC-API-Methods.md#eth_hashrate) to get the number of hashes per second with which the node is mining. \ No newline at end of file +* [`miner_start`](../Reference/Pantheon-API-Methods.md#miner_start) to start mining. +* [`miner_stop`](../Reference/Pantheon-API-Methods.md#miner_stop) to stop mining. +* [`eth_mining`](../Reference/Pantheon-API-Methods.md#eth_mining) to determine whether the client is actively mining new blocks. +* [`eth_hashrate`](../Reference/Pantheon-API-Methods.md#eth_hashrate) to get the number of hashes per second with which the node is mining. \ No newline at end of file diff --git a/docs/Using-Pantheon/Monitoring.md b/docs/Using-Pantheon/Monitoring.md index 86eccd437c..ebf281f219 100644 --- a/docs/Using-Pantheon/Monitoring.md +++ b/docs/Using-Pantheon/Monitoring.md @@ -5,7 +5,7 @@ description: Frequently asked questions FAQ and answers for troubleshooting Pant ## Monitor Node Performance and Connectivity Using the JSON-RPC API -You can monitor node performance using the [`debug_metrics`](../Reference/JSON-RPC-API-Methods.md#debug_metrics) +You can monitor node performance using the [`debug_metrics`](../Reference/Pantheon-API-Methods.md#debug_metrics) JSON-RPC API method. ## Monitor Node Performance Using Prometheus diff --git a/docs/Using-Pantheon/Transactions/Transaction-Pool.md b/docs/Using-Pantheon/Transactions/Transaction-Pool.md index a3682d6f22..499a11d58f 100644 --- a/docs/Using-Pantheon/Transactions/Transaction-Pool.md +++ b/docs/Using-Pantheon/Transactions/Transaction-Pool.md @@ -2,13 +2,13 @@ Options and methods for configuring and monitoring the transaction pool include: -* [`txpool_pantheonTransactions`](../../Reference/JSON-RPC-API-Methods.md#txpool_pantheontransactions) JSON-RPC API method to list +* [`txpool_pantheonTransactions`](../../Reference/Pantheon-API-Methods.md#txpool_pantheontransactions) JSON-RPC API method to list transactions in the node transaction pool * [`--tx-pool-max-size`](../../Reference/Pantheon-CLI-Syntax.md#tx-pool-max-size) command line option to specify the maximum number of transactions in the node transaction pool -* [`newPendingTransactions`](../RPC-PubSub.md#pending-transactions) and [`droppedPendingTransactions`](../RPC-PubSub.md#dropped-transactions) +* [`newPendingTransactions`](../../Pantheon-API/RPC-PubSub.md#pending-transactions) and [`droppedPendingTransactions`](../../Pantheon-API/RPC-PubSub.md#dropped-transactions) RPC subscriptions to notify of transactions added to and dropped from the node transaction pool Once full, the Pantheon transaction pool accepts and retains local transactions in preference to remote transactions. diff --git a/docs/Using-Pantheon/Transactions/Transactions.md b/docs/Using-Pantheon/Transactions/Transactions.md index 0624c26c68..b87f388450 100644 --- a/docs/Using-Pantheon/Transactions/Transactions.md +++ b/docs/Using-Pantheon/Transactions/Transactions.md @@ -3,9 +3,9 @@ description: Some use cases of creating transactions on a Pantheon network # Creating and Sending Transactions -You can send signed transactions using the [`eth_sendRawTransaction`](../../Reference/JSON-RPC-API-Methods.md#eth_sendrawtransaction) JSON-RPC API method. +You can send signed transactions using the [`eth_sendRawTransaction`](../../Reference/Pantheon-API-Methods.md#eth_sendrawtransaction) JSON-RPC API method. -These examples describe how to create a signed raw transaction that can be passed to [`eth_sendRawTransaction`](../../Reference/JSON-RPC-API-Methods.md#eth_sendrawtransaction). +These examples describe how to create a signed raw transaction that can be passed to [`eth_sendRawTransaction`](../../Reference/Pantheon-API-Methods.md#eth_sendrawtransaction). !!!tip To avoid exposing your private keys, create signed transactions offline. @@ -146,7 +146,7 @@ All accounts and private keys in the examples are from the `dev.json` genesis fi ## eth_call or eth_sendRawTransaction -You can interact with contracts using [eth_call](../../Reference/JSON-RPC-API-Methods.md#eth_call) or [eth_sendRawTransaction](../../Reference/JSON-RPC-API-Methods.md#eth_sendrawtransaction). The table below compares the characteristics of both calls. +You can interact with contracts using [eth_call](../../Reference/Pantheon-API-Methods.md#eth_call) or [eth_sendRawTransaction](../../Reference/Pantheon-API-Methods.md#eth_sendrawtransaction). The table below compares the characteristics of both calls. | eth_call | eth_sendRawTransaction | |---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/index.md b/docs/index.md index 92c61860f5..519f88e0a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ Pantheon supports enterprise features including privacy and permissioning. ## What can you do with Pantheon? -Pantheon includes a [command line interface](Reference/Pantheon-CLI-Syntax.md) and [JSON-RPC API](JSON-RPC-API/JSON-RPC-API.md) +Pantheon includes a [command line interface](Reference/Pantheon-CLI-Syntax.md) and [JSON-RPC API](Pantheon-API/JSON-RPC-API.md) for running, maintaining, debugging, and monitoring nodes in an Ethereum network. You can use the API via RPC over HTTP or via WebSockets, and Pub/Sub is supported. The API supports typical Ethereum functionalities such as: diff --git a/mkdocs.yml b/mkdocs.yml index fbf0c46e97..396a51037e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,16 +59,11 @@ nav: - Create a Private Network using Clique (PoA): Tutorials/Create-Private-Clique-Network.md - Create a Private Network using IBFT 2.0 (PoA): Tutorials/Create-IBFT-Network.md - Create a Permissioned Network: Tutorials/Create-Permissioned-Network.md - - Consensus Protocols: - - Pantheon Consensus Protocols: Consensus-Protocols/Overview-Consensus.md - - Comparing PoA Consensus Protocols: Consensus-Protocols/Comparing-PoA.md - - Clique: Consensus-Protocols/Clique.md - - IBFT 2.0: Consensus-Protocols/IBFT.md - - Quorum IBFT 1.0: Consensus-Protocols/QuorumIBFT.md - - JSON-RPC API: - - Overview: JSON-RPC-API/JSON-RPC-API.md - - Using the JSON-RPC API: JSON-RPC-API/Using-JSON-RPC-API.md - - Authentication: JSON-RPC-API/Authentication.md + - Pantheon API: + - Overview: Pantheon-API/Pantheon-API.md + - JSON-RPC over HTTP or WebSockets: Pantheon-API/Using-JSON-RPC-API.md + - Authentication: Pantheon-API/Authentication.md + - RPC Pub/Sub over WebSockets: Pantheon-API/RPC-PubSub.md - Configuring Pantheon: - Network vs Node Configuration: Configuring-Pantheon/Network-vs-Node.md - Configuration File: Configuring-Pantheon/Using-Configuration-File.md @@ -83,6 +78,12 @@ nav: - Bootnodes: Configuring-Pantheon/Networking/Bootnodes.md - Configuring Ports: Configuring-Pantheon/Networking/Configuring-Ports.md - Managing Peers: Configuring-Pantheon/Networking/Managing-Peers.md + - Consensus Protocols: + - Pantheon Consensus Protocols: Consensus-Protocols/Overview-Consensus.md + - Comparing PoA Consensus Protocols: Consensus-Protocols/Comparing-PoA.md + - Clique: Consensus-Protocols/Clique.md + - IBFT 2.0: Consensus-Protocols/IBFT.md + - Quorum IBFT 1.0: Consensus-Protocols/QuorumIBFT.md - Privacy: - Overview: Privacy/Privacy-Overview.md - Processing Private Transactions: Privacy/Private-Transaction-Processing.md @@ -103,7 +104,6 @@ nav: - Accessing Logs Using JSON-RPC API: Using-Pantheon/Accessing-Logs-Using-JSON-RPC.md - Using Wallets for Account Management: Using-Pantheon/Account-Management.md - Mining: Using-Pantheon/Mining.md - - RPC Pub/Sub: Using-Pantheon/RPC-PubSub.md - Monitoring Pantheon: Using-Pantheon/Monitoring.md - Monitoring Pantheon: - EthStats: @@ -114,8 +114,8 @@ nav: - Troubleshooting: Troubleshooting/Troubleshooting.md - Reference: - Pantheon Command Line: Reference/Pantheon-CLI-Syntax.md - - JSON-RPC API Methods: Reference/JSON-RPC-API-Methods.md - - JSON-RPC API Objects: Reference/JSON-RPC-API-Objects.md + - Pantheon API Methods: Reference/Pantheon-API-Methods.md + - Pantheon API Objects: Reference/Pantheon-API-Objects.md - Resources: - Blog Posts and Webinars: Resources/Resources.md