Skip to content

Improve errors #293

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

Merged
merged 1 commit into from
Sep 14, 2022
Merged

Improve errors #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion program/rust/src/deserialize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ pub fn load_checked<'a, T: PythAccount>(
account_header.magic_number == PC_MAGIC
&& account_header.version == version
&& account_header.account_type == T::ACCOUNT_TYPE,
ProgramError::InvalidArgument,
OracleError::InvalidAccountHeader.into(),
)?;
}

Expand Down
4 changes: 4 additions & 0 deletions program/rust/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ pub enum OracleError {
InvalidUpgradeAuthority = 614,
#[error("FailedPdaVerification")]
InvalidPda = 615,
#[error("InvalidAccountHeader")]
InvalidAccountHeader = 616,
#[error("InvalidNumberOfAccounts")]
Copy link
Contributor

@tompntn tompntn Sep 14, 2022

Choose a reason for hiding this comment

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

nit: the error attribute is supposed to be a human-readable explanation of the error - for example invalid number of accounts passed. This representation can then be used in logs and user-facing error messages, without the need to map the errors to strings.

InvalidNumberOfAccounts = 617,
}

impl From<OracleError> for ProgramError {
Expand Down
28 changes: 14 additions & 14 deletions program/rust/src/rust_oracle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ pub fn resize_price_account(
) -> ProgramResult {
let [funding_account_info, price_account_info, system_program] = match accounts {
[x, y, z] => Ok([x, y, z]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account_info)?;
Expand Down Expand Up @@ -148,7 +148,7 @@ pub fn init_mapping(
) -> ProgramResult {
let [funding_account, fresh_mapping_account] = match accounts {
[x, y] => Ok([x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand All @@ -168,7 +168,7 @@ pub fn add_mapping(
) -> ProgramResult {
let [funding_account, cur_mapping, next_mapping] = match accounts {
[x, y, z] => Ok([x, y, z]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -203,7 +203,7 @@ pub fn upd_price(
let [funding_account, price_account, clock_account] = match accounts {
[x, y, z] => Ok([x, y, z]),
[x, y, _, z] => Ok([x, y, z]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -319,7 +319,7 @@ pub fn add_price(

let [funding_account, product_account, price_account] = match accounts {
[x, y, z] => Ok([x, y, z]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -354,7 +354,7 @@ pub fn del_price(
) -> ProgramResult {
let [funding_account, product_account, price_account] = match accounts {
[w, x, y] => Ok([w, x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -399,7 +399,7 @@ pub fn init_price(

let [funding_account, price_account] = match accounts {
[x, y] => Ok([x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -469,7 +469,7 @@ pub fn add_publisher(

let [funding_account, price_account] = match accounts {
[x, y] => Ok([x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -519,7 +519,7 @@ pub fn del_publisher(

let [funding_account, price_account] = match accounts {
[x, y] => Ok([x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -555,7 +555,7 @@ pub fn add_product(
) -> ProgramResult {
let [funding_account, tail_mapping_account, new_product_account] = match accounts {
[x, y, z] => Ok([x, y, z]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -592,7 +592,7 @@ pub fn upd_product(
) -> ProgramResult {
let [funding_account, product_account] = match accounts {
[x, y] => Ok([x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -657,7 +657,7 @@ pub fn set_min_pub(

let [funding_account, price_account] = match accounts {
[x, y] => Ok([x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand All @@ -683,7 +683,7 @@ pub fn del_product(
) -> ProgramResult {
let [funding_account, mapping_account, product_account] = match accounts {
[w, x, y] => Ok([w, x, y]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

check_valid_funding_account(funding_account)?;
Expand Down Expand Up @@ -751,7 +751,7 @@ pub fn upd_permissions(
let [funding_account, program_account, programdata_account, permissions_account, system_program] =
match accounts {
[v, w, x, y, z] => Ok([v, w, x, y, z]),
_ => Err(ProgramError::InvalidArgument),
_ => Err(OracleError::InvalidNumberOfAccounts),
}?;

let cmd_args = load::<UpdPermissionsArgs>(instruction_data)?;
Expand Down
3 changes: 2 additions & 1 deletion program/rust/src/tests/test_add_mapping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use crate::deserialize::{
load_account_as_mut,
load_checked,
};
use crate::error::OracleError;
use crate::instruction::{
CommandHeader,
OracleCommand,
Expand Down Expand Up @@ -98,7 +99,7 @@ fn test_add_mapping() {
],
instruction_data
),
Err(ProgramError::InvalidArgument)
Err(OracleError::InvalidAccountHeader.into())
);

{
Expand Down
4 changes: 2 additions & 2 deletions program/rust/src/tests/test_add_price.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ fn test_add_price() {
&[funding_account.clone(), product_account.clone()],
instruction_data_add_price
),
Err(ProgramError::InvalidArgument)
Err(OracleError::InvalidNumberOfAccounts.into())
);

// Price account is already initialized
Expand Down Expand Up @@ -191,6 +191,6 @@ fn test_add_price() {
],
instruction_data_add_price
),
Err(ProgramError::InvalidArgument)
Err(OracleError::InvalidAccountHeader.into())
);
}
2 changes: 1 addition & 1 deletion program/rust/src/tests/test_add_publisher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ fn test_add_publisher() {
&[funding_account.clone(), price_account.clone(),],
instruction_data
),
Err(ProgramError::InvalidArgument)
Err(OracleError::InvalidAccountHeader.into())
);

initialize_pyth_account_checked::<PriceAccount>(&price_account, PC_VERSION).unwrap();
Expand Down
3 changes: 1 addition & 2 deletions program/rust/src/tests/test_init_mapping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ use crate::processor::process_instruction;
use crate::tests::test_utils::AccountSetup;
use crate::utils::clear_account;
use bytemuck::bytes_of;
use solana_program::program_error::ProgramError;
use solana_program::pubkey::Pubkey;
use std::cell::RefCell;
use std::rc::Rc;
Expand Down Expand Up @@ -62,7 +61,7 @@ fn test_init_mapping() {

assert_eq!(
process_instruction(&program_id, &[funding_account.clone()], instruction_data),
Err(ProgramError::InvalidArgument)
Err(OracleError::InvalidNumberOfAccounts.into())
);

funding_account.is_signer = false;
Expand Down
2 changes: 1 addition & 1 deletion program/rust/src/tests/test_init_price.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ fn test_init_price() {
&[funding_account.clone(), price_account.clone()],
instruction_data
),
Err(ProgramError::InvalidArgument)
Err(OracleError::InvalidAccountHeader.into())
);

initialize_pyth_account_checked::<PriceAccount>(&price_account, PC_VERSION).unwrap();
Expand Down