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

rest: introduce protobuf as an acceptable content type #20040

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

bmwill
Copy link
Contributor

@bmwill bmwill commented Oct 25, 2024

Given the BCS format is inherently un-evolvable (unless you utilize enums) it makes a poor wire format as any changes made lead to incompatibilities with existing clients.

Today the REST api uses JSON as the default, and human-readable, format and BCS for the binary one. This PR introduces Protobuf as another possible format type and converts the list_checkpoints api to support requesting a page of checkpoints in a protobuf format. The plan is to introduce support for protobuf to other apis and to phase out bcs in most places.

Description

Describe the changes or additions included in this PR.

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:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

Copy link

vercel bot commented Oct 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 26, 2024 1:00am
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Oct 26, 2024 1:00am
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Oct 26, 2024 1:00am
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Oct 26, 2024 1:00am

Given the BCS format is inherently un-evolvable (unless you utilize
enums) it makes a poor wire format as any changes made lead to
incompatibilities with existing clients.

Today the REST api uses JSON as the default, and human-readable, format
and BCS for the binary one. This PR introduces Protobuf as another
possible format type and converts the `list_checkpoints` api to support
requesting a page of checkpoints in a protobuf format. The plan is to
introduce support for protobuf to other apis and to phase out bcs in
most places.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant