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

grpc: leverage FieldMasks for partial responses and other proto tweaks #21182

Merged
merged 3 commits into from
Feb 13, 2025

Conversation

bmwill
Copy link
Contributor

@bmwill bmwill commented Feb 11, 2025

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):
  • gRPC:
  • Update the SignatureScheme message enum to match the values as expected with its BCS serialized form.
  • Flatten a number of message types that wrapped repeated fields to reduce complexity
  • Introduce google.protobuf.FieldMask read_mask parameters to most endpoints, support for old custom "options" types will be removed on the next release. Instead of defining custom "options" types for each endpoint to control the amount of data being returned, leverage the standard google.protobuf.FieldMask type and inspiration from https://google.aip.dev/157 in order to provide users fine-grained control over what fields are returned.
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:

Copy link

vercel bot commented Feb 11, 2025

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 Feb 12, 2025 6:21pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Feb 12, 2025 6:21pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Feb 12, 2025 6:21pm

@bmwill bmwill temporarily deployed to sui-typescript-aws-kms-test-env February 11, 2025 21:10 — with GitHub Actions Inactive
@bmwill bmwill temporarily deployed to sui-typescript-aws-kms-test-env February 12, 2025 15:22 — with GitHub Actions Inactive
@bmwill bmwill temporarily deployed to sui-typescript-aws-kms-test-env February 12, 2025 15:27 — with GitHub Actions Inactive
@bmwill bmwill requested review from amnn and phoenix-o February 12, 2025 15:30
@bmwill bmwill marked this pull request as ready for review February 12, 2025 15:30
@bmwill bmwill temporarily deployed to sui-typescript-aws-kms-test-env February 12, 2025 15:31 — with GitHub Actions Inactive
@bmwill bmwill changed the title grpc: changes to proto definitions grpc: leverage FieldMasks for partial responses and other proto tweaks Feb 12, 2025
Instead of defining custom "options" types for each endpoint to control
the amount of data being returned, leverage the standard
google.protobuf.FieldMask type and inspiration from
https://google.aip.dev/157 in order to provide users fine-grained
control over what fields are returned.

Initially the provided field masks will support parity with the existing
options and in the future provided field masks may support more
fine-grained control over nested fields.
@bmwill bmwill temporarily deployed to sui-typescript-aws-kms-test-env February 12, 2025 18:20 — with GitHub Actions Inactive
@bmwill bmwill merged commit 52756b4 into MystenLabs:main Feb 13, 2025
43 checks passed
@bmwill bmwill deleted the grpc-proto-tweaks branch February 13, 2025 00:20
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.

2 participants