fix: panics in non-Must* functions

sonicfromnewyoke · sonicfromnewyoke · commit e17cd730796b · 2026-04-03T03:07:53.000+03:00
diff --git a/message.go b/message.go
@@ -137,15 +137,15 @@ var _ bin.EncoderDecoder = &Message{}
 // SetVersion sets the message version.
 // This method forces the message to be encoded in the specified version.
 // NOTE: if you set lookups, the version will default to V0.
-func (m *Message) SetVersion(version MessageVersion) *Message {
+func (m *Message) SetVersion(version MessageVersion) (*Message, error) {
 	// check if the version is valid
 	switch version {
 	case MessageVersionV0, MessageVersionLegacy:
 	default:
-		panic(fmt.Errorf("invalid message version: %d", version))
+		return nil, fmt.Errorf("invalid message version: %d", version)
 	}
 	m.version = version
-	return m
+	return m, nil
 }
 
 // GetVersion returns the message version.
diff --git a/nativetypes.go b/nativetypes.go
@@ -329,8 +329,7 @@ func (t Data) String() string {
 	case EncodingBase64Zstd:
 		enc, err := zstdEncoderPool.Get(nil)
 		if err != nil {
-			// TODO: remove panic?
-			panic(err)
+			return fmt.Sprintf("<zstd encoder error: %v>", err)
 		}
 		defer zstdEncoderPool.Put(enc)
 		return base64.StdEncoding.EncodeToString(enc.EncodeAll(t.Content, nil))
diff --git a/programs/address-lookup-table/instructions.go b/programs/address-lookup-table/instructions.go
@@ -14,15 +14,15 @@ import (
 
 var ProgramID solana.PublicKey = solana.AddressLookupTableProgramID
 
-func SetProgramID(pubkey solana.PublicKey) {
+func SetProgramID(pubkey solana.PublicKey) error {
 	ProgramID = pubkey
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "AddressLookupTable"
 
 func init() {
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const (
diff --git a/programs/associated-token-account/instructions.go b/programs/associated-token-account/instructions.go
@@ -27,15 +27,15 @@ import (
 
 var ProgramID solana.PublicKey = solana.SPLAssociatedTokenAccountProgramID
 
-func SetProgramID(pubkey solana.PublicKey) {
+func SetProgramID(pubkey solana.PublicKey) error {
 	ProgramID = pubkey
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "AssociatedTokenAccount"
 
 func init() {
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const (
diff --git a/programs/compute-budget/instruction.go b/programs/compute-budget/instruction.go
@@ -27,16 +27,16 @@ import (
 
 var ProgramID ag_solanago.PublicKey = ag_solanago.ComputeBudget
 
-func SetProgramID(pubkey ag_solanago.PublicKey) {
+func SetProgramID(pubkey ag_solanago.PublicKey) error {
 	ProgramID = pubkey
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "ComputeBudget"
 
 func init() {
 	if !ProgramID.IsZero() {
-		ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+		ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 	}
 }
 
diff --git a/programs/memo/instructions.go b/programs/memo/instructions.go
@@ -26,13 +26,13 @@ import (
 
 var ProgramID = ag_solanago.MemoProgramID
 
-func SetProgramID(pubkey ag_solanago.PublicKey) {
+func SetProgramID(pubkey ag_solanago.PublicKey) error {
 	ProgramID = pubkey
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 func init() {
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 type MemoInstruction struct {
diff --git a/programs/stake/instructions.go b/programs/stake/instructions.go
@@ -29,15 +29,15 @@ import (
 
 var ProgramID solana.PublicKey = solana.StakeProgramID
 
-func SetProgramID(pubkey solana.PublicKey) {
+func SetProgramID(pubkey solana.PublicKey) error {
 	ProgramID = pubkey
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "Stake"
 
 func init() {
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const (
diff --git a/programs/system/instructions.go b/programs/system/instructions.go
@@ -31,15 +31,15 @@ import (
 
 var ProgramID ag_solanago.PublicKey = ag_solanago.SystemProgramID
 
-func SetProgramID(pubkey ag_solanago.PublicKey) {
+func SetProgramID(pubkey ag_solanago.PublicKey) error {
 	ProgramID = pubkey
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "System"
 
 func init() {
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const (
diff --git a/programs/token-2022/instructions.go b/programs/token-2022/instructions.go
@@ -34,16 +34,16 @@ const MAX_SIGNERS = 11
 
 var ProgramID ag_solanago.PublicKey = ag_solanago.Token2022ProgramID
 
-func SetProgramID(pubkey ag_solanago.PublicKey) {
+func SetProgramID(pubkey ag_solanago.PublicKey) error {
 	ProgramID = pubkey
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "Token2022"
 
 func init() {
 	if !ProgramID.IsZero() {
-		ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+		ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 	}
 }
 
diff --git a/programs/token/instructions.go b/programs/token/instructions.go
@@ -33,16 +33,16 @@ const MAX_SIGNERS = 11
 
 var ProgramID ag_solanago.PublicKey = ag_solanago.TokenProgramID
 
-func SetProgramID(pubkey ag_solanago.PublicKey) {
+func SetProgramID(pubkey ag_solanago.PublicKey) error {
 	ProgramID = pubkey
-	ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "Token"
 
 func init() {
 	if !ProgramID.IsZero() {
-		ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+		ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 	}
 }
 
diff --git a/programs/tokenregistry/instruction.go b/programs/tokenregistry/instruction.go
@@ -29,7 +29,7 @@ import (
 )
 
 func init() {
-	solana.RegisterInstructionDecoder(ProgramID(), registryDecodeInstruction)
+	solana.MustRegisterInstructionDecoder(ProgramID(), registryDecodeInstruction)
 }
 
 func registryDecodeInstruction(accounts []*solana.AccountMeta, data []byte) (interface{}, error) {
diff --git a/programs/vote/instructions.go b/programs/vote/instructions.go
@@ -28,15 +28,15 @@ import (
 
 var ProgramID solana.PublicKey = solana.VoteProgramID
 
-func SetProgramID(pubkey solana.PublicKey) {
+func SetProgramID(pubkey solana.PublicKey) error {
 	ProgramID = pubkey
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 const ProgramName = "Vote"
 
 func init() {
-	solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
+	solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)
 }
 
 type Instruction struct {
diff --git a/registry.go b/registry.go
@@ -77,20 +77,35 @@ func (reg *decoderRegistry) RegisterIfNew(programID PublicKey, decoder Instructi
 	return true
 }
 
-func RegisterInstructionDecoder(programID PublicKey, decoder InstructionDecoder) {
-	prev, has := instructionDecoderRegistry.Get(programID)
+// RegisterInstructionDecoder registers a decoder for the given programID.
+// Returns an error if a different decoder is already registered for that programID.
+// Re-registering the same decoder function is a no-op.
+func RegisterInstructionDecoder(programID PublicKey, decoder InstructionDecoder) error {
+	instructionDecoderRegistry.mu.Lock()
+	defer instructionDecoderRegistry.mu.Unlock()
+
+	prev, has := instructionDecoderRegistry.decoders[programID]
 	if has {
-		// If it's the same function, then OK (tollerate multiple calls with same params).
+		// If it's the same function, then OK (tolerate multiple calls with same params).
 		if isSameFunction(prev, decoder) {
-			return
+			return nil
 		}
-		// If it's another decoder for the same pubkey, then panic.
-		panic(fmt.Sprintf("unable to re-register instruction decoder for program %s", programID))
+		// If it's another decoder for the same pubkey, return error.
+		return fmt.Errorf("unable to re-register instruction decoder for program %s", programID)
 	}
-	instructionDecoderRegistry.RegisterIfNew(programID, decoder)
+	instructionDecoderRegistry.decoders[programID] = decoder
+	return nil
 }
 
-func isSameFunction(f1 interface{}, f2 interface{}) bool {
+// MustRegisterInstructionDecoder is like RegisterInstructionDecoder but panics on error.
+// Intended for use in init() functions where error handling is not possible.
+func MustRegisterInstructionDecoder(programID PublicKey, decoder InstructionDecoder) {
+	if err := RegisterInstructionDecoder(programID, decoder); err != nil {
+		panic(err)
+	}
+}
+
+func isSameFunction(f1 any, f2 any) bool {
 	return reflect.ValueOf(f1).Pointer() == reflect.ValueOf(f2).Pointer()
 }
 
diff --git a/registry_test.go b/registry_test.go
@@ -4,24 +4,24 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestRegisterInstructionDecoder(t *testing.T) {
 
-	decoder := func(instructionAccounts []*AccountMeta, data []byte) (interface{}, error) {
+	decoder := func(instructionAccounts []*AccountMeta, data []byte) (any, error) {
 		return nil, nil
 	}
-	decoderAnother := func(instructionAccounts []*AccountMeta, data []byte) (interface{}, error) {
+	decoderAnother := func(instructionAccounts []*AccountMeta, data []byte) (any, error) {
 		return nil, nil
 	}
 
-	assert.NotPanics(t, func() {
-		RegisterInstructionDecoder(BPFLoaderProgramID, decoder)
-	})
-	assert.NotPanics(t, func() {
-		RegisterInstructionDecoder(BPFLoaderProgramID, decoder)
-	})
-	assert.Panics(t, func() {
-		RegisterInstructionDecoder(BPFLoaderProgramID, decoderAnother)
-	})
+	// First registration succeeds.
+	require.NoError(t, RegisterInstructionDecoder(BPFLoaderProgramID, decoder))
+
+	// Re-registering the same decoder is a no-op.
+	require.NoError(t, RegisterInstructionDecoder(BPFLoaderProgramID, decoder))
+
+	// Registering a different decoder for the same programID returns an error.
+	assert.Error(t, RegisterInstructionDecoder(BPFLoaderProgramID, decoderAnother))
 }

Original file line number	Diff line number	Diff line change
`@@ -14,15 +14,15 @@ import (`
`14`	`14`
`15`	`15`	`var ProgramID solana.PublicKey = solana.AddressLookupTableProgramID`
`16`	`16`
`17`		`-func SetProgramID(pubkey solana.PublicKey) {`
	`17`	`+func SetProgramID(pubkey solana.PublicKey) error {`
`18`	`18`	`ProgramID = pubkey`
`19`		`- solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`19`	`+ return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`const ProgramName = "AddressLookupTable"`
`23`	`23`
`24`	`24`	`func init() {`
`25`		`- solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`25`	`+ solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -27,15 +27,15 @@ import (`
`27`	`27`
`28`	`28`	`var ProgramID solana.PublicKey = solana.SPLAssociatedTokenAccountProgramID`
`29`	`29`
`30`		`-func SetProgramID(pubkey solana.PublicKey) {`
	`30`	`+func SetProgramID(pubkey solana.PublicKey) error {`
`31`	`31`	`ProgramID = pubkey`
`32`		`- solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`32`	`+ return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`const ProgramName = "AssociatedTokenAccount"`
`36`	`36`
`37`	`37`	`func init() {`
`38`		`- solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`38`	`+ solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -27,16 +27,16 @@ import (`
`27`	`27`
`28`	`28`	`var ProgramID ag_solanago.PublicKey = ag_solanago.ComputeBudget`
`29`	`29`
`30`		`-func SetProgramID(pubkey ag_solanago.PublicKey) {`
	`30`	`+func SetProgramID(pubkey ag_solanago.PublicKey) error {`
`31`	`31`	`ProgramID = pubkey`
`32`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`32`	`+ return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`const ProgramName = "ComputeBudget"`
`36`	`36`
`37`	`37`	`func init() {`
`38`	`38`	`if !ProgramID.IsZero() {`
`39`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`39`	`+ ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -26,13 +26,13 @@ import (`
`26`	`26`
`27`	`27`	`var ProgramID = ag_solanago.MemoProgramID`
`28`	`28`
`29`		`-func SetProgramID(pubkey ag_solanago.PublicKey) {`
	`29`	`+func SetProgramID(pubkey ag_solanago.PublicKey) error {`
`30`	`30`	`ProgramID = pubkey`
`31`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`31`	`+ return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`func init() {`
`35`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`35`	`+ ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`type MemoInstruction struct {`
Original file line number	Diff line number	Diff line change
`@@ -29,15 +29,15 @@ import (`
`29`	`29`
`30`	`30`	`var ProgramID solana.PublicKey = solana.StakeProgramID`
`31`	`31`
`32`		`-func SetProgramID(pubkey solana.PublicKey) {`
	`32`	`+func SetProgramID(pubkey solana.PublicKey) error {`
`33`	`33`	`ProgramID = pubkey`
`34`		`- solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`34`	`+ return solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`const ProgramName = "Stake"`
`38`	`38`
`39`	`39`	`func init() {`
`40`		`- solana.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`40`	`+ solana.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -31,15 +31,15 @@ import (`
`31`	`31`
`32`	`32`	`var ProgramID ag_solanago.PublicKey = ag_solanago.SystemProgramID`
`33`	`33`
`34`		`-func SetProgramID(pubkey ag_solanago.PublicKey) {`
	`34`	`+func SetProgramID(pubkey ag_solanago.PublicKey) error {`
`35`	`35`	`ProgramID = pubkey`
`36`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`36`	`+ return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`const ProgramName = "System"`
`40`	`40`
`41`	`41`	`func init() {`
`42`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`42`	`+ ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -34,16 +34,16 @@ const MAX_SIGNERS = 11`
`34`	`34`
`35`	`35`	`var ProgramID ag_solanago.PublicKey = ag_solanago.Token2022ProgramID`
`36`	`36`
`37`		`-func SetProgramID(pubkey ag_solanago.PublicKey) {`
	`37`	`+func SetProgramID(pubkey ag_solanago.PublicKey) error {`
`38`	`38`	`ProgramID = pubkey`
`39`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`39`	`+ return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`const ProgramName = "Token2022"`
`43`	`43`
`44`	`44`	`func init() {`
`45`	`45`	`if !ProgramID.IsZero() {`
`46`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`46`	`+ ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -33,16 +33,16 @@ const MAX_SIGNERS = 11`
`33`	`33`
`34`	`34`	`var ProgramID ag_solanago.PublicKey = ag_solanago.TokenProgramID`
`35`	`35`
`36`		`-func SetProgramID(pubkey ag_solanago.PublicKey) {`
	`36`	`+func SetProgramID(pubkey ag_solanago.PublicKey) error {`
`37`	`37`	`ProgramID = pubkey`
`38`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`38`	`+ return ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`const ProgramName = "Token"`
`42`	`42`
`43`	`43`	`func init() {`
`44`	`44`	`if !ProgramID.IsZero() {`
`45`		`- ag_solanago.RegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
	`45`	`+ ag_solanago.MustRegisterInstructionDecoder(ProgramID, registryDecodeInstruction)`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`