Skip to content

Commit

Permalink
Fix help stdout fixtures
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitrylavrenov committed Oct 28, 2024
1 parent ef07075 commit e2fa728
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 74 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasm-instantiation-strategy <STRATEGY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,54 +30,35 @@ Options:
--rpc-methods <METHOD SET>
RPC methods to expose.

- `unsafe`: Exposes every RPC method.
- `safe`: Exposes only a safe subset of RPC methods, denying unsafe RPC methods.
- `auto`: Acts as `safe` if RPC is served externally, e.g. when `--{rpc,ws}-external` is
passed, otherwise acts as `unsafe`.

[default: auto]

Possible values:
- auto: Expose every RPC method only when RPC is listening on `localhost`, otherwise serve only safe RPC methods
- safe: Allow only a safe subset of RPC methods
- unsafe: Expose every RPC method (even potentially unsafe ones)

--ws-external
Listen to all Websocket interfaces.

Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy server to filter out dangerous methods. More details: <https://docs.substrate.io/main-docs/build/custom-rpc/#public-rpcs>. Use `--unsafe-ws-external` to suppress the warning if you understand the risks.

--unsafe-ws-external
Listen to all Websocket interfaces.

Same as `--ws-external` but doesn't warn you about it.

--rpc-max-payload <RPC_MAX_PAYLOAD>
DEPRECATED, this has no affect anymore. Use `rpc_max_request_size` or `rpc_max_response_size` instead

--rpc-max-request-size <RPC_MAX_REQUEST_SIZE>
Set the the maximum RPC request payload size for both HTTP and WS in megabytes. Default is 15MiB
Set the maximum RPC request payload size for both HTTP and WS in megabytes

[default: 15]

--rpc-max-response-size <RPC_MAX_RESPONSE_SIZE>
Set the the maximum RPC response payload size for both HTTP and WS in megabytes. Default is 15MiB
Set the maximum RPC response payload size for both HTTP and WS in megabytes

[default: 15]

--rpc-max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION>
Set the the maximum concurrent subscriptions per connection. Default is 1024

--ipc-path <PATH>
DEPRECATED, IPC support has been removed
Set the maximum concurrent subscriptions per connection

[default: 1024]

--rpc-port <PORT>
Specify HTTP RPC server TCP port

--ws-port <PORT>
Specify WebSockets RPC server TCP port
Specify JSON-RPC server TCP port

--ws-max-connections <COUNT>
Maximum number of WS RPC server connections

--ws-max-out-buffer-capacity <WS_MAX_OUT_BUFFER_CAPACITY>
DEPRECATED, this has no affect anymore. Use `rpc_max_response_size` instead
--rpc-max-connections <COUNT>
Maximum number of RPC server connections

[default: 100]

--rpc-cors <ORIGINS>
Specify browser *origins* allowed to access the HTTP and WS RPC servers.
Expand Down Expand Up @@ -228,7 +209,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down
12 changes: 12 additions & 0 deletions utils/e2e-tests/bash/fixtures/help-output/help.revert.stdout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ Options:

[default: archive-canonical]

--database <DB>
Select database backend to use

Possible values:
- rocksdb: Facebooks RocksDB
- paritydb: ParityDb. <https://github.com/paritytech/parity-db/>
- auto: Detect whether there is an existing database. Use it, if there is, if not, create new instance of ParityDb
- paritydb-experimental: ParityDb. <https://github.com/paritytech/parity-db/>

--db-cache <MiB>
Limit the memory the database cache can use

-h, --help
Print help (see a summary with '-h')

Expand Down
49 changes: 15 additions & 34 deletions utils/e2e-tests/bash/fixtures/help-output/help.stdout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,54 +48,35 @@ Options:
--rpc-methods <METHOD SET>
RPC methods to expose.

- `unsafe`: Exposes every RPC method.
- `safe`: Exposes only a safe subset of RPC methods, denying unsafe RPC methods.
- `auto`: Acts as `safe` if RPC is served externally, e.g. when `--{rpc,ws}-external` is
passed, otherwise acts as `unsafe`.

[default: auto]

Possible values:
- auto: Expose every RPC method only when RPC is listening on `localhost`, otherwise serve only safe RPC methods
- safe: Allow only a safe subset of RPC methods
- unsafe: Expose every RPC method (even potentially unsafe ones)

--ws-external
Listen to all Websocket interfaces.

Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy server to filter out dangerous methods. More details: <https://docs.substrate.io/main-docs/build/custom-rpc/#public-rpcs>. Use `--unsafe-ws-external` to suppress the warning if you understand the risks.

--unsafe-ws-external
Listen to all Websocket interfaces.

Same as `--ws-external` but doesn't warn you about it.

--rpc-max-payload <RPC_MAX_PAYLOAD>
DEPRECATED, this has no affect anymore. Use `rpc_max_request_size` or `rpc_max_response_size` instead

--rpc-max-request-size <RPC_MAX_REQUEST_SIZE>
Set the the maximum RPC request payload size for both HTTP and WS in megabytes. Default is 15MiB
Set the maximum RPC request payload size for both HTTP and WS in megabytes

[default: 15]

--rpc-max-response-size <RPC_MAX_RESPONSE_SIZE>
Set the the maximum RPC response payload size for both HTTP and WS in megabytes. Default is 15MiB
Set the maximum RPC response payload size for both HTTP and WS in megabytes

[default: 15]

--rpc-max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION>
Set the the maximum concurrent subscriptions per connection. Default is 1024

--ipc-path <PATH>
DEPRECATED, IPC support has been removed
Set the maximum concurrent subscriptions per connection

[default: 1024]

--rpc-port <PORT>
Specify HTTP RPC server TCP port

--ws-port <PORT>
Specify WebSockets RPC server TCP port
Specify JSON-RPC server TCP port

--ws-max-connections <COUNT>
Maximum number of WS RPC server connections

--ws-max-out-buffer-capacity <WS_MAX_OUT_BUFFER_CAPACITY>
DEPRECATED, this has no affect anymore. Use `rpc_max_response_size` instead
--rpc-max-connections <COUNT>
Maximum number of RPC server connections

[default: 100]

--rpc-cors <ORIGINS>
Specify browser *origins* allowed to access the HTTP and WS RPC servers.
Expand Down Expand Up @@ -246,7 +227,7 @@ Options:
[default: compiled]

Possible values:
- interpreted-i-know-what-i-do: Uses an interpreter
- interpreted-i-know-what-i-do: Uses an interpreter which now is deprecated
- compiled: Uses a compiled runtime

--wasmtime-instantiation-strategy <STRATEGY>
Expand Down

0 comments on commit e2fa728

Please sign in to comment.