sui_json_rpc/

coin_api.rs

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

use std::collections::HashMap;
use std::sync::Arc;

use async_trait::async_trait;
use cached::SizedCache;
use cached::proc_macro::cached;
use jsonrpsee::RpcModule;
use jsonrpsee::core::RpcResult;
use move_core_types::language_storage::{StructTag, TypeTag};
use sui_core::jsonrpc_index::TotalBalance;
use tap::TapFallible;
use tracing::{debug, instrument};

use sui_core::authority::AuthorityState;
use sui_json_rpc_api::{CoinReadApiOpenRpc, CoinReadApiServer, JsonRpcMetrics, cap_page_limit};
use sui_json_rpc_types::Balance;
use sui_json_rpc_types::{CoinPage, SuiCoinMetadata};
use sui_open_rpc::Module;
use sui_storage::key_value_store::TransactionKeyValueStore;
use sui_types::balance::Supply;
use sui_types::base_types::{ObjectID, SuiAddress};
use sui_types::coin::{CoinMetadata, TreasuryCap};
use sui_types::coin_registry::{Currency, SupplyState};
use sui_types::effects::TransactionEffectsAPI;
use sui_types::gas_coin::{GAS, TOTAL_SUPPLY_MIST};
use sui_types::object::Object;
use sui_types::parse_sui_struct_tag;
use sui_types::storage::ObjectStore;

#[cfg(test)]
use mockall::automock;

use crate::authority_state::StateRead;
use crate::error::{Error, RpcInterimResult, SuiRpcInputError};
use crate::{SuiRpcModule, with_tracing};

pub fn parse_to_struct_tag(coin_type: &str) -> Result<StructTag, SuiRpcInputError> {
    parse_sui_struct_tag(coin_type)
        .map_err(|e| SuiRpcInputError::CannotParseSuiStructTag(format!("{e}")))
}

pub fn parse_to_type_tag(coin_type: Option<String>) -> Result<TypeTag, SuiRpcInputError> {
    Ok(TypeTag::Struct(Box::new(match coin_type {
        Some(c) => parse_to_struct_tag(&c)?,
        None => GAS::type_(),
    })))
}

pub struct CoinReadApi {
    // Trait object w/ Box as we do not need to share this across multiple threads
    internal: Box<dyn CoinReadInternal + Send + Sync>,
}

impl CoinReadApi {
    pub fn new(
        state: Arc<AuthorityState>,
        transaction_kv_store: Arc<TransactionKeyValueStore>,
        metrics: Arc<JsonRpcMetrics>,
    ) -> Self {
        Self {
            internal: Box::new(CoinReadInternalImpl::new(
                state,
                transaction_kv_store,
                metrics,
            )),
        }
    }
}

impl SuiRpcModule for CoinReadApi {
    fn rpc(self) -> RpcModule<Self> {
        self.into_rpc()
    }

    fn rpc_doc_module() -> Module {
        CoinReadApiOpenRpc::module_doc()
    }
}

#[derive(serde::Serialize, serde::Deserialize)]
struct CoinCursor {
    coin_type: String,
    inverted_balance: u64,
    object_id: ObjectID,
}

impl CoinCursor {
    fn new(coin_type: String, balance: u64, object_id: ObjectID) -> Self {
        Self {
            coin_type,
            inverted_balance: !balance,
            object_id,
        }
    }

    fn encode(&self) -> String {
        use base64::Engine;
        use base64::prelude::BASE64_STANDARD;

        let json = serde_json::to_string(self).unwrap();

        BASE64_STANDARD.encode(json.as_bytes())
    }

    fn decode(cursor: &str) -> Option<Self> {
        use base64::Engine;
        use base64::prelude::BASE64_STANDARD;

        let bytes = BASE64_STANDARD.decode(cursor).ok()?;
        serde_json::from_slice(&bytes).ok()
    }
}

#[async_trait]
impl CoinReadApiServer for CoinReadApi {
    #[instrument(skip(self))]
    async fn get_coins(
        &self,
        owner: SuiAddress,
        coin_type: Option<String>,
        // exclusive cursor if `Some`, otherwise start from the beginning
        cursor: Option<String>,
        limit: Option<usize>,
    ) -> RpcResult<CoinPage> {
        with_tracing!(async move {
            let coin_type_tag = parse_to_type_tag(coin_type)?;

            let cursor = match cursor {
                Some(c) => {
                    let decoded = CoinCursor::decode(&c).ok_or_else(|| {
                        SuiRpcInputError::GenericInvalid("invalid cursor".to_string())
                    })?;

                    if coin_type_tag.to_string() != decoded.coin_type {
                        return Err(
                            SuiRpcInputError::GenericInvalid("invalid cursor".to_string()).into(),
                        );
                    }
                    (
                        decoded.coin_type,
                        decoded.inverted_balance,
                        decoded.object_id,
                    )
                }
                // If cursor is not specified, we need to start from the beginning of the coin type, which is the minimal possible ObjectID.
                None => (coin_type_tag.to_string(), 0, ObjectID::ZERO),
            };

            self.internal
                .get_coins_iterator(
                    owner, cursor, limit, true, // only care about one type of coin
                )
                .await
        })
    }

    #[instrument(skip(self))]
    async fn get_all_coins(
        &self,
        owner: SuiAddress,
        // exclusive cursor if `Some`, otherwise start from the beginning
        cursor: Option<String>,
        limit: Option<usize>,
    ) -> RpcResult<CoinPage> {
        with_tracing!(async move {
            let cursor = match cursor {
                Some(c) => {
                    let decoded = CoinCursor::decode(&c).ok_or_else(|| {
                        SuiRpcInputError::GenericInvalid("invalid cursor".to_string())
                    })?;
                    (
                        decoded.coin_type,
                        decoded.inverted_balance,
                        decoded.object_id,
                    )
                }
                None => {
                    // If cursor is None, start from the beginning
                    (
                        String::from_utf8([0u8].to_vec()).unwrap(),
                        0,
                        ObjectID::ZERO,
                    )
                }
            };

            let coins = self
                .internal
                .get_coins_iterator(
                    owner, cursor, limit, false, // return all types of coins
                )
                .await?;

            Ok(coins)
        })
    }

    #[instrument(skip(self))]
    async fn get_balance(
        &self,
        owner: SuiAddress,
        coin_type: Option<String>,
    ) -> RpcResult<Balance> {
        with_tracing!(async move {
            let coin_type_tag = parse_to_type_tag(coin_type)?;
            let balance = self
                .internal
                .get_balance(owner, coin_type_tag.clone())
                .await
                .tap_err(|e| {
                    debug!(?owner, "Failed to get balance with error: {:?}", e);
                })?;
            Ok(Balance {
                coin_type: coin_type_tag.to_string(),
                coin_object_count: balance.num_coins as usize,
                total_balance: balance.balance as u128,
                // note: LockedCoin is deprecated
                locked_balance: Default::default(),
            })
        })
    }

    #[instrument(skip(self))]
    async fn get_all_balances(&self, owner: SuiAddress) -> RpcResult<Vec<Balance>> {
        with_tracing!(async move {
            let all_balance = self.internal.get_all_balance(owner).await.tap_err(|e| {
                debug!(?owner, "Failed to get all balance with error: {:?}", e);
            })?;
            Ok(all_balance
                .iter()
                .map(|(coin_type, balance)| {
                    Balance {
                        coin_type: coin_type.to_string(),
                        coin_object_count: balance.num_coins as usize,
                        total_balance: balance.balance as u128,
                        // note: LockedCoin is deprecated
                        locked_balance: Default::default(),
                    }
                })
                .collect())
        })
    }

    #[instrument(skip(self))]
    async fn get_coin_metadata(&self, coin_type: String) -> RpcResult<Option<SuiCoinMetadata>> {
        with_tracing!(async move {
            let coin_struct = parse_to_struct_tag(&coin_type)?;

            let state = self.internal.get_state();
            let object_store = state.get_object_store();
            if let Some(currency) = get_currency_from_registry(object_store, &coin_struct).await? {
                return Ok(Some(currency.into()));
            }

            let metadata_object = self
                .internal
                .find_package_object(
                    &coin_struct.address.into(),
                    CoinMetadata::type_(coin_struct),
                )
                .await
                .ok();
            Ok(metadata_object.and_then(|v: Object| v.try_into().ok()))
        })
    }

    #[instrument(skip(self))]
    async fn get_total_supply(&self, coin_type: String) -> RpcResult<Supply> {
        with_tracing!(async move {
            let coin_struct = parse_to_struct_tag(&coin_type)?;

            if GAS::is_gas(&coin_struct) {
                return Ok(Supply {
                    value: TOTAL_SUPPLY_MIST,
                });
            }

            let state = self.internal.get_state();
            let object_store = state.get_object_store();
            if let Some(currency) = get_currency_from_registry(object_store, &coin_struct).await? {
                match &currency.supply {
                    Some(SupplyState::Fixed(supply)) | Some(SupplyState::BurnOnly(supply)) => {
                        return Ok(Supply { value: *supply });
                    }
                    _ => {
                        if let Some(treasury_cap_id) = currency.treasury_cap_id {
                            let state = self.internal.get_state();
                            let object_store = state.get_object_store();
                            if let Some(treasury_cap_obj) =
                                object_store.get_object(&treasury_cap_id)
                            {
                                let treasury_cap = TreasuryCap::from_bcs_bytes(
                                    treasury_cap_obj
                                        .data
                                        .try_as_move()
                                        .ok_or_else(|| {
                                            Error::UnexpectedError(
                                                "Treasury cap is not a Move object".to_string(),
                                            )
                                        })?
                                        .contents(),
                                )
                                .map_err(Error::from)?;
                                return Ok(treasury_cap.total_supply);
                            }
                        }
                    }
                }
            }

            let treasury_cap_object = self
                .internal
                .find_package_object(&coin_struct.address.into(), TreasuryCap::type_(coin_struct))
                .await?;
            let treasury_cap = TreasuryCap::from_bcs_bytes(
                treasury_cap_object.data.try_as_move().unwrap().contents(),
            )
            .map_err(Error::from)?;
            Ok(treasury_cap.total_supply)
        })
    }
}

#[cached(
    type = "SizedCache<String, ObjectID>",
    create = "{ SizedCache::with_size(10000) }",
    convert = r#"{ format!("{}{}", package_id, object_struct_tag) }"#,
    result = true
)]
async fn find_package_object_id(
    state: Arc<dyn StateRead>,
    package_id: ObjectID,
    object_struct_tag: StructTag,
    kv_store: Arc<TransactionKeyValueStore>,
) -> RpcInterimResult<ObjectID> {
    async move {
        let publish_txn_digest = state.find_publish_txn_digest(package_id)?;

        let effect = kv_store.get_fx_by_tx_digest(publish_txn_digest).await?;

        for ((id, _, _), _) in effect.created() {
            if let Ok(object_read) = state.get_object_read(&id)
                && let Ok(object) = object_read.into_object()
                && matches!(object.type_(), Some(type_) if type_.is(&object_struct_tag))
            {
                return Ok(id);
            }
        }
        Err(SuiRpcInputError::GenericNotFound(format!(
            "Cannot find object with type [{}] from [{}] package created objects.",
            object_struct_tag, package_id,
        ))
        .into())
    }
    .await
}

/// CoinReadInternal trait to capture logic of interactions with AuthorityState and metrics
/// This allows us to also mock internal implementation for testing
#[cfg_attr(test, automock)]
#[async_trait]
pub trait CoinReadInternal {
    fn get_state(&self) -> Arc<dyn StateRead>;
    async fn get_object(&self, object_id: &ObjectID) -> RpcInterimResult<Option<Object>>;
    async fn get_balance(
        &self,
        owner: SuiAddress,
        coin_type: TypeTag,
    ) -> RpcInterimResult<TotalBalance>;
    async fn get_all_balance(
        &self,
        owner: SuiAddress,
    ) -> RpcInterimResult<Arc<HashMap<TypeTag, TotalBalance>>>;
    async fn find_package_object(
        &self,
        package_id: &ObjectID,
        object_struct_tag: StructTag,
    ) -> RpcInterimResult<Object>;
    async fn get_coins_iterator(
        &self,
        owner: SuiAddress,
        cursor: (String, u64, ObjectID),
        limit: Option<usize>,
        one_coin_type_only: bool,
    ) -> RpcInterimResult<CoinPage>;
}

pub struct CoinReadInternalImpl {
    // Trait object w/ Arc as we have methods that require sharing this across multiple threads
    state: Arc<dyn StateRead>,
    transaction_kv_store: Arc<TransactionKeyValueStore>,
    pub metrics: Arc<JsonRpcMetrics>,
}

impl CoinReadInternalImpl {
    pub fn new(
        state: Arc<AuthorityState>,
        transaction_kv_store: Arc<TransactionKeyValueStore>,
        metrics: Arc<JsonRpcMetrics>,
    ) -> Self {
        Self {
            state,
            transaction_kv_store,
            metrics,
        }
    }
}

async fn get_currency_from_registry(
    object_store: &Arc<dyn ObjectStore + Send + Sync>,
    coin_type: &StructTag,
) -> RpcInterimResult<Option<Currency>> {
    let currency_id = Currency::derive_object_id(coin_type.clone().into()).map_err(|e| {
        Error::UnexpectedError(format!(
            "Failed to derive Currency ID for coin type {}: {}",
            coin_type, e
        ))
    })?;

    let currency_obj = match object_store.get_object(&currency_id) {
        Some(obj) => obj,
        None => return Ok(None),
    };

    let move_obj = currency_obj.data.try_as_move().ok_or_else(|| {
        Error::UnexpectedError(format!(
            "Currency for coin type {} is not a Move object",
            coin_type
        ))
    })?;

    let currency = bcs::from_bytes::<Currency>(move_obj.contents()).map_err(|e| {
        Error::UnexpectedError(format!(
            "Failed to deserialize Currency for coin type {}: {}",
            coin_type, e
        ))
    })?;

    Ok(Some(currency))
}

#[async_trait]
impl CoinReadInternal for CoinReadInternalImpl {
    fn get_state(&self) -> Arc<dyn StateRead> {
        self.state.clone()
    }

    async fn get_object(&self, object_id: &ObjectID) -> RpcInterimResult<Option<Object>> {
        Ok(self.state.get_object(object_id).await?)
    }

    async fn get_balance(
        &self,
        owner: SuiAddress,
        coin_type: TypeTag,
    ) -> RpcInterimResult<TotalBalance> {
        Ok(self.state.get_balance(owner, coin_type).await?)
    }

    async fn get_all_balance(
        &self,
        owner: SuiAddress,
    ) -> RpcInterimResult<Arc<HashMap<TypeTag, TotalBalance>>> {
        Ok(self.state.get_all_balance(owner).await?)
    }

    async fn find_package_object(
        &self,
        package_id: &ObjectID,
        object_struct_tag: StructTag,
    ) -> RpcInterimResult<Object> {
        let state = self.get_state();
        let kv_store = self.transaction_kv_store.clone();
        let object_id =
            find_package_object_id(state, *package_id, object_struct_tag, kv_store).await?;
        Ok(self.state.get_object_read(&object_id)?.into_object()?)
    }

    async fn get_coins_iterator(
        &self,
        owner: SuiAddress,
        cursor: (String, u64, ObjectID),
        limit: Option<usize>,
        one_coin_type_only: bool,
    ) -> RpcInterimResult<CoinPage> {
        let limit = cap_page_limit(limit);
        self.metrics.get_coins_limit.observe(limit as f64);
        let state = self.get_state();
        let mut data = state.get_owned_coins(owner, cursor, limit + 1, one_coin_type_only)?;

        let has_next_page = data.len() > limit;
        data.truncate(limit);

        self.metrics
            .get_coins_result_size
            .observe(data.len() as f64);
        self.metrics
            .get_coins_result_size_total
            .inc_by(data.len() as u64);
        let next_cursor = has_next_page
            .then(|| {
                data.last().map(|coin| {
                    CoinCursor::new(coin.coin_type.clone(), coin.balance, coin.coin_object_id)
                        .encode()
                })
            })
            .flatten();
        Ok(CoinPage {
            data,
            next_cursor,
            has_next_page,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::authority_state::{MockStateRead, StateReadError};
    use expect_test::expect;
    use mockall::mock;
    use mockall::predicate;
    use move_core_types::account_address::AccountAddress;
    use move_core_types::language_storage::StructTag;
    use sui_json_rpc_types::Coin;
    use sui_storage::key_value_store::{
        KVStoreCheckpointData, KVStoreTransactionData, TransactionKeyValueStoreTrait,
    };
    use sui_storage::key_value_store_metrics::KeyValueStoreMetrics;
    use sui_types::balance::Supply;
    use sui_types::base_types::{ObjectID, SequenceNumber, SuiAddress};
    use sui_types::coin::TreasuryCap;
    use sui_types::digests::{ObjectDigest, TransactionDigest};
    use sui_types::effects::{TransactionEffects, TransactionEvents};
    use sui_types::error::{SuiError, SuiErrorKind, SuiResult};
    use sui_types::gas_coin::GAS;
    use sui_types::id::UID;
    use sui_types::messages_checkpoint::{CheckpointDigest, CheckpointSequenceNumber};
    use sui_types::object::MoveObject;
    use sui_types::object::Object;
    use sui_types::object::Owner;
    use sui_types::utils::create_fake_transaction;
    use sui_types::{TypeTag, parse_sui_struct_tag};

    mock! {
        pub KeyValueStore {}
        #[async_trait]
        impl TransactionKeyValueStoreTrait for KeyValueStore {
            async fn multi_get(
                &self,
                transactions: &[TransactionDigest],
                effects: &[TransactionDigest],
            ) -> SuiResult<KVStoreTransactionData>;

            async fn multi_get_checkpoints(
                &self,
                checkpoint_summaries: &[CheckpointSequenceNumber],
                checkpoint_contents: &[CheckpointSequenceNumber],
                checkpoint_summaries_by_digest: &[CheckpointDigest],
            ) -> SuiResult<KVStoreCheckpointData>;

            async fn deprecated_get_transaction_checkpoint(
                &self,
                digest: TransactionDigest,
            ) -> SuiResult<Option<CheckpointSequenceNumber>>;

            async fn get_object(&self, object_id: ObjectID, version: SequenceNumber) -> SuiResult<Option<Object>>;
            async fn multi_get_objects(&self, object_keys: &[sui_types::storage::ObjectKey]) -> SuiResult<Vec<Option<Object>>>;

            async fn multi_get_transaction_checkpoint(
                &self,
                digests: &[TransactionDigest],
            ) -> SuiResult<Vec<Option<CheckpointSequenceNumber>>>;

            async fn multi_get_events_by_tx_digests(&self,digests: &[TransactionDigest]) -> SuiResult<Vec<Option<TransactionEvents>>>;
        }
    }

    impl CoinReadInternalImpl {
        pub fn new_for_tests(
            state: Arc<MockStateRead>,
            kv_store: Option<Arc<MockKeyValueStore>>,
        ) -> Self {
            let kv_store = kv_store.unwrap_or_else(|| Arc::new(MockKeyValueStore::new()));
            let metrics = KeyValueStoreMetrics::new_for_tests();
            let transaction_kv_store =
                Arc::new(TransactionKeyValueStore::new("rocksdb", metrics, kv_store));
            Self {
                state,
                transaction_kv_store,
                metrics: Arc::new(JsonRpcMetrics::new_for_tests()),
            }
        }
    }

    impl CoinReadApi {
        pub fn new_for_tests(
            state: Arc<MockStateRead>,
            kv_store: Option<Arc<MockKeyValueStore>>,
        ) -> Self {
            let kv_store = kv_store.unwrap_or_else(|| Arc::new(MockKeyValueStore::new()));
            Self {
                internal: Box::new(CoinReadInternalImpl::new_for_tests(state, Some(kv_store))),
            }
        }
    }

    fn get_test_owner() -> SuiAddress {
        AccountAddress::ONE.into()
    }

    fn get_test_package_id() -> ObjectID {
        ObjectID::from_hex_literal("0xf").unwrap()
    }

    fn get_test_coin_type(package_id: ObjectID) -> String {
        format!("{}::test_coin::TEST_COIN", package_id)
    }

    fn get_test_coin_type_tag(coin_type: String) -> TypeTag {
        TypeTag::Struct(Box::new(parse_sui_struct_tag(&coin_type).unwrap()))
    }

    enum CoinType {
        Gas,
        Usdc,
    }

    fn get_test_coin(id_hex_literal: Option<&str>, coin_type: CoinType) -> (Object, Coin) {
        let (arr, coin_type_string, balance, default_hex) = match coin_type {
            CoinType::Gas => ([0; 32], GAS::type_().to_string(), 42, "0xA"),
            CoinType::Usdc => (
                [1; 32],
                "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC".to_string(),
                24,
                "0xB",
            ),
        };

        let object_id = if let Some(literal) = id_hex_literal {
            ObjectID::from_hex_literal(literal).unwrap()
        } else {
            ObjectID::from_hex_literal(default_hex).unwrap()
        };
        let owner = get_test_owner();
        let previous_transaction = TransactionDigest::from(arr);
        let object = Object::new_move(
            MoveObject::new_coin(
                coin_type_string.parse::<TypeTag>().unwrap(),
                1.into(),
                object_id,
                balance,
            ),
            Owner::AddressOwner(owner),
            previous_transaction,
        );

        let coin = Coin {
            coin_type: coin_type_string,
            coin_object_id: object_id,
            version: SequenceNumber::from_u64(1),
            digest: ObjectDigest::from(arr),
            balance,
            previous_transaction,
        };

        (object, coin)
    }

    fn get_test_treasury_cap_peripherals(
        package_id: ObjectID,
    ) -> (String, StructTag, StructTag, TreasuryCap, Object) {
        let coin_name = get_test_coin_type(package_id);
        let input_coin_struct = parse_sui_struct_tag(&coin_name).expect("should not fail");
        let treasury_cap_struct = TreasuryCap::type_(input_coin_struct.clone());
        let treasury_cap = TreasuryCap {
            id: UID::new(get_test_package_id()),
            total_supply: Supply { value: 420 },
        };
        let treasury_cap_object =
            Object::treasury_cap_for_testing(input_coin_struct.clone(), treasury_cap.clone());
        (
            coin_name,
            input_coin_struct,
            treasury_cap_struct,
            treasury_cap,
            treasury_cap_object,
        )
    }

    fn create_currency_object(currency: Currency) -> Object {
        use sui_types::object::{Data, ObjectInner};

        let currency_bytes = bcs::to_bytes(&currency).unwrap();
        let data = Data::Move(unsafe {
            MoveObject::new_from_execution_with_limit(
                move_core_types::language_storage::StructTag {
                    address: move_core_types::account_address::AccountAddress::from_hex_literal(
                        "0x2",
                    )
                    .unwrap(),
                    module: move_core_types::identifier::Identifier::new("coin_registry").unwrap(),
                    name: move_core_types::identifier::Identifier::new("Currency").unwrap(),
                    type_params: vec![],
                }
                .into(),
                false,
                SequenceNumber::from_u64(1),
                currency_bytes,
                10000,
            )
            .unwrap()
        });
        ObjectInner {
            data,
            owner: Owner::Shared {
                initial_shared_version: SequenceNumber::from_u64(1),
            },
            previous_transaction: TransactionDigest::from([0; 32]),
            storage_rebate: 0,
        }
        .into()
    }

    mock! {
        pub ObjectStore {}
        impl sui_types::storage::ObjectStore for ObjectStore {
            fn get_object(&self, object_id: &ObjectID) -> Option<Object>;
            fn get_object_by_key(&self, object_id: &ObjectID, version: SequenceNumber) -> Option<Object>;
        }
    }

    fn setup_mock_object_store_with_registry(
        currency_id: ObjectID,
        currency_object: Object,
        treasury_cap: Option<(ObjectID, Object)>,
    ) -> MockObjectStore {
        let mut mock_object_store = MockObjectStore::new();

        mock_object_store
            .expect_get_object()
            .with(predicate::eq(currency_id))
            .return_once(move |_| Some(currency_object));

        if let Some((treasury_cap_id, treasury_cap_object)) = treasury_cap {
            mock_object_store
                .expect_get_object()
                .with(predicate::eq(treasury_cap_id))
                .return_once(move |_| Some(treasury_cap_object));
        }

        mock_object_store
    }

    mod get_coins_tests {
        use super::super::*;
        use super::*;

        // Success scenarios
        #[tokio::test]
        async fn test_gas_coin_no_cursor() {
            let owner = get_test_owner();
            let gas_coin = get_test_coin(None, CoinType::Gas).1;
            let gas_coin_clone = gas_coin.clone();
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .with(
                    predicate::eq(owner),
                    predicate::eq((GAS::type_().to_string(), 0, ObjectID::ZERO)),
                    predicate::eq(51),
                    predicate::eq(true),
                )
                .return_once(move |_, _, _, _| Ok(vec![gas_coin_clone]));

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api.get_coins(owner, None, None, None).await;
            assert!(response.is_ok());
            let result = response.unwrap();
            assert_eq!(
                result,
                CoinPage {
                    data: vec![gas_coin.clone()],
                    next_cursor: None,
                    has_next_page: false,
                }
            );
        }

        #[tokio::test]
        async fn test_gas_coin_with_cursor() {
            let owner = get_test_owner();
            let limit = 2;
            let coins = vec![
                get_test_coin(Some("0xA"), CoinType::Gas).1,
                get_test_coin(Some("0xAA"), CoinType::Gas).1,
                get_test_coin(Some("0xAAA"), CoinType::Gas).1,
            ];
            let coins_clone = coins.clone();
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .with(
                    predicate::eq(owner),
                    predicate::eq((
                        GAS::type_().to_string(),
                        !coins[0].balance,
                        coins[0].coin_object_id,
                    )),
                    predicate::eq(limit + 1),
                    predicate::eq(true),
                )
                .return_once(move |_, _, _, _| Ok(coins_clone));
            mock_state
                .expect_get_object()
                .with(predicate::eq(coins[0].coin_object_id))
                .return_once(|_| Ok(Some(get_test_coin(Some("0xA"), CoinType::Gas).0)));

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let cursor = CoinCursor::new(
                coins[0].coin_type.clone(),
                coins[0].balance,
                coins[0].coin_object_id,
            )
            .encode();
            let response = coin_read_api
                .get_coins(owner, None, Some(cursor), Some(limit))
                .await;
            assert!(response.is_ok());
            let result = response.unwrap();

            let expected_cursor = CoinCursor::new(
                coins[limit - 1].coin_type.clone(),
                coins[limit - 1].balance,
                coins[limit - 1].coin_object_id,
            )
            .encode();
            assert_eq!(
                result,
                CoinPage {
                    data: coins[..limit].to_vec(),
                    next_cursor: Some(expected_cursor),
                    has_next_page: true,
                }
            );
        }

        #[tokio::test]
        async fn test_coin_no_cursor() {
            let coin = get_test_coin(None, CoinType::Usdc).1;
            let coin_clone = coin.clone();
            // Build request params
            let owner = get_test_owner();
            let coin_type = coin.coin_type.clone();

            let coin_type_tag =
                TypeTag::Struct(Box::new(parse_sui_struct_tag(&coin.coin_type).unwrap()));
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .with(
                    predicate::eq(owner),
                    predicate::eq((coin_type_tag.to_string(), 0, ObjectID::ZERO)),
                    predicate::eq(51),
                    predicate::eq(true),
                )
                .return_once(move |_, _, _, _| Ok(vec![coin_clone]));

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_coins(owner, Some(coin_type), None, None)
                .await;

            assert!(response.is_ok());
            let result = response.unwrap();
            assert_eq!(
                result,
                CoinPage {
                    data: vec![coin.clone()],
                    next_cursor: None,
                    has_next_page: false,
                }
            );
        }

        #[tokio::test]
        async fn test_coin_with_cursor() {
            let coins = vec![
                get_test_coin(Some("0xB"), CoinType::Usdc).1,
                get_test_coin(Some("0xBB"), CoinType::Usdc).1,
                get_test_coin(Some("0xBBB"), CoinType::Usdc).1,
            ];
            let coins_clone = coins.clone();
            // Build request params
            let owner = get_test_owner();
            let coin_type = coins[0].coin_type.clone();
            let cursor = CoinCursor::new(
                coins[0].coin_type.clone(),
                coins[0].balance,
                coins[0].coin_object_id,
            )
            .encode();
            let limit = 2;

            let coin_type_tag =
                TypeTag::Struct(Box::new(parse_sui_struct_tag(&coins[0].coin_type).unwrap()));
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .with(
                    predicate::eq(owner),
                    predicate::eq((
                        coin_type_tag.to_string(),
                        !coins[0].balance,
                        coins[0].coin_object_id,
                    )),
                    predicate::eq(limit + 1),
                    predicate::eq(true),
                )
                .return_once(move |_, _, _, _| Ok(coins_clone));
            mock_state
                .expect_get_object()
                .with(predicate::eq(coins[0].coin_object_id))
                .return_once(|_| Ok(Some(get_test_coin(Some("0xBB"), CoinType::Usdc).0)));

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_coins(owner, Some(coin_type), Some(cursor), Some(limit))
                .await;

            assert!(response.is_ok());
            let result = response.unwrap();
            let expected_cursor = CoinCursor::new(
                coins[limit - 1].coin_type.clone(),
                coins[limit - 1].balance,
                coins[limit - 1].coin_object_id,
            )
            .encode();
            assert_eq!(
                result,
                CoinPage {
                    data: coins[..limit].to_vec(),
                    next_cursor: Some(expected_cursor),
                    has_next_page: true,
                }
            );
        }

        // Expected error scenarios
        #[tokio::test]
        async fn test_invalid_coin_type() {
            let owner = get_test_owner();
            let coin_type = "0x2::invalid::struct::tag";
            let mock_state = MockStateRead::new();
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_coins(owner, Some(coin_type.to_string()), None, None)
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            let expected = expect!["-32602"];
            expected.assert_eq(&error_object.code().to_string());
            let expected = expect![
                "Invalid struct type: 0x2::invalid::struct::tag. Got error: Expected end of token stream. Got: ::"
            ];
            expected.assert_eq(error_object.message());
        }

        #[tokio::test]
        async fn test_unrecognized_token() {
            let owner = get_test_owner();
            let coin_type = "0x2::sui:🤵";
            let mock_state = MockStateRead::new();
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_coins(owner, Some(coin_type.to_string()), None, None)
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            let expected = expect!["-32602"];
            expected.assert_eq(&error_object.code().to_string());
            let expected =
                expect!["Invalid struct type: 0x2::sui:🤵. Got error: unrecognized token: :🤵"];
            expected.assert_eq(error_object.message());
        }

        // Unexpected error scenarios
        #[tokio::test]
        async fn test_get_coins_iterator_index_store_not_available() {
            let owner = get_test_owner();
            let coin_type = get_test_coin_type(get_test_package_id());
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .returning(move |_, _, _, _| {
                    Err(StateReadError::Client(
                        SuiErrorKind::IndexStoreNotAvailable.into(),
                    ))
                });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_coins(owner, Some(coin_type.to_string()), None, None)
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            assert_eq!(
                error_object.code(),
                jsonrpsee::types::error::INVALID_PARAMS_CODE
            );
            let expected = expect!["Index store not available on this Fullnode."];
            expected.assert_eq(error_object.message());
        }

        #[tokio::test]
        async fn test_get_coins_iterator_typed_store_error() {
            let owner = get_test_owner();
            let coin_type = get_test_coin_type(get_test_package_id());
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .returning(move |_, _, _, _| {
                    Err(SuiErrorKind::Storage("mock rocksdb error".to_string()).into())
                });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_coins(owner, Some(coin_type.to_string()), None, None)
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            assert_eq!(
                error_object.code(),
                jsonrpsee::types::error::INTERNAL_ERROR_CODE
            );
            let expected = expect!["Storage error: mock rocksdb error"];
            expected.assert_eq(error_object.message());
        }
    }

    mod get_all_coins_tests {
        use sui_types::object::{MoveObject, Owner};

        use super::super::*;
        use super::*;

        // Success scenarios
        #[tokio::test]
        async fn test_no_cursor() {
            let owner = get_test_owner();
            let gas_coin = get_test_coin(None, CoinType::Gas).1;
            let gas_coin_clone = gas_coin.clone();
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_owned_coins()
                .with(
                    predicate::eq(owner),
                    predicate::eq((
                        String::from_utf8([0u8].to_vec()).unwrap(),
                        0,
                        ObjectID::ZERO,
                    )),
                    predicate::eq(51),
                    predicate::eq(false),
                )
                .return_once(move |_, _, _, _| Ok(vec![gas_coin_clone]));
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_all_coins(owner, None, Some(51))
                .await
                .unwrap();
            assert_eq!(response.data.len(), 1);
            assert_eq!(response.data[0], gas_coin);
        }

        #[tokio::test]
        async fn test_with_cursor() {
            let owner = get_test_owner();
            let limit = 2;
            let coins = vec![
                get_test_coin(Some("0xA"), CoinType::Gas).1,
                get_test_coin(Some("0xAA"), CoinType::Gas).1,
                get_test_coin(Some("0xAAA"), CoinType::Gas).1,
            ];
            let coins_clone = coins.clone();
            let coin_move_object = MoveObject::new_gas_coin(
                coins[0].version,
                coins[0].coin_object_id,
                coins[0].balance,
            );
            let coin_object = Object::new_move(
                coin_move_object,
                Owner::Immutable,
                coins[0].previous_transaction,
            );
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object()
                .return_once(move |_| Ok(Some(coin_object)));
            mock_state
                .expect_get_owned_coins()
                .with(
                    predicate::eq(owner),
                    predicate::eq((
                        coins[0].coin_type.clone(),
                        !coins[0].balance,
                        coins[0].coin_object_id,
                    )),
                    predicate::eq(limit + 1),
                    predicate::eq(false),
                )
                .return_once(move |_, _, _, _| Ok(coins_clone));
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let cursor = CoinCursor::new(
                coins[0].coin_type.clone(),
                coins[0].balance,
                coins[0].coin_object_id,
            )
            .encode();
            let response = coin_read_api
                .get_all_coins(owner, Some(cursor), Some(limit))
                .await
                .unwrap();
            assert_eq!(response.data.len(), limit);
            assert_eq!(response.data, coins[..limit].to_vec());
        }

        // Expected error scenarios
        #[tokio::test]
        async fn test_object_is_not_coin() {
            let owner = get_test_owner();
            let object_id = get_test_package_id();
            let (_, _, _, _, treasury_cap_object) = get_test_treasury_cap_peripherals(object_id);
            let mut mock_state = MockStateRead::new();
            mock_state.expect_get_object().returning(move |obj_id| {
                if obj_id == &object_id {
                    Ok(Some(treasury_cap_object.clone()))
                } else {
                    panic!("should not be called with any other object id")
                }
            });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_all_coins(owner, Some(object_id.to_string()), None)
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            assert_eq!(error_object.code(), -32602);
            let expected = expect!["-32602"];
            expected.assert_eq(&error_object.code().to_string());
            let expected = expect!["invalid cursor"];
            expected.assert_eq(error_object.message());
        }

        #[tokio::test]
        async fn test_object_not_found() {
            let owner = get_test_owner();
            let object_id = get_test_package_id();
            let mut mock_state = MockStateRead::new();
            mock_state.expect_get_object().returning(move |_| Ok(None));

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_all_coins(owner, Some(object_id.to_string()), None)
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            let expected = expect!["-32602"];
            expected.assert_eq(&error_object.code().to_string());
            let expected = expect!["invalid cursor"];
            expected.assert_eq(error_object.message());
        }
    }

    mod get_balance_tests {
        use super::super::*;
        use super::*;
        // Success scenarios
        #[tokio::test]
        async fn test_gas_coin() {
            let owner = get_test_owner();
            let gas_coin = get_test_coin(None, CoinType::Gas).1;
            let gas_coin_clone = gas_coin.clone();
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_balance()
                .with(
                    predicate::eq(owner),
                    predicate::eq(get_test_coin_type_tag(gas_coin_clone.coin_type)),
                )
                .return_once(move |_, _| {
                    Ok(TotalBalance {
                        balance: 7,
                        num_coins: 9,
                    })
                });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api.get_balance(owner, None).await;

            assert!(response.is_ok());
            let result = response.unwrap();
            assert_eq!(
                result,
                Balance {
                    coin_type: gas_coin.coin_type,
                    coin_object_count: 9,
                    total_balance: 7,
                    locked_balance: Default::default()
                }
            );
        }

        #[tokio::test]
        async fn test_with_coin_type() {
            let owner = get_test_owner();
            let coin = get_test_coin(None, CoinType::Usdc).1;
            let coin_clone = coin.clone();
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_balance()
                .with(
                    predicate::eq(owner),
                    predicate::eq(get_test_coin_type_tag(coin_clone.coin_type)),
                )
                .return_once(move |_, _| {
                    Ok(TotalBalance {
                        balance: 10,
                        num_coins: 11,
                    })
                });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_balance(owner, Some(coin.coin_type.clone()))
                .await;

            assert!(response.is_ok());
            let result = response.unwrap();
            assert_eq!(
                result,
                Balance {
                    coin_type: coin.coin_type,
                    coin_object_count: 11,
                    total_balance: 10,
                    locked_balance: Default::default()
                }
            );
        }

        // Expected error scenarios
        #[tokio::test]
        async fn test_invalid_coin_type() {
            let owner = get_test_owner();
            let coin_type = "0x2::invalid::struct::tag";
            let mock_state = MockStateRead::new();
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_balance(owner, Some(coin_type.to_string()))
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            let expected = expect!["-32602"];
            expected.assert_eq(&error_object.code().to_string());
            let expected = expect![
                "Invalid struct type: 0x2::invalid::struct::tag. Got error: Expected end of token stream. Got: ::"
            ];
            expected.assert_eq(error_object.message());
        }

        // Unexpected error scenarios
        #[tokio::test]
        async fn test_get_balance_index_store_not_available() {
            let owner = get_test_owner();
            let coin_type = get_test_coin_type(get_test_package_id());
            let mut mock_state = MockStateRead::new();
            mock_state.expect_get_balance().returning(move |_, _| {
                Err(StateReadError::Client(
                    SuiErrorKind::IndexStoreNotAvailable.into(),
                ))
            });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_balance(owner, Some(coin_type.to_string()))
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            assert_eq!(
                error_object.code(),
                jsonrpsee::types::error::INVALID_PARAMS_CODE
            );
            let expected = expect!["Index store not available on this Fullnode."];
            expected.assert_eq(error_object.message());
        }

        #[tokio::test]
        async fn test_get_balance_execution_error() {
            // Validate that we handle and return an error message when we encounter an unexpected error
            let owner = get_test_owner();
            let coin_type = get_test_coin_type(get_test_package_id());
            let mut mock_state = MockStateRead::new();
            mock_state.expect_get_balance().returning(move |_, _| {
                Err(SuiErrorKind::ExecutionError("mock db error".to_string()).into())
            });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api
                .get_balance(owner, Some(coin_type.to_string()))
                .await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();

            assert_eq!(
                error_object.code(),
                jsonrpsee::types::error::INTERNAL_ERROR_CODE
            );
            let expected = expect!["Error executing mock db error"];
            expected.assert_eq(error_object.message());
        }
    }

    mod get_all_balances_tests {
        use sui_types::error::SuiErrorKind;

        use super::super::*;
        use super::*;

        // Success scenarios
        #[tokio::test]
        async fn test_success_scenario() {
            let owner = get_test_owner();
            let gas_coin = get_test_coin(None, CoinType::Gas).1;
            let gas_coin_type_tag = get_test_coin_type_tag(gas_coin.coin_type.clone());
            let usdc_coin = get_test_coin(None, CoinType::Usdc).1;
            let usdc_coin_type_tag = get_test_coin_type_tag(usdc_coin.coin_type.clone());
            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_all_balance()
                .with(predicate::eq(owner))
                .return_once(move |_| {
                    let mut hash_map = HashMap::new();
                    hash_map.insert(
                        gas_coin_type_tag,
                        TotalBalance {
                            balance: 7,
                            num_coins: 9,
                        },
                    );
                    hash_map.insert(
                        usdc_coin_type_tag,
                        TotalBalance {
                            balance: 10,
                            num_coins: 11,
                        },
                    );
                    Ok(Arc::new(hash_map))
                });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api.get_all_balances(owner).await;

            assert!(response.is_ok());
            let expected_result = vec![
                Balance {
                    coin_type: gas_coin.coin_type,
                    coin_object_count: 9,
                    total_balance: 7,
                    locked_balance: Default::default(),
                },
                Balance {
                    coin_type: usdc_coin.coin_type,
                    coin_object_count: 11,
                    total_balance: 10,
                    locked_balance: Default::default(),
                },
            ];
            // This is because the underlying result is a hashmap, so order is not guaranteed
            let mut result = response.unwrap();
            for item in expected_result {
                if let Some(pos) = result.iter().position(|i| *i == item) {
                    result.remove(pos);
                } else {
                    panic!("{:?} not found in result", item);
                }
            }
            assert!(result.is_empty());
        }

        // Unexpected error scenarios
        #[tokio::test]
        async fn test_index_store_not_available() {
            let owner = get_test_owner();
            let mut mock_state = MockStateRead::new();
            mock_state.expect_get_all_balance().returning(move |_| {
                Err(StateReadError::Client(
                    SuiError(Box::new(SuiErrorKind::IndexStoreNotAvailable)).into(),
                ))
            });
            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
            let response = coin_read_api.get_all_balances(owner).await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            assert_eq!(
                error_object.code(),
                jsonrpsee::types::error::INVALID_PARAMS_CODE
            );
            let expected = expect!["Index store not available on this Fullnode."];
            expected.assert_eq(error_object.message());
        }
    }

    mod get_coin_metadata_tests {
        use super::super::*;
        use super::*;
        use mockall::predicate;
        use sui_types::id::UID;

        // Success scenarios
        #[tokio::test]
        async fn test_valid_coin_metadata_object() {
            let package_id = get_test_package_id();
            let coin_name = get_test_coin_type(package_id);
            let input_coin_struct = parse_sui_struct_tag(&coin_name).expect("should not fail");
            let coin_metadata_struct = CoinMetadata::type_(input_coin_struct.clone());
            let coin_metadata = CoinMetadata {
                id: UID::new(get_test_package_id()),
                decimals: 2,
                name: "test_coin".to_string(),
                symbol: "TEST".to_string(),
                description: "test coin".to_string(),
                icon_url: Some("unit.test.io".to_string()),
            };
            let coin_metadata_object =
                Object::coin_metadata_for_testing(input_coin_struct.clone(), coin_metadata);
            let metadata = SuiCoinMetadata::try_from(coin_metadata_object.clone()).unwrap();

            // Mock object store that returns None for registry lookup
            let mut mock_object_store = MockObjectStore::new();
            mock_object_store.expect_get_object().return_once(|_| None); // No registry entry

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let mut mock_internal = MockCoinReadInternal::new();
            mock_internal
                .expect_get_state()
                .return_once(move || Arc::new(mock_state) as Arc<dyn StateRead>);
            mock_internal
                .expect_find_package_object()
                .with(predicate::always(), predicate::eq(coin_metadata_struct))
                .return_once(move |object_id, _| {
                    if object_id == &package_id {
                        Ok(coin_metadata_object)
                    } else {
                        panic!("should not be called with any other object id")
                    }
                });

            let coin_read_api = CoinReadApi {
                internal: Box::new(mock_internal),
            };

            let response = coin_read_api.get_coin_metadata(coin_name.clone()).await;
            assert!(response.is_ok());
            let result = response.unwrap().unwrap();
            assert_eq!(result, metadata);
        }

        #[tokio::test]
        async fn test_object_not_found() {
            let transaction_digest = TransactionDigest::from([0; 32]);
            let transaction_effects = TransactionEffects::default();
            let transaction_effects_clone = transaction_effects.clone();

            // Mock object store that returns None for registry lookup
            let mut mock_object_store = MockObjectStore::new();
            mock_object_store.expect_get_object().return_once(|_| None); // No registry entry

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);
            mock_state
                .expect_find_publish_txn_digest()
                .return_once(move |_| Ok(transaction_digest));
            mock_state
                .expect_get_executed_transaction_and_effects()
                .return_once(move |_, _| {
                    Ok((create_fake_transaction(), transaction_effects.clone()))
                });

            let mut mock_kv_store = MockKeyValueStore::new();
            mock_kv_store.expect_multi_get().return_once(move |_, _| {
                Ok((
                    vec![Some(create_fake_transaction())],
                    vec![Some(transaction_effects_clone)],
                ))
            });

            let coin_read_api =
                CoinReadApi::new_for_tests(Arc::new(mock_state), Some(Arc::new(mock_kv_store)));
            let response = coin_read_api
                .get_coin_metadata("0x2::sui::SUI".to_string())
                .await;

            assert!(response.is_ok());
            let result = response.unwrap();
            assert_eq!(result, None);
        }

        #[tokio::test]
        async fn test_find_package_object_not_sui_coin_metadata() {
            let package_id = get_test_package_id();
            let coin_name = get_test_coin_type(package_id);
            let input_coin_struct = parse_sui_struct_tag(&coin_name).expect("should not fail");
            let coin_metadata_struct = CoinMetadata::type_(input_coin_struct.clone());
            let treasury_cap = TreasuryCap {
                id: UID::new(get_test_package_id()),
                total_supply: Supply { value: 420 },
            };
            let treasury_cap_object =
                Object::treasury_cap_for_testing(input_coin_struct.clone(), treasury_cap);

            // Mock object store that returns None for registry lookup
            let mut mock_object_store = MockObjectStore::new();
            mock_object_store.expect_get_object().return_once(|_| None); // No registry entry

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let mut mock_internal = MockCoinReadInternal::new();
            mock_internal
                .expect_get_state()
                .return_once(move || Arc::new(mock_state) as Arc<dyn StateRead>);
            // return TreasuryCap instead of CoinMetadata to set up test
            mock_internal
                .expect_find_package_object()
                .with(predicate::always(), predicate::eq(coin_metadata_struct))
                .returning(move |object_id, _| {
                    if object_id == &package_id {
                        Ok(treasury_cap_object.clone())
                    } else {
                        panic!("should not be called with any other object id")
                    }
                });

            let coin_read_api = CoinReadApi {
                internal: Box::new(mock_internal),
            };

            let response = coin_read_api.get_coin_metadata(coin_name.clone()).await;
            assert!(response.is_ok());
            let result = response.unwrap();
            assert!(result.is_none());
        }

        #[tokio::test]
        async fn test_coin_metadata_with_registry_data() {
            use sui_types::coin_registry::{self, Currency, MetadataCapState, SupplyState};
            use sui_types::collection_types::VecMap;

            let package_id = get_test_package_id();
            let coin_name = get_test_coin_type(package_id);
            let coin_struct = parse_sui_struct_tag(&coin_name).expect("should not fail");

            let currency_object_id = ObjectID::from_hex_literal(
                "0xDADA000000000000000000000000000000000000000000000000000000000000",
            )
            .unwrap();
            let currency = Currency {
                id: currency_object_id,
                decimals: 9,
                name: "Registry Test Coin".to_string(),
                symbol: "RTC".to_string(),
                description: "A coin from the registry".to_string(),
                icon_url: "https://registry.test/icon.png".to_string(),
                supply: Some(SupplyState::Fixed(1000000)),
                regulated: coin_registry::RegulatedState::Unknown,
                treasury_cap_id: None,
                metadata_cap_id: MetadataCapState::Unclaimed,
                extra_fields: VecMap { contents: vec![] },
            };

            // Derive currency ID the same way the function does
            let currency_id = Currency::derive_object_id(coin_struct.clone().into()).unwrap();
            let currency_object = create_currency_object(currency);

            let mock_object_store =
                setup_mock_object_store_with_registry(currency_id, currency_object, None);

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);

            let response = coin_read_api.get_coin_metadata(coin_name).await;
            assert!(response.is_ok());
            let result = response.unwrap();
            assert!(result.is_some());

            let metadata = result.unwrap();
            assert_eq!(metadata.decimals, 9);
            assert_eq!(metadata.name, "Registry Test Coin");
            assert_eq!(metadata.symbol, "RTC");
            assert_eq!(metadata.description, "A coin from the registry");
            assert_eq!(
                metadata.icon_url,
                Some("https://registry.test/icon.png".to_string())
            );
        }
    }

    mod get_total_supply_tests {
        use super::super::*;
        use super::*;
        use mockall::predicate;
        use sui_types::id::UID;

        #[tokio::test]
        async fn test_success_response_for_gas_coin() {
            let coin_type = "0x2::sui::SUI";
            let mock_internal = MockCoinReadInternal::new();
            let coin_read_api = CoinReadApi {
                internal: Box::new(mock_internal),
            };

            let response = coin_read_api.get_total_supply(coin_type.to_string()).await;

            let supply = response.unwrap();
            let expected = expect!["10000000000000000000"];
            expected.assert_eq(&supply.value.to_string());
        }

        #[tokio::test]
        async fn test_success_response_for_other_coin() {
            let package_id = get_test_package_id();
            let (coin_name, _, treasury_cap_struct, _, treasury_cap_object) =
                get_test_treasury_cap_peripherals(package_id);

            // Mock object store that returns None for registry lookup
            let mut mock_object_store = MockObjectStore::new();
            mock_object_store.expect_get_object().return_once(|_| None); // No registry entry

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let mut mock_internal = MockCoinReadInternal::new();
            mock_internal
                .expect_get_state()
                .return_once(move || Arc::new(mock_state) as Arc<dyn StateRead>);
            mock_internal
                .expect_find_package_object()
                .with(predicate::always(), predicate::eq(treasury_cap_struct))
                .returning(move |object_id, _| {
                    if object_id == &package_id {
                        Ok(treasury_cap_object.clone())
                    } else {
                        panic!("should not be called with any other object id")
                    }
                });
            let coin_read_api = CoinReadApi {
                internal: Box::new(mock_internal),
            };

            let response = coin_read_api.get_total_supply(coin_name.clone()).await;

            assert!(response.is_ok());
            let result = response.unwrap();
            let expected = expect!["420"];
            expected.assert_eq(&result.value.to_string());
        }

        #[tokio::test]
        async fn test_object_not_found() {
            let package_id = get_test_package_id();
            let (coin_name, _, _, _, _) = get_test_treasury_cap_peripherals(package_id);
            let transaction_digest = TransactionDigest::from([0; 32]);
            let transaction_effects = TransactionEffects::default();
            let transaction_effects_clone = transaction_effects.clone();

            // Mock object store that returns None for registry lookup
            let mut mock_object_store = MockObjectStore::new();
            mock_object_store.expect_get_object().return_once(|_| None); // No registry entry

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);
            mock_state
                .expect_find_publish_txn_digest()
                .return_once(move |_| Ok(transaction_digest));
            mock_state
                .expect_multi_get()
                .return_once(move |_, _| Ok((vec![], vec![Some(transaction_effects.clone())])));

            let mut mock_kv_store = MockKeyValueStore::new();
            mock_kv_store.expect_multi_get().return_once(move |_, _| {
                Ok((
                    vec![Some(create_fake_transaction())],
                    vec![Some(transaction_effects_clone)],
                ))
            });

            let coin_read_api =
                CoinReadApi::new_for_tests(Arc::new(mock_state), Some(Arc::new(mock_kv_store)));
            let response = coin_read_api.get_total_supply(coin_name.clone()).await;

            assert!(response.is_err());
            let error_object = response.unwrap_err();
            let expected = expect!["-32602"];
            expected.assert_eq(&error_object.code().to_string());
            let expected = expect![
                "Cannot find object with type [0x2::coin::TreasuryCap<0xf::test_coin::TEST_COIN>] from [0x000000000000000000000000000000000000000000000000000000000000000f] package created objects."
            ];
            expected.assert_eq(error_object.message());
        }

        #[tokio::test]
        async fn test_find_package_object_not_treasury_cap() {
            let package_id = get_test_package_id();
            let (coin_name, input_coin_struct, treasury_cap_struct, _, _) =
                get_test_treasury_cap_peripherals(package_id);
            let coin_metadata = CoinMetadata {
                id: UID::new(get_test_package_id()),
                decimals: 2,
                name: "test_coin".to_string(),
                symbol: "TEST".to_string(),
                description: "test coin".to_string(),
                icon_url: None,
            };
            let coin_metadata_object =
                Object::coin_metadata_for_testing(input_coin_struct.clone(), coin_metadata);

            // Mock object store that returns None for registry lookup
            let mut mock_object_store = MockObjectStore::new();
            mock_object_store.expect_get_object().return_once(|_| None); // No registry entry

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let mut mock_internal = MockCoinReadInternal::new();
            mock_internal
                .expect_get_state()
                .return_once(move || Arc::new(mock_state) as Arc<dyn StateRead>);
            mock_internal
                .expect_find_package_object()
                .with(predicate::always(), predicate::eq(treasury_cap_struct))
                .returning(move |object_id, _| {
                    if object_id == &package_id {
                        Ok(coin_metadata_object.clone())
                    } else {
                        panic!("should not be called with any other object id")
                    }
                });

            let coin_read_api = CoinReadApi {
                internal: Box::new(mock_internal),
            };

            let response = coin_read_api.get_total_supply(coin_name.clone()).await;
            let error_object = response.unwrap_err();
            assert_eq!(
                error_object.code(),
                jsonrpsee::types::error::CALL_EXECUTION_FAILED_CODE
            );
            let expected = expect![
                "Failure deserializing object in the requested format: Unable to deserialize TreasuryCap object: remaining input"
            ];
            expected.assert_eq(error_object.message());
        }

        #[tokio::test]
        async fn test_total_supply_with_registry_fixed_supply() {
            use sui_types::coin_registry::{self, Currency, MetadataCapState, SupplyState};
            use sui_types::collection_types::VecMap;

            let package_id = get_test_package_id();
            let coin_name = get_test_coin_type(package_id);
            let coin_struct = parse_sui_struct_tag(&coin_name).expect("should not fail");

            let currency_uid = ObjectID::from_hex_literal(
                "0xDADA200000000000000000000000000000000000000000000000000000000000",
            )
            .unwrap();
            let currency = Currency {
                id: currency_uid,
                decimals: 18,
                name: "Fixed Supply Coin".to_string(),
                symbol: "FSC".to_string(),
                description: "A coin with fixed supply".to_string(),
                icon_url: "https://fixed.supply/icon.png".to_string(),
                supply: Some(SupplyState::Fixed(21_000_000_000_000_000)),
                regulated: coin_registry::RegulatedState::Unknown,
                treasury_cap_id: None,
                metadata_cap_id: MetadataCapState::Unclaimed,
                extra_fields: VecMap { contents: vec![] },
            };

            // Derive currency ID the same way the function does
            let currency_id = Currency::derive_object_id(coin_struct.clone().into()).unwrap();
            let currency_object = create_currency_object(currency);

            let mock_object_store =
                setup_mock_object_store_with_registry(currency_id, currency_object, None);

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);

            let response = coin_read_api.get_total_supply(coin_name).await;
            assert!(response.is_ok());
            let supply = response.unwrap();
            assert_eq!(supply.value, 21_000_000_000_000_000);
        }

        #[tokio::test]
        async fn test_total_supply_with_registry_unknown_supply() {
            use sui_types::coin_registry::{self, Currency, MetadataCapState, SupplyState};
            use sui_types::collection_types::VecMap;

            let package_id = get_test_package_id();
            let coin_name = get_test_coin_type(package_id);
            let coin_struct = parse_sui_struct_tag(&coin_name).expect("should not fail");

            let treasury_cap_id = ObjectID::from_hex_literal(
                "0x7EA5000000000000000000000000000000000000000000000000000000000000",
            )
            .unwrap();

            let currency_uid = ObjectID::from_hex_literal(
                "0xDADA300000000000000000000000000000000000000000000000000000000000",
            )
            .unwrap();
            let currency = Currency {
                id: currency_uid,
                decimals: 6,
                name: "Unknown Supply Coin".to_string(),
                symbol: "USC".to_string(),
                description: "A coin with unknown supply".to_string(),
                icon_url: "https://unknown.supply/icon.png".to_string(),
                supply: Some(SupplyState::Unknown),
                regulated: coin_registry::RegulatedState::Unknown,
                treasury_cap_id: Some(treasury_cap_id),
                metadata_cap_id: MetadataCapState::Unclaimed,
                extra_fields: VecMap { contents: vec![] },
            };

            // Derive currency ID the same way the function does
            let currency_id = Currency::derive_object_id(coin_struct.clone().into()).unwrap();
            let currency_object = create_currency_object(currency);

            let treasury_cap = TreasuryCap {
                id: UID::new(treasury_cap_id),
                total_supply: Supply { value: 100_000_000 },
            };
            let treasury_cap_object =
                Object::treasury_cap_for_testing(coin_struct.clone(), treasury_cap);

            let mock_object_store = setup_mock_object_store_with_registry(
                currency_id,
                currency_object,
                Some((treasury_cap_id, treasury_cap_object)),
            );

            let mut mock_state = MockStateRead::new();
            mock_state
                .expect_get_object_store()
                .return_const(Arc::new(mock_object_store) as Arc<dyn ObjectStore + Send + Sync>);

            let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);

            let response = coin_read_api.get_total_supply(coin_name).await;
            assert!(response.is_ok());
            let supply = response.unwrap();
            assert_eq!(supply.value, 100_000_000);
        }
    }
}