Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RPC cli flags #1570

Closed
Tracked by #1595
kamilsa opened this issue Apr 17, 2023 · 0 comments
Closed
Tracked by #1595

RPC cli flags #1570

kamilsa opened this issue Apr 17, 2023 · 0 comments
Assignees
Labels

Comments

@kamilsa
Copy link
Contributor

kamilsa commented Apr 17, 2023

Add the following flags:

      --rpc-external
          Listen to all RPC 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-rpc-external` to suppress the warning if you understand the risks.

      --unsafe-rpc-external
          Listen to all RPC interfaces.

          Same as `--rpc-external`.

      --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.

Unsafe methods could be found here. Correct behaviour for unsafe methods, when they are prohibited is to return message that method is unsafe

zombienet needed flags:

--rpc-cors all
--unsafe-rpc-external
--rpc-methods unsafe
--unsafe-ws-external
--no-mdns
--prometheus-external

safe methods: search check_if_safe

@kamilsa kamilsa added this to KAGOME Apr 17, 2023
@kamilsa kamilsa converted this from a draft issue Apr 17, 2023
@kamilsa kamilsa added the RPC label Apr 17, 2023
@kamilsa kamilsa added this to the Kusama treasury 1 milestone Apr 17, 2023
@kamilsa kamilsa moved this from Selected for development to Review in progress in KAGOME Apr 20, 2023
@turuslan turuslan closed this as completed May 2, 2023
@github-project-automation github-project-automation bot moved this from Review in progress to Done in KAGOME May 2, 2023
@kamilsa kamilsa mentioned this issue May 4, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants