iota_cluster_test/

helper.rs

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

use anyhow::bail;
use iota_json_rpc_types::{
    BalanceChange, IotaData, IotaObjectData, IotaObjectDataOptions, IotaObjectResponseError,
};
use iota_sdk::IotaClient;
use iota_sdk_types::{ObjectId, Owner, TypeTag};
use iota_types::{gas_coin::GasCoin, parse_iota_type_tag};
use tracing::{debug, trace};

/// A util struct that helps verify IOTA Object.
/// Use builder style to construct the conditions.
/// When optionals fields are not set, related checks are omitted.
/// Consuming functions such as `check` perform the check and panics if
/// verification results are unexpected. `check_into_object` and
/// `check_into_gas_coin` expect to get a `IotaObjectData` and `GasCoin`
/// respectfully.
#[derive(Debug)]
pub struct ObjectChecker {
    object_id: ObjectId,
    owner: Option<Owner>,
    is_deleted: bool,
    is_iota_coin: Option<bool>,
}

impl ObjectChecker {
    pub fn new(object_id: ObjectId) -> ObjectChecker {
        Self {
            object_id,
            owner: None,
            is_deleted: false, // default to exist
            is_iota_coin: None,
        }
    }

    pub fn owner(mut self, owner: Owner) -> Self {
        self.owner = Some(owner);
        self
    }

    pub fn deleted(mut self) -> Self {
        self.is_deleted = true;
        self
    }

    pub fn is_iota_coin(mut self, is_iota_coin: bool) -> Self {
        self.is_iota_coin = Some(is_iota_coin);
        self
    }

    pub async fn check_into_gas_coin(self, client: &IotaClient) -> GasCoin {
        if self.is_iota_coin == Some(false) {
            panic!("'check_into_gas_coin' shouldn't be called with 'is_iota_coin' set as false");
        }
        self.is_iota_coin(true)
            .check(client)
            .await
            .unwrap()
            .into_gas_coin()
    }

    pub async fn check_into_object(self, client: &IotaClient) -> IotaObjectData {
        self.check(client).await.unwrap().into_object()
    }

    pub async fn check(self, client: &IotaClient) -> Result<CheckerResultObject, anyhow::Error> {
        debug!(?self);

        let object_id = self.object_id;
        let object_info = client
            .read_api()
            .get_object_with_options(
                object_id,
                IotaObjectDataOptions::new()
                    .with_type()
                    .with_owner()
                    .with_bcs(),
            )
            .await
            .or_else(|err| bail!("failed to get object info (id: {object_id}), err: {err}"))?;

        trace!("getting object {object_id}, info :: {object_info:?}");

        match (object_info.data, object_info.error) {
            (None, Some(IotaObjectResponseError::NotExists { object_id })) => {
                panic!(
                    "node can't find gas object {object_id} with client {:?}",
                    client.read_api()
                )
            }
            (
                None,
                Some(IotaObjectResponseError::DynamicFieldNotFound {
                    parent_object_id: object_id,
                }),
            ) => {
                panic!(
                    "node can't find dynamic field for {object_id} with client {:?}",
                    client.read_api()
                )
            }
            (
                None,
                Some(IotaObjectResponseError::Deleted {
                    object_id,
                    version: _,
                    digest: _,
                }),
            ) => {
                if !self.is_deleted {
                    panic!("gas object {object_id} was deleted");
                }
                Ok(CheckerResultObject::new(None, None))
            }
            (Some(object), _) => {
                if self.is_deleted {
                    panic!("expect gas object {object_id} deleted, but it is not");
                }
                if let Some(owner) = self.owner {
                    let object_owner = object
                        .owner
                        .unwrap_or_else(|| panic!("object {object_id} does not have owner"));
                    assert_eq!(
                        object_owner, owner,
                        "gas coin {object_id} does not belong to {owner}, but {object_owner}"
                    );
                }
                if self.is_iota_coin == Some(true) {
                    let move_obj = object
                        .bcs
                        .as_ref()
                        .unwrap_or_else(|| panic!("object {object_id} does not have bcs data"))
                        .try_as_move()
                        .unwrap_or_else(|| panic!("object {object_id} is not a move object"));

                    let gas_coin = move_obj.deserialize()?;
                    return Ok(CheckerResultObject::new(Some(gas_coin), Some(object)));
                }
                Ok(CheckerResultObject::new(None, Some(object)))
            }
            (None, Some(IotaObjectResponseError::Display { error })) => {
                panic!("display error: {error:?}");
            }
            (None, None) | (None, Some(IotaObjectResponseError::Unknown)) => {
                panic!("unexpected response: object not found and no specific error provided");
            }
        }
    }
}

pub struct CheckerResultObject {
    gas_coin: Option<GasCoin>,
    object: Option<IotaObjectData>,
}

impl CheckerResultObject {
    pub fn new(gas_coin: Option<GasCoin>, object: Option<IotaObjectData>) -> Self {
        Self { gas_coin, object }
    }
    pub fn into_gas_coin(self) -> GasCoin {
        self.gas_coin.unwrap()
    }
    pub fn into_object(self) -> IotaObjectData {
        self.object.unwrap()
    }
}

#[macro_export]
macro_rules! assert_eq_if_present {
    ($left:expr, $right:expr, $($arg:tt)+) => {
        match (&$left, &$right) {
            (Some(left_val), right_val) if !(&left_val == right_val) => {
                panic!("{} does not match, left: {left_val:?}, right: {right_val:?}", $($arg)+);
            }
            _ => ()
        }
    };
}

#[derive(Default, Debug)]
pub struct BalanceChangeChecker {
    owner: Option<Owner>,
    coin_type: Option<TypeTag>,
    amount: Option<i128>,
}

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

    pub fn owner(mut self, owner: Owner) -> Self {
        self.owner = Some(owner);
        self
    }
    pub fn coin_type(mut self, coin_type: &str) -> Self {
        self.coin_type = Some(parse_iota_type_tag(coin_type).unwrap());
        self
    }

    pub fn amount(mut self, amount: i128) -> Self {
        self.amount = Some(amount);
        self
    }

    pub fn check(self, event: &BalanceChange) {
        let BalanceChange {
            owner,
            coin_type,
            amount,
        } = event;

        assert_eq_if_present!(self.owner, owner, "owner");
        assert_eq_if_present!(self.coin_type, coin_type, "coin_type");
        assert_eq_if_present!(self.amount, amount, "version");
    }
}