Skip to content

docs: describe program decoders #406

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

Merged
HealthyBuilder merged 1 commit into from
Apr 23, 2026
Merged

docs: describe program decoders #406

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,9 +343,25 @@ func decodeSystemTransfer(tx *solana.Transaction) {
// OR
{
// There is a more general instruction decoder: `solana.DecodeInstruction`.
// But before you can use `solana.DecodeInstruction`,
// you must register a decoder for each program ID beforehand
// by using `solana.RegisterInstructionDecoder` (all solana-go program clients do it automatically with the default program IDs).
// It looks up the decoder for `progKey` in a central registry, so it
// works for any program ID regardless of what you know at compile time.
//
// Each `programs/<name>` package registers its decoder via init(),
// which only runs when the package is imported. If you are not
// already using the package's builders (e.g. `system.NewTransferInstruction`),
// blank-import it so the decoder is available - same idiom as
// database/sql drivers:
//
// import (
// _ "github.com/gagliardetto/solana-go/programs/system"
// _ "github.com/gagliardetto/solana-go/programs/token"
// // ...add more as needed
// )
//
// For a program that solana-go does not ship (e.g. a custom Anchor
// program), register its decoder yourself:
//
// solana.MustRegisterInstructionDecoder(myProgramID, myDecoderFunc)
decodedInstruction, err := solana.DecodeInstruction(
progKey,
accounts,
Expand All @@ -361,9 +377,6 @@ func decodeSystemTransfer(tx *solana.Transaction) {
if !reflect.DeepEqual(inst, decodedInstruction) {
panic("they are NOT equal (this would never happen)")
}

// To register other (not yet registered decoders), you can add them with
// `solana.RegisterInstructionDecoder` function.
}

{
Expand Down
Loading