chore: actualize documentation#372
Merged
HealthyBuilder merged 2 commits intoApr 9, 2026
Merged
Conversation
82a91ba to
066b414
Compare
Closed
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
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.
Problem
README.mdserved as both project documentation and a complete API cookbook with 2k lines of inline code examples for every RPC and WebSocket method. This caused several issues:bin.NewDecoder,CommitmentRecent,GetParsedTransaction) and wrong types (PublicKeyvs*PublicKey) that silently broke without anyone noticingBlockSubscribe,SlotsUpdatesSubscribe) or in the Solana RPC spec (GetStakeMinimumDelegation) were absent from documentationSummary of Changes
bin.NewDecoder -> NewBinDecoder,CommitmentRecent -> CommitmentProcessed, Mint/VotePubkey pointer types, removed nonexistentGetParsedTransactionGetStakeMinimumDelegation- new RPC client method + result type to match the Solana specExample*functions - rpc/example_test.go (52 methods) and rpc/ws/example_test.go (11 subscriptions) that compile-check on every go build and render on pkg.go.dev