Skip to content

Commit 10cf3f7

Browse files
bomanapsbomanaps
committed
Update JSON-RPC docs and sidebar generation script
1 parent bf87eae commit 10cf3f7

File tree

6 files changed

+131
-67
lines changed

6 files changed

+131
-67
lines changed

‎docs/reference/json-rpc/debug-namespace.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ sidebar_position: 1
66

77
This page lists all JSON-RPC methods in the debug namespace.
88

9-
- [debug_getBadBlocks](/reference/debug_getBadBlocks)
10-
- [debug_getRawBlock](/reference/debug_getRawBlock)
11-
- [debug_getRawHeader](/reference/debug_getRawHeader)
12-
- [debug_getRawReceipts](/reference/debug_getRawReceipts)
13-
- [debug_getRawTransaction](/reference/debug_getRawTransaction)
9+
- [debug_getBadBlocks](/docs/reference/debug_getBadBlocks)
10+
- [debug_getRawBlock](/docs/reference/debug_getRawBlock)
11+
- [debug_getRawHeader](/docs/reference/debug_getRawHeader)
12+
- [debug_getRawReceipts](/docs/reference/debug_getRawReceipts)
13+
- [debug_getRawTransaction](/docs/reference/debug_getRawTransaction)

‎docs/reference/json-rpc/engine-namespace.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ sidebar_position: 1
66

77
This page lists all JSON-RPC methods in the engine namespace.
88

9-
- [engine_exchangeCapabilities](/reference/engine_exchangeCapabilities)
10-
- [engine_exchangeTransitionConfigurationV1](/reference/engine_exchangeTransitionConfigurationV1)
11-
- [engine_forkchoiceUpdatedV1](/reference/engine_forkchoiceUpdatedV1)
12-
- [engine_forkchoiceUpdatedV2](/reference/engine_forkchoiceUpdatedV2)
13-
- [engine_forkchoiceUpdatedV3](/reference/engine_forkchoiceUpdatedV3)
14-
- [engine_getBlobsV1](/reference/engine_getBlobsV1)
15-
- [engine_getBlobsV2](/reference/engine_getBlobsV2)
16-
- [engine_getPayloadBodiesByHashV1](/reference/engine_getPayloadBodiesByHashV1)
17-
- [engine_getPayloadBodiesByRangeV1](/reference/engine_getPayloadBodiesByRangeV1)
18-
- [engine_getPayloadV1](/reference/engine_getPayloadV1)
19-
- [engine_getPayloadV2](/reference/engine_getPayloadV2)
20-
- [engine_getPayloadV3](/reference/engine_getPayloadV3)
21-
- [engine_getPayloadV4](/reference/engine_getPayloadV4)
22-
- [engine_getPayloadV5](/reference/engine_getPayloadV5)
23-
- [engine_newPayloadV1](/reference/engine_newPayloadV1)
24-
- [engine_newPayloadV2](/reference/engine_newPayloadV2)
25-
- [engine_newPayloadV3](/reference/engine_newPayloadV3)
26-
- [engine_newPayloadV4](/reference/engine_newPayloadV4)
9+
- [engine_exchangeCapabilities](/docs/reference/engine_exchangeCapabilities)
10+
- [engine_exchangeTransitionConfigurationV1](/docs/reference/engine_exchangeTransitionConfigurationV1)
11+
- [engine_forkchoiceUpdatedV1](/docs/reference/engine_forkchoiceUpdatedV1)
12+
- [engine_forkchoiceUpdatedV2](/docs/reference/engine_forkchoiceUpdatedV2)
13+
- [engine_forkchoiceUpdatedV3](/docs/reference/engine_forkchoiceUpdatedV3)
14+
- [engine_getBlobsV1](/docs/reference/engine_getBlobsV1)
15+
- [engine_getBlobsV2](/docs/reference/engine_getBlobsV2)
16+
- [engine_getPayloadBodiesByHashV1](/docs/reference/engine_getPayloadBodiesByHashV1)
17+
- [engine_getPayloadBodiesByRangeV1](/docs/reference/engine_getPayloadBodiesByRangeV1)
18+
- [engine_getPayloadV1](/docs/reference/engine_getPayloadV1)
19+
- [engine_getPayloadV2](/docs/reference/engine_getPayloadV2)
20+
- [engine_getPayloadV3](/docs/reference/engine_getPayloadV3)
21+
- [engine_getPayloadV4](/docs/reference/engine_getPayloadV4)
22+
- [engine_getPayloadV5](/docs/reference/engine_getPayloadV5)
23+
- [engine_newPayloadV1](/docs/reference/engine_newPayloadV1)
24+
- [engine_newPayloadV2](/docs/reference/engine_newPayloadV2)
25+
- [engine_newPayloadV3](/docs/reference/engine_newPayloadV3)
26+
- [engine_newPayloadV4](/docs/reference/engine_newPayloadV4)

‎docs/reference/json-rpc/eth-namespace.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,42 @@ sidebar_position: 1
66

77
This page lists all JSON-RPC methods in the eth namespace.
88

9-
- [eth_accounts](/reference/eth_accounts)
10-
- [eth_blobBaseFee](/reference/eth_blobBaseFee)
11-
- [eth_blockNumber](/reference/eth_blockNumber)
12-
- [eth_call](/reference/eth_call)
13-
- [eth_chainId](/reference/eth_chainId)
14-
- [eth_coinbase](/reference/eth_coinbase)
15-
- [eth_createAccessList](/reference/eth_createAccessList)
16-
- [eth_estimateGas](/reference/eth_estimateGas)
17-
- [eth_feeHistory](/reference/eth_feeHistory)
18-
- [eth_gasPrice](/reference/eth_gasPrice)
19-
- [eth_getBalance](/reference/eth_getBalance)
20-
- [eth_getBlockByHash](/reference/eth_getBlockByHash)
21-
- [eth_getBlockByNumber](/reference/eth_getBlockByNumber)
22-
- [eth_getBlockReceipts](/reference/eth_getBlockReceipts)
23-
- [eth_getBlockTransactionCountByHash](/reference/eth_getBlockTransactionCountByHash)
24-
- [eth_getBlockTransactionCountByNumber](/reference/eth_getBlockTransactionCountByNumber)
25-
- [eth_getCode](/reference/eth_getCode)
26-
- [eth_getFilterChanges](/reference/eth_getFilterChanges)
27-
- [eth_getFilterLogs](/reference/eth_getFilterLogs)
28-
- [eth_getLogs](/reference/eth_getLogs)
29-
- [eth_getProof](/reference/eth_getProof)
30-
- [eth_getStorageAt](/reference/eth_getStorageAt)
31-
- [eth_getTransactionByBlockHashAndIndex](/reference/eth_getTransactionByBlockHashAndIndex)
32-
- [eth_getTransactionByBlockNumberAndIndex](/reference/eth_getTransactionByBlockNumberAndIndex)
33-
- [eth_getTransactionByHash](/reference/eth_getTransactionByHash)
34-
- [eth_getTransactionCount](/reference/eth_getTransactionCount)
35-
- [eth_getTransactionReceipt](/reference/eth_getTransactionReceipt)
36-
- [eth_getUncleCountByBlockHash](/reference/eth_getUncleCountByBlockHash)
37-
- [eth_getUncleCountByBlockNumber](/reference/eth_getUncleCountByBlockNumber)
38-
- [eth_maxPriorityFeePerGas](/reference/eth_maxPriorityFeePerGas)
39-
- [eth_newBlockFilter](/reference/eth_newBlockFilter)
40-
- [eth_newFilter](/reference/eth_newFilter)
41-
- [eth_newPendingTransactionFilter](/reference/eth_newPendingTransactionFilter)
42-
- [eth_sendRawTransaction](/reference/eth_sendRawTransaction)
43-
- [eth_sendTransaction](/reference/eth_sendTransaction)
44-
- [eth_sign](/reference/eth_sign)
45-
- [eth_signTransaction](/reference/eth_signTransaction)
46-
- [eth_syncing](/reference/eth_syncing)
47-
- [eth_uninstallFilter](/reference/eth_uninstallFilter)
9+
- [eth_accounts](/docs/reference/eth_accounts)
10+
- [eth_blobBaseFee](/docs/reference/eth_blobBaseFee)
11+
- [eth_blockNumber](/docs/reference/eth_blockNumber)
12+
- [eth_call](/docs/reference/eth_call)
13+
- [eth_chainId](/docs/reference/eth_chainId)
14+
- [eth_coinbase](/docs/reference/eth_coinbase)
15+
- [eth_createAccessList](/docs/reference/eth_createAccessList)
16+
- [eth_estimateGas](/docs/reference/eth_estimateGas)
17+
- [eth_feeHistory](/docs/reference/eth_feeHistory)
18+
- [eth_gasPrice](/docs/reference/eth_gasPrice)
19+
- [eth_getBalance](/docs/reference/eth_getBalance)
20+
- [eth_getBlockByHash](/docs/reference/eth_getBlockByHash)
21+
- [eth_getBlockByNumber](/docs/reference/eth_getBlockByNumber)
22+
- [eth_getBlockReceipts](/docs/reference/eth_getBlockReceipts)
23+
- [eth_getBlockTransactionCountByHash](/docs/reference/eth_getBlockTransactionCountByHash)
24+
- [eth_getBlockTransactionCountByNumber](/docs/reference/eth_getBlockTransactionCountByNumber)
25+
- [eth_getCode](/docs/reference/eth_getCode)
26+
- [eth_getFilterChanges](/docs/reference/eth_getFilterChanges)
27+
- [eth_getFilterLogs](/docs/reference/eth_getFilterLogs)
28+
- [eth_getLogs](/docs/reference/eth_getLogs)
29+
- [eth_getProof](/docs/reference/eth_getProof)
30+
- [eth_getStorageAt](/docs/reference/eth_getStorageAt)
31+
- [eth_getTransactionByBlockHashAndIndex](/docs/reference/eth_getTransactionByBlockHashAndIndex)
32+
- [eth_getTransactionByBlockNumberAndIndex](/docs/reference/eth_getTransactionByBlockNumberAndIndex)
33+
- [eth_getTransactionByHash](/docs/reference/eth_getTransactionByHash)
34+
- [eth_getTransactionCount](/docs/reference/eth_getTransactionCount)
35+
- [eth_getTransactionReceipt](/docs/reference/eth_getTransactionReceipt)
36+
- [eth_getUncleCountByBlockHash](/docs/reference/eth_getUncleCountByBlockHash)
37+
- [eth_getUncleCountByBlockNumber](/docs/reference/eth_getUncleCountByBlockNumber)
38+
- [eth_maxPriorityFeePerGas](/docs/reference/eth_maxPriorityFeePerGas)
39+
- [eth_newBlockFilter](/docs/reference/eth_newBlockFilter)
40+
- [eth_newFilter](/docs/reference/eth_newFilter)
41+
- [eth_newPendingTransactionFilter](/docs/reference/eth_newPendingTransactionFilter)
42+
- [eth_sendRawTransaction](/docs/reference/eth_sendRawTransaction)
43+
- [eth_sendTransaction](/docs/reference/eth_sendTransaction)
44+
- [eth_sign](/docs/reference/eth_sign)
45+
- [eth_signTransaction](/docs/reference/eth_signTransaction)
46+
- [eth_syncing](/docs/reference/eth_syncing)
47+
- [eth_uninstallFilter](/docs/reference/eth_uninstallFilter)

‎docs/reference/json-rpc/introduction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ sidebar_position: 1
66

77
The Ethereum JSON-RPC API is organized into several namespaces, each containing related methods:
88

9-
- [Debug Namespace](/reference/json-rpc/debug-namespace)
10-
- [Engine Namespace](/reference/json-rpc/engine-namespace)
11-
- [Eth Namespace](/reference/json-rpc/eth-namespace)
9+
- [Debug Namespace](/docs/reference/json-rpc/debug-namespace)
10+
- [Engine Namespace](/docs/reference/json-rpc/engine-namespace)
11+
- [Eth Namespace](/docs/reference/json-rpc/eth-namespace)
1212

1313
Each namespace contains methods with specific functionality related to different aspects of Ethereum node operation.

‎method-namespaces.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"eth_getBlockByHash": "eth",
3+
"eth_getBlockByNumber": "eth",
4+
"eth_getBlockTransactionCountByHash": "eth",
5+
"eth_getBlockTransactionCountByNumber": "eth",
6+
"eth_getUncleCountByBlockHash": "eth",
7+
"eth_getUncleCountByBlockNumber": "eth",
8+
"eth_getBlockReceipts": "eth",
9+
"eth_chainId": "eth",
10+
"eth_syncing": "eth",
11+
"eth_coinbase": "eth",
12+
"eth_accounts": "eth",
13+
"eth_blockNumber": "eth",
14+
"eth_call": "eth",
15+
"eth_estimateGas": "eth",
16+
"eth_createAccessList": "eth",
17+
"eth_gasPrice": "eth",
18+
"eth_blobBaseFee": "eth",
19+
"eth_maxPriorityFeePerGas": "eth",
20+
"eth_feeHistory": "eth",
21+
"eth_newFilter": "eth",
22+
"eth_newBlockFilter": "eth",
23+
"eth_newPendingTransactionFilter": "eth",
24+
"eth_uninstallFilter": "eth",
25+
"eth_getFilterChanges": "eth",
26+
"eth_getFilterLogs": "eth",
27+
"eth_getLogs": "eth",
28+
"eth_sign": "eth",
29+
"eth_signTransaction": "eth",
30+
"eth_getBalance": "eth",
31+
"eth_getStorageAt": "eth",
32+
"eth_getTransactionCount": "eth",
33+
"eth_getCode": "eth",
34+
"eth_getProof": "eth",
35+
"eth_sendTransaction": "eth",
36+
"eth_sendRawTransaction": "eth",
37+
"eth_getTransactionByHash": "eth",
38+
"eth_getTransactionByBlockHashAndIndex": "eth",
39+
"eth_getTransactionByBlockNumberAndIndex": "eth",
40+
"eth_getTransactionReceipt": "eth",
41+
"debug_getRawHeader": "debug",
42+
"debug_getRawBlock": "debug",
43+
"debug_getRawTransaction": "debug",
44+
"debug_getRawReceipts": "debug",
45+
"debug_getBadBlocks": "debug",
46+
"engine_getBlobsV1": "engine",
47+
"engine_getBlobsV2": "engine",
48+
"engine_exchangeCapabilities": "engine",
49+
"engine_forkchoiceUpdatedV1": "engine",
50+
"engine_forkchoiceUpdatedV2": "engine",
51+
"engine_forkchoiceUpdatedV3": "engine",
52+
"engine_newPayloadV1": "engine",
53+
"engine_newPayloadV2": "engine",
54+
"engine_newPayloadV3": "engine",
55+
"engine_newPayloadV4": "engine",
56+
"engine_getPayloadV1": "engine",
57+
"engine_getPayloadV2": "engine",
58+
"engine_getPayloadV3": "engine",
59+
"engine_getPayloadV4": "engine",
60+
"engine_getPayloadV5": "engine",
61+
"engine_getPayloadBodiesByHashV1": "engine",
62+
"engine_getPayloadBodiesByRangeV1": "engine",
63+
"engine_exchangeTransitionConfigurationV1": "engine"
64+
}

‎scripts/generateNamespacedSidebars.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ sidebar_position: 1
6868
6969
This page lists all JSON-RPC methods in the ${title.toLowerCase()}.
7070
71-
${sortedMethods.map(method => `- [${method}](/reference/${method})`).join('\n')}
71+
${sortedMethods.map(method => `- [${method}](/docs/reference/${method})`).join('\n')}
7272
`;
7373
}
7474

@@ -84,7 +84,7 @@ sidebar_position: 1
8484
8585
The Ethereum JSON-RPC API is organized into several namespaces, each containing related methods:
8686
87-
${namespaces.map(namespace => `- [${namespace.charAt(0).toUpperCase() + namespace.slice(1)} Namespace](/reference/json-rpc/${namespace}-namespace)`).join('\n')}
87+
${namespaces.map(namespace => `- [${namespace.charAt(0).toUpperCase() + namespace.slice(1)} Namespace](/docs/reference/json-rpc/${namespace}-namespace)`).join('\n')}
8888
8989
Each namespace contains methods with specific functionality related to different aspects of Ethereum node operation.
9090
`;

0 commit comments

Comments
 (0)