[docs-agent] Add 5 missing Sui gRPC method reference pages - #1580
Merged
oskarciupider-alchemy merged 1 commit intoAug 31, 2026
Conversation
Adds per-method reference documentation for the 5 sui.rpc.v2 methods already
reachable on sui-mainnet.g.alchemy.com:443 but not yet documented:
* LedgerService/ListCheckpoints, ListTransactions, ListEvents
(server-streaming, cursor-bounded via QueryOptions + Watermark + QueryEnd)
* SubscriptionService/SubscribeTransactions, SubscribeEvents
(server-streaming from tip, TransactionFilter/EventFilter)
Also updates the sui-grpc overview page to list the new methods under
LedgerService and SubscriptionService, and broadens the SubscriptionService
intro (previously described as checkpoint-only) plus the streaming bullet on
the "Why Sui gRPC?" section.
Source for all shapes: MystenLabs/sui-apis @ proto/sui/rpc/v2/{ledger_service,
subscription_service,filter,query_options}.proto.
Refs DOCS-210
Requested-by: @oskarciupider-alchemy
🔗 Preview Mode
|
SahilAujla
approved these changes
Aug 31, 2026
oskarciupider-alchemy
deleted the
docs/sui-grpc-list-and-subscribe-methods
branch
August 31, 2026 12:28
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds per-method reference documentation for the 5
sui.rpc.v2methods that already reachsui-mainnet.g.alchemy.com:443but aren't documented today:LedgerService/ListCheckpoints,ListTransactions,ListEvents— server-streaming, cursor-bounded viaQueryOptions+Watermark+QueryEnd.SubscriptionService/SubscribeTransactions,SubscribeEvents— server-streaming from the current tip.Files touched:
content/api-reference/sui-grpc/objects-and-ledger.mdx— 3 newList*sections appended in the existing per-method format (Request table, Response table,grpcurlexample, Note where useful).content/api-reference/sui-grpc/subscriptions.mdx— 2 newSubscribe*sections appended, same shape asSubscribeCheckpoints.content/api-reference/sui-grpc/overview.mdx— 3 new rows in the LedgerService table, 2 new rows in the SubscriptionService table, and the SubscriptionService intro re-worded (previously checkpoint-only) plus the "Streaming support" bullet in the top-of-page pitch broadened.Canonical source for all shapes:
MystenLabs/sui-apis@proto/sui/rpc/v2/{ledger_service,subscription_service,filter,query_options}.proto.Related
Not in scope (natural follow-up)
The 3
LedgerService/List*methods areisStreaming: truein Alchemy'stopconfig.ymlbut are NOT registered undermulti_network_ws.yml grpc_stream_configsforSUI_MAINNET, so they currently bill at the defaultcu_per_byte: 0.04(~200x higher than Yellowstone's $75/TB rate). That's anOMGWINNING/chain-configchange, deliberately deferred per the requester's ordering. Filing separately after this lands.Linear
DOCS-210 - https://linear.app/alchemyapi/issue/DOCS-210/add-5-missing-sui-grpc-method-reference-pages-ledgerservicelist
Requested by
@oskarciupider-alchemy (via Slack thread)