Add Custom Errors for Better Debugging #266
Open
Conversation
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
febo
reviewed
Oct 23, 2025
|
|
||
| /// Defines a custom error macro to create custom errors in pinocchio framework | ||
| #[proc_macro_derive(ErrorCode, attributes(msg))] | ||
| pub fn error_code(input: TokenStream) -> TokenStream { |
There was a problem hiding this comment.
This seems to replicate the logic from thiserror, so not sure if that is necessary.
febo
reviewed
Oct 23, 2025
Comment on lines
+301
to
+313
| // If the error type has a `message()` function, call it. | ||
| // Otherwise, do nothing. | ||
| #[allow(unused_variables)] | ||
| { | ||
| if false { | ||
| // just to scope-check type | ||
| } else { | ||
| #[allow(unused_unsafe)] | ||
| unsafe { | ||
| $crate::msg!($error.message()); | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
This is super strange. I am not sure why it is not written just like:
$crate::msg!($error.message());Also, it is inefficient in terms of program size since it will generate a call to the log syscall in every use of require!. It would be much better to follow a pattern where any error is printed at the end of the process_instruction, similar to p-token: https://github.com/solana-program/token/blob/main/pinocchio/program/src/entrypoint.rs#L258
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #253
Overview
This PR introduces custom error definitions and enhanced logging for program errors.
Currently, when a custom error occurs, the output is not very informative:
This lack of clarity increases debugging time for developers and can be particularly problematic when deployed on-chain.
Problem
Solution
By defining custom errors and leveraging enhanced logging, this PR aims to reduce debugging time significantly for contracts built on Pinocchio.
Implementation
pinocchio_errcrate:require!macro from thepinocchiocrate to return program errors:Result
When a custom error occurs, the output becomes clear and actionable:
This improvement helps developers quickly identify and resolve issues, making on-chain program debugging far more efficient.