Document `@solana/rpc-subscriptions-spec` with TypeDoc #352

steveluscher · 2025-04-04T22:54:38Z

No description provided.

changeset-bot · 2025-04-04T22:54:41Z

⚠️ No Changeset found

Latest commit: 64d702a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2025-04-04T22:54:42Z

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

Name	Status	Preview	Comments	Updated (UTC)
kit-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 10, 2025 7:05pm

steveluscher · 2025-04-04T22:54:53Z

steveluscher · 2025-04-04T22:55:35Z

packages/rpc-spec/src/rpc.ts

@@ -52,7 +52,7 @@ type PendingRpcRequestReturnTypeMapper<TMethodImplementation> =
        : never;

 /**
- * Creates a {@link Rpc} instance given an {@link RpcApi | RpcApi<TRpcMethods>} and a
+ * Creates a {@link Rpc} instance given a {@link RpcApi | RpcApi<TRpcMethods>} and a


#yolo grammar fix.

steveluscher · 2025-04-04T22:56:39Z

packages/rpc-subscriptions-spec/README.md

@@ -40,7 +40,7 @@ try {

 ### `RpcSubscriptionsChannel<TOutboundMessage, TInboundMessage>`

-A channel is a `DataPublisher` that you can subscribe to events of type `RpcSubscriptionChannelEvents<TInboundMessage>`. Additionally, you can use it to send messages of type `TOutboundMessage` back to the remote end by calling the `send(message)` method.
+A channel is a `DataPublisher` on which you can subscribe to events of type `RpcSubscriptionChannelEvents<TInboundMessage>`. Additionally, you can use this object to send messages of type `TOutboundMessage` back to the remote end by calling its `send(message)` method.


I decided not to complete the README here with all the new documentation in this PR. I think after this is all done we just delete all the READMEs and replace them with a link to the live documentation, whether that's on our site or on tsdocs.dev.

bundlemon · 2025-04-04T22:59:51Z

BundleMon

Unchanged files (127)

Status	Path	Size	Limits
✅	@solana/kit production bundle _{kit/dist/index.production.min.js}	34.11KB	-
✅	rpc-graphql/dist/index.browser.mjs	18.76KB	-
✅	rpc-graphql/dist/index.native.mjs	18.75KB	-
✅	rpc-graphql/dist/index.node.mjs	18.75KB	-
✅	errors/dist/index.node.mjs	14.48KB	-
✅	errors/dist/index.browser.mjs	14.46KB	-
✅	errors/dist/index.native.mjs	14.46KB	-
✅	transaction-messages/dist/index.browser.mjs	7.06KB	-
✅	transaction-messages/dist/index.native.mjs	7.06KB	-
✅	transaction-messages/dist/index.node.mjs	7.06KB	-
✅	codecs-data-structures/dist/index.native.mjs	4.77KB	-
✅	codecs-data-structures/dist/index.browser.mjs	4.77KB	-
✅	codecs-data-structures/dist/index.node.mjs	4.77KB	-
✅	webcrypto-ed25519-polyfill/dist/index.node.mj s	3.57KB	-
✅	webcrypto-ed25519-polyfill/dist/index.browser .mjs	3.56KB	-
✅	webcrypto-ed25519-polyfill/dist/index.native. mjs	3.54KB	-
✅	rpc-subscriptions/dist/index.browser.mjs	3.38KB	-
✅	rpc-subscriptions/dist/index.node.mjs	3.34KB	-
✅	rpc-subscriptions/dist/index.native.mjs	3.31KB	-
✅	codecs-core/dist/index.browser.mjs	3.3KB	-
✅	codecs-core/dist/index.native.mjs	3.3KB	-
✅	codecs-core/dist/index.node.mjs	3.3KB	-
✅	rpc-transformers/dist/index.browser.mjs	2.92KB	-
✅	rpc-transformers/dist/index.native.mjs	2.92KB	-
✅	rpc-transformers/dist/index.node.mjs	2.92KB	-
✅	addresses/dist/index.browser.mjs	2.86KB	-
✅	addresses/dist/index.native.mjs	2.86KB	-
✅	addresses/dist/index.node.mjs	2.86KB	-
✅	kit/dist/index.browser.mjs	2.71KB	-
✅	kit/dist/index.native.mjs	2.71KB	-
✅	kit/dist/index.node.mjs	2.71KB	-
✅	signers/dist/index.browser.mjs	2.63KB	-
✅	signers/dist/index.native.mjs	2.63KB	-
✅	signers/dist/index.node.mjs	2.63KB	-
✅	codecs-strings/dist/index.browser.mjs	2.53KB	-
✅	codecs-strings/dist/index.node.mjs	2.48KB	-
✅	codecs-strings/dist/index.native.mjs	2.45KB	-
✅	transaction-confirmation/dist/index.node.mjs	2.4KB	-
✅	transaction-confirmation/dist/index.native.mj s	2.34KB	-
✅	transaction-confirmation/dist/index.browser.m js	2.34KB	-
✅	sysvars/dist/index.browser.mjs	2.25KB	-
✅	sysvars/dist/index.native.mjs	2.25KB	-
✅	sysvars/dist/index.node.mjs	2.24KB	-
✅	rpc-subscriptions-spec/dist/index.node.mjs	2.13KB	-
✅	rpc-subscriptions-spec/dist/index.native.mjs	2.08KB	-
✅	rpc-subscriptions-spec/dist/index.browser.mjs	2.08KB	-
✅	keys/dist/index.browser.mjs	2.02KB	-
✅	keys/dist/index.native.mjs	2.02KB	-
✅	keys/dist/index.node.mjs	2.02KB	-
✅	codecs-numbers/dist/index.native.mjs	2.01KB	-
✅	codecs-numbers/dist/index.browser.mjs	2.01KB	-
✅	codecs-numbers/dist/index.node.mjs	2.01KB	-
✅	transactions/dist/index.browser.mjs	1.99KB	-
✅	react/dist/index.native.mjs	1.99KB	-
✅	transactions/dist/index.native.mjs	1.99KB	-
✅	react/dist/index.browser.mjs	1.99KB	-
✅	react/dist/index.node.mjs	1.99KB	-
✅	transactions/dist/index.node.mjs	1.99KB	-
✅	rpc/dist/index.node.mjs	1.95KB	-
✅	rpc-transport-http/dist/index.browser.mjs	1.91KB	-
✅	rpc-transport-http/dist/index.native.mjs	1.91KB	-
✅	rpc/dist/index.native.mjs	1.8KB	-
✅	subscribable/dist/index.node.mjs	1.8KB	-
✅	rpc/dist/index.browser.mjs	1.8KB	-
✅	subscribable/dist/index.native.mjs	1.75KB	-
✅	subscribable/dist/index.browser.mjs	1.74KB	-
✅	rpc-transport-http/dist/index.node.mjs	1.73KB	-
✅	rpc-types/dist/index.browser.mjs	1.6KB	-
✅	rpc-types/dist/index.native.mjs	1.6KB	-
✅	rpc-types/dist/index.node.mjs	1.6KB	-
✅	rpc-subscriptions-channel-websocket/dist/inde x.node.mjs	1.33KB	-
✅	rpc-subscriptions-channel-websocket/dist/inde x.native.mjs	1.27KB	-
✅	rpc-subscriptions-channel-websocket/dist/inde x.browser.mjs	1.26KB	-
✅	options/dist/index.browser.mjs	1.18KB	-
✅	options/dist/index.native.mjs	1.18KB	-
✅	options/dist/index.node.mjs	1.17KB	-
✅	accounts/dist/index.browser.mjs	1.13KB	-
✅	accounts/dist/index.native.mjs	1.12KB	-
✅	accounts/dist/index.node.mjs	1.12KB	-
✅	compat/dist/index.browser.mjs	971B	-
✅	compat/dist/index.native.mjs	970B	-
✅	compat/dist/index.node.mjs	968B	-
✅	rpc-spec-types/dist/index.browser.mjs	964B	-
✅	rpc-api/dist/index.browser.mjs	963B	-
✅	rpc-api/dist/index.native.mjs	962B	-
✅	rpc-spec-types/dist/index.native.mjs	962B	-
✅	rpc-api/dist/index.node.mjs	961B	-
✅	rpc-spec-types/dist/index.node.mjs	961B	-
✅	rpc-subscriptions-api/dist/index.native.mjs	870B	-
✅	rpc-subscriptions-api/dist/index.node.mjs	869B	-
✅	rpc-subscriptions-api/dist/index.browser.mjs	868B	-
✅	rpc-spec/dist/index.browser.mjs	829B	-
✅	rpc-spec/dist/index.native.mjs	829B	-
✅	rpc-spec/dist/index.node.mjs	828B	-
✅	promises/dist/index.browser.mjs	799B	-
✅	promises/dist/index.native.mjs	798B	-
✅	promises/dist/index.node.mjs	797B	-
✅	assertions/dist/index.browser.mjs	783B	-
✅	instructions/dist/index.browser.mjs	769B	-
✅	instructions/dist/index.native.mjs	768B	-
✅	instructions/dist/index.node.mjs	767B	-
✅	fast-stable-stringify/dist/index.browser.mjs	726B	-
✅	fast-stable-stringify/dist/index.native.mjs	725B	-
✅	assertions/dist/index.native.mjs	724B	-
✅	fast-stable-stringify/dist/index.node.mjs	724B	-
✅	assertions/dist/index.node.mjs	723B	-
✅	programs/dist/index.browser.mjs	329B	-
✅	programs/dist/index.native.mjs	327B	-
✅	programs/dist/index.node.mjs	325B	-
✅	event-target-impl/dist/index.node.mjs	233B	-
✅	functional/dist/index.browser.mjs	154B	-
✅	functional/dist/index.native.mjs	152B	-
✅	text-encoding-impl/dist/index.native.mjs	152B	-
✅	functional/dist/index.node.mjs	151B	-
✅	codecs/dist/index.browser.mjs	137B	-
✅	codecs/dist/index.native.mjs	136B	-
✅	codecs/dist/index.node.mjs	134B	-
✅	event-target-impl/dist/index.browser.mjs	133B	-
✅	ws-impl/dist/index.node.mjs	131B	-
✅	text-encoding-impl/dist/index.browser.mjs	122B	-
✅	text-encoding-impl/dist/index.node.mjs	119B	-
✅	crypto-impl/dist/index.node.mjs	114B	-
✅	ws-impl/dist/index.browser.mjs	113B	-
✅	crypto-impl/dist/index.browser.mjs	109B	-
✅	rpc-parsed-types/dist/index.browser.mjs	66B	-
✅	rpc-parsed-types/dist/index.native.mjs	65B	-
✅	rpc-parsed-types/dist/index.node.mjs	63B	-

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

steveluscher · 2025-04-11T16:34:57Z

Merge activity

Apr 11, 9:34 AM PDT: A user started a stack merge that includes this pull request via Graphite.
Apr 11, 9:35 AM PDT: A user merged this pull request with Graphite.

steveluscher mentioned this pull request Apr 4, 2025

Document @solana/rpc-subscriptions-channel-websocket using TypeDoc #351

Merged

steveluscher requested review from lorisleiva and mcintyre94 April 4, 2025 22:54

steveluscher commented Apr 4, 2025

View reviewed changes

vercel bot deployed to Preview April 4, 2025 22:59 View deployment

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-channel-websocket_using_typedoc branch from 9b1a067 to 1d16cdc Compare April 5, 2025 00:27

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-spec_with_typedoc branch from fe47b6d to 23d6ef0 Compare April 5, 2025 00:27

This was referenced Apr 5, 2025

Make a good deal of @solana/rpc-transformers private #353

Open

Document @solana/rpc-transformers with TypeDoc #354

Open

vercel bot deployed to Preview April 5, 2025 00:35 View deployment

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-channel-websocket_using_typedoc branch from 1d16cdc to 24d33eb Compare April 5, 2025 00:54

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-spec_with_typedoc branch from 23d6ef0 to 1d12a42 Compare April 5, 2025 00:54

vercel bot deployed to Preview April 5, 2025 01:11 View deployment

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-channel-websocket_using_typedoc branch from 24d33eb to 880a7f3 Compare April 7, 2025 22:05

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-spec_with_typedoc branch from 1d12a42 to 2c1779c Compare April 7, 2025 22:05

steveluscher mentioned this pull request Apr 7, 2025

Document @solana/rpc-transport-http with TypeDoc #361

Open

vercel bot deployed to Preview April 7, 2025 22:18 View deployment

steveluscher mentioned this pull request Apr 10, 2025

Document @solana/rpc-types with TypeDoc #365

Open

steveluscher changed the base branch from 04-04-document_solana_rpc-subscriptions-channel-websocket_using_typedoc to graphite-base/352 April 10, 2025 04:42

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-spec_with_typedoc branch from 2c1779c to 2ea177a Compare April 10, 2025 04:45

steveluscher force-pushed the graphite-base/352 branch from 880a7f3 to 0f8f024 Compare April 10, 2025 04:45

steveluscher changed the base branch from graphite-base/352 to main April 10, 2025 04:45

vercel bot deployed to Preview April 10, 2025 05:05 View deployment

Document @solana/rpc-subscriptions-spec with TypeDoc

64d702a

steveluscher force-pushed the 04-04-document_solana_rpc-subscriptions-spec_with_typedoc branch from 2ea177a to 64d702a Compare April 10, 2025 18:46

steveluscher mentioned this pull request Apr 10, 2025

Update the getTransaction documentation to mostly match that in the @solana/rpc-types documentation #372

Open

vercel bot deployed to Preview April 10, 2025 19:05 View deployment

This was referenced Apr 10, 2025

Document @solana/subscribable with TypeDoc #373

Open

Repair the SysvarEpochRewards fetcher/decoder/encoder #374

Merged

Repair the StakeHistory sysvar fetcher #375

Merged

Document @solana/sysvars with TypeDoc #376

Open

lorisleiva approved these changes Apr 11, 2025

View reviewed changes

steveluscher merged commit 7e049d6 into main Apr 11, 2025
11 of 13 checks passed

steveluscher deleted the 04-04-document_solana_rpc-subscriptions-spec_with_typedoc branch April 11, 2025 16:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document `@solana/rpc-subscriptions-spec` with TypeDoc #352

Document `@solana/rpc-subscriptions-spec` with TypeDoc #352

steveluscher commented Apr 4, 2025

changeset-bot bot commented Apr 4, 2025 •

edited

Loading

vercel bot commented Apr 4, 2025 •

edited

Loading

steveluscher commented Apr 4, 2025 •

edited

Loading

steveluscher Apr 4, 2025

steveluscher Apr 4, 2025

bundlemon bot commented Apr 4, 2025 •

edited

Loading

steveluscher commented Apr 11, 2025 •

edited

Loading

Document @solana/rpc-subscriptions-spec with TypeDoc #352

Document @solana/rpc-subscriptions-spec with TypeDoc #352

Conversation

steveluscher commented Apr 4, 2025

changeset-bot bot commented Apr 4, 2025 • edited Loading

⚠️ No Changeset found

vercel bot commented Apr 4, 2025 • edited Loading

steveluscher commented Apr 4, 2025 • edited Loading

steveluscher Apr 4, 2025

Choose a reason for hiding this comment

steveluscher Apr 4, 2025

Choose a reason for hiding this comment

bundlemon bot commented Apr 4, 2025 • edited Loading

BundleMon

steveluscher commented Apr 11, 2025 • edited Loading

Merge activity

Document `@solana/rpc-subscriptions-spec` with TypeDoc #352

Document `@solana/rpc-subscriptions-spec` with TypeDoc #352

changeset-bot bot commented Apr 4, 2025 •

edited

Loading

vercel bot commented Apr 4, 2025 •

edited

Loading

steveluscher commented Apr 4, 2025 •

edited

Loading

bundlemon bot commented Apr 4, 2025 •

edited

Loading

steveluscher commented Apr 11, 2025 •

edited

Loading