iota_json_rpc_types/

iota_transaction.rs

// Copyright (c) Mysten Labs, Inc.
// Modifications Copyright (c) 2024 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use std::fmt::{self, Display, Formatter, Write};

use enum_dispatch::enum_dispatch;
use fastcrypto::encoding::{Base64, Encoding};
use futures::{Stream, StreamExt, stream::FuturesOrdered};
use iota_json::{IotaJsonValue, primitive_type};
use iota_metrics::monitored_scope;
use iota_package_resolver::{CleverError, ErrorConstants, PackageStore, Resolver};
use iota_types::{
    IOTA_FRAMEWORK_ADDRESS,
    authenticator_state::ActiveJwk,
    base_types::{EpochId, IotaAddress, ObjectID, ObjectRef, SequenceNumber, TransactionDigest},
    crypto::IotaSignature,
    digests::{ConsensusCommitDigest, ObjectDigest, TransactionEventsDigest},
    effects::{TransactionEffects, TransactionEffectsAPI, TransactionEvents},
    error::{ExecutionError, IotaError, IotaResult},
    event::EventID,
    execution_status::{ExecutionFailureStatus, ExecutionStatus},
    gas::GasCostSummary,
    iota_serde::{
        BigInt, IotaTypeTag as AsIotaTypeTag, Readable, SequenceNumber as AsSequenceNumber,
    },
    layout_resolver::{LayoutResolver, get_layout_from_struct_tag},
    messages_checkpoint::CheckpointSequenceNumber,
    messages_consensus::ConsensusDeterminedVersionAssignments,
    object::{Owner, bounded_visitor::BoundedVisitor},
    parse_iota_type_tag,
    quorum_driver_types::ExecuteTransactionRequestType,
    signature::GenericSignature,
    storage::{DeleteKind, WriteKind},
    transaction::{
        Argument, CallArg, ChangeEpoch, ChangeEpochV2, ChangeEpochV3, ChangeEpochV4, Command,
        EndOfEpochTransactionKind, GenesisObject, InputObjectKind, ObjectArg, ProgrammableMoveCall,
        ProgrammableTransaction, SenderSignedData, TransactionData, TransactionDataAPI,
        TransactionKind,
    },
};
use move_binary_format::CompiledModule;
use move_bytecode_utils::module_cache::GetModule;
use move_core_types::{
    annotated_value::MoveTypeLayout,
    identifier::{IdentStr, Identifier},
    language_storage::{ModuleId, StructTag, TypeTag},
};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_with::serde_as;
use strum::{Display, EnumString};
use tabled::{
    builder::Builder as TableBuilder,
    settings::{Panel as TablePanel, Style as TableStyle, style::HorizontalLine},
};

use crate::{
    Filter, IotaEvent, IotaMoveValue, IotaObjectRef, Page, balance_changes::BalanceChange,
    iota_transaction::GenericSignature::Signature, object_changes::ObjectChange,
};

// similar to EpochId of iota-types but BigInt
pub type IotaEpochId = BigInt<u64>;

#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema, Default)]
#[serde(
    rename_all = "camelCase",
    rename = "TransactionBlockResponseQuery",
    default
)]
pub struct IotaTransactionBlockResponseQuery {
    /// If None, no filter will be applied
    pub filter: Option<TransactionFilter>,
    /// config which fields to include in the response, by default only digest
    /// is included
    pub options: Option<IotaTransactionBlockResponseOptions>,
}

impl IotaTransactionBlockResponseQuery {
    pub fn new(
        filter: Option<TransactionFilter>,
        options: Option<IotaTransactionBlockResponseOptions>,
    ) -> Self {
        Self { filter, options }
    }

    pub fn new_with_filter(filter: TransactionFilter) -> Self {
        Self {
            filter: Some(filter),
            options: None,
        }
    }
}

#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema, Default)]
#[serde(
    rename_all = "camelCase",
    rename = "TransactionBlockResponseQuery",
    default
)]
pub struct IotaTransactionBlockResponseQueryV2 {
    /// If None, no filter will be applied
    pub filter: Option<TransactionFilterV2>,
    /// config which fields to include in the response, by default only digest
    /// is included
    pub options: Option<IotaTransactionBlockResponseOptions>,
}

impl IotaTransactionBlockResponseQueryV2 {
    pub fn new(
        filter: Option<TransactionFilterV2>,
        options: Option<IotaTransactionBlockResponseOptions>,
    ) -> Self {
        Self { filter, options }
    }

    pub fn new_with_filter(filter: TransactionFilterV2) -> Self {
        Self {
            filter: Some(filter),
            options: None,
        }
    }
}

pub type TransactionBlocksPage = Page<IotaTransactionBlockResponse, TransactionDigest>;

#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema, Eq, PartialEq, Default)]
#[serde(
    rename_all = "camelCase",
    rename = "TransactionBlockResponseOptions",
    default
)]
pub struct IotaTransactionBlockResponseOptions {
    /// Whether to show transaction input data. Default to be False
    pub show_input: bool,
    /// Whether to show bcs-encoded transaction input data
    pub show_raw_input: bool,
    /// Whether to show transaction effects. Default to be False
    pub show_effects: bool,
    /// Whether to show transaction events. Default to be False
    pub show_events: bool,
    /// Whether to show object_changes. Default to be False
    pub show_object_changes: bool,
    /// Whether to show balance_changes. Default to be False
    pub show_balance_changes: bool,
    /// Whether to show raw transaction effects. Default to be False
    pub show_raw_effects: bool,
}

impl IotaTransactionBlockResponseOptions {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn full_content() -> Self {
        Self {
            show_effects: true,
            show_input: true,
            show_raw_input: true,
            show_events: true,
            show_object_changes: true,
            show_balance_changes: true,
            // This field is added for graphql execution. We keep it false here
            // so current users of `full_content` will not get raw effects unexpectedly.
            show_raw_effects: false,
        }
    }

    pub fn with_input(mut self) -> Self {
        self.show_input = true;
        self
    }

    pub fn with_raw_input(mut self) -> Self {
        self.show_raw_input = true;
        self
    }

    pub fn with_effects(mut self) -> Self {
        self.show_effects = true;
        self
    }

    pub fn with_events(mut self) -> Self {
        self.show_events = true;
        self
    }

    pub fn with_balance_changes(mut self) -> Self {
        self.show_balance_changes = true;
        self
    }

    pub fn with_object_changes(mut self) -> Self {
        self.show_object_changes = true;
        self
    }

    pub fn with_raw_effects(mut self) -> Self {
        self.show_raw_effects = true;
        self
    }

    /// default to return `WaitForEffectsCert` unless some options require
    /// local execution
    pub fn default_execution_request_type(&self) -> ExecuteTransactionRequestType {
        // if people want effects or events, they typically want to wait for local
        // execution
        if self.require_effects() {
            ExecuteTransactionRequestType::WaitForLocalExecution
        } else {
            ExecuteTransactionRequestType::WaitForEffectsCert
        }
    }

    pub fn require_input(&self) -> bool {
        self.show_input || self.show_raw_input || self.show_object_changes
    }

    pub fn require_effects(&self) -> bool {
        self.show_effects
            || self.show_events
            || self.show_balance_changes
            || self.show_object_changes
            || self.show_raw_effects
    }

    pub fn only_digest(&self) -> bool {
        self == &Self::default()
    }
}

#[serde_as]
#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone, Default)]
#[serde(rename_all = "camelCase", rename = "TransactionBlockResponse")]
pub struct IotaTransactionBlockResponse {
    pub digest: TransactionDigest,
    /// Transaction input data
    #[serde(skip_serializing_if = "Option::is_none")]
    pub transaction: Option<IotaTransactionBlock>,
    /// BCS encoded [SenderSignedData] that includes input object references
    /// returns empty array if `show_raw_transaction` is false
    #[serde_as(as = "Base64")]
    #[schemars(with = "Base64")]
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub raw_transaction: Vec<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub effects: Option<IotaTransactionBlockEffects>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub events: Option<IotaTransactionBlockEvents>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub object_changes: Option<Vec<ObjectChange>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub balance_changes: Option<Vec<BalanceChange>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[schemars(with = "Option<BigInt<u64>>")]
    #[serde_as(as = "Option<BigInt<u64>>")]
    pub timestamp_ms: Option<u64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub confirmed_local_execution: Option<bool>,
    /// The checkpoint number when this transaction was included and hence
    /// finalized. This is only returned in the read api, not in the
    /// transaction execution api.
    #[schemars(with = "Option<BigInt<u64>>")]
    #[serde_as(as = "Option<BigInt<u64>>")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub checkpoint: Option<CheckpointSequenceNumber>,
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub errors: Vec<String>,
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub raw_effects: Vec<u8>,
}

impl IotaTransactionBlockResponse {
    pub fn new(digest: TransactionDigest) -> Self {
        Self {
            digest,
            ..Default::default()
        }
    }

    pub fn status_ok(&self) -> Option<bool> {
        self.effects.as_ref().map(|e| e.status().is_ok())
    }

    /// Get mutated objects if any
    pub fn mutated_objects(&self) -> impl Iterator<Item = ObjectRef> + '_ {
        self.object_changes.iter().flat_map(|obj_changes| {
            obj_changes
                .iter()
                .filter(|change| matches!(change, ObjectChange::Mutated { .. }))
                .map(|change| change.object_ref())
        })
    }
}

/// We are specifically ignoring events for now until events become more stable.
impl PartialEq for IotaTransactionBlockResponse {
    fn eq(&self, other: &Self) -> bool {
        self.transaction == other.transaction
            && self.effects == other.effects
            && self.timestamp_ms == other.timestamp_ms
            && self.confirmed_local_execution == other.confirmed_local_execution
            && self.checkpoint == other.checkpoint
    }
}

impl Display for IotaTransactionBlockResponse {
    fn fmt(&self, writer: &mut Formatter<'_>) -> fmt::Result {
        writeln!(writer, "Transaction Digest: {}", &self.digest)?;

        if let Some(t) = &self.transaction {
            writeln!(writer, "{t}")?;
        }

        if let Some(e) = &self.effects {
            writeln!(writer, "{e}")?;
        }

        if let Some(e) = &self.events {
            writeln!(writer, "{e}")?;
        }

        if let Some(object_changes) = &self.object_changes {
            let mut builder = TableBuilder::default();
            let (
                mut created,
                mut deleted,
                mut mutated,
                mut published,
                mut transferred,
                mut wrapped,
                mut unwrapped,
            ) = (vec![], vec![], vec![], vec![], vec![], vec![], vec![]);

            for obj in object_changes {
                match obj {
                    ObjectChange::Created { .. } => created.push(obj),
                    ObjectChange::Deleted { .. } => deleted.push(obj),
                    ObjectChange::Mutated { .. } => mutated.push(obj),
                    ObjectChange::Published { .. } => published.push(obj),
                    ObjectChange::Transferred { .. } => transferred.push(obj),
                    ObjectChange::Wrapped { .. } => wrapped.push(obj),
                    ObjectChange::Unwrapped { .. } => unwrapped.push(obj),
                };
            }

            write_obj_changes(created, "Created", &mut builder)?;
            write_obj_changes(deleted, "Deleted", &mut builder)?;
            write_obj_changes(mutated, "Mutated", &mut builder)?;
            write_obj_changes(published, "Published", &mut builder)?;
            write_obj_changes(transferred, "Transferred", &mut builder)?;
            write_obj_changes(wrapped, "Wrapped", &mut builder)?;
            write_obj_changes(unwrapped, "Unwrapped", &mut builder)?;

            let mut table = builder.build();
            table.with(TablePanel::header("Object Changes"));
            table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
                1,
                TableStyle::modern().get_horizontal(),
            )]));
            writeln!(writer, "{table}")?;
        }

        if let Some(balance_changes) = &self.balance_changes {
            // Only build a table if the vector of balance changes is non-empty.
            // Empty balance changes occur, for example, for system transactions
            // like `ConsensusCommitPrologueV1`
            if !balance_changes.is_empty() {
                let mut builder = TableBuilder::default();
                for balance in balance_changes {
                    builder.push_record(vec![format!("{balance}")]);
                }
                let mut table = builder.build();
                table.with(TablePanel::header("Balance Changes"));
                table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
                    1,
                    TableStyle::modern().get_horizontal(),
                )]));
                writeln!(writer, "{table}")?;
            } else {
                writeln!(writer, "╭────────────────────╮")?;
                writeln!(writer, "│ No balance changes │")?;
                writeln!(writer, "╰────────────────────╯")?;
            }
        }
        Ok(())
    }
}

fn write_obj_changes<T: Display>(
    values: Vec<T>,
    output_string: &str,
    builder: &mut TableBuilder,
) -> std::fmt::Result {
    if !values.is_empty() {
        builder.push_record(vec![format!("{output_string} Objects: ")]);
        for obj in values {
            builder.push_record(vec![format!("{obj}")]);
        }
    }
    Ok(())
}

pub fn get_new_package_obj_from_response(
    response: &IotaTransactionBlockResponse,
) -> Option<ObjectRef> {
    response.object_changes.as_ref().and_then(|changes| {
        changes
            .iter()
            .find(|change| matches!(change, ObjectChange::Published { .. }))
            .map(|change| change.object_ref())
    })
}

pub fn get_new_package_upgrade_cap_from_response(
    response: &IotaTransactionBlockResponse,
) -> Option<ObjectRef> {
    response.object_changes.as_ref().and_then(|changes| {
        changes
            .iter()
            .find(|change| {
                matches!(change, ObjectChange::Created {
                    owner: Owner::AddressOwner(_),
                    object_type: StructTag {
                        address: IOTA_FRAMEWORK_ADDRESS,
                        module,
                        name,
                        ..
                    },
                    ..
                } if module.as_str() == "package" && name.as_str() == "UpgradeCap")
            })
            .map(|change| change.object_ref())
    })
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename = "TransactionBlockKind", tag = "kind")]
pub enum IotaTransactionBlockKind {
    /// A system transaction used for initializing the initial state of the
    /// chain.
    Genesis(IotaGenesisTransaction),
    /// A system transaction marking the start of a series of transactions
    /// scheduled as part of a checkpoint
    ConsensusCommitPrologueV1(IotaConsensusCommitPrologueV1),
    /// A series of transactions where the results of one transaction can be
    /// used in future transactions
    ProgrammableTransaction(IotaProgrammableTransactionBlock),
    /// A transaction which updates global authenticator state
    AuthenticatorStateUpdateV1(IotaAuthenticatorStateUpdateV1),
    /// A transaction which updates global randomness state
    RandomnessStateUpdate(IotaRandomnessStateUpdate),
    /// The transaction which occurs only at the end of the epoch
    EndOfEpochTransaction(IotaEndOfEpochTransaction),
    // .. more transaction types go here
}

impl Display for IotaTransactionBlockKind {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let mut writer = String::new();
        match &self {
            Self::Genesis(_) => {
                writeln!(writer, "Transaction Kind: Genesis Transaction")?;
            }
            Self::ConsensusCommitPrologueV1(p) => {
                writeln!(writer, "Transaction Kind: Consensus Commit Prologue V1")?;
                writeln!(
                    writer,
                    "Epoch: {}, Round: {}, SubDagIndex: {:?}, Timestamp: {}, ConsensusCommitDigest: {}",
                    p.epoch,
                    p.round,
                    p.sub_dag_index,
                    p.commit_timestamp_ms,
                    p.consensus_commit_digest
                )?;
            }
            Self::ProgrammableTransaction(p) => {
                write!(writer, "Transaction Kind: Programmable")?;
                write!(writer, "{}", crate::displays::Pretty(p))?;
            }
            Self::AuthenticatorStateUpdateV1(_) => {
                writeln!(writer, "Transaction Kind: Authenticator State Update")?;
            }
            Self::RandomnessStateUpdate(_) => {
                writeln!(writer, "Transaction Kind: Randomness State Update")?;
            }
            Self::EndOfEpochTransaction(_) => {
                writeln!(writer, "Transaction Kind: End of Epoch Transaction")?;
            }
        }
        write!(f, "{writer}")
    }
}

impl IotaTransactionBlockKind {
    fn try_from_inner(
        tx: TransactionKind,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        Ok(match tx {
            TransactionKind::Genesis(g) => Self::Genesis(IotaGenesisTransaction {
                objects: g.objects.iter().map(GenesisObject::id).collect(),
                events: g
                    .events
                    .into_iter()
                    .enumerate()
                    .map(|(seq, _event)| EventID::from((tx_digest, seq as u64)))
                    .collect(),
            }),
            TransactionKind::ConsensusCommitPrologueV1(p) => {
                Self::ConsensusCommitPrologueV1(IotaConsensusCommitPrologueV1 {
                    epoch: p.epoch,
                    round: p.round,
                    sub_dag_index: p.sub_dag_index,
                    commit_timestamp_ms: p.commit_timestamp_ms,
                    consensus_commit_digest: p.consensus_commit_digest,
                    consensus_determined_version_assignments: p
                        .consensus_determined_version_assignments,
                })
            }
            TransactionKind::ProgrammableTransaction(_) => {
                // This case is handled separately by the callers
                unreachable!()
            }
            TransactionKind::AuthenticatorStateUpdateV1(update) => {
                Self::AuthenticatorStateUpdateV1(IotaAuthenticatorStateUpdateV1 {
                    epoch: update.epoch,
                    round: update.round,
                    new_active_jwks: update
                        .new_active_jwks
                        .into_iter()
                        .map(IotaActiveJwk::from)
                        .collect(),
                })
            }
            TransactionKind::RandomnessStateUpdate(update) => {
                Self::RandomnessStateUpdate(IotaRandomnessStateUpdate {
                    epoch: update.epoch,
                    randomness_round: update.randomness_round.0,
                    random_bytes: update.random_bytes,
                })
            }
            TransactionKind::EndOfEpochTransaction(end_of_epoch_tx) => {
                Self::EndOfEpochTransaction(IotaEndOfEpochTransaction {
                    transactions: end_of_epoch_tx
                        .into_iter()
                        .map(|tx| match tx {
                            EndOfEpochTransactionKind::ChangeEpoch(e) => {
                                IotaEndOfEpochTransactionKind::ChangeEpoch(e.into())
                            }
                            EndOfEpochTransactionKind::ChangeEpochV2(e) => {
                                IotaEndOfEpochTransactionKind::ChangeEpochV2(e.into())
                            }
                            EndOfEpochTransactionKind::ChangeEpochV3(e) => {
                                IotaEndOfEpochTransactionKind::ChangeEpochV2(e.into())
                            }
                            EndOfEpochTransactionKind::ChangeEpochV4(e) => {
                                IotaEndOfEpochTransactionKind::ChangeEpochV2(e.into())
                            }
                            EndOfEpochTransactionKind::AuthenticatorStateCreate => {
                                IotaEndOfEpochTransactionKind::AuthenticatorStateCreate
                            }
                            EndOfEpochTransactionKind::AuthenticatorStateExpire(expire) => {
                                IotaEndOfEpochTransactionKind::AuthenticatorStateExpire(
                                    IotaAuthenticatorStateExpire {
                                        min_epoch: expire.min_epoch,
                                    },
                                )
                            }
                        })
                        .collect(),
                })
            }
        })
    }

    fn try_from_with_module_cache(
        tx: TransactionKind,
        module_cache: &impl GetModule,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        match tx {
            TransactionKind::ProgrammableTransaction(p) => Ok(Self::ProgrammableTransaction(
                IotaProgrammableTransactionBlock::try_from_with_module_cache(p, module_cache)?,
            )),
            tx => Self::try_from_inner(tx, tx_digest),
        }
    }

    async fn try_from_with_package_resolver(
        tx: TransactionKind,
        package_resolver: &Resolver<impl PackageStore>,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        match tx {
            TransactionKind::ProgrammableTransaction(p) => Ok(Self::ProgrammableTransaction(
                IotaProgrammableTransactionBlock::try_from_with_package_resolver(
                    p,
                    package_resolver,
                )
                .await?,
            )),
            tx => Self::try_from_inner(tx, tx_digest),
        }
    }

    pub fn transaction_count(&self) -> usize {
        match self {
            Self::ProgrammableTransaction(p) => p.commands.len(),
            _ => 1,
        }
    }

    pub fn name(&self) -> &'static str {
        match self {
            Self::Genesis(_) => "Genesis",
            Self::ConsensusCommitPrologueV1(_) => "ConsensusCommitPrologueV1",
            Self::ProgrammableTransaction(_) => "ProgrammableTransaction",
            Self::AuthenticatorStateUpdateV1(_) => "AuthenticatorStateUpdateV1",
            Self::RandomnessStateUpdate(_) => "RandomnessStateUpdate",
            Self::EndOfEpochTransaction(_) => "EndOfEpochTransaction",
        }
    }
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaChangeEpoch {
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch: EpochId,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub storage_charge: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub computation_charge: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub storage_rebate: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch_start_timestamp_ms: u64,
}

impl From<ChangeEpoch> for IotaChangeEpoch {
    fn from(e: ChangeEpoch) -> Self {
        Self {
            epoch: e.epoch,
            storage_charge: e.storage_charge,
            computation_charge: e.computation_charge,
            storage_rebate: e.storage_rebate,
            epoch_start_timestamp_ms: e.epoch_start_timestamp_ms,
        }
    }
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaChangeEpochV2 {
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch: EpochId,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub storage_charge: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub computation_charge: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub computation_charge_burned: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub storage_rebate: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch_start_timestamp_ms: u64,
    #[schemars(with = "Option<Vec<BigInt<u64>>>")]
    #[serde_as(as = "Option<Vec<BigInt<u64>>>")]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub eligible_active_validators: Option<Vec<u64>>,
    #[schemars(with = "Option<Vec<BigInt<u64>>>")]
    #[serde_as(as = "Option<Vec<BigInt<u64>>>")]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub scores: Option<Vec<u64>>,
}

impl From<ChangeEpochV2> for IotaChangeEpochV2 {
    fn from(e: ChangeEpochV2) -> Self {
        Self {
            epoch: e.epoch,
            storage_charge: e.storage_charge,
            computation_charge: e.computation_charge,
            computation_charge_burned: e.computation_charge_burned,
            storage_rebate: e.storage_rebate,
            epoch_start_timestamp_ms: e.epoch_start_timestamp_ms,
            eligible_active_validators: None,
            scores: None,
        }
    }
}

impl From<ChangeEpochV3> for IotaChangeEpochV2 {
    fn from(e: ChangeEpochV3) -> Self {
        Self {
            epoch: e.epoch,
            storage_charge: e.storage_charge,
            computation_charge: e.computation_charge,
            computation_charge_burned: e.computation_charge_burned,
            storage_rebate: e.storage_rebate,
            epoch_start_timestamp_ms: e.epoch_start_timestamp_ms,
            eligible_active_validators: Some(e.eligible_active_validators),
            scores: None,
        }
    }
}

impl From<ChangeEpochV4> for IotaChangeEpochV2 {
    fn from(e: ChangeEpochV4) -> Self {
        Self {
            epoch: e.epoch,
            storage_charge: e.storage_charge,
            computation_charge: e.computation_charge,
            computation_charge_burned: e.computation_charge_burned,
            storage_rebate: e.storage_rebate,
            epoch_start_timestamp_ms: e.epoch_start_timestamp_ms,
            eligible_active_validators: Some(e.eligible_active_validators),
            scores: Some(e.scores),
        }
    }
}

#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, PartialEq, Eq)]
#[enum_dispatch(IotaTransactionBlockEffectsAPI)]
#[serde(
    rename = "TransactionBlockEffects",
    rename_all = "camelCase",
    tag = "messageVersion"
)]
pub enum IotaTransactionBlockEffects {
    V1(IotaTransactionBlockEffectsV1),
}

#[enum_dispatch]
pub trait IotaTransactionBlockEffectsAPI {
    fn status(&self) -> &IotaExecutionStatus;
    fn into_status(self) -> IotaExecutionStatus;
    fn shared_objects(&self) -> &[IotaObjectRef];
    fn created(&self) -> &[OwnedObjectRef];
    fn mutated(&self) -> &[OwnedObjectRef];
    fn unwrapped(&self) -> &[OwnedObjectRef];
    fn deleted(&self) -> &[IotaObjectRef];
    fn unwrapped_then_deleted(&self) -> &[IotaObjectRef];
    fn wrapped(&self) -> &[IotaObjectRef];
    fn gas_object(&self) -> &OwnedObjectRef;
    fn events_digest(&self) -> Option<&TransactionEventsDigest>;
    fn dependencies(&self) -> &[TransactionDigest];
    fn executed_epoch(&self) -> EpochId;
    fn transaction_digest(&self) -> &TransactionDigest;
    fn gas_cost_summary(&self) -> &GasCostSummary;

    /// Return an iterator of mutated objects, but excluding the gas object.
    fn mutated_excluding_gas(&self) -> Vec<OwnedObjectRef>;
    fn modified_at_versions(&self) -> Vec<(ObjectID, SequenceNumber)>;
    fn all_changed_objects(&self) -> Vec<(&OwnedObjectRef, WriteKind)>;
    fn all_deleted_objects(&self) -> Vec<(&IotaObjectRef, DeleteKind)>;
}

#[serde_as]
#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[serde(
    rename = "TransactionBlockEffectsModifiedAtVersions",
    rename_all = "camelCase"
)]
pub struct IotaTransactionBlockEffectsModifiedAtVersions {
    object_id: ObjectID,
    #[schemars(with = "AsSequenceNumber")]
    #[serde_as(as = "AsSequenceNumber")]
    sequence_number: SequenceNumber,
}

/// The response from processing a transaction or a certified transaction
#[serde_as]
#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "TransactionBlockEffectsV1", rename_all = "camelCase")]
pub struct IotaTransactionBlockEffectsV1 {
    /// The status of the execution
    pub status: IotaExecutionStatus,
    /// The epoch when this transaction was executed.
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub executed_epoch: EpochId,
    pub gas_used: GasCostSummary,
    /// The version that every modified (mutated or deleted) object had before
    /// it was modified by this transaction.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modified_at_versions: Vec<IotaTransactionBlockEffectsModifiedAtVersions>,
    /// The object references of the shared objects used in this transaction.
    /// Empty if no shared objects were used.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub shared_objects: Vec<IotaObjectRef>,
    /// The transaction digest
    pub transaction_digest: TransactionDigest,
    /// ObjectRef and owner of new objects created.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub created: Vec<OwnedObjectRef>,
    /// ObjectRef and owner of mutated objects, including gas object.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub mutated: Vec<OwnedObjectRef>,
    /// ObjectRef and owner of objects that are unwrapped in this transaction.
    /// Unwrapped objects are objects that were wrapped into other objects in
    /// the past, and just got extracted out.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub unwrapped: Vec<OwnedObjectRef>,
    /// Object Refs of objects now deleted (the old refs).
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub deleted: Vec<IotaObjectRef>,
    /// Object refs of objects previously wrapped in other objects but now
    /// deleted.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub unwrapped_then_deleted: Vec<IotaObjectRef>,
    /// Object refs of objects now wrapped in other objects.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub wrapped: Vec<IotaObjectRef>,
    /// The updated gas object reference. Have a dedicated field for convenient
    /// access. It's also included in mutated.
    pub gas_object: OwnedObjectRef,
    /// The digest of the events emitted during execution,
    /// can be None if the transaction does not emit any event.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub events_digest: Option<TransactionEventsDigest>,
    /// The set of transaction digests this transaction depends on.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub dependencies: Vec<TransactionDigest>,
}

impl IotaTransactionBlockEffectsAPI for IotaTransactionBlockEffectsV1 {
    fn status(&self) -> &IotaExecutionStatus {
        &self.status
    }
    fn into_status(self) -> IotaExecutionStatus {
        self.status
    }
    fn shared_objects(&self) -> &[IotaObjectRef] {
        &self.shared_objects
    }
    fn created(&self) -> &[OwnedObjectRef] {
        &self.created
    }
    fn mutated(&self) -> &[OwnedObjectRef] {
        &self.mutated
    }
    fn unwrapped(&self) -> &[OwnedObjectRef] {
        &self.unwrapped
    }
    fn deleted(&self) -> &[IotaObjectRef] {
        &self.deleted
    }
    fn unwrapped_then_deleted(&self) -> &[IotaObjectRef] {
        &self.unwrapped_then_deleted
    }
    fn wrapped(&self) -> &[IotaObjectRef] {
        &self.wrapped
    }
    fn gas_object(&self) -> &OwnedObjectRef {
        &self.gas_object
    }
    fn events_digest(&self) -> Option<&TransactionEventsDigest> {
        self.events_digest.as_ref()
    }
    fn dependencies(&self) -> &[TransactionDigest] {
        &self.dependencies
    }

    fn executed_epoch(&self) -> EpochId {
        self.executed_epoch
    }

    fn transaction_digest(&self) -> &TransactionDigest {
        &self.transaction_digest
    }

    fn gas_cost_summary(&self) -> &GasCostSummary {
        &self.gas_used
    }

    fn mutated_excluding_gas(&self) -> Vec<OwnedObjectRef> {
        self.mutated
            .iter()
            .filter(|o| *o != &self.gas_object)
            .cloned()
            .collect()
    }

    fn modified_at_versions(&self) -> Vec<(ObjectID, SequenceNumber)> {
        self.modified_at_versions
            .iter()
            .map(|v| (v.object_id, v.sequence_number))
            .collect::<Vec<_>>()
    }

    fn all_changed_objects(&self) -> Vec<(&OwnedObjectRef, WriteKind)> {
        self.mutated
            .iter()
            .map(|owner_ref| (owner_ref, WriteKind::Mutate))
            .chain(
                self.created
                    .iter()
                    .map(|owner_ref| (owner_ref, WriteKind::Create)),
            )
            .chain(
                self.unwrapped
                    .iter()
                    .map(|owner_ref| (owner_ref, WriteKind::Unwrap)),
            )
            .collect()
    }

    fn all_deleted_objects(&self) -> Vec<(&IotaObjectRef, DeleteKind)> {
        self.deleted
            .iter()
            .map(|r| (r, DeleteKind::Normal))
            .chain(
                self.unwrapped_then_deleted
                    .iter()
                    .map(|r| (r, DeleteKind::UnwrapThenDelete)),
            )
            .chain(self.wrapped.iter().map(|r| (r, DeleteKind::Wrap)))
            .collect()
    }
}

impl IotaTransactionBlockEffects {
    pub fn new_for_testing(
        transaction_digest: TransactionDigest,
        status: IotaExecutionStatus,
    ) -> Self {
        Self::V1(IotaTransactionBlockEffectsV1 {
            transaction_digest,
            status,
            gas_object: OwnedObjectRef {
                owner: Owner::AddressOwner(IotaAddress::random_for_testing_only()),
                reference: iota_types::base_types::random_object_ref().into(),
            },
            executed_epoch: 0,
            modified_at_versions: vec![],
            gas_used: GasCostSummary::default(),
            shared_objects: vec![],
            created: vec![],
            mutated: vec![],
            unwrapped: vec![],
            deleted: vec![],
            unwrapped_then_deleted: vec![],
            wrapped: vec![],
            events_digest: None,
            dependencies: vec![],
        })
    }

    /// Construct the RPC view of the transaction effects.
    ///
    /// This differs from the `TryFrom<TransactionEffects>` implementation
    /// in that it tries to convert Move abort errors into human-readable form.
    /// This is referred to as clever error.
    pub async fn from_native_with_clever_error<S: PackageStore>(
        native: TransactionEffects,
        resolver: &Resolver<S>,
    ) -> Self {
        let clever_status =
            IotaExecutionStatus::from_native_with_clever_error(native.status().clone(), resolver)
                .await;
        match native {
            TransactionEffects::V1(inner) => {
                let mut inner = IotaTransactionBlockEffectsV1::from(inner);
                inner.status = clever_status;
                inner.into()
            }
        }
    }
}

impl TryFrom<TransactionEffects> for IotaTransactionBlockEffects {
    type Error = IotaError;

    fn try_from(native: TransactionEffects) -> Result<Self, Self::Error> {
        Ok(IotaTransactionBlockEffects::V1(native.into()))
    }
}

impl<T: TransactionEffectsAPI> From<T> for IotaTransactionBlockEffectsV1 {
    fn from(native: T) -> Self {
        Self {
            status: native.status().clone().into(),
            executed_epoch: native.executed_epoch(),
            modified_at_versions: native
                .modified_at_versions()
                .into_iter()
                .map(
                    |(object_id, sequence_number)| IotaTransactionBlockEffectsModifiedAtVersions {
                        object_id,
                        sequence_number,
                    },
                )
                .collect(),
            gas_used: native.gas_cost_summary().clone(),
            shared_objects: to_iota_object_ref(
                native
                    .input_shared_objects()
                    .into_iter()
                    .map(|kind| kind.object_ref())
                    .collect(),
            ),
            transaction_digest: *native.transaction_digest(),
            created: to_owned_ref(native.created()),
            mutated: to_owned_ref(native.mutated().to_vec()),
            unwrapped: to_owned_ref(native.unwrapped().to_vec()),
            deleted: to_iota_object_ref(native.deleted().to_vec()),
            unwrapped_then_deleted: to_iota_object_ref(native.unwrapped_then_deleted().to_vec()),
            wrapped: to_iota_object_ref(native.wrapped().to_vec()),
            gas_object: OwnedObjectRef {
                owner: native.gas_object().1,
                reference: native.gas_object().0.into(),
            },
            events_digest: native.events_digest().copied(),
            dependencies: native.dependencies().to_vec(),
        }
    }
}

fn owned_objref_string(obj: &OwnedObjectRef) -> String {
    format!(
        " ┌──\n │ ID: {} \n │ Owner: {} \n │ Version: {} \n │ Digest: {}\n └──",
        obj.reference.object_id,
        obj.owner,
        u64::from(obj.reference.version),
        obj.reference.digest
    )
}

fn objref_string(obj: &IotaObjectRef) -> String {
    format!(
        " ┌──\n │ ID: {} \n │ Version: {} \n │ Digest: {}\n └──",
        obj.object_id,
        u64::from(obj.version),
        obj.digest
    )
}

impl Display for IotaTransactionBlockEffects {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let mut builder = TableBuilder::default();

        builder.push_record(vec![format!("Digest: {}", self.transaction_digest())]);
        builder.push_record(vec![format!("Status: {:?}", self.status())]);
        builder.push_record(vec![format!("Executed Epoch: {}", self.executed_epoch())]);

        if !self.created().is_empty() {
            builder.push_record(vec![format!("\nCreated Objects: ")]);

            for oref in self.created() {
                builder.push_record(vec![owned_objref_string(oref)]);
            }
        }

        if !self.mutated().is_empty() {
            builder.push_record(vec![format!("Mutated Objects: ")]);
            for oref in self.mutated() {
                builder.push_record(vec![owned_objref_string(oref)]);
            }
        }

        if !self.shared_objects().is_empty() {
            builder.push_record(vec![format!("Shared Objects: ")]);
            for oref in self.shared_objects() {
                builder.push_record(vec![objref_string(oref)]);
            }
        }

        if !self.deleted().is_empty() {
            builder.push_record(vec![format!("Deleted Objects: ")]);

            for oref in self.deleted() {
                builder.push_record(vec![objref_string(oref)]);
            }
        }

        if !self.wrapped().is_empty() {
            builder.push_record(vec![format!("Wrapped Objects: ")]);

            for oref in self.wrapped() {
                builder.push_record(vec![objref_string(oref)]);
            }
        }

        if !self.unwrapped().is_empty() {
            builder.push_record(vec![format!("Unwrapped Objects: ")]);
            for oref in self.unwrapped() {
                builder.push_record(vec![owned_objref_string(oref)]);
            }
        }

        builder.push_record(vec![format!(
            "Gas Object: \n{}",
            owned_objref_string(self.gas_object())
        )]);

        let gas_cost_summary = self.gas_cost_summary();
        builder.push_record(vec![format!(
            "Gas Cost Summary:\n   \
             Storage Cost: {} NANOS\n   \
             Computation Cost: {} NANOS\n   \
             Computation Cost Burned: {} NANOS\n   \
             Storage Rebate: {} NANOS\n   \
             Non-refundable Storage Fee: {} NANOS",
            gas_cost_summary.storage_cost,
            gas_cost_summary.computation_cost,
            gas_cost_summary.computation_cost_burned,
            gas_cost_summary.storage_rebate,
            gas_cost_summary.non_refundable_storage_fee,
        )]);

        let dependencies = self.dependencies();
        if !dependencies.is_empty() {
            builder.push_record(vec![format!("\nTransaction Dependencies:")]);
            for dependency in dependencies {
                builder.push_record(vec![format!("   {dependency}")]);
            }
        }

        let mut table = builder.build();
        table.with(TablePanel::header("Transaction Effects"));
        table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
            1,
            TableStyle::modern().get_horizontal(),
        )]));
        write!(f, "{table}")
    }
}

#[serde_as]
#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct DryRunTransactionBlockResponse {
    pub effects: IotaTransactionBlockEffects,
    pub events: IotaTransactionBlockEvents,
    pub object_changes: Vec<ObjectChange>,
    pub balance_changes: Vec<BalanceChange>,
    pub input: IotaTransactionBlockData,
    /// If an input object is congested, suggest a gas price to use.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[schemars(with = "Option<BigInt<u64>>")]
    #[serde_as(as = "Option<BigInt<u64>>")]
    pub suggested_gas_price: Option<u64>,
    pub execution_error_source: Option<String>,
}

#[derive(Eq, PartialEq, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "TransactionBlockEvents", transparent)]
pub struct IotaTransactionBlockEvents {
    pub data: Vec<IotaEvent>,
}

impl IotaTransactionBlockEvents {
    pub fn try_from(
        events: TransactionEvents,
        tx_digest: TransactionDigest,
        timestamp_ms: Option<u64>,
        resolver: &mut dyn LayoutResolver,
    ) -> IotaResult<Self> {
        Ok(Self {
            data: events
                .data
                .into_iter()
                .enumerate()
                .map(|(seq, event)| {
                    let layout = resolver.get_annotated_layout(&event.type_)?;
                    IotaEvent::try_from(event, tx_digest, seq as u64, timestamp_ms, layout)
                })
                .collect::<Result<_, _>>()?,
        })
    }

    // TODO: this is only called from the indexer. Remove this once indexer moves to
    // its own resolver.
    pub fn try_from_using_module_resolver(
        events: TransactionEvents,
        tx_digest: TransactionDigest,
        timestamp_ms: Option<u64>,
        resolver: &impl GetModule,
    ) -> IotaResult<Self> {
        Ok(Self {
            data: events
                .data
                .into_iter()
                .enumerate()
                .map(|(seq, event)| {
                    let layout = get_layout_from_struct_tag(event.type_.clone(), resolver)?;
                    IotaEvent::try_from(event, tx_digest, seq as u64, timestamp_ms, layout)
                })
                .collect::<Result<_, _>>()?,
        })
    }
}

impl Display for IotaTransactionBlockEvents {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        if self.data.is_empty() {
            writeln!(f, "╭─────────────────────────────╮")?;
            writeln!(f, "│ No transaction block events │")?;
            writeln!(f, "╰─────────────────────────────╯")
        } else {
            let mut builder = TableBuilder::default();

            for event in &self.data {
                builder.push_record(vec![format!("{event}")]);
            }

            let mut table = builder.build();
            table.with(TablePanel::header("Transaction Block Events"));
            table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
                1,
                TableStyle::modern().get_horizontal(),
            )]));
            write!(f, "{table}")
        }
    }
}

// TODO: this file might not be the best place for this struct.
/// Additional arguments supplied to dev inspect beyond what is allowed in
/// today's API.
#[derive(Debug, Default, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "DevInspectArgs", rename_all = "camelCase")]
pub struct DevInspectArgs {
    /// The sponsor of the gas for the transaction, might be different from the
    /// sender.
    pub gas_sponsor: Option<IotaAddress>,
    /// The gas budget for the transaction.
    pub gas_budget: Option<BigInt<u64>>,
    /// The gas objects used to pay for the transaction.
    pub gas_objects: Option<Vec<ObjectRef>>,
    /// Whether to skip transaction checks for the transaction.
    pub skip_checks: Option<bool>,
    /// Whether to return the raw transaction data and effects.
    pub show_raw_txn_data_and_effects: Option<bool>,
}

/// The response from processing a dev inspect transaction
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "DevInspectResults", rename_all = "camelCase")]
pub struct DevInspectResults {
    /// Summary of effects that likely would be generated if the transaction is
    /// actually run. Note however, that not all dev-inspect transactions
    /// are actually usable as transactions so it might not be possible
    /// actually generate these effects from a normal transaction.
    pub effects: IotaTransactionBlockEffects,
    /// Events that likely would be generated if the transaction is actually
    /// run.
    pub events: IotaTransactionBlockEvents,
    /// Execution results (including return values) from executing the
    /// transactions
    #[serde(skip_serializing_if = "Option::is_none")]
    pub results: Option<Vec<IotaExecutionResult>>,
    /// Execution error from executing the transactions
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
    /// The raw transaction data that was dev inspected.
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub raw_txn_data: Vec<u8>,
    /// The raw effects of the transaction that was dev inspected.
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub raw_effects: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "IotaExecutionResult", rename_all = "camelCase")]
pub struct IotaExecutionResult {
    /// The value of any arguments that were mutably borrowed.
    /// Non-mut borrowed values are not included
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub mutable_reference_outputs: Vec<(/* argument */ IotaArgument, Vec<u8>, IotaTypeTag)>,
    /// The return values from the transaction
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub return_values: Vec<(Vec<u8>, IotaTypeTag)>,
}

impl IotaExecutionResult {
    fn into_stream_return_value_layouts<S: PackageStore>(
        self,
        package_resolver: &Resolver<S>,
    ) -> impl Stream<Item = anyhow::Result<(Vec<u8>, MoveTypeLayout)>> + use<'_, S> {
        self.return_values
            .into_iter()
            .map(|(bytes, iota_type_tag)| async {
                let type_tag = TypeTag::try_from(iota_type_tag)?;
                let move_type_layout = package_resolver.type_layout(type_tag).await?;
                Ok((bytes, move_type_layout))
            })
            .collect::<FuturesOrdered<_>>()
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub enum IotaMoveViewCallResults {
    /// Execution error from executing the move view call
    #[serde(rename = "executionError")]
    Error(String),
    /// The return values of the move view function
    #[serde(rename = "functionReturnValues")]
    Results(Vec<IotaMoveValue>),
}

impl IotaMoveViewCallResults {
    /// Processes the dev-inspect results to produce the response
    /// of the move-view function call.
    pub async fn from_dev_inspect_results<S: PackageStore>(
        package_store: S,
        dev_inspect_results: DevInspectResults,
    ) -> anyhow::Result<Self> {
        if let Some(error) = dev_inspect_results.error {
            return Ok(Self::Error(error));
        }
        let Some(mut tx_execution_results) = dev_inspect_results.results else {
            return Ok(Self::Error("function call returned no values".into()));
        };
        let Some(execution_results) = tx_execution_results.pop() else {
            return Ok(Self::Error(
                "no results from move view function call".into(),
            ));
        };
        if !tx_execution_results.is_empty() {
            return Ok(Self::Error("multiple transactions executed".into()));
        }
        let mut move_call_results = Vec::with_capacity(execution_results.return_values.len());
        let package_resolver = Resolver::new(package_store);
        let mut execution_results =
            execution_results.into_stream_return_value_layouts(&package_resolver);
        while let Some(result) = execution_results.next().await {
            let (bytes, move_type_layout) = result?;
            let move_value = BoundedVisitor::deserialize_value(&bytes, &move_type_layout)?;
            move_call_results.push(IotaMoveValue::from(move_value));
        }
        Ok(Self::Results(move_call_results))
    }

    pub fn into_return_values(self) -> Vec<IotaMoveValue> {
        match self {
            IotaMoveViewCallResults::Error(_) => Default::default(),
            IotaMoveViewCallResults::Results(values) => values,
        }
    }

    pub fn error(&self) -> Option<&str> {
        match self {
            IotaMoveViewCallResults::Error(e) => Some(e.as_str()),
            IotaMoveViewCallResults::Results(_) => None,
        }
    }
}

type ExecutionResult = (
    // mutable_reference_outputs
    Vec<(Argument, Vec<u8>, TypeTag)>,
    // return_values
    Vec<(Vec<u8>, TypeTag)>,
);

impl DevInspectResults {
    pub fn new(
        effects: TransactionEffects,
        events: TransactionEvents,
        return_values: Result<Vec<ExecutionResult>, ExecutionError>,
        raw_txn_data: Vec<u8>,
        raw_effects: Vec<u8>,
        resolver: &mut dyn LayoutResolver,
    ) -> IotaResult<Self> {
        let tx_digest = *effects.transaction_digest();
        let mut error = None;
        let mut results = None;
        match return_values {
            Err(e) => error = Some(e.to_string()),
            Ok(srvs) => {
                results = Some(
                    srvs.into_iter()
                        .map(|srv| {
                            let (mutable_reference_outputs, return_values) = srv;
                            let mutable_reference_outputs = mutable_reference_outputs
                                .into_iter()
                                .map(|(a, bytes, tag)| (a.into(), bytes, IotaTypeTag::from(tag)))
                                .collect();
                            let return_values = return_values
                                .into_iter()
                                .map(|(bytes, tag)| (bytes, IotaTypeTag::from(tag)))
                                .collect();
                            IotaExecutionResult {
                                mutable_reference_outputs,
                                return_values,
                            }
                        })
                        .collect(),
                )
            }
        };
        Ok(Self {
            effects: effects.try_into()?,
            events: IotaTransactionBlockEvents::try_from(events, tx_digest, None, resolver)?,
            results,
            error,
            raw_txn_data,
            raw_effects,
        })
    }
}

#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, JsonSchema)]
pub enum IotaTransactionBlockBuilderMode {
    /// Regular IOTA Transactions that are committed on chain
    Commit,
    /// Simulated transaction that allows calling any Move function with
    /// arbitrary values.
    DevInspect,
}

#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "ExecutionStatus", rename_all = "camelCase", tag = "status")]
pub enum IotaExecutionStatus {
    // Gas used in the success case.
    Success,
    // Gas used in the failed case, and the error.
    Failure { error: String },
}

impl IotaExecutionStatus {
    /// Construct the RPC view of the execution status.
    ///
    /// This differs from the `From<ExecutionStatus>` implementation
    /// in that it tries to convert Move abort errors into human-readable form.
    /// This is referred to as clever error.
    pub async fn from_native_with_clever_error<S: PackageStore>(
        native: ExecutionStatus,
        resolver: &Resolver<S>,
    ) -> Self {
        match native {
            ExecutionStatus::Failure {
                error,
                command: Some(mut command_index),
            } => {
                let error = 'error: {
                    let ExecutionFailureStatus::MoveAbort(loc, code) = &error else {
                        break 'error error.to_string();
                    };
                    let fname_string = if let Some(fname) = &loc.function_name {
                        format!("::{fname}'")
                    } else {
                        "'".to_string()
                    };

                    let Some(CleverError {
                        module_id,
                        source_line_number,
                        error_info,
                    }) = resolver
                        .resolve_clever_error(loc.module.clone(), *code)
                        .await
                    else {
                        break 'error format!(
                            "from '{}{fname_string} (instruction {}), abort code: {code}",
                            loc.module.to_canonical_display(true),
                            loc.instruction,
                        );
                    };

                    match error_info {
                        ErrorConstants::Rendered {
                            identifier,
                            constant,
                        } => {
                            format!(
                                "from '{}{fname_string} (line {source_line_number}), abort '{identifier}': {constant}",
                                module_id.to_canonical_display(true)
                            )
                        }
                        ErrorConstants::Raw { identifier, bytes } => {
                            let const_str = Base64::encode(bytes);
                            format!(
                                "from '{}{fname_string} (line {source_line_number}), abort '{identifier}': {const_str}",
                                module_id.to_canonical_display(true)
                            )
                        }
                        ErrorConstants::None => {
                            format!(
                                "from '{}{fname_string} (line {source_line_number})",
                                module_id.to_canonical_display(true)
                            )
                        }
                    }
                };
                // Convert the command index into an ordinal.
                command_index += 1;
                let suffix = match command_index % 10 {
                    1 => "st",
                    2 => "nd",
                    3 => "rd",
                    _ => "th",
                };
                IotaExecutionStatus::Failure {
                    error: format!("Error in {command_index}{suffix} command, {error}"),
                }
            }
            _ => native.into(),
        }
    }
}

impl Display for IotaExecutionStatus {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::Success => write!(f, "success"),
            Self::Failure { error } => write!(f, "failure due to {error}"),
        }
    }
}

impl IotaExecutionStatus {
    pub fn is_ok(&self) -> bool {
        matches!(self, IotaExecutionStatus::Success)
    }
    pub fn is_err(&self) -> bool {
        matches!(self, IotaExecutionStatus::Failure { .. })
    }
}

impl From<ExecutionStatus> for IotaExecutionStatus {
    fn from(status: ExecutionStatus) -> Self {
        match status {
            ExecutionStatus::Success => Self::Success,
            ExecutionStatus::Failure {
                error,
                command: None,
            } => Self::Failure {
                error: error.to_string(),
            },
            ExecutionStatus::Failure {
                error,
                command: Some(idx),
            } => Self::Failure {
                error: format!("{error} in command {idx}"),
            },
        }
    }
}

fn to_iota_object_ref(refs: Vec<ObjectRef>) -> Vec<IotaObjectRef> {
    refs.into_iter().map(IotaObjectRef::from).collect()
}

fn to_owned_ref(owned_refs: Vec<(ObjectRef, Owner)>) -> Vec<OwnedObjectRef> {
    owned_refs
        .into_iter()
        .map(|(oref, owner)| OwnedObjectRef {
            owner,
            reference: oref.into(),
        })
        .collect()
}

#[serde_as]
#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, PartialEq, Eq)]
#[serde(rename = "GasData", rename_all = "camelCase")]
pub struct IotaGasData {
    pub payment: Vec<IotaObjectRef>,
    pub owner: IotaAddress,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub price: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub budget: u64,
}

impl Display for IotaGasData {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        writeln!(f, "Gas Owner: {}", self.owner)?;
        writeln!(f, "Gas Budget: {} NANOS", self.budget)?;
        writeln!(f, "Gas Price: {} NANOS", self.price)?;
        writeln!(f, "Gas Payment:")?;
        for payment in &self.payment {
            write!(f, "{} ", objref_string(payment))?;
        }
        writeln!(f)
    }
}

#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, PartialEq, Eq)]
#[enum_dispatch(IotaTransactionBlockDataAPI)]
#[serde(
    rename = "TransactionBlockData",
    rename_all = "camelCase",
    tag = "messageVersion"
)]
pub enum IotaTransactionBlockData {
    V1(IotaTransactionBlockDataV1),
}

#[enum_dispatch]
pub trait IotaTransactionBlockDataAPI {
    fn transaction(&self) -> &IotaTransactionBlockKind;
    fn sender(&self) -> &IotaAddress;
    fn gas_data(&self) -> &IotaGasData;
}

#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, PartialEq, Eq)]
#[serde(rename = "TransactionBlockDataV1", rename_all = "camelCase")]
pub struct IotaTransactionBlockDataV1 {
    pub transaction: IotaTransactionBlockKind,
    pub sender: IotaAddress,
    pub gas_data: IotaGasData,
}

impl IotaTransactionBlockDataAPI for IotaTransactionBlockDataV1 {
    fn transaction(&self) -> &IotaTransactionBlockKind {
        &self.transaction
    }
    fn sender(&self) -> &IotaAddress {
        &self.sender
    }
    fn gas_data(&self) -> &IotaGasData {
        &self.gas_data
    }
}

impl IotaTransactionBlockData {
    pub fn move_calls(&self) -> Vec<&IotaProgrammableMoveCall> {
        match self {
            Self::V1(data) => match &data.transaction {
                IotaTransactionBlockKind::ProgrammableTransaction(pt) => pt
                    .commands
                    .iter()
                    .filter_map(|command| match command {
                        IotaCommand::MoveCall(c) => Some(&**c),
                        _ => None,
                    })
                    .collect(),
                _ => vec![],
            },
        }
    }

    fn try_from_inner(
        data: TransactionData,
        transaction: IotaTransactionBlockKind,
    ) -> Result<Self, anyhow::Error> {
        let message_version = data.message_version();
        let sender = data.sender();
        let gas_data = IotaGasData {
            payment: data
                .gas()
                .iter()
                .map(|obj_ref| IotaObjectRef::from(*obj_ref))
                .collect(),
            owner: data.gas_owner(),
            price: data.gas_price(),
            budget: data.gas_budget(),
        };

        match message_version {
            1 => Ok(IotaTransactionBlockData::V1(IotaTransactionBlockDataV1 {
                transaction,
                sender,
                gas_data,
            })),
            _ => Err(anyhow::anyhow!(
                "Support for TransactionData version {} not implemented",
                message_version
            )),
        }
    }

    pub fn try_from_with_module_cache(
        data: TransactionData,
        module_cache: &impl GetModule,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        let transaction = IotaTransactionBlockKind::try_from_with_module_cache(
            data.kind().clone(),
            module_cache,
            tx_digest,
        )?;
        Self::try_from_inner(data, transaction)
    }

    pub async fn try_from_with_package_resolver(
        data: TransactionData,
        package_resolver: &Resolver<impl PackageStore>,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        let transaction = IotaTransactionBlockKind::try_from_with_package_resolver(
            data.kind().clone(),
            package_resolver,
            tx_digest,
        )
        .await?;
        Self::try_from_inner(data, transaction)
    }
}

impl Display for IotaTransactionBlockData {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::V1(data) => {
                writeln!(f, "Sender: {}", data.sender)?;
                writeln!(f, "{}", self.gas_data())?;
                writeln!(f, "{}", data.transaction)
            }
        }
    }
}

#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, PartialEq, Eq)]
#[serde(rename = "TransactionBlock", rename_all = "camelCase")]
pub struct IotaTransactionBlock {
    pub data: IotaTransactionBlockData,
    pub tx_signatures: Vec<GenericSignature>,
}

impl IotaTransactionBlock {
    pub fn try_from(
        data: SenderSignedData,
        module_cache: &impl GetModule,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        Ok(Self {
            data: IotaTransactionBlockData::try_from_with_module_cache(
                data.intent_message().value.clone(),
                module_cache,
                tx_digest,
            )?,
            tx_signatures: data.tx_signatures().to_vec(),
        })
    }

    // TODO: the IotaTransactionBlock `try_from` can be removed after cleaning up
    // indexer v1, so are the related `try_from` methods for nested structs like
    // IotaTransactionBlockData etc.
    pub async fn try_from_with_package_resolver(
        data: SenderSignedData,
        package_resolver: &Resolver<impl PackageStore>,
        tx_digest: TransactionDigest,
    ) -> Result<Self, anyhow::Error> {
        Ok(Self {
            data: IotaTransactionBlockData::try_from_with_package_resolver(
                data.intent_message().value.clone(),
                package_resolver,
                tx_digest,
            )
            .await?,
            tx_signatures: data.tx_signatures().to_vec(),
        })
    }
}

impl Display for IotaTransactionBlock {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let mut builder = TableBuilder::default();

        builder.push_record(vec![format!("{}", self.data)]);
        builder.push_record(vec![format!("Signatures:")]);
        for tx_sig in &self.tx_signatures {
            builder.push_record(vec![format!(
                "   {}\n",
                match tx_sig {
                    Signature(sig) => Base64::from_bytes(sig.signature_bytes()).encoded(),
                    // the signatures for multisig and zklogin
                    // are not suited to be parsed out. they
                    // should be interpreted as a whole
                    _ => Base64::from_bytes(tx_sig.as_ref()).encoded(),
                }
            )]);
        }

        let mut table = builder.build();
        table.with(TablePanel::header("Transaction Data"));
        table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
            1,
            TableStyle::modern().get_horizontal(),
        )]));
        write!(f, "{table}")
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaGenesisTransaction {
    pub objects: Vec<ObjectID>,
    pub events: Vec<EventID>,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaConsensusCommitPrologueV1 {
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub round: u64,
    #[schemars(with = "Option<BigInt<u64>>")]
    #[serde_as(as = "Option<BigInt<u64>>")]
    pub sub_dag_index: Option<u64>,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub commit_timestamp_ms: u64,
    pub consensus_commit_digest: ConsensusCommitDigest,
    pub consensus_determined_version_assignments: ConsensusDeterminedVersionAssignments,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaAuthenticatorStateUpdateV1 {
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch: u64,
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub round: u64,

    pub new_active_jwks: Vec<IotaActiveJwk>,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaRandomnessStateUpdate {
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch: u64,

    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub randomness_round: u64,
    pub random_bytes: Vec<u8>,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaEndOfEpochTransaction {
    pub transactions: Vec<IotaEndOfEpochTransactionKind>,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub enum IotaEndOfEpochTransactionKind {
    ChangeEpoch(IotaChangeEpoch),
    ChangeEpochV2(IotaChangeEpochV2),
    AuthenticatorStateCreate,
    AuthenticatorStateExpire(IotaAuthenticatorStateExpire),
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaAuthenticatorStateExpire {
    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub min_epoch: u64,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaActiveJwk {
    pub jwk_id: IotaJwkId,
    pub jwk: IotaJWK,

    #[schemars(with = "BigInt<u64>")]
    #[serde_as(as = "BigInt<u64>")]
    pub epoch: u64,
}

impl From<ActiveJwk> for IotaActiveJwk {
    fn from(active_jwk: ActiveJwk) -> Self {
        Self {
            jwk_id: IotaJwkId {
                iss: active_jwk.jwk_id.iss.clone(),
                kid: active_jwk.jwk_id.kid.clone(),
            },
            jwk: IotaJWK {
                kty: active_jwk.jwk.kty.clone(),
                e: active_jwk.jwk.e.clone(),
                n: active_jwk.jwk.n.clone(),
                alg: active_jwk.jwk.alg.clone(),
            },
            epoch: active_jwk.epoch,
        }
    }
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaJwkId {
    pub iss: String,
    pub kid: String,
}

#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaJWK {
    pub kty: String,
    pub e: String,
    pub n: String,
    pub alg: String,
}

#[serde_as]
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "InputObjectKind")]
pub enum IotaInputObjectKind {
    // A Move package, must be immutable.
    MovePackage(ObjectID),
    // A Move object, either immutable, or owned mutable.
    ImmOrOwnedMoveObject(IotaObjectRef),
    // A Move object that's shared and mutable.
    SharedMoveObject {
        id: ObjectID,
        #[schemars(with = "AsSequenceNumber")]
        #[serde_as(as = "AsSequenceNumber")]
        initial_shared_version: SequenceNumber,
        #[serde(default = "default_shared_object_mutability")]
        mutable: bool,
    },
}

/// A series of commands where the results of one command can be used in future
/// commands
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaProgrammableTransactionBlock {
    /// Input objects or primitive values
    pub inputs: Vec<IotaCallArg>,
    #[serde(rename = "transactions")]
    /// The transactions to be executed sequentially. A failure in any
    /// transaction will result in the failure of the entire programmable
    /// transaction block.
    pub commands: Vec<IotaCommand>,
}

impl Display for IotaProgrammableTransactionBlock {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Self { inputs, commands } = self;
        writeln!(f, "Inputs: {inputs:?}")?;
        writeln!(f, "Commands: [")?;
        for c in commands {
            writeln!(f, "  {c},")?;
        }
        writeln!(f, "]")
    }
}

impl IotaProgrammableTransactionBlock {
    fn try_from_with_module_cache(
        value: ProgrammableTransaction,
        module_cache: &impl GetModule,
    ) -> Result<Self, anyhow::Error> {
        let ProgrammableTransaction { inputs, commands } = value;
        let input_types = Self::resolve_input_type(&inputs, &commands, module_cache);
        Ok(IotaProgrammableTransactionBlock {
            inputs: inputs
                .into_iter()
                .zip(input_types)
                .map(|(arg, layout)| IotaCallArg::try_from(arg, layout.as_ref()))
                .collect::<Result<_, _>>()?,
            commands: commands.into_iter().map(IotaCommand::from).collect(),
        })
    }

    async fn try_from_with_package_resolver(
        value: ProgrammableTransaction,
        package_resolver: &Resolver<impl PackageStore>,
    ) -> Result<Self, anyhow::Error> {
        // If the pure input layouts cannot be built, we will use `None` for the input
        // types.
        let input_types = package_resolver
            .pure_input_layouts(&value)
            .await
            .unwrap_or_else(|e| {
                tracing::warn!("pure_input_layouts failed: {:?}", e);
                vec![None; value.inputs.len()]
            });

        let ProgrammableTransaction { inputs, commands } = value;
        Ok(IotaProgrammableTransactionBlock {
            inputs: inputs
                .into_iter()
                .zip(input_types)
                .map(|(arg, layout)| IotaCallArg::try_from(arg, layout.as_ref()))
                .collect::<Result<_, _>>()?,
            commands: commands.into_iter().map(IotaCommand::from).collect(),
        })
    }

    fn resolve_input_type(
        inputs: &[CallArg],
        commands: &[Command],
        module_cache: &impl GetModule,
    ) -> Vec<Option<MoveTypeLayout>> {
        let mut result_types = vec![None; inputs.len()];
        for command in commands.iter() {
            match command {
                Command::MoveCall(c) => {
                    let Ok(module) = Identifier::new(c.module.clone()) else {
                        return result_types;
                    };

                    let Ok(function) = Identifier::new(c.function.clone()) else {
                        return result_types;
                    };

                    let id = ModuleId::new(c.package.into(), module);
                    let Some(types) =
                        get_signature_types(id, function.as_ident_str(), module_cache)
                    else {
                        return result_types;
                    };
                    for (arg, type_) in c.arguments.iter().zip(types) {
                        if let (&Argument::Input(i), Some(type_)) = (arg, type_) {
                            if let Some(x) = result_types.get_mut(i as usize) {
                                x.replace(type_);
                            }
                        }
                    }
                }
                Command::SplitCoins(_, amounts) => {
                    for arg in amounts {
                        if let &Argument::Input(i) = arg {
                            if let Some(x) = result_types.get_mut(i as usize) {
                                x.replace(MoveTypeLayout::U64);
                            }
                        }
                    }
                }
                Command::TransferObjects(_, Argument::Input(i)) => {
                    if let Some(x) = result_types.get_mut((*i) as usize) {
                        x.replace(MoveTypeLayout::Address);
                    }
                }
                _ => {}
            }
        }
        result_types
    }
}

fn get_signature_types(
    id: ModuleId,
    function: &IdentStr,
    module_cache: &impl GetModule,
) -> Option<Vec<Option<MoveTypeLayout>>> {
    use std::borrow::Borrow;
    if let Ok(Some(module)) = module_cache.get_module_by_id(&id) {
        let module: &CompiledModule = module.borrow();
        let func = module
            .function_handles
            .iter()
            .find(|f| module.identifier_at(f.name) == function)?;
        Some(
            module
                .signature_at(func.parameters)
                .0
                .iter()
                .map(|s| primitive_type(module, &[], s))
                .collect(),
        )
    } else {
        None
    }
}

/// A single transaction in a programmable transaction block.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename = "IotaTransaction")]
pub enum IotaCommand {
    /// A call to either an entry or a public Move function
    MoveCall(Box<IotaProgrammableMoveCall>),
    /// `(Vec<forall T:key+store. T>, address)`
    /// It sends n-objects to the specified address. These objects must have
    /// store (public transfer) and either the previous owner must be an
    /// address or the object must be newly created.
    TransferObjects(Vec<IotaArgument>, IotaArgument),
    /// `(&mut Coin<T>, Vec<u64>)` -> `Vec<Coin<T>>`
    /// It splits off some amounts into a new coins with those amounts
    SplitCoins(IotaArgument, Vec<IotaArgument>),
    /// `(&mut Coin<T>, Vec<Coin<T>>)`
    /// It merges n-coins into the first coin
    MergeCoins(IotaArgument, Vec<IotaArgument>),
    /// Publishes a Move package. It takes the package bytes and a list of the
    /// package's transitive dependencies to link against on-chain.
    Publish(Vec<ObjectID>),
    /// Upgrades a Move package
    Upgrade(Vec<ObjectID>, ObjectID, IotaArgument),
    /// `forall T: Vec<T> -> vector<T>`
    /// Given n-values of the same type, it constructs a vector. For non objects
    /// or an empty vector, the type tag must be specified.
    MakeMoveVec(Option<String>, Vec<IotaArgument>),
}

impl Display for IotaCommand {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::MoveCall(p) => {
                write!(f, "MoveCall({p})")
            }
            Self::MakeMoveVec(ty_opt, elems) => {
                write!(f, "MakeMoveVec(")?;
                if let Some(ty) = ty_opt {
                    write!(f, "Some{ty}")?;
                } else {
                    write!(f, "None")?;
                }
                write!(f, ",[")?;
                write_sep(f, elems, ",")?;
                write!(f, "])")
            }
            Self::TransferObjects(objs, addr) => {
                write!(f, "TransferObjects([")?;
                write_sep(f, objs, ",")?;
                write!(f, "],{addr})")
            }
            Self::SplitCoins(coin, amounts) => {
                write!(f, "SplitCoins({coin},")?;
                write_sep(f, amounts, ",")?;
                write!(f, ")")
            }
            Self::MergeCoins(target, coins) => {
                write!(f, "MergeCoins({target},")?;
                write_sep(f, coins, ",")?;
                write!(f, ")")
            }
            Self::Publish(deps) => {
                write!(f, "Publish(<modules>,")?;
                write_sep(f, deps, ",")?;
                write!(f, ")")
            }
            Self::Upgrade(deps, current_package_id, ticket) => {
                write!(f, "Upgrade(<modules>, {ticket},")?;
                write_sep(f, deps, ",")?;
                write!(f, ", {current_package_id}")?;
                write!(f, ")")
            }
        }
    }
}

impl From<Command> for IotaCommand {
    fn from(value: Command) -> Self {
        match value {
            Command::MoveCall(m) => IotaCommand::MoveCall(Box::new((*m).into())),
            Command::TransferObjects(args, arg) => IotaCommand::TransferObjects(
                args.into_iter().map(IotaArgument::from).collect(),
                arg.into(),
            ),
            Command::SplitCoins(arg, args) => IotaCommand::SplitCoins(
                arg.into(),
                args.into_iter().map(IotaArgument::from).collect(),
            ),
            Command::MergeCoins(arg, args) => IotaCommand::MergeCoins(
                arg.into(),
                args.into_iter().map(IotaArgument::from).collect(),
            ),
            Command::Publish(_modules, dep_ids) => IotaCommand::Publish(dep_ids),
            Command::MakeMoveVec(tag_opt, args) => IotaCommand::MakeMoveVec(
                tag_opt.map(|tag| tag.to_string()),
                args.into_iter().map(IotaArgument::from).collect(),
            ),
            Command::Upgrade(_modules, dep_ids, current_package_id, ticket) => {
                IotaCommand::Upgrade(dep_ids, current_package_id, IotaArgument::from(ticket))
            }
        }
    }
}

/// An argument to a transaction in a programmable transaction block
#[derive(Debug, Copy, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub enum IotaArgument {
    /// The gas coin. The gas coin can only be used by-ref, except for with
    /// `TransferObjects`, which can use it by-value.
    GasCoin,
    /// One of the input objects or primitive values (from
    /// `ProgrammableTransactionBlock` inputs)
    Input(u16),
    /// The result of another transaction (from `ProgrammableTransactionBlock`
    /// transactions)
    Result(u16),
    /// Like a `Result` but it accesses a nested result. Currently, the only
    /// usage of this is to access a value from a Move call with multiple
    /// return values.
    NestedResult(u16, u16),
}

impl Display for IotaArgument {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::GasCoin => write!(f, "GasCoin"),
            Self::Input(i) => write!(f, "Input({i})"),
            Self::Result(i) => write!(f, "Result({i})"),
            Self::NestedResult(i, j) => write!(f, "NestedResult({i},{j})"),
        }
    }
}

impl From<Argument> for IotaArgument {
    fn from(value: Argument) -> Self {
        match value {
            Argument::GasCoin => Self::GasCoin,
            Argument::Input(i) => Self::Input(i),
            Argument::Result(i) => Self::Result(i),
            Argument::NestedResult(i, j) => Self::NestedResult(i, j),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(untagged)]
pub enum PtbInput {
    PtbRef(IotaArgument),
    CallArg(IotaJsonValue),
}

/// The transaction for calling a Move function, either an entry function or a
/// public function (which cannot return references).
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub struct IotaProgrammableMoveCall {
    /// The package containing the module and function.
    pub package: ObjectID,
    /// The specific module in the package containing the function.
    pub module: String,
    /// The function to be called.
    pub function: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    /// The type arguments to the function.
    pub type_arguments: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    /// The arguments to the function.
    pub arguments: Vec<IotaArgument>,
}

fn write_sep<T: Display>(
    f: &mut Formatter<'_>,
    items: impl IntoIterator<Item = T>,
    sep: &str,
) -> std::fmt::Result {
    let mut xs = items.into_iter().peekable();
    while let Some(x) = xs.next() {
        write!(f, "{x}")?;
        if xs.peek().is_some() {
            write!(f, "{sep}")?;
        }
    }
    Ok(())
}

impl Display for IotaProgrammableMoveCall {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Self {
            package,
            module,
            function,
            type_arguments,
            arguments,
        } = self;
        write!(f, "{package}::{module}::{function}")?;
        if !type_arguments.is_empty() {
            write!(f, "<")?;
            write_sep(f, type_arguments, ",")?;
            write!(f, ">")?;
        }
        write!(f, "(")?;
        write_sep(f, arguments, ",")?;
        write!(f, ")")
    }
}

impl From<ProgrammableMoveCall> for IotaProgrammableMoveCall {
    fn from(value: ProgrammableMoveCall) -> Self {
        let ProgrammableMoveCall {
            package,
            module,
            function,
            type_arguments,
            arguments,
        } = value;
        Self {
            package,
            module,
            function,
            type_arguments: type_arguments.into_iter().map(|t| t.to_string()).collect(),
            arguments: arguments.into_iter().map(IotaArgument::from).collect(),
        }
    }
}

const fn default_shared_object_mutability() -> bool {
    true
}

impl From<InputObjectKind> for IotaInputObjectKind {
    fn from(input: InputObjectKind) -> Self {
        match input {
            InputObjectKind::MovePackage(id) => Self::MovePackage(id),
            InputObjectKind::ImmOrOwnedMoveObject(oref) => Self::ImmOrOwnedMoveObject(oref.into()),
            InputObjectKind::SharedMoveObject {
                id,
                initial_shared_version,
                mutable,
            } => Self::SharedMoveObject {
                id,
                initial_shared_version,
                mutable,
            },
        }
    }
}

#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone)]
#[serde(rename = "TypeTag", rename_all = "camelCase")]
pub struct IotaTypeTag(String);

impl IotaTypeTag {
    pub fn new(tag: String) -> Self {
        Self(tag)
    }
}

impl AsRef<str> for IotaTypeTag {
    fn as_ref(&self) -> &str {
        &self.0
    }
}

impl TryFrom<IotaTypeTag> for TypeTag {
    type Error = anyhow::Error;
    fn try_from(tag: IotaTypeTag) -> Result<Self, Self::Error> {
        parse_iota_type_tag(&tag.0)
    }
}

impl From<TypeTag> for IotaTypeTag {
    fn from(tag: TypeTag) -> Self {
        Self(format!("{tag}"))
    }
}

#[derive(Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub enum RPCTransactionRequestParams {
    TransferObjectRequestParams(TransferObjectParams),
    MoveCallRequestParams(MoveCallParams),
}

#[derive(Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct TransferObjectParams {
    pub recipient: IotaAddress,
    pub object_id: ObjectID,
}

#[derive(Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct MoveCallParams {
    pub package_object_id: ObjectID,
    pub module: String,
    pub function: String,
    #[serde(default)]
    pub type_arguments: Vec<IotaTypeTag>,
    pub arguments: Vec<PtbInput>,
}

#[serde_as]
#[derive(Serialize, Deserialize, Clone, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct TransactionBlockBytes {
    /// BCS serialized transaction data bytes without its type tag, as base-64
    /// encoded string.
    pub tx_bytes: Base64,
    /// the gas objects to be used
    pub gas: Vec<IotaObjectRef>,
    /// objects to be used in this transaction
    pub input_objects: Vec<IotaInputObjectKind>,
}

impl TransactionBlockBytes {
    pub fn from_data(data: TransactionData) -> Result<Self, anyhow::Error> {
        Ok(Self {
            tx_bytes: Base64::from_bytes(bcs::to_bytes(&data)?.as_slice()),
            gas: data
                .gas()
                .iter()
                .map(|obj_ref| IotaObjectRef::from(*obj_ref))
                .collect(),
            input_objects: data
                .input_objects()?
                .into_iter()
                .map(IotaInputObjectKind::from)
                .collect(),
        })
    }

    pub fn to_data(self) -> Result<TransactionData, anyhow::Error> {
        bcs::from_bytes::<TransactionData>(&self.tx_bytes.to_vec().map_err(|e| anyhow::anyhow!(e))?)
            .map_err(|e| anyhow::anyhow!(e))
    }
}

#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[serde(rename = "OwnedObjectRef")]
pub struct OwnedObjectRef {
    pub owner: Owner,
    pub reference: IotaObjectRef,
}

impl OwnedObjectRef {
    pub fn object_id(&self) -> ObjectID {
        self.reference.object_id
    }
    pub fn version(&self) -> SequenceNumber {
        self.reference.version
    }
}

#[derive(Eq, PartialEq, Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum IotaCallArg {
    // Needs to become an Object Ref or Object ID, depending on object type
    Object(IotaObjectArg),
    // pure value, bcs encoded
    Pure(IotaPureValue),
}

impl IotaCallArg {
    pub fn try_from(
        value: CallArg,
        layout: Option<&MoveTypeLayout>,
    ) -> Result<Self, anyhow::Error> {
        Ok(match value {
            CallArg::Pure(p) => IotaCallArg::Pure(IotaPureValue {
                value_type: layout.map(|l| l.into()),
                value: IotaJsonValue::from_bcs_bytes(layout, &p)?,
            }),
            CallArg::Object(ObjectArg::ImmOrOwnedObject((id, version, digest))) => {
                IotaCallArg::Object(IotaObjectArg::ImmOrOwnedObject {
                    object_id: id,
                    version,
                    digest,
                })
            }
            CallArg::Object(ObjectArg::SharedObject {
                id,
                initial_shared_version,
                mutable,
            }) => IotaCallArg::Object(IotaObjectArg::SharedObject {
                object_id: id,
                initial_shared_version,
                mutable,
            }),
            CallArg::Object(ObjectArg::Receiving((object_id, version, digest))) => {
                IotaCallArg::Object(IotaObjectArg::Receiving {
                    object_id,
                    version,
                    digest,
                })
            }
        })
    }

    pub fn pure(&self) -> Option<&IotaJsonValue> {
        match self {
            IotaCallArg::Pure(v) => Some(&v.value),
            _ => None,
        }
    }

    pub fn object(&self) -> Option<&ObjectID> {
        match self {
            IotaCallArg::Object(IotaObjectArg::SharedObject { object_id, .. })
            | IotaCallArg::Object(IotaObjectArg::ImmOrOwnedObject { object_id, .. })
            | IotaCallArg::Object(IotaObjectArg::Receiving { object_id, .. }) => Some(object_id),
            _ => None,
        }
    }
}

#[serde_as]
#[derive(Eq, PartialEq, Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct IotaPureValue {
    #[schemars(with = "Option<String>")]
    #[serde_as(as = "Option<AsIotaTypeTag>")]
    value_type: Option<TypeTag>,
    value: IotaJsonValue,
}

impl IotaPureValue {
    pub fn value(&self) -> IotaJsonValue {
        self.value.clone()
    }

    pub fn value_type(&self) -> Option<TypeTag> {
        self.value_type.clone()
    }
}

#[serde_as]
#[derive(Eq, PartialEq, Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(tag = "objectType", rename_all = "camelCase")]
pub enum IotaObjectArg {
    // A Move object, either immutable, or owned mutable.
    #[serde(rename_all = "camelCase")]
    ImmOrOwnedObject {
        object_id: ObjectID,
        #[schemars(with = "AsSequenceNumber")]
        #[serde_as(as = "AsSequenceNumber")]
        version: SequenceNumber,
        digest: ObjectDigest,
    },
    // A Move object that's shared.
    // SharedObject::mutable controls whether caller asks for a mutable reference to shared
    // object.
    #[serde(rename_all = "camelCase")]
    SharedObject {
        object_id: ObjectID,
        #[schemars(with = "AsSequenceNumber")]
        #[serde_as(as = "AsSequenceNumber")]
        initial_shared_version: SequenceNumber,
        mutable: bool,
    },
    // A reference to a Move object that's going to be received in the transaction.
    #[serde(rename_all = "camelCase")]
    Receiving {
        object_id: ObjectID,
        #[schemars(with = "AsSequenceNumber")]
        #[serde_as(as = "AsSequenceNumber")]
        version: SequenceNumber,
        digest: ObjectDigest,
    },
}

#[derive(Clone)]
pub struct EffectsWithInput {
    pub effects: IotaTransactionBlockEffects,
    pub input: TransactionData,
}

impl From<EffectsWithInput> for IotaTransactionBlockEffects {
    fn from(e: EffectsWithInput) -> Self {
        e.effects
    }
}

#[serde_as]
#[derive(Clone, Debug, JsonSchema, Serialize, Deserialize)]
pub enum TransactionFilter {
    /// Query by checkpoint.
    Checkpoint(
        #[schemars(with = "BigInt<u64>")]
        #[serde_as(as = "Readable<BigInt<u64>, _>")]
        CheckpointSequenceNumber,
    ),
    /// Query by move function.
    MoveFunction {
        package: ObjectID,
        module: Option<String>,
        function: Option<String>,
    },
    /// Query by input object.
    InputObject(ObjectID),
    /// Query by changed object, including created, mutated and unwrapped
    /// objects.
    ChangedObject(ObjectID),
    /// Query by sender address.
    FromAddress(IotaAddress),
    /// Query by recipient address.
    ToAddress(IotaAddress),
    /// Query by sender and recipient address.
    FromAndToAddress { from: IotaAddress, to: IotaAddress },
    /// Query txs that have a given address as sender or recipient.
    FromOrToAddress { addr: IotaAddress },
    /// Query by transaction kind
    TransactionKind(IotaTransactionKind),
    /// Query transactions of any given kind in the input.
    TransactionKindIn(Vec<IotaTransactionKind>),
}

impl TransactionFilter {
    pub fn as_v2(&self) -> TransactionFilterV2 {
        match self {
            TransactionFilter::InputObject(o) => TransactionFilterV2::InputObject(*o),
            TransactionFilter::ChangedObject(o) => TransactionFilterV2::ChangedObject(*o),
            TransactionFilter::FromAddress(a) => TransactionFilterV2::FromAddress(*a),
            TransactionFilter::ToAddress(a) => TransactionFilterV2::ToAddress(*a),
            TransactionFilter::FromAndToAddress { from, to } => {
                TransactionFilterV2::FromAndToAddress {
                    from: *from,
                    to: *to,
                }
            }
            TransactionFilter::FromOrToAddress { addr } => {
                TransactionFilterV2::FromOrToAddress { addr: *addr }
            }
            TransactionFilter::MoveFunction {
                package,
                module,
                function,
            } => TransactionFilterV2::MoveFunction {
                package: *package,
                module: module.clone(),
                function: function.clone(),
            },
            TransactionFilter::TransactionKind(kind) => TransactionFilterV2::TransactionKind(*kind),
            TransactionFilter::TransactionKindIn(kinds) => {
                TransactionFilterV2::TransactionKindIn(kinds.clone())
            }
            TransactionFilter::Checkpoint(checkpoint) => {
                TransactionFilterV2::Checkpoint(*checkpoint)
            }
        }
    }
}

impl Filter<EffectsWithInput> for TransactionFilter {
    fn matches(&self, item: &EffectsWithInput) -> bool {
        let _scope = monitored_scope("TransactionFilter::matches");
        match self {
            TransactionFilter::InputObject(o) => {
                let Ok(input_objects) = item.input.input_objects() else {
                    return false;
                };
                input_objects.iter().any(|object| object.object_id() == *o)
            }
            TransactionFilter::ChangedObject(o) => item
                .effects
                .mutated()
                .iter()
                .any(|oref: &OwnedObjectRef| &oref.reference.object_id == o),
            TransactionFilter::FromAddress(a) => &item.input.sender() == a,
            TransactionFilter::ToAddress(a) => {
                let mutated: &[OwnedObjectRef] = item.effects.mutated();
                mutated.iter().chain(item.effects.unwrapped().iter()).any(|oref: &OwnedObjectRef| {
                    matches!(oref.owner, Owner::AddressOwner(owner) if owner == *a)
                })
            }
            TransactionFilter::FromAndToAddress { from, to } => {
                Self::FromAddress(*from).matches(item) && Self::ToAddress(*to).matches(item)
            }
            TransactionFilter::FromOrToAddress { addr } => {
                Self::FromAddress(*addr).matches(item) || Self::ToAddress(*addr).matches(item)
            }
            TransactionFilter::MoveFunction {
                package,
                module,
                function,
            } => item.input.move_calls().into_iter().any(|(p, m, f)| {
                p == package
                    && (module.is_none() || matches!(module,  Some(m2) if m2 == &m.to_string()))
                    && (function.is_none() || matches!(function, Some(f2) if f2 == &f.to_string()))
            }),
            TransactionFilter::TransactionKind(kind) => {
                kind == &IotaTransactionKind::from(item.input.kind())
            }
            TransactionFilter::TransactionKindIn(kinds) => kinds
                .iter()
                .any(|kind| kind == &IotaTransactionKind::from(item.input.kind())),
            // this filter is not supported, RPC will reject it on subscription
            TransactionFilter::Checkpoint(_) => false,
        }
    }
}

#[serde_as]
#[derive(Clone, Debug, JsonSchema, Serialize, Deserialize)]
#[non_exhaustive]
pub enum TransactionFilterV2 {
    /// Query by checkpoint.
    Checkpoint(
        #[schemars(with = "BigInt<u64>")]
        #[serde_as(as = "Readable<BigInt<u64>, _>")]
        CheckpointSequenceNumber,
    ),
    /// Query by move function.
    MoveFunction {
        package: ObjectID,
        module: Option<String>,
        function: Option<String>,
    },
    /// Query by input object.
    InputObject(ObjectID),
    /// Query by changed object, including created, mutated and unwrapped
    /// objects.
    ChangedObject(ObjectID),
    /// Query transactions that wrapped or deleted the specified object.
    /// Includes transactions that either created and immediately wrapped
    /// the object or unwrapped and immediately deleted it.
    WrappedOrDeletedObject(ObjectID),
    /// Query by sender address.
    FromAddress(IotaAddress),
    /// Query by recipient address.
    ToAddress(IotaAddress),
    /// Query by sender and recipient address.
    FromAndToAddress { from: IotaAddress, to: IotaAddress },
    /// Query txs that have a given address as sender or recipient.
    FromOrToAddress { addr: IotaAddress },
    /// Query by transaction kind
    TransactionKind(IotaTransactionKind),
    /// Query transactions of any given kind in the input.
    TransactionKindIn(Vec<IotaTransactionKind>),
}

impl TransactionFilterV2 {
    pub fn as_v1(&self) -> Option<TransactionFilter> {
        match self {
            TransactionFilterV2::InputObject(o) => Some(TransactionFilter::InputObject(*o)),
            TransactionFilterV2::ChangedObject(o) => Some(TransactionFilter::ChangedObject(*o)),
            TransactionFilterV2::FromAddress(a) => Some(TransactionFilter::FromAddress(*a)),
            TransactionFilterV2::ToAddress(a) => Some(TransactionFilter::ToAddress(*a)),
            TransactionFilterV2::FromAndToAddress { from, to } => {
                Some(TransactionFilter::FromAndToAddress {
                    from: *from,
                    to: *to,
                })
            }
            TransactionFilterV2::FromOrToAddress { addr } => {
                Some(TransactionFilter::FromOrToAddress { addr: *addr })
            }
            TransactionFilterV2::MoveFunction {
                package,
                module,
                function,
            } => Some(TransactionFilter::MoveFunction {
                package: *package,
                module: module.clone(),
                function: function.clone(),
            }),
            TransactionFilterV2::TransactionKind(kind) => {
                Some(TransactionFilter::TransactionKind(*kind))
            }
            TransactionFilterV2::TransactionKindIn(kinds) => {
                Some(TransactionFilter::TransactionKindIn(kinds.clone()))
            }
            TransactionFilterV2::Checkpoint(checkpoint) => {
                Some(TransactionFilter::Checkpoint(*checkpoint))
            }
            // V2-only variants which do not have a V1 equivalent
            TransactionFilterV2::WrappedOrDeletedObject(_) => None,
        }
    }
}

impl Filter<EffectsWithInput> for TransactionFilterV2 {
    fn matches(&self, item: &EffectsWithInput) -> bool {
        let _scope = monitored_scope("TransactionFilterV2::matches");
        if let Some(v1) = self.as_v1() {
            return v1.matches(item);
        }
        // Fallback for new V2-only variants:
        match self {
            TransactionFilterV2::WrappedOrDeletedObject(o) => item
                .effects
                .wrapped()
                .iter()
                .chain(item.effects.deleted())
                .chain(item.effects.unwrapped_then_deleted())
                .any(|oref| &oref.object_id == o),

            _ => false,
        }
    }
}

/// Represents the type of a transaction. All transactions except
/// `ProgrammableTransaction` are considered system transactions.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, EnumString, Display, Serialize, Deserialize, JsonSchema,
)]
#[non_exhaustive]
pub enum IotaTransactionKind {
    /// The `SystemTransaction` variant can be used to filter for all types of
    /// system transactions.
    SystemTransaction = 0,
    ProgrammableTransaction = 1,
    Genesis = 2,
    ConsensusCommitPrologueV1 = 3,
    AuthenticatorStateUpdateV1 = 4,
    RandomnessStateUpdate = 5,
    EndOfEpochTransaction = 6,
}

impl IotaTransactionKind {
    /// Returns true if the transaction is a system transaction.
    pub fn is_system_transaction(&self) -> bool {
        !matches!(self, Self::ProgrammableTransaction)
    }
}

impl From<&TransactionKind> for IotaTransactionKind {
    fn from(kind: &TransactionKind) -> Self {
        match kind {
            TransactionKind::Genesis(_) => Self::Genesis,
            TransactionKind::ConsensusCommitPrologueV1(_) => Self::ConsensusCommitPrologueV1,
            TransactionKind::AuthenticatorStateUpdateV1(_) => Self::AuthenticatorStateUpdateV1,
            TransactionKind::RandomnessStateUpdate(_) => Self::RandomnessStateUpdate,
            TransactionKind::EndOfEpochTransaction(_) => Self::EndOfEpochTransaction,
            TransactionKind::ProgrammableTransaction(_) => Self::ProgrammableTransaction,
        }
    }
}