Skip to content

Add the inner instruction index and address of erroring programs to TransactionError::InstructionError #6083

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.

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
278 changes: 51 additions & 227 deletions Cargo.lock

Large diffs are not rendered by default.

100 changes: 100 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -681,3 +681,103 @@ crossbeam-epoch = { git = "https://github.com/anza-xyz/crossbeam", rev = "fd279d
# comments and the overrides in sync.
solana-curve25519 = { path = "curves/curve25519" }
solana-zk-sdk = { path = "zk-sdk" }

# The following entries are auto-generated by /bin/bash
Copy link
Author

Choose a reason for hiding this comment

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

Ignore this. This will disappear when anza-xyz/solana-sdk#74 is released.

solana-account = { path = "/home/sol/src/solana-sdk/account" }
solana-account-info = { path = "/home/sol/src/solana-sdk/account-info" }
solana-address-lookup-table-interface = { path = "/home/sol/src/solana-sdk/address-lookup-table-interface" }
solana-atomic-u64 = { path = "/home/sol/src/solana-sdk/atomic-u64" }
solana-big-mod-exp = { path = "/home/sol/src/solana-sdk/big-mod-exp" }
solana-bincode = { path = "/home/sol/src/solana-sdk/bincode" }
solana-blake3-hasher = { path = "/home/sol/src/solana-sdk/blake3-hasher" }
solana-bn254 = { path = "/home/sol/src/solana-sdk/bn254" }
solana-borsh = { path = "/home/sol/src/solana-sdk/borsh" }
solana-client-traits = { path = "/home/sol/src/solana-sdk/client-traits" }
solana-clock = { path = "/home/sol/src/solana-sdk/clock" }
solana-cluster-type = { path = "/home/sol/src/solana-sdk/cluster-type" }
solana-commitment-config = { path = "/home/sol/src/solana-sdk/commitment-config" }
solana-compute-budget-interface = { path = "/home/sol/src/solana-sdk/compute-budget-interface" }
solana-cpi = { path = "/home/sol/src/solana-sdk/cpi" }
solana-decode-error = { path = "/home/sol/src/solana-sdk/decode-error" }
solana-define-syscall = { path = "/home/sol/src/solana-sdk/define-syscall" }
solana-derivation-path = { path = "/home/sol/src/solana-sdk/derivation-path" }
solana-ed25519-program = { path = "/home/sol/src/solana-sdk/ed25519-program" }
solana-epoch-info = { path = "/home/sol/src/solana-sdk/epoch-info" }
solana-epoch-rewards = { path = "/home/sol/src/solana-sdk/epoch-rewards" }
solana-epoch-rewards-hasher = { path = "/home/sol/src/solana-sdk/epoch-rewards-hasher" }
solana-epoch-schedule = { path = "/home/sol/src/solana-sdk/epoch-schedule" }
solana-example-mocks = { path = "/home/sol/src/solana-sdk/example-mocks" }
solana-feature-gate-interface = { path = "/home/sol/src/solana-sdk/feature-gate-interface" }
solana-feature-set = { path = "/home/sol/src/solana-sdk/feature-set" }
solana-fee-calculator = { path = "/home/sol/src/solana-sdk/fee-calculator" }
solana-fee-structure = { path = "/home/sol/src/solana-sdk/fee-structure" }
solana-file-download = { path = "/home/sol/src/solana-sdk/file-download" }
solana-frozen-abi = { path = "/home/sol/src/solana-sdk/frozen-abi" }
solana-frozen-abi-macro = { path = "/home/sol/src/solana-sdk/frozen-abi-macro" }
solana-genesis-config = { path = "/home/sol/src/solana-sdk/genesis-config" }
solana-hard-forks = { path = "/home/sol/src/solana-sdk/hard-forks" }
solana-hash = { path = "/home/sol/src/solana-sdk/hash" }
solana-inflation = { path = "/home/sol/src/solana-sdk/inflation" }
solana-instruction = { path = "/home/sol/src/solana-sdk/instruction" }
solana-instructions-sysvar = { path = "/home/sol/src/solana-sdk/instructions-sysvar" }
solana-keccak-hasher = { path = "/home/sol/src/solana-sdk/keccak-hasher" }
solana-keypair = { path = "/home/sol/src/solana-sdk/keypair" }
solana-last-restart-slot = { path = "/home/sol/src/solana-sdk/last-restart-slot" }
solana-loader-v2-interface = { path = "/home/sol/src/solana-sdk/loader-v2-interface" }
solana-loader-v3-interface = { path = "/home/sol/src/solana-sdk/loader-v3-interface" }
solana-loader-v4-interface = { path = "/home/sol/src/solana-sdk/loader-v4-interface" }
solana-logger = { path = "/home/sol/src/solana-sdk/logger" }
solana-message = { path = "/home/sol/src/solana-sdk/message" }
solana-msg = { path = "/home/sol/src/solana-sdk/msg" }
solana-native-token = { path = "/home/sol/src/solana-sdk/native-token" }
solana-nonce = { path = "/home/sol/src/solana-sdk/nonce" }
solana-nonce-account = { path = "/home/sol/src/solana-sdk/nonce-account" }
solana-offchain-message = { path = "/home/sol/src/solana-sdk/offchain-message" }
solana-package-metadata = { path = "/home/sol/src/solana-sdk/package-metadata" }
solana-package-metadata-macro = { path = "/home/sol/src/solana-sdk/package-metadata-macro" }
solana-packet = { path = "/home/sol/src/solana-sdk/packet" }
solana-poh-config = { path = "/home/sol/src/solana-sdk/poh-config" }
solana-precompile-error = { path = "/home/sol/src/solana-sdk/precompile-error" }
solana-precompiles = { path = "/home/sol/src/solana-sdk/precompiles" }
solana-presigner = { path = "/home/sol/src/solana-sdk/presigner" }
solana-program = { path = "/home/sol/src/solana-sdk/program" }
solana-program-entrypoint = { path = "/home/sol/src/solana-sdk/program-entrypoint" }
solana-program-error = { path = "/home/sol/src/solana-sdk/program-error" }
solana-program-memory = { path = "/home/sol/src/solana-sdk/program-memory" }
solana-program-option = { path = "/home/sol/src/solana-sdk/program-option" }
solana-program-pack = { path = "/home/sol/src/solana-sdk/program-pack" }
solana-pubkey = { path = "/home/sol/src/solana-sdk/pubkey" }
solana-quic-definitions = { path = "/home/sol/src/solana-sdk/quic-definitions" }
solana-rent = { path = "/home/sol/src/solana-sdk/rent" }
solana-rent-collector = { path = "/home/sol/src/solana-sdk/rent-collector" }
solana-rent-debits = { path = "/home/sol/src/solana-sdk/rent-debits" }
solana-reserved-account-keys = { path = "/home/sol/src/solana-sdk/reserved-account-keys" }
solana-reward-info = { path = "/home/sol/src/solana-sdk/reward-info" }
solana-sanitize = { path = "/home/sol/src/solana-sdk/sanitize" }
solana-sdk = { path = "/home/sol/src/solana-sdk/sdk" }
solana-sdk-ids = { path = "/home/sol/src/solana-sdk/sdk-ids" }
solana-sdk-macro = { path = "/home/sol/src/solana-sdk/sdk-macro" }
solana-secp256k1-program = { path = "/home/sol/src/solana-sdk/secp256k1-program" }
solana-secp256k1-recover = { path = "/home/sol/src/solana-sdk/secp256k1-recover" }
solana-secp256r1-program = { path = "/home/sol/src/solana-sdk/secp256r1-program" }
solana-seed-derivable = { path = "/home/sol/src/solana-sdk/seed-derivable" }
solana-seed-phrase = { path = "/home/sol/src/solana-sdk/seed-phrase" }
solana-serde = { path = "/home/sol/src/solana-sdk/serde" }
solana-serde-varint = { path = "/home/sol/src/solana-sdk/serde-varint" }
solana-serialize-utils = { path = "/home/sol/src/solana-sdk/serialize-utils" }
solana-sha256-hasher = { path = "/home/sol/src/solana-sdk/sha256-hasher" }
solana-short-vec = { path = "/home/sol/src/solana-sdk/short-vec" }
solana-shred-version = { path = "/home/sol/src/solana-sdk/shred-version" }
solana-signature = { path = "/home/sol/src/solana-sdk/signature" }
solana-signer = { path = "/home/sol/src/solana-sdk/signer" }
solana-slot-hashes = { path = "/home/sol/src/solana-sdk/slot-hashes" }
solana-slot-history = { path = "/home/sol/src/solana-sdk/slot-history" }
solana-stable-layout = { path = "/home/sol/src/solana-sdk/stable-layout" }
solana-system-transaction = { path = "/home/sol/src/solana-sdk/system-transaction" }
solana-sysvar = { path = "/home/sol/src/solana-sdk/sysvar" }
solana-sysvar-id = { path = "/home/sol/src/solana-sdk/sysvar-id" }
solana-time-utils = { path = "/home/sol/src/solana-sdk/time-utils" }
solana-transaction = { path = "/home/sol/src/solana-sdk/transaction" }
solana-transaction-error = { path = "/home/sol/src/solana-sdk/transaction-error" }
solana-validator-exit = { path = "/home/sol/src/solana-sdk/validator-exit" }
solana-vote-interface = { path = "/home/sol/src/solana-sdk/vote-interface" }
1 change: 1 addition & 0 deletions cli-output/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ solana-sysvar = { workspace = true }
solana-transaction = { workspace = true, features = ["verify"] }
solana-transaction-error = { workspace = true }
solana-transaction-status = { workspace = true }
solana-transaction-status-client-types = { workspace = true }
solana-vote-program = { workspace = true }
spl-memo = { workspace = true, features = ["no-entrypoint"] }

Expand Down
7 changes: 4 additions & 3 deletions cli-output/src/display.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ use {
solana_pubkey::Pubkey,
solana_signature::Signature,
solana_transaction::versioned::{TransactionVersion, VersionedTransaction},
solana_transaction_error::TransactionError,
solana_transaction_error::TransactionResult,
solana_transaction_status::{
Rewards, UiReturnDataEncoding, UiTransactionReturnData, UiTransactionStatusMeta,
},
solana_transaction_status_client_types::UiTransactionResult,
spl_memo::{id as spl_memo_id, v1::id as spl_memo_v1_id},
std::{collections::HashMap, fmt, io, time::Duration},
};
Expand Down Expand Up @@ -541,14 +542,14 @@ fn write_rewards<W: io::Write>(

fn write_status<W: io::Write>(
w: &mut W,
transaction_status: &Result<(), TransactionError>,
transaction_status: &UiTransactionResult<()>,
prefix: &str,
) -> io::Result<()> {
writeln!(
w,
"{}Status: {}",
prefix,
match transaction_status {
match Into::<TransactionResult<()>>::into(transaction_status.clone()) {
Ok(_) => "Ok".into(),
Err(err) => err.to_string(),
}
Expand Down
1 change: 1 addition & 0 deletions cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ solana-tpu-client = { workspace = true, features = ["default"] }
solana-transaction = "=2.2.2"
solana-transaction-error = "=2.2.1"
solana-transaction-status = { workspace = true }
solana-transaction-status-client-types = { workspace = true }
solana-udp-client = { workspace = true }
solana-version = { workspace = true }
solana-vote-program = { workspace = true }
Expand Down
2 changes: 1 addition & 1 deletion cli/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1768,7 +1768,7 @@ where
match result {
Err(err) => {
let maybe_tx_err = err.get_transaction_error();
if let Some(TransactionError::InstructionError(_, ix_error)) = maybe_tx_err {
if let Some(TransactionError::InstructionError { err: ix_error, .. }) = maybe_tx_err {
if let Some(specific_error) = error_adapter(&ix_error) {
return Err(specific_error.into());
}
Expand Down
4 changes: 2 additions & 2 deletions cli/src/cluster_query.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2155,7 +2155,7 @@ pub fn process_transaction_history(
signature.verbose = Some(CliHistoryVerbose {
slot: result.slot,
block_time: result.block_time,
err: result.err,
err: result.err.map(Into::into),
confirmation_status: result.confirmation_status,
memo: result.memo,
});
Expand Down Expand Up @@ -2209,7 +2209,7 @@ pub fn process_transaction_history(
confirmation_status: result.confirmation_status,
transaction,
get_transaction_error,
err: result.err,
err: result.err.map(Into::into),
});
}
}
Expand Down
3 changes: 2 additions & 1 deletion cli/src/compute_budget.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use {
solana_rpc_client::rpc_client::RpcClient,
solana_rpc_client_api::config::RpcSimulateTransactionConfig,
solana_transaction::Transaction,
solana_transaction_status_client_types::UiTransactionError,
};

/// Enum capturing the possible results of updating a message based on the
Expand Down Expand Up @@ -56,7 +57,7 @@ fn simulate_for_compute_unit_limit_unchecked(
.value;

// Bail if the simulated transaction failed
if let Some(err) = simulate_result.err {
if let Some(UiTransactionError(err)) = simulate_result.err {
return Err(err.into());
}

Expand Down
32 changes: 16 additions & 16 deletions cli/src/program.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2224,16 +2224,16 @@ fn close(
config.send_transaction_config,
);
if let Err(err) = result {
if let ClientErrorKind::TransactionError(TransactionError::InstructionError(
_,
InstructionError::InvalidInstructionData,
)) = err.kind()
if let ClientErrorKind::TransactionError(TransactionError::InstructionError {
err: InstructionError::InvalidInstructionData,
..
}) = err.kind()
{
return Err("Closing a buffer account is not supported by the cluster".into());
} else if let ClientErrorKind::TransactionError(TransactionError::InstructionError(
_,
InstructionError::InvalidArgument,
)) = err.kind()
} else if let ClientErrorKind::TransactionError(TransactionError::InstructionError {
err: InstructionError::InvalidArgument,
..
}) = err.kind()
{
return Err("Closing a program account is not supported by the cluster".into());
} else {
Expand Down Expand Up @@ -2465,10 +2465,10 @@ fn process_extend_program(
config.send_transaction_config,
);
if let Err(err) = result {
if let ClientErrorKind::TransactionError(TransactionError::InstructionError(
_,
InstructionError::InvalidInstructionData,
)) = err.kind()
if let ClientErrorKind::TransactionError(TransactionError::InstructionError {
err: InstructionError::InvalidInstructionData,
..
}) = err.kind()
{
return Err("Extending a program is not supported by the cluster".into());
} else {
Expand Down Expand Up @@ -2560,10 +2560,10 @@ fn process_migrate_program(
config.send_transaction_config,
);
if let Err(err) = result {
if let ClientErrorKind::TransactionError(TransactionError::InstructionError(
_,
InstructionError::InvalidInstructionData,
)) = err.kind()
if let ClientErrorKind::TransactionError(TransactionError::InstructionError {
err: InstructionError::InvalidInstructionData,
..
}) = err.kind()
{
return Err("Migrating a program is not supported by the cluster".into());
} else {
Expand Down
1 change: 1 addition & 0 deletions client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ solana-time-utils = { workspace = true }
solana-tpu-client = { workspace = true, features = ["default"] }
solana-transaction = { workspace = true }
solana-transaction-error = { workspace = true }
solana-transaction-status-client-types = { workspace = true }
solana-udp-client = { workspace = true }
thiserror = { workspace = true }
tokio = { workspace = true, features = ["full"] }
Expand Down
5 changes: 3 additions & 2 deletions client/src/send_and_confirm_transactions_in_parallel.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ use {
solana_tpu_client::tpu_client::{Result, TpuSenderError},
solana_transaction::Transaction,
solana_transaction_error::TransactionError,
solana_transaction_status_client_types::UiTransactionError,
std::{
sync::{
atomic::{AtomicU64, AtomicUsize, Ordering},
Expand Down Expand Up @@ -289,7 +290,7 @@ async fn send_transaction_with_rpc_fallback(
data:
RpcResponseErrorData::SendTransactionPreflightFailure(
RpcSimulateTransactionResult {
err: Some(TransactionError::BlockhashNotFound),
err: Some(UiTransactionError(TransactionError::BlockhashNotFound)),
..
},
),
Expand All @@ -302,7 +303,7 @@ async fn send_transaction_with_rpc_fallback(
data:
RpcResponseErrorData::SendTransactionPreflightFailure(
RpcSimulateTransactionResult {
err: Some(transaction_error),
err: Some(UiTransactionError(transaction_error)),
..
},
),
Expand Down
1 change: 1 addition & 0 deletions compute-budget-instruction/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ crate-type = ["lib"]
name = "solana_compute_budget_instruction"

[dev-dependencies]
assert_matches = { workspace = true }

Choose a reason for hiding this comment

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

Was this change intended?

bincode = { workspace = true }
criterion = { workspace = true }
rand = { workspace = true }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use {
solana_compute_budget_interface::ComputeBudgetInstruction,
solana_instruction::error::InstructionError,
solana_pubkey::Pubkey,
solana_sdk_ids::compute_budget,
solana_svm_transaction::instruction::SVMInstruction,
solana_transaction_error::{TransactionError, TransactionResult as Result},
std::num::{NonZeroU32, Saturating},
Expand Down Expand Up @@ -103,20 +104,23 @@ impl ComputeBudgetInstructionDetails {
feature_set: &FeatureSet,
) -> Result<ComputeBudgetLimits> {
// Sanitize requested heap size
let updated_heap_bytes =
if let Some((index, requested_heap_size)) = self.requested_heap_size {
if Self::sanitize_requested_heap_size(requested_heap_size) {
requested_heap_size
} else {
return Err(TransactionError::InstructionError(
index,
InstructionError::InvalidInstructionData,
));
}
let updated_heap_bytes = if let Some((outer_instruction_index, requested_heap_size)) =
self.requested_heap_size
{
if Self::sanitize_requested_heap_size(requested_heap_size) {
requested_heap_size
} else {
MIN_HEAP_FRAME_BYTES
return Err(TransactionError::InstructionError {
err: InstructionError::InvalidInstructionData,
inner_instruction_index: None,
outer_instruction_index,
responsible_program_address: Some(compute_budget::id()),
});
}
.min(MAX_HEAP_FRAME_BYTES);
} else {
MIN_HEAP_FRAME_BYTES
}
.min(MAX_HEAP_FRAME_BYTES);

// Calculate compute unit limit
let compute_unit_limit = self
Expand Down Expand Up @@ -153,8 +157,12 @@ impl ComputeBudgetInstructionDetails {
}

fn process_instruction(&mut self, index: u8, instruction: &SVMInstruction) -> Result<()> {
let invalid_instruction_data_error =
TransactionError::InstructionError(index, InstructionError::InvalidInstructionData);
let invalid_instruction_data_error = TransactionError::InstructionError {
err: InstructionError::InvalidInstructionData,
inner_instruction_index: None,
outer_instruction_index: index,
responsible_program_address: Some(compute_budget::id()),
};
let duplicate_instruction_error = TransactionError::DuplicateInstruction(index);

match try_from_slice_unchecked(instruction.data) {
Expand Down Expand Up @@ -404,10 +412,12 @@ mod test {
})
);

let expected_heap_size_err = Err(TransactionError::InstructionError(
3,
InstructionError::InvalidInstructionData,
));
let expected_heap_size_err = Err(TransactionError::InstructionError {
err: InstructionError::InvalidInstructionData,
inner_instruction_index: None,
outer_instruction_index: 3,
responsible_program_address: Some(compute_budget::id()),
});
// invalid: requested_heap_size can't be zero
let instruction_details = ComputeBudgetInstructionDetails {
requested_compute_unit_limit: Some((1, 0)),
Expand Down
Loading