Skip to content

chore(ICP_Rosetta): DEFI-2459: Improve ICP Rosetta logging and errors #7625

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 3 commits into from
Nov 19, 2025
+217 −80
Merged

chore(ICP_Rosetta): DEFI-2459: Improve ICP Rosetta logging and errors #7625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
916679c
Start adding some logging and improve errors for construction/payloads
mbjorkqvist Nov 10, 2025
6446ce1
More informative error messages and debug logs for ICP Rosetta
mbjorkqvist Nov 11, 2025
2e83cda
Rustfmt
mbjorkqvist Nov 11, 2025
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
88 changes: 74 additions & 14 deletions rs/rosetta-api/icp/src/convert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
mod state;

use crate::errors::Details;
use crate::{
convert,
convert::state::State,
Expand Down Expand Up @@ -42,6 +43,7 @@ use on_wire::{FromWire, IntoWire};
use rosetta_core::convert::principal_id_from_public_key;
use serde_json::{Number, Value, from_value, map::Map};
use std::convert::{TryFrom, TryInto};
use tracing::log::debug;

/// This module converts from ledger_canister data structures to Rosetta data
/// structures
Expand Down Expand Up @@ -111,8 +113,15 @@ pub fn operations_to_requests(
if o.coin_change.is_some() {
return Err(op_error(o, "Coin changes are not permitted".into()));
}
let account = from_model_account_identifier(o.account.as_ref().unwrap())
.map_err(|e| op_error(o, e))?;
let account = from_model_account_identifier(o.account.as_ref().unwrap()).map_err(|e| {
op_error(
o,
format!(
"error converting '{:?}' to account identifier: {e:?}",
o.account.as_ref()
),
)
})?;

let validate_neuron_management_op = || {
if o.amount.is_some() && o.type_.parse::<OperationType>()? != OperationType::Disburse {
Expand All @@ -136,13 +145,25 @@ pub fn operations_to_requests(
}
};

match o.type_.parse::<OperationType>()? {
let parsed_type = o.type_.parse::<OperationType>().map_err(|e| {
let err_msg = format!("Error parsing operation type '{}': {e}", o.type_);
debug!("{}", err_msg);
ApiError::InvalidTransaction(false, Details::from(err_msg))
})?;
match parsed_type {
OperationType::Transaction => {
let amount = o
.amount
.as_ref()
.ok_or_else(|| op_error(o, "Amount must be populated".into()))?;
let amount = from_amount(amount, token_name).map_err(|e| op_error(o, e))?;
let amount = from_amount(amount, token_name).map_err(|e| {
let err_msg = format!(
"Transaction - Error converting amount (value: {}, currency: {:?}): {e}",
amount.value, amount.currency
);
debug!("{}", err_msg);
op_error(o, err_msg)
})?;
state.transaction(account, amount)?;
}
OperationType::Approve => {
Expand All @@ -156,29 +177,45 @@ pub fn operations_to_requests(
.amount
.as_ref()
.ok_or_else(|| op_error(o, "Amount must be populated".into()))?;
let amount = from_amount(amount, token_name).map_err(|e| op_error(o, e))?;
let amount = from_amount(amount, token_name).map_err(|e| {
let err_msg = format!(
"Fee - Error converting amount (value: {}, currency: {:?}): {e}",
amount.value, amount.currency
);
debug!("{}", err_msg);
op_error(o, err_msg)
})?;
state.fee(account, Tokens::from_e8s((-amount) as u64))?;
}
OperationType::Stake => {
validate_neuron_management_op()?;
let NeuronIdentifierMetadata { neuron_index, .. } =
o.metadata.clone().try_into()?;
NeuronIdentifierMetadata::try_from(o.metadata.clone()).map_err(|e| {
let err_msg =
format!("Stake - Failed to parse neuron identifier metadata: {e:?}");
debug!("{}", err_msg);
e
})?;
state.stake(account, neuron_index)?;
}
OperationType::SetDissolveTimestamp => {
validate_neuron_management_op()?;
let SetDissolveTimestampMetadata {
neuron_index,
timestamp,
} = o.metadata.clone().try_into()?;
} = SetDissolveTimestampMetadata::try_from(o.metadata.clone()).map_err(|e| {
let err_msg = format!("SetDissolveTimestamp - Failed to parse metadata: {e:?}");
debug!("{}", err_msg);
e
})?;
state.set_dissolve_timestamp(account, neuron_index, timestamp)?;
}
OperationType::ChangeAutoStakeMaturity => {
validate_neuron_management_op()?;
let ChangeAutoStakeMaturityMetadata {
neuron_index,
requested_setting_for_auto_stake_maturity,
} = o.metadata.clone().try_into()?;
} = ChangeAutoStakeMaturityMetadata::try_from(o.metadata.clone())?;
state.change_auto_stake_maturity(
account,
neuron_index,
Expand Down Expand Up @@ -212,11 +249,20 @@ pub fn operations_to_requests(
let DisburseMetadata {
neuron_index,
recipient,
} = o.metadata.clone().try_into()?;
} = o.metadata.clone().try_into().map_err(|e| {
let err_msg = format!("Disburse - Failed to parse metadata: {e:?}");
debug!("{}", err_msg);
e
})?;
validate_neuron_management_op()?;
let amount = if let Some(ref amount) = o.amount {
Some(ledgeramount_from_amount(amount, token_name).map_err(|e| {
ApiError::internal_error(format!("Could not convert Amount {e:?}"))
let err_msg = format!(
"Disburse - Could not convert amount (value: {}, currency: {:?}): {e:?}",
amount.value, amount.currency
);
debug!("{}", err_msg);
ApiError::internal_error(err_msg)
})?)
} else {
None
Expand All @@ -243,7 +289,11 @@ pub fn operations_to_requests(
controller,
percentage_to_spawn,
spawned_neuron_index,
} = o.metadata.clone().try_into()?;
} = o.metadata.clone().try_into().map_err(|e| {
let err_msg = format!("Spawn - Failed to parse metadata: {e:?}");
debug!("{}", err_msg);
e
})?;
validate_neuron_management_op()?;
state.spawn(
account,
Expand Down Expand Up @@ -301,7 +351,11 @@ pub fn operations_to_requests(
followees,
controller,
neuron_index,
} = o.metadata.clone().try_into()?;
} = o.metadata.clone().try_into().map_err(|e| {
let err_msg = format!("Follow - Failed to parse metadata: {e:?}");
debug!("{}", err_msg);
e
})?;
validate_neuron_management_op()?;
// convert from pkp in operation to principal in request.
let pid = match controller {
Expand Down Expand Up @@ -433,8 +487,14 @@ pub fn principal_id_from_public_key_or_principal(
) -> Result<PrincipalId, ApiError> {
match pkp {
PublicKeyOrPrincipal::Principal(p) => Ok(p),
PublicKeyOrPrincipal::PublicKey(pk) => principal_id_from_public_key(&pk)
.map_err(|err| ApiError::InvalidPublicKey(false, err.into())),
PublicKeyOrPrincipal::PublicKey(pk) => principal_id_from_public_key(&pk).map_err(|err| {
let err_msg = format!(
"Failed to derive principal ID from public key (curve_type: {:?}): {err:?}",
pk.curve_type
);
debug!("{}", err_msg);
ApiError::InvalidPublicKey(false, Details::from(err_msg))
}),
}
}

Expand Down
31 changes: 20 additions & 11 deletions rs/rosetta-api/icp/src/request_handler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ use ic_nns_common::pb::v1::NeuronId;
use ic_nns_governance_api::manage_neuron::NeuronIdOrSubaccount;
use ic_types::{CanisterId, crypto::DOMAIN_IC_REQUEST, messages::MessageId};
use icp_ledger::{Block, BlockIndex};
use rosetta_core::metrics::RosettaMetrics;
use rosetta_core::{
objects::ObjectMap,
response_types::{MempoolResponse, MempoolTransactionResponse, NetworkListResponse},
Expand All @@ -46,8 +47,7 @@ use std::{
sync::Arc,
};
use strum::IntoEnumIterator;

use rosetta_core::metrics::RosettaMetrics;
use tracing::log::debug;

/// The maximum amount of blocks to retrieve in a single search.
const MAX_SEARCH_LIMIT: usize = 10_000;
Expand Down Expand Up @@ -920,22 +920,31 @@ impl RosettaRequestHandler {

fn verify_network_id(canister_id: &CanisterId, net_id: &NetworkIdentifier) -> Result<(), ApiError> {
verify_network_blockchain(net_id)?;
let id: CanisterId = net_id
.try_into()
.map_err(|err| ApiError::InvalidNetworkId(false, format!("{err:?}").into()))?;
let id = CanisterId::try_from(net_id).map_err(|err| {
let err_msg = format!("Invalid network ID ('{net_id:?}'): {err:?}");
debug!("{err_msg}");
ApiError::InvalidNetworkId(false, Details::from(err_msg))
})?;
if *canister_id != id {
return Err(ApiError::InvalidNetworkId(false, "unknown network".into()));
let err_msg = format!("Invalid canister ID (expected '{canister_id}', received '{id}')");
debug!("{err_msg}");
return Err(ApiError::InvalidNetworkId(false, Details::from(err_msg)));
}
Ok(())
}

fn verify_network_blockchain(net_id: &NetworkIdentifier) -> Result<(), ApiError> {
const EXPECTED_BLOCKCHAIN: &str = "Internet Computer";
match net_id.blockchain.as_str() {
"Internet Computer" => Ok(()),
_ => Err(ApiError::InvalidNetworkId(
false,
"unknown blockchain".into(),
)),
EXPECTED_BLOCKCHAIN => Ok(()),
_ => {
let err_msg = format!(
"Unknown blockchain (expected '{EXPECTED_BLOCKCHAIN}', received '{}')",
net_id.blockchain
);
debug!("{err_msg}");
Err(ApiError::InvalidNetworkId(false, Details::from(err_msg)))
}
}
}

Expand Down
Loading
Loading