Skip to content

feature: mpl-utils: Log assert failures for easier debugging #1163

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feature: mpl-utils: Log assert failures for easier debugging #1163

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f15e902
utils: Log assert failures for easier debugging
KartikSoneji Nov 11, 2023
89d86ff
Replace `sol_log(format!())` with `msg!()`
KartikSoneji Nov 20, 2023
d687949
Remove extra `\n`
KartikSoneji Nov 22, 2023
433aa54
Shorten assert failure log messages
KartikSoneji Nov 30, 2023
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
29 changes: 29 additions & 0 deletions core/rust/utils/src/assertions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use solana_program::{
account_info::AccountInfo,
entrypoint::ProgramResult,
msg,
program_error::ProgramError,
program_pack::{IsInitialized, Pack},
pubkey::Pubkey,
Expand All @@ -9,6 +10,10 @@ use solana_program::{

pub fn assert_signer(account_info: &AccountInfo) -> ProgramResult {
if !account_info.is_signer {
msg!(
"signer assertion failed for {key}: not signer",
key = account_info.key,
);
Err(ProgramError::MissingRequiredSignature)
} else {
Ok(())
Expand All @@ -21,6 +26,10 @@ pub fn assert_initialized<T: Pack + IsInitialized>(
) -> Result<T, ProgramError> {
let account: T = T::unpack_unchecked(&account_info.data.borrow())?;
if !account.is_initialized() {
msg!(
"initialized assertion failed for {key}: not initialized",
key = account_info.key,
);
Err(error.into())
} else {
Ok(account)
Expand All @@ -33,6 +42,12 @@ pub fn assert_owned_by(
error: impl Into<ProgramError>,
) -> ProgramResult {
if account.owner != owner {
msg!(
"owner assertion failed for {key}: expected {expected}, got {actual}",
Copy link
Contributor

@febo febo Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"invalid owner for {key} ({actual} != {expected})"

key = account.key,
expected = owner,
actual = account.owner
);
Err(error.into())
} else {
Ok(())
Expand All @@ -47,6 +62,14 @@ pub fn assert_derivation(
) -> Result<u8, ProgramError> {
let (key, bump) = Pubkey::find_program_address(path, program_id);
if key != *account.key {
msg!(
"derivation assertion failed for {actual_key}:\n
Copy link
Contributor

@febo febo Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"invalid derivation {actual_key} != {key}"

Copy link
Contributor Author

@KartikSoneji KartikSoneji Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like \n is not needed, I'll remove that.

\x20 expected {key} with program {program_id}, path {path:?}",
actual_key = account.key,
key = key,
program_id = program_id,
path = path,
);
return Err(error.into());
}
Ok(bump)
Expand All @@ -58,6 +81,12 @@ pub fn assert_rent_exempt(
error: impl Into<ProgramError>,
) -> ProgramResult {
if !rent.is_exempt(account_info.lamports(), account_info.data_len()) {
msg!(
"rent exempt assertion failed for {key}: has {balance} lamports, requires at least {min} lamports",
key = account_info.key,
balance = account_info.lamports(),
min = rent.minimum_balance(account_info.data_len()),
);
Err(error.into())
} else {
Ok(())
Expand Down