1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
// Copyright (c) Mysten Labs, Inc.
// Modifications Copyright (c) 2024 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0
use std::{future, sync::Arc};
use futures::{StreamExt, stream};
use futures_core::Stream;
use iota_json_rpc_api::CoinReadApiClient;
use iota_json_rpc_types::{Balance, Coin, CoinPage, IotaCoinMetadata};
use iota_types::{
balance::Supply,
base_types::{IotaAddress, ObjectID},
};
use crate::{
RpcClient,
error::{Error, IotaRpcResult},
};
/// Defines methods that retrieve information from the IOTA network regarding
/// the coins owned by an address.
#[derive(Debug, Clone)]
pub struct CoinReadApi {
api: Arc<RpcClient>,
}
impl CoinReadApi {
pub(crate) fn new(api: Arc<RpcClient>) -> Self {
Self { api }
}
/// Get coins for the given address filtered by coin type.
/// Results are paginated.
///
/// The coin type defaults to `0x2::iota::IOTA`.
///
/// # Examples
///
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use iota_sdk::IotaClientBuilder;
/// use iota_types::base_types::IotaAddress;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let address = IotaAddress::from_str("0x0000....0000")?;
/// let coin_type = String::from("0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC");
/// let coins = iota
/// .coin_read_api()
/// .get_coins(address, coin_type, None, None)
/// .await?;
/// Ok(())
/// }
/// ```
pub async fn get_coins(
&self,
owner: IotaAddress,
coin_type: impl Into<Option<String>>,
cursor: impl Into<Option<ObjectID>>,
limit: impl Into<Option<usize>>,
) -> IotaRpcResult<CoinPage> {
Ok(self
.api
.http
.get_coins(owner, coin_type.into(), cursor.into(), limit.into())
.await?)
}
/// Get all the coins for the given address regardless of coin type.
/// Results are paginated.
///
/// # Examples
///
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use iota_sdk::IotaClientBuilder;
/// use iota_types::base_types::IotaAddress;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let address = IotaAddress::from_str("0x0000....0000")?;
/// let coins = iota
/// .coin_read_api()
/// .get_all_coins(address, None, None)
/// .await?;
/// Ok(())
/// }
/// ```
pub async fn get_all_coins(
&self,
owner: IotaAddress,
cursor: impl Into<Option<ObjectID>>,
limit: impl Into<Option<usize>>,
) -> IotaRpcResult<CoinPage> {
Ok(self
.api
.http
.get_all_coins(owner, cursor.into(), limit.into())
.await?)
}
/// Get the coins for the given address filtered by coin type.
/// Returns a stream.
///
/// The coin type defaults to `0x2::iota::IOTA`.
///
/// # Examples
///
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use iota_sdk::IotaClientBuilder;
/// use iota_types::base_types::IotaAddress;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let address = IotaAddress::from_str("0x0000....0000")?;
/// let coin_type = String::from("0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC");
/// let coins = iota.coin_read_api().get_coins_stream(address, coin_type);
/// Ok(())
/// }
/// ```
pub fn get_coins_stream(
&self,
owner: IotaAddress,
coin_type: impl Into<Option<String>>,
) -> impl Stream<Item = Coin> + '_ {
let coin_type = coin_type.into();
stream::unfold(
(
vec![],
// cursor
None,
// has_next_page
true,
coin_type,
),
move |(mut data, cursor, has_next_page, coin_type)| async move {
if let Some(item) = data.pop() {
Some((item, (data, cursor, /* has_next_page */ true, coin_type)))
} else if has_next_page {
let page = self
.get_coins(owner, coin_type.clone(), cursor, Some(100))
.await
.ok()?;
let mut data = page.data;
data.reverse();
data.pop().map(|item| {
(
item,
(data, page.next_cursor, page.has_next_page, coin_type),
)
})
} else {
None
}
},
)
}
/// Get a list of coins for the given address filtered by coin type with at
/// least `amount` total value.
///
/// If it is not possible to select enough coins, this function will return
/// an [`Error::InsufficientFunds`].
///
/// The coin type defaults to `0x2::iota::IOTA`.
///
/// # Examples
///
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use iota_sdk::IotaClientBuilder;
/// use iota_types::base_types::IotaAddress;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let address = IotaAddress::from_str("0x0000....0000")?;
/// let coin_type = String::from("0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC");
/// let coins = iota
/// .coin_read_api()
/// .select_coins(address, coin_type, 5, vec![])
/// .await?;
/// Ok(())
/// }
/// ```
pub async fn select_coins(
&self,
address: IotaAddress,
coin_type: impl Into<Option<String>>,
amount: u128,
exclude: Vec<ObjectID>,
) -> IotaRpcResult<Vec<Coin>> {
let mut total = 0u128;
let coins = self
.get_coins_stream(address, coin_type.into())
.filter(|coin: &Coin| future::ready(!exclude.contains(&coin.coin_object_id)))
.take_while(|coin: &Coin| {
let ready = future::ready(total < amount);
total += coin.balance as u128;
ready
})
.collect::<Vec<_>>()
.await;
if total < amount {
return Err(Error::InsufficientFunds { address, amount });
}
Ok(coins)
}
/// Get the balance for the given address filtered by coin type.
///
/// The coin type defaults to `0x2::iota::IOTA`.
///
/// # Examples
///
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use iota_sdk::IotaClientBuilder;
/// use iota_types::base_types::IotaAddress;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let address = IotaAddress::from_str("0x0000....0000")?;
/// let balance = iota.coin_read_api().get_balance(address, None).await?;
/// Ok(())
/// }
/// ```
pub async fn get_balance(
&self,
owner: IotaAddress,
coin_type: impl Into<Option<String>>,
) -> IotaRpcResult<Balance> {
Ok(self.api.http.get_balance(owner, coin_type.into()).await?)
}
/// Get a list of balances grouped by coin type and owned by the given
/// address.
///
/// # Examples
///
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use iota_sdk::IotaClientBuilder;
/// use iota_types::base_types::IotaAddress;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let address = IotaAddress::from_str("0x0000....0000")?;
/// let all_balances = iota.coin_read_api().get_all_balances(address).await?;
/// Ok(())
/// }
/// ```
pub async fn get_all_balances(&self, owner: IotaAddress) -> IotaRpcResult<Vec<Balance>> {
Ok(self.api.http.get_all_balances(owner).await?)
}
/// Get the coin metadata (name, symbol, description, decimals, etc.) for a
/// given coin type.
///
/// # Examples
///
/// ```rust,no_run
/// use iota_sdk::IotaClientBuilder;
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let coin_metadata = iota
/// .coin_read_api()
/// .get_coin_metadata("0x2::iota::IOTA")
/// .await?;
/// Ok(())
/// }
/// ```
pub async fn get_coin_metadata(
&self,
coin_type: impl Into<String>,
) -> IotaRpcResult<Option<IotaCoinMetadata>> {
Ok(self.api.http.get_coin_metadata(coin_type.into()).await?)
}
/// Get the total supply for a given coin type.
///
/// # Examples
///
/// ```rust,no_run
/// use iota_sdk::IotaClientBuilder;
///
/// #[tokio::main]
/// async fn main() -> Result<(), anyhow::Error> {
/// let iota = IotaClientBuilder::default().build_localnet().await?;
/// let total_supply = iota
/// .coin_read_api()
/// .get_total_supply("0x2::iota::IOTA")
/// .await?;
/// Ok(())
/// }
/// ```
pub async fn get_total_supply(&self, coin_type: impl Into<String>) -> IotaRpcResult<Supply> {
Ok(self.api.http.get_total_supply(coin_type.into()).await?)
}
}