From 336379518150ad69e1fb0670c2a14e8b3bd96c7c Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Mon, 3 Feb 2025 23:04:52 -0800 Subject: [PATCH 1/4] Document truststore options Signed-off-by: Alexandra Tran --- docs/public-networks/reference/cli/options.md | 82 ++++++++++++++++++- 1 file changed, 81 insertions(+), 1 deletion(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index b14f547d88..4de9493657 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -4194,7 +4194,7 @@ rpc-http-tls-keystore-file="/home/me/me_node/keystore.pfx" -The Keystore file (in PKCS #12 format) that contains private key and the certificate presented to the client during authentication. +The keystore file (in PKCS #12 format) that contains private key and the certificate presented to the client during authentication. ### `rpc-http-tls-keystore-password-file` @@ -4330,6 +4330,86 @@ The singular `--rpc-http-tls-protocol` and plural `--rpc-http-tls-protocols` are ::: +### `rpc-http-tls-truststore-file` + + + + + +```bash +--rpc-http-tls-truststore-file= +``` + + + + + +```bash +--rpc-http-tls-truststore-file=/home/me/me_node/truststore.pfx +``` + + + + + +```bash +BESU_RPC_HTTP_TLS_TRUSTSTORE_FILE=/home/me/me_node/truststore.pfx +``` + + + + + +```bash +rpc-http-tls-truststore-file="/home/me/me_node/truststore.pfx" +``` + + + + + +The path to the truststore file used for authentication. + +### `rpc-http-tls-truststore-password-file` + + + + + +```bash +--rpc-http-tls-truststore-password-file= +``` + + + + + +```bash +--rpc-http-tls-truststore-password-file=/home/me/me_node/password +``` + + + + + +```bash +BESU_RPC_HTTP_TLS_TRUSTSTORE_PASSWORD_FILE=/home/me/me_node/password +``` + + + + + +```bash +rpc-http-tls-truststore-password-file="/home/me/me_node/password" +``` + + + + + +The path to the file containing the password to decrypt the truststore. + ### `rpc-max-logs-range` From 9fce7700b51ffb69bce3393a52aed64758d1e9d4 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Tue, 4 Feb 2025 13:07:55 -0800 Subject: [PATCH 2/4] add more context to descriptions Signed-off-by: Alexandra Tran --- docs/public-networks/reference/cli/options.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 4de9493657..5943a31029 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -4194,7 +4194,10 @@ rpc-http-tls-keystore-file="/home/me/me_node/keystore.pfx" -The keystore file (in PKCS #12 format) that contains private key and the certificate presented to the client during authentication. +Path to the keystore file (in PKCS #12 format) when enabling TLS for the JSON-RPC HTTP service. +The keystore file contains the private key and certificate presented to the client during authentication. + +Specify the keystore password file using [`--rpc-http-tls-keystore-password-file`](#rpc-http-tls-keystore-password-file). ### `rpc-http-tls-keystore-password-file` @@ -4234,7 +4237,8 @@ rpc-http-tls-keystore-password-file="/home/me/me_node/password" -The path to the file containing the password to decrypt the keystore. +Path to the file containing the password for the keystore specified in [`--rpc-http-tls-keystore-file`](#rpc-http-tls-keystore-file), +when enabling TLS for the JSON-RPC HTTP service. ### `rpc-http-tls-known-clients-file` @@ -4274,7 +4278,7 @@ rpc-http-tls-known-clients-file="/home/me/me_node/knownClients" -The path to the file used to [authenticate clients](../../../private-networks/how-to/configure/tls/client-and-server.md#create-the-known-clients-file) using self-signed certificates or non-public certificates. +Path to the file used to [authenticate clients](../../../private-networks/how-to/configure/tls/client-and-server.md#create-the-known-clients-file) using self-signed certificates or non-public certificates. Must contain the certificate's Common Name, and SHA-256 fingerprint in the format ` `. @@ -4368,7 +4372,9 @@ rpc-http-tls-truststore-file="/home/me/me_node/truststore.pfx" -The path to the truststore file used for authentication. +Path to the truststore file when enabling TLS for the JSON-RPC HTTP service. + +Specify the truststore password file using [`--rpc-http-tls-truststore-password-file`](#rpc-http-tls-truststore-password-file). ### `rpc-http-tls-truststore-password-file` @@ -4408,7 +4414,8 @@ rpc-http-tls-truststore-password-file="/home/me/me_node/password" -The path to the file containing the password to decrypt the truststore. +Path to the file containing the password for the truststore specified in [`--rpc-http-tls-truststore-file`](#rpc-http-tls-truststore-file), +when enabling TLS for the JSON-RPC HTTP service. ### `rpc-max-logs-range` From d00ff32a3f85fd8d2e45a0283058745c70ebfd85 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Wed, 19 Feb 2025 11:07:49 -0800 Subject: [PATCH 3/4] Update debug_traceBlock* docs Signed-off-by: Alexandra Tran --- docs/public-networks/reference/api/index.md | 23 ++++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index a1f08d609d..a84d9f4ca6 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -1763,13 +1763,16 @@ Returns full trace of all invoked opcodes of all transactions included in the bl - `block`: _string_ - RLP of the block -- `options`: _object_ - request options object with the following fields (all optional and default to `false`): +- `options`: _object_ - (optional) request options object with the following fields: - `disableStorage`: _boolean_ - `true` disables storage capture. + The default is `false`. - `disableMemory`: _boolean_ - `true` disables memory capture. + The default is `true`. - `disableStack` : _boolean_ - `true` disables stack capture. + The default is `false`. #### Returns @@ -1817,9 +1820,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"debug_traceBlock","params":["0xf "gas": 0, "gasCost": 0, "depth": 1, - "stack": [], - "memory": [], - "storage": null + "stack": [] } ] } @@ -1838,13 +1839,16 @@ Returns full trace of all invoked opcodes of all transactions included in the bl - `blockHash`: _string_ - block hash -- `options`: _object_ - request options object with the following fields (all optional and default to `false`): +- `options`: _object_ - (optional) request options object with the following fields: - `disableStorage`: _boolean_ - `true` disables storage capture. + The default is `false`. - `disableMemory`: _boolean_ - `true` disables memory capture. + The default is `true`. - `disableStack` : _boolean_ - `true` disables stack capture. + The default is `false`. #### Returns @@ -1894,8 +1898,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"debug_traceBlockByHash","params" "gasCost": 0, "depth": 1, "stack": [], - "memory": [], - "storage": {}, "reason": null } ] @@ -1922,13 +1924,16 @@ Returns full trace of all invoked opcodes of all transactions included in the bl `pending` returns the same value as `latest`. ::: -- `options`: _object_ - request options object with the following fields (all optional and default to `false`): +- `options`: _object_ - (optional) request options object with the following fields: - `disableStorage`: _boolean_ - `true` disables storage capture. + The default is `false`. - `disableMemory`: _boolean_ - `true` disables memory capture. + The default is `true`. - `disableStack` : _boolean_ - `true` disables stack capture. + The default is `false`. #### Returns @@ -1976,8 +1981,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"debug_traceBlockByNumber","param "gasCost": 0, "depth": 1, "stack": [], - "memory": [], - "storage": null, "reason": null } ] From ef76dff375d52d60f09fd3555b149f45313d9fcf Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Thu, 20 Feb 2025 09:58:33 -0800 Subject: [PATCH 4/4] remove null reason Signed-off-by: Alexandra Tran --- docs/public-networks/reference/api/index.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index a84d9f4ca6..6277ecfb49 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -1897,8 +1897,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"debug_traceBlockByHash","params" "gas": 0, "gasCost": 0, "depth": 1, - "stack": [], - "reason": null + "stack": [] } ] } @@ -1980,8 +1979,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"debug_traceBlockByNumber","param "gas": 0, "gasCost": 0, "depth": 1, - "stack": [], - "reason": null + "stack": [] } ] }