Make ProgramError compatible with pinocchio #12

kevinheavey · 2025-02-09T13:05:28Z

Problem: solana-program-error and pinocchio define ProgramError enums that are identical except for the BorshIoError variant, which looks like BorshIoError(String) in solana-program-error and is fieldless (just BorshIoError) in pinocchio.

It is going to be a significant source of grief for users to have two almost-identical ProgramError types in their dependency tree. People will accidentally import the wrong one a lot

Solution: make solana_program_error::ProgramError the same as the pinocchio one so pinocchio can replace its definition with a re-export.

Breaking changes:

the BorshIoError variants of ProgramError and InstructionError become fieldless. This will require a major version bump for solana-program-error, solana-instruction-error, solana-program and solana-sdk. I haven't included the version bump in the PR as it breaks compilation because of the solana-system-interface dep. This may or may not be curable with patching but is ultimately not a real problem.
add a num-traits feature to solana-program-error so that all functionality requiring num-traits becomes optional (pinocchio isn't using this functionality)
make std optional in solana-program-error as pinocchio is no-std. The only thing this affects is impl std::error::Error for ProgramError {}

Other changes:

Extract solana-pubkey-error and solana-instruction-error crates and use them in solana-program-error. This is so pinocchio's deps can be as light as possible
Make num-traits optional

kevinheavey · 2025-02-09T14:20:10Z

CI error is as expected given the breaking change

febo · 2025-02-13T21:39:08Z

program-error/Cargo.toml

-solana-msg = { workspace = true }
-solana-pubkey = { workspace = true, default-features = false }
+solana-decode-error = { workspace = true, optional = true }
+solana-instruction-error = { workspace = true }


Can we make this one optional?

are you sure? I think this is at the point where the cognitive overhead of the extra feature outweighs any impact on compile times or API surface area

Yeah, the amount of features to enable/disable depending of whether you are using pinocchio or the SDK concerns me - hopefully is not going to be annoying.

Ideally I would not have solana-instruction-error and solana-pubkey-error exported here – those should be added by the code that wants to use them. So the other option is to remove the export from here, instead of adding another feature.

pinocchio would want the error codes defined in solana-instruction-error e.g. pub const INVALID_ARGUMENT: u64 = to_builtin!(2);. Currently it's redefining these itself. Are you saying you'd want these consts to be in a standalone crate without the InstructionError enum?

I was thinking that we can have the error codes defined in solana-program-error, like in pinocchio. So solana-instruction-error is the one that depends on solana-program-error, not the other way around. The error codes cover the "program errors" variants and InstructionError is a super set of ProgramError.

ok i've moved some stuff to program-error

febo · 2025-02-13T21:39:19Z

program-error/Cargo.toml

+solana-decode-error = { workspace = true, optional = true }
+solana-instruction-error = { workspace = true }
+solana-msg = { workspace = true, optional = true }
+solana-pubkey-error = { workspace = true, default-features = false }


Can we make this one optional?

febo · 2025-02-13T21:40:15Z

program-error/src/lib.rs

-    solana_decode_error::DecodeError,
-    solana_instruction::error::{
+    core::{convert::TryFrom, fmt},
+    solana_instruction_error::{


If we make solana-instruction-error optional, we should add a feature here.

febo · 2025-02-13T21:40:33Z

program-error/src/lib.rs

-    solana_msg::msg,
-    solana_pubkey::PubkeyError,
-    std::convert::TryFrom,
+    solana_pubkey_error::PubkeyError,


Same here, If we make solana-pubkey-error optional, we should add a feature here.

febo · 2025-02-13T21:41:35Z

program-error/src/lib.rs

@@ -122,12 +124,14 @@ impl fmt::Display for ProgramError {
    }
 }

+#[cfg(feature = "num-traits")]
 pub trait PrintProgramError {
    fn print<E>(&self)
    where
        E: 'static + std::error::Error + DecodeError<E> + PrintProgramError + FromPrimitive;


Is there a way to relax the requirements for E? E.g., drop std::error::Error and FromPrimitive. This way we could use the trait in pinocchio-based errors.

We can remove the DecodeError and Error constraints, which is technically a breaking change but is trivial and we're already making a breaking change here, so I've committed that.

We can replace the FromPrimitive constraint with TryFrom but this is a more significant break because users would have to write their own impl or switch to num_enum to derive it https://docs.rs/num_enum/latest/num_enum/derive.TryFromPrimitive.html. For now I've committed this change too

…port

kevinheavey requested a review from joncinque February 10, 2025 11:07

kevinheavey added 10 commits February 13, 2025 08:53

turn BorshIoError variants into unit variants

efea873

make std optional in solana-program-error

f6991b8

extract solana-pubkey-error crate

5fc7e63

add missing feature activation

cda9d3a

extract instruction-error crate

32d2338

remove unnecessary docs target from pubkey-error

d63925c

make num-traits optional in solana-program-error

5be8223

missing feature activation in solana-program

12c22de

move min_specialization to instruction-error

a532c94

missing feature activation in solana-instruction

bc3494a

kevinheavey force-pushed the program-error-pinocchio-compat branch from f625acf to bc3494a Compare February 13, 2025 09:16

febo reviewed Feb 13, 2025

View reviewed changes

kevinheavey added 7 commits February 14, 2025 06:27

remove redundant DecodeError constraint from PrintProgramError

bcf7383

remove unncecessary Error constraint from PrintProgramError

5fa488f

remove num-traits dep and rename the num-traits feature to solana-msg

cbd37ab

add missing changes after removing num-traits

73a3e21

make pubkey-error optional

f7d253e

move instruction error codes to program-error and fix pubkey-error im…

e29899c

…port

fmt

0619cdf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make ProgramError compatible with pinocchio #12

Make ProgramError compatible with pinocchio #12

kevinheavey commented Feb 9, 2025

kevinheavey commented Feb 9, 2025

febo Feb 13, 2025

kevinheavey Feb 14, 2025

febo Feb 14, 2025

kevinheavey Feb 14, 2025

febo Feb 14, 2025

kevinheavey Feb 15, 2025

febo Feb 13, 2025

febo Feb 13, 2025

febo Feb 13, 2025

febo Feb 13, 2025 •

edited

Loading

kevinheavey Feb 14, 2025

Make ProgramError compatible with pinocchio #12

Are you sure you want to change the base?

Make ProgramError compatible with pinocchio #12

Conversation

kevinheavey commented Feb 9, 2025

kevinheavey commented Feb 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

febo Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

febo Feb 13, 2025 •

edited

Loading