program-error!: Make ProgramError compatible with pinocchio #12
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| [package] | ||
| name = "solana-instruction-error" | ||
| description = "Solana InstructionError type." | ||
| documentation = "https://docs.rs/solana-instruction-error" | ||
| version = "1.0.0" | ||
| authors = { workspace = true } | ||
| repository = { workspace = true } | ||
| homepage = { workspace = true } | ||
| license = { workspace = true } | ||
| edition = { workspace = true } | ||
|
|
||
| [dependencies] | ||
| num-traits = { workspace = true, optional = true } | ||
| serde = { workspace = true, optional = true } | ||
| serde_derive = { workspace = true, optional = true } | ||
| solana-frozen-abi = { workspace = true, optional = true } | ||
| solana-frozen-abi-macro = { workspace = true, optional = true } | ||
| solana-program-error = { workspace = true } | ||
|
|
||
| [features] | ||
| frozen-abi = [ | ||
| "dep:solana-frozen-abi", | ||
| "dep:solana-frozen-abi-macro", | ||
| "serde", | ||
| "std" | ||
| ] | ||
| num-traits = ["dep:num-traits"] | ||
| serde = ["dep:serde", "dep:serde_derive"] | ||
| std = [] | ||
|
|
||
| [package.metadata.docs.rs] | ||
| targets = ["x86_64-unknown-linux-gnu"] | ||
| all-features = true | ||
| rustdoc-args = ["--cfg=docsrs"] | ||
|
|
||
| [lints] | ||
| workspace = true |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,31 @@ | ||
| #![no_std] | ||
| #![cfg_attr(feature = "frozen-abi", feature(min_specialization))] | ||
| use core::fmt; | ||
| #[cfg(feature = "num-traits")] | ||
| use num_traits::ToPrimitive; | ||
| #[cfg(feature = "frozen-abi")] | ||
| use solana_frozen_abi_macro::{AbiEnumVisitor, AbiExample}; | ||
| #[cfg(feature = "std")] | ||
| extern crate std; | ||
| use solana_program_error::ProgramError; | ||
| pub use solana_program_error::{ | ||
| ACCOUNT_ALREADY_INITIALIZED, ACCOUNT_BORROW_FAILED, ACCOUNT_DATA_TOO_SMALL, | ||
| ACCOUNT_NOT_RENT_EXEMPT, ARITHMETIC_OVERFLOW, BORSH_IO_ERROR, | ||
| BUILTIN_PROGRAMS_MUST_CONSUME_COMPUTE_UNITS, CUSTOM_ZERO, ILLEGAL_OWNER, IMMUTABLE, | ||
| INCORRECT_AUTHORITY, INCORRECT_PROGRAM_ID, INSUFFICIENT_FUNDS, INVALID_ACCOUNT_DATA, | ||
| INVALID_ACCOUNT_DATA_REALLOC, INVALID_ACCOUNT_OWNER, INVALID_ARGUMENT, | ||
| INVALID_INSTRUCTION_DATA, INVALID_SEEDS, MAX_ACCOUNTS_DATA_ALLOCATIONS_EXCEEDED, | ||
| MAX_INSTRUCTION_TRACE_LENGTH_EXCEEDED, MAX_SEED_LENGTH_EXCEEDED, MISSING_REQUIRED_SIGNATURES, | ||
| NOT_ENOUGH_ACCOUNT_KEYS, UNINITIALIZED_ACCOUNT, UNSUPPORTED_SYSVAR, | ||
| }; | ||
|
|
||
| /// Reasons the runtime might have rejected an instruction. | ||
| /// | ||
| /// Members of this enum must not be removed, but new ones can be added. | ||
| /// Also, it is crucial that meta-information if any that comes along with | ||
| /// an error be consistent across software versions. For example, it is | ||
| /// dangerous to include error strings from 3rd party crates because they could | ||
| /// change at any time and changes to them are difficult to detect. | ||
| #[cfg_attr(feature = "frozen-abi", derive(AbiExample, AbiEnumVisitor))] | ||
| #[cfg_attr( | ||
| feature = "serde", | ||
|
|
@@ -202,15 +173,7 @@ pub enum InstructionError { | |
| IncorrectAuthority, | ||
|
|
||
| /// Failed to serialize or deserialize account data | ||
| BorshIoError, | ||
|
There was a problem hiding this comment. Confirming that this change is good from the runtime side too -- the error text is never used or stored anywhere |
||
|
|
||
| /// An account does not have enough lamports to be rent-exempt | ||
| AccountNotRentExempt, | ||
|
|
@@ -245,7 +208,6 @@ pub enum InstructionError { | |
| #[cfg(feature = "std")] | ||
| impl std::error::Error for InstructionError {} | ||
joncinque marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| impl fmt::Display for InstructionError { | ||
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | ||
| match self { | ||
|
|
@@ -361,8 +323,8 @@ impl fmt::Display for InstructionError { | |
| InstructionError::ProgramFailedToCompile => f.write_str("Program failed to compile"), | ||
| InstructionError::Immutable => f.write_str("Account is immutable"), | ||
| InstructionError::IncorrectAuthority => f.write_str("Incorrect authority provided"), | ||
| InstructionError::BorshIoError => { | ||
| f.write_str("Failed to serialize or deserialize account data") | ||
| } | ||
| InstructionError::AccountNotRentExempt => { | ||
| f.write_str("An account does not have enough lamports to be rent-exempt") | ||
|
|
@@ -385,7 +347,7 @@ impl fmt::Display for InstructionError { | |
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "num-traits")] | ||
|
There was a problem hiding this comment. I looked around to see if there was a standard feature name for num-traits. The highest downloaded crate that has it optional uses All that to say, I'm good with |
||
| impl<T> From<T> for InstructionError | ||
| where | ||
| T: ToPrimitive, | ||
|
|
@@ -407,7 +369,7 @@ where | |
| ACCOUNT_BORROW_FAILED => Self::AccountBorrowFailed, | ||
| MAX_SEED_LENGTH_EXCEEDED => Self::MaxSeedLengthExceeded, | ||
| INVALID_SEEDS => Self::InvalidSeeds, | ||
| BORSH_IO_ERROR => Self::BorshIoError, | ||
| ACCOUNT_NOT_RENT_EXEMPT => Self::AccountNotRentExempt, | ||
| UNSUPPORTED_SYSVAR => Self::UnsupportedSysvar, | ||
| ILLEGAL_OWNER => Self::IllegalOwner, | ||
|
|
@@ -423,7 +385,7 @@ where | |
| INCORRECT_AUTHORITY => Self::IncorrectAuthority, | ||
| _ => { | ||
| // A valid custom error has no bits set in the upper 32 | ||
| if error >> solana_program_error::BUILTIN_BIT_SHIFT == 0 { | ||
| Self::Custom(error as u32) | ||
| } else { | ||
| Self::InvalidError | ||
|
|
@@ -453,7 +415,6 @@ impl fmt::Display for LamportsError { | |
| } | ||
| } | ||
|
|
||
| impl From<LamportsError> for InstructionError { | ||
| fn from(error: LamportsError) -> Self { | ||
| match error { | ||
|
|
@@ -462,3 +423,45 @@ impl From<LamportsError> for InstructionError { | |
| } | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<InstructionError> for ProgramError { | ||
| type Error = InstructionError; | ||
|
|
||
| fn try_from(error: InstructionError) -> Result<Self, Self::Error> { | ||
| match error { | ||
| Self::Error::Custom(err) => Ok(Self::Custom(err)), | ||
| Self::Error::InvalidArgument => Ok(Self::InvalidArgument), | ||
| Self::Error::InvalidInstructionData => Ok(Self::InvalidInstructionData), | ||
| Self::Error::InvalidAccountData => Ok(Self::InvalidAccountData), | ||
| Self::Error::AccountDataTooSmall => Ok(Self::AccountDataTooSmall), | ||
| Self::Error::InsufficientFunds => Ok(Self::InsufficientFunds), | ||
| Self::Error::IncorrectProgramId => Ok(Self::IncorrectProgramId), | ||
| Self::Error::MissingRequiredSignature => Ok(Self::MissingRequiredSignature), | ||
| Self::Error::AccountAlreadyInitialized => Ok(Self::AccountAlreadyInitialized), | ||
| Self::Error::UninitializedAccount => Ok(Self::UninitializedAccount), | ||
| Self::Error::NotEnoughAccountKeys => Ok(Self::NotEnoughAccountKeys), | ||
| Self::Error::AccountBorrowFailed => Ok(Self::AccountBorrowFailed), | ||
| Self::Error::MaxSeedLengthExceeded => Ok(Self::MaxSeedLengthExceeded), | ||
| Self::Error::InvalidSeeds => Ok(Self::InvalidSeeds), | ||
| Self::Error::BorshIoError => Ok(Self::BorshIoError), | ||
| Self::Error::AccountNotRentExempt => Ok(Self::AccountNotRentExempt), | ||
| Self::Error::UnsupportedSysvar => Ok(Self::UnsupportedSysvar), | ||
| Self::Error::IllegalOwner => Ok(Self::IllegalOwner), | ||
| Self::Error::MaxAccountsDataAllocationsExceeded => { | ||
| Ok(Self::MaxAccountsDataAllocationsExceeded) | ||
| } | ||
| Self::Error::InvalidRealloc => Ok(Self::InvalidRealloc), | ||
| Self::Error::MaxInstructionTraceLengthExceeded => { | ||
| Ok(Self::MaxInstructionTraceLengthExceeded) | ||
| } | ||
| Self::Error::BuiltinProgramsMustConsumeComputeUnits => { | ||
| Ok(Self::BuiltinProgramsMustConsumeComputeUnits) | ||
| } | ||
| Self::Error::InvalidAccountOwner => Ok(Self::InvalidAccountOwner), | ||
| Self::Error::ArithmeticOverflow => Ok(Self::ArithmeticOverflow), | ||
| Self::Error::Immutable => Ok(Self::Immutable), | ||
| Self::Error::IncorrectAuthority => Ok(Self::IncorrectAuthority), | ||
| _ => Err(error), | ||
| } | ||
| } | ||
| } | ||
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.