-
Notifications
You must be signed in to change notification settings - Fork 11.1k
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
config: allow configuring jsonrpc server type #18099
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@bmwill is attempting to deploy a commit to the Mysten Labs Team on Vercel. A member of the Team first needs to authorize it. |
Allow for configuring the jsonrpc server type as well as setting the default to be an HTTP only based service.
|
## Description When merging a PR, we can either use `squashed` or `rebase`. Before, our release note script supports `squashed` commit only, this change will add support to `rebase` PR as well. The downside of this is it might take a bit longer to run given that we'll need to send a HTTP request to Github API if it's not a squashed commit. But given this script won't be run more than once a week, it's a good tradeoff. ## Test plan `GITHUB_TOKEN=<my_PAT> python ./scripts/release_notes.py generate 9e2be6a 1428c71` (all the release notes from `releases/sui-v1.27.0-release` to `releases/sui-v1.28.0-release` branch) now shows @bmwill 's #18099 --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK:
## Description When merging a PR, we can either use `squashed` or `rebase`. Before, our release note script supports `squashed` commit only, this change will add support to `rebase` PR as well. The downside of this is it might take a bit longer to run given that we'll need to send a HTTP request to Github API if it's not a squashed commit. But given this script won't be run more than once a week, it's a good tradeoff. ## Test plan `GITHUB_TOKEN=<my_PAT> python ./scripts/release_notes.py generate 9e2be6a 1428c71` (all the release notes from `releases/sui-v1.27.0-release` to `releases/sui-v1.28.0-release` branch) now shows @bmwill 's MystenLabs#18099 --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK:
Description
config: allow configuring jsonrpc server type
Allow for configuring the jsonrpc server type as well as setting the default to be an HTTP only based service.
Enable configuring the jsonrpc server type via the
jsonrpc-server-type
field in the node config as follows:Test plan
How did you test the new or updated feature?
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.
Protocol:
Nodes (Validators and Full nodes):
Indexer:
JSON-RPC:
Enable configuring the jsonrpc server type via the
jsonrpc-server-type
field in the node config as follows:'websocket' for a websocket based service (deprecated)
'http' for an http based service
'both' for both a websocket and http based service (deprecated)
The default is 'http' if not specified.
This also formally deprecates the websocket jsonrpc service which will be removed completely within another few releases. For now users can opt back in to enabling this service by setting the
jsonrpc-server-type
config. We have found that this service is overall unreliable and leads to production issues/missing data or events when used and as such have decided to sunset it.Deprecate the websocket-based jsonrpc service