github/reth
1
1
Fork 0
mirror of https://github.com/paradigmxyz/reth.git synced 2026-01-09 15:28:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add missing RPC namespaces to JSON-RPC intro (#20321)

Browse Source
This commit is contained in:
emmmm
2025-12-12 10:40:38 -05:00
committed by GitHub
parent ace4e515b5
commit d2d58f9a0e
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/vocs/docs/pages/jsonrpc/intro.mdx
View File

@@ -26,8 +26,14 @@ The methods are grouped into namespaces, which are listed below:
| [`trace`](/jsonrpc/trace) | The `trace` API provides several methods to inspect the Ethereum state, including Parity-style traces. | No | | [`trace`](/jsonrpc/trace) | The `trace` API provides several methods to inspect the Ethereum state, including Parity-style traces. | No |
| [`admin`](/jsonrpc/admin) | The `admin` API allows you to configure your node. | **Yes** | | [`admin`](/jsonrpc/admin) | The `admin` API allows you to configure your node. | **Yes** |
| [`rpc`](/jsonrpc/rpc) | The `rpc` API provides information about the RPC server and its modules. | No | | [`rpc`](/jsonrpc/rpc) | The `rpc` API provides information about the RPC server and its modules. | No |
| `reth` | The `reth` API provides reth-specific methods like balance changes and chain notifications. | No |
| `ots` | The `ots` API provides Otterscan-compatible methods for block exploration. | No |
| `flashbots` | The `flashbots` API provides block submission validation methods for builders. | No |
| `miner` | The `miner` API allows you to configure miner/builder settings like extra data and gas limits. | **Yes** |
| `mev` | The `mev` API provides MEV bundle submission and simulation methods. | No |
| `testing` | The `testing` API provides methods for building blocks in a single call (testing only). | **Yes** |
Note that some APIs are sensitive, since they can be used to configure your node (`admin`), or access accounts stored on the node (`eth`). Note that some APIs are sensitive, since they can be used to configure your node (`admin`, `miner`), access accounts stored on the node (`eth`), or perform testing operations (`testing`).
Generally, it is advisable to not expose any JSONRPC namespace publicly, unless you know what you are doing. Generally, it is advisable to not expose any JSONRPC namespace publicly, unless you know what you are doing.
@@ -61,7 +67,7 @@ To enable JSON-RPC namespaces on the HTTP server, pass each namespace separated
reth node --http --http.api eth,net,trace reth node --http --http.api eth,net,trace
``` ```
You can pass the `all` option, which is a convenient wrapper for all the JSON-RPC namespaces `admin,debug,eth,net,trace,txpool,web3,rpc` on the HTTP server: You can pass the `all` option, which is a convenient wrapper for all the JSON-RPC namespaces `admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev,testing` on the HTTP server:
```bash ```bash
reth node --http --http.api all reth node --http --http.api all
@@ -117,7 +123,7 @@ You can use `curl`, a programming language with a low-level library, or a tool l
As a reminder, you need to run the command below to enable all of these APIs using an HTTP transport: As a reminder, you need to run the command below to enable all of these APIs using an HTTP transport:
```bash ```bash
reth node --http --http.api "admin,debug,eth,net,trace,txpool,web3,rpc" reth node --http --http.api "admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev,testing"
``` ```
This allows you to then call: This allows you to then call: