[docs-agent] Split Sui gRPC streaming methods into a bandwidth-priced section - #1518
[docs-agent] Split Sui gRPC streaming methods into a bandwidth-priced section#1518alchemy-bot wants to merge 2 commits into
Conversation
… section
Add a new "Sui: gRPC Streaming Methods" section modeled on the existing "Solana: Yellowstone gRPC" bandwidth section ($75 / 1 TB, pro-rated). Streaming methods (SubscriptionService/{SubscribeCheckpoints,SubscribeTransactions,SubscribeEvents} and LedgerService/{ListCheckpoints,ListTransactions,ListEvents}) are called out inline in the intro sentence.
Also drop sui.rpc.v2.SubscriptionService/SubscribeCheckpoints from the per-method cu:auto "Sui: gRPC Methods" table since it is bandwidth-priced, not per-call. NOTE: that table is Daikon-managed via cu:auto markers and the row will be re-added on the next daily Daikon run unless the method is also reclassified in topconfig.yml upstream (OMGWINNING/chain-config).
Refs DOCS-185
Requested-by: @oskarciupider-alchemy
🔗 Preview Mode
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ca951cb6fd
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| # Sui: gRPC Streaming Methods | ||
|
|
||
| Sui gRPC [streaming methods](/docs/reference/sui-grpc-overview) (`SubscriptionService/SubscribeCheckpoints`, `SubscribeTransactions`, `SubscribeEvents`, and `LedgerService/ListCheckpoints`, `ListTransactions`, `ListEvents`) deliver real-time blockchain data via server-streaming RPCs. Pricing is based on **bandwidth:** the amount of data delivered as part of the stream. |
There was a problem hiding this comment.
This sentence starts advertising and pricing five Sui gRPC methods that the linked Alchemy Sui gRPC overview/API reference does not expose (SubscribeTransactions, SubscribeEvents, ListCheckpoints, ListTransactions, and ListEvents); I checked the Sui gRPC docs in this repo and rg shows those names only in this new pricing line. When customers follow the pricing page to implement one of these bandwidth-priced streams, they have no Alchemy request/response docs or examples, so please either add the corresponding API reference pages/overview entries or limit this pricing section to methods that are actually documented.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Codex's observation is factually correct — the five newly-priced Sui gRPC streaming methods (SubscribeTransactions, SubscribeEvents, ListCheckpoints, ListTransactions, ListEvents) do not have per-method API reference pages under the Sui gRPC section today. SubscribeCheckpoints is the only Sui streaming method with any docs presence, and it was in the cu:auto product="sui-grpc" table strictly because Daikon's topconfig.yml grouped it there for per-method CU tracking (removed in this PR since it's actually bandwidth-priced).
Not applying the fix here because:
- Scope: this PR was tightly scoped to the pricing-page clarification the requester (@oskarciupider-alchemy) asked for. Adding five new per-method API reference pages is a substantially different scope.
- Daikon-managed surface: Sui gRPC per-method pages live under the
cu:auto product="sui-grpc"scope; adding real reference pages requires coordinated changes inOMGWINNING/chain-config(topconfig.yml+chainconfig/) before the docs side can stabilize. That's a separate cross-repo workstream, not a small docs edit. - Precedent: Alchemy's Solana Yellowstone gRPC pricing section on the same page also disclaims bandwidth pricing for the
geyser.Geyser/Subscribestream without linking to a dedicated per-method API reference page — the pricing disclosure and the API reference surface have historically been decoupled here.
The underlying gap (bandwidth-priced streaming methods lack dedicated API reference pages) is worth tracking, but as a follow-up ticket rather than blocking this pricing clarification. Leaving the thread open so a human reviewer can decide whether to spin one off.
…on Compute Unit Costs Move "Solana: Yellowstone gRPC Unary Methods" from the bottom of the page up to sit right after "Solana: Yellowstone gRPC" and before "Solana: WebSocket Subscriptions", so both Yellowstone sections are adjacent. Move "Sui: gRPC Methods" from the bottom of the page up to sit right after "Sui: gRPC Streaming Methods" and before "Tron: Standard HTTP Methods", so the three Sui sections (Standard Methods, gRPC Streaming Methods, gRPC Methods) are adjacent. Pure reorder: content and cu:auto markers are unchanged. Refs DOCS-185 Requested-by: @oskarciupider-alchemy
1 participant
Summary
Clarifies Sui gRPC billing on the Compute Unit Costs page:
# Sui: gRPC Streaming Methodssection modeled on the existing# Solana: Yellowstone gRPCsection — bandwidth pricing at $75 / 1 TB, pro-rated,[Contact us]CTA. Placed immediately after# Sui: Standard Methodsfor parity with how Solana Yellowstone gRPC sits alongside# Solana: Standard JSON-RPC Methods.SubscriptionService/{SubscribeCheckpoints, SubscribeTransactions, SubscribeEvents}andLedgerService/{ListCheckpoints, ListTransactions, ListEvents}.sui.rpc.v2.SubscriptionService/SubscribeCheckpointsfrom the per-method{/* cu:auto product="sui-grpc" */}table since it is bandwidth-priced, not per-call. This is the only one of the six methods currently present in that cu:auto table.Daikon note
The
sui-grpcper-method table is Daikon-managed viacu:automarkers (PR #1424 / #1425 pattern). The manual removal ofSubscribeCheckpointsfrom that block will be reverted on the next daily 12 PM EST Daikon run unless the method is also reclassified intopconfig.ymlupstream (OMGWINNING/chain-config) so Daikon stops emitting it under thesui-grpcproduct. Flagged so a follow-up chain-config PR can pin the change.The other five methods listed in the new section are not currently in the
sui-grpccu:auto table, so no removal is needed for them today.Linear
DOCS-185 — https://linear.app/alchemyapi/issue/DOCS-185/split-sui-grpc-streaming-methods-into-a-separate-bandwidth-priced
Requested by
@oskarciupider-alchemy (via Slack thread)