Skip to content

Document @solana/rpc-types with TypeDoc #365

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: 04-07-document_solana_rpc-transport-http_with_typedoc
Choose a base branch
from
Open

Document @solana/rpc-types with TypeDoc #365

wants to merge 1 commit into from
+586 −100

Conversation

steveluscher
Copy link
Collaborator

No description provided.

@changeset-bot changeset-bot
Copy link

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

⚠️ No Changeset found

Latest commit: 22c8c75

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 Vercel
Copy link

vercel bot commented Apr 10, 2025 •
edited
Loading

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 14, 2025 10:06pm

This was referenced Apr 10, 2025
Merged
Merged
Open
Merged
Merged
@steveluscher Graphite App
Copy link
Collaborator Author

steveluscher commented Apr 10, 2025 •
edited
Loading

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

steveluscher
steveluscher commented Apr 10, 2025
View reviewed changes
Copy link
Collaborator Author

@steveluscher steveluscher left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was torturous and I feel like I only got 80% of the way there. Feedback welcome.

packages/rpc-graphql/src/resolvers/block.ts
Comment on lines +86 to +94
const jsonParsedData: typeof data = {
...data,
message: {
...data.message,
instructions: mapJsonParsedInstructions(
data.message.instructions,
) as unknown as (typeof jsonParsedData)['message']['instructions'],
},
};
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changed because I made message Readonly.

@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from 8fc2388 to a24cd8d Compare April 10, 2025 04:45
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 9df5a2d to 09e7f24 Compare April 10, 2025 04:45
@bundlemon BundleMon
Copy link

bundlemon bot commented Apr 10, 2025 •
edited
Loading

BundleMon

Files updated (3)
Status Path Size Limits
✅ rpc-graphql/dist/index.browser.mjs
 18.79KB (+29B +0.15%) -
✅ rpc-graphql/dist/index.native.mjs
 18.78KB (+29B +0.15%) -
✅ rpc-graphql/dist/index.node.mjs
 18.78KB (+29B +0.15%) -
Unchanged files (124)
Status Path Size Limits
✅ @solana/kit production bundle
kit/dist/index.production.min.js
 34.11KB -
✅ 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.93KB -
✅ rpc-transformers/dist/index.native.mjs
 2.93KB -
✅ rpc-transformers/dist/index.node.mjs
 2.93KB -
✅ 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 -
✅ sysvars/dist/index.browser.mjs
 2.35KB -
✅ sysvars/dist/index.native.mjs
 2.34KB -
✅ transaction-confirmation/dist/index.native.mj
s
 2.34KB -
✅ sysvars/dist/index.node.mjs
 2.34KB -
✅ transaction-confirmation/dist/index.browser.m
js
 2.34KB -
✅ 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 -

Total files change +87B +0.02%

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from a24cd8d to 2a5d6db Compare April 10, 2025 18:46
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 09e7f24 to 1c58594 Compare April 10, 2025 18:46
@steveluscher steveluscher mentioned this pull request Apr 10, 2025
Open
This was referenced Apr 10, 2025
Open
Merged
Merged
Open
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from 2a5d6db to baf091e Compare April 11, 2025 16:33
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 1c58594 to 696afd8 Compare April 11, 2025 16:33
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from baf091e to f73bc43 Compare April 11, 2025 16:34
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 696afd8 to c8e8b8f Compare April 11, 2025 16:34
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from f73bc43 to 15acde0 Compare April 11, 2025 17:43
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from c8e8b8f to 2df819e Compare April 11, 2025 17:43
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from 15acde0 to 02bd005 Compare April 11, 2025 17:46
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 2df819e to d46f081 Compare April 11, 2025 17:47
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from 02bd005 to b61e32e Compare April 11, 2025 18:00
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from d46f081 to e09e014 Compare April 11, 2025 18:00
This was referenced Apr 11, 2025
Merged
Open
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from b61e32e to 66ea079 Compare April 14, 2025 15:36
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from e09e014 to 0284aee Compare April 14, 2025 15:37
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from 66ea079 to 39750a9 Compare April 14, 2025 19:41
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 0284aee to 3b9cf6e Compare April 14, 2025 19:41
This was referenced Apr 14, 2025
Open
Open
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch 2 times, most recently from 032d7f6 to f183611 Compare April 14, 2025 19:42
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 3b9cf6e to 1e2e983 Compare April 14, 2025 19:42
@steveluscher steveluscher force-pushed the 04-07-document_solana_rpc-transport-http_with_typedoc branch from f183611 to 7a849f7 Compare April 14, 2025 21:44
@steveluscher steveluscher force-pushed the 04-10-document_solana_rpc-types_with_typedoc branch from 1e2e983 to 22c8c75 Compare April 14, 2025 21:44
This was referenced Apr 14, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lorisleiva lorisleiva Awaiting requested review from lorisleiva

@mcintyre94 mcintyre94 Awaiting requested review from mcintyre94

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@steveluscher