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 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
//! # Proxy Asset
//! Proxy assets are objects that describe an asset and a way to calculate that asset's value against a base asset.
//!
//! ## Details
//! A proxy asset is composed of two components.
//! * The `asset`, which is an [`AssetInfo`].
//! * The [`PriceSource`] which is an enum that indicates how to calculate the value for that asset.
//!
//! The base asset is the asset for which `price_source` in `None`.
//! **There should only be ONE base asset when configuring your proxy**
use cosmwasm_std::{
to_json_binary, Addr, Decimal, Deps, QuerierWrapper, QueryRequest, StdError, Uint128, WasmQuery,
};
use cw_asset::{Asset, AssetInfo};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use super::{
ans_host::AnsHost, AnsEntryConvertor, AssetEntry, DexAssetPairing, PoolAddress, PoolReference,
};
use crate::{error::AbstractError, AbstractResult};
/// represents the conversion of an asset in terms of the provided asset
/// Example: provided asset is ETH and the price source for ETH is the pair ETH/USD, the price is 100USD/ETH
/// then `AssetConversion { into: USD, ratio: 100}`
#[derive(Deserialize, Serialize, Clone, Debug, PartialEq)]
pub struct AssetConversion {
into: AssetInfo,
ratio: Decimal,
}
impl AssetConversion {
pub fn new(asset: impl Into<AssetInfo>, price: Decimal) -> Self {
Self {
into: asset.into(),
ratio: price,
}
}
/// convert the balance of an asset into a (list of) asset(s) given the provided rate(s)
pub fn convert(rates: &[Self], amount: Uint128) -> Vec<Asset> {
rates
.iter()
.map(|rate| Asset::new(rate.into.clone(), amount * rate.ratio))
.collect()
}
}
/// Provides information on how to calculate the value of an asset
#[derive(Deserialize, Serialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
#[non_exhaustive]
pub enum UncheckedPriceSource {
/// A pool address of an asset/asset pair
/// Both assets must be defined in the Proxy_assets state
Pair(DexAssetPairing),
// Liquidity Pool token
LiquidityToken {},
// a Proxy, the proxy also takes a Decimal (the multiplier)
// Asset will be valued as if they are Proxy tokens
ValueAs {
asset: AssetEntry,
multiplier: Decimal,
},
None,
}
impl UncheckedPriceSource {
pub fn check(
self,
deps: Deps,
ans_host: &AnsHost,
entry: &AssetEntry,
) -> AbstractResult<PriceSource> {
match self {
UncheckedPriceSource::Pair(pair_info) => {
let PoolReference {
pool_address,
unique_id,
} = ans_host
.query_asset_pairing(&deps.querier, &pair_info)?
.pop()
.unwrap();
let pool_assets = ans_host
.query_pool_metadata(&deps.querier, unique_id)?
.assets;
let assets = ans_host.query_assets(&deps.querier, &pool_assets)?;
// TODO: fix this for pools with multiple assets
assert_eq!(assets.len(), 2);
// TODO: fix this for Osmosis pools
pool_address.expect_contract()?;
Ok(PriceSource::Pool {
address: pool_address,
pair: assets,
})
}
UncheckedPriceSource::LiquidityToken {} => {
let lp_token = AnsEntryConvertor::new(entry.clone()).lp_token()?;
let pairing = AnsEntryConvertor::new(lp_token.clone()).dex_asset_pairing()?;
let pool_assets = ans_host.query_assets(&deps.querier, &lp_token.assets)?;
// TODO: fix this for multiple pools with same pair
// TODO: don't use unwrap
let pool_address = ans_host
.query_asset_pairing(&deps.querier, &pairing)?
.pop()
.unwrap()
.pool_address;
Ok(PriceSource::LiquidityToken {
pool_assets,
pool_address,
})
}
UncheckedPriceSource::ValueAs { asset, multiplier } => {
let asset_info = ans_host.query_asset(&deps.querier, &asset)?;
Ok(PriceSource::ValueAs {
asset: asset_info,
multiplier,
})
}
UncheckedPriceSource::None => Ok(PriceSource::None),
}
}
}
/// Provides information on how to calculate the value of an asset
#[derive(Deserialize, Serialize, Clone, Debug, PartialEq, JsonSchema)]
#[non_exhaustive]
pub enum PriceSource {
/// Should only be used for the base asset
None,
/// A pool name of an asset/asset pair
/// Both assets must be defined in the Vault_assets state
Pool {
address: PoolAddress,
/// two assets that make up a pair in the pool
pair: Vec<AssetInfo>,
},
/// Liquidity pool token
LiquidityToken {
pool_assets: Vec<AssetInfo>,
pool_address: PoolAddress,
},
/// Asset will be valued as if they are ValueAs.asset tokens
ValueAs {
asset: AssetInfo,
multiplier: Decimal,
},
}
impl PriceSource {
/// Returns the assets that are required to calculate the price of the asset
/// Panics if the price source is None
pub fn dependencies(&self, asset: &AssetInfo) -> Vec<AssetInfo> {
match self {
// return the other asset as the dependency
PriceSource::Pool { pair, .. } => {
pair.iter().filter(|a| *a != asset).cloned().collect()
}
PriceSource::LiquidityToken { pool_assets, .. } => pool_assets.clone(),
PriceSource::ValueAs { asset, .. } => vec![asset.clone()],
PriceSource::None => vec![],
}
}
/// Calculates the conversion ratio of the asset.
pub fn conversion_rates(
&self,
deps: Deps,
asset: &AssetInfo,
) -> AbstractResult<Vec<AssetConversion>> {
// Is there a reference to calculate the price?
// each method must return the price of the asset in terms of the another asset, accept for the base asset.
match self {
// A Pool refers to a swap pair, the ratio of assets in the pool represents the price of the asset in the other asset's denom
PriceSource::Pool { address, pair } => self
.trade_pair_price(deps, asset, &address.expect_contract()?, pair)
.map(|e| vec![e]),
// Liquidity is an LP token,
PriceSource::LiquidityToken {
pool_address,
pool_assets,
} => self.lp_conversion(deps, asset, &pool_address.expect_contract()?, pool_assets),
// A proxy asset is used instead
PriceSource::ValueAs { asset, multiplier } => {
Ok(vec![AssetConversion::new(asset.clone(), *multiplier)])
}
// None means it's the base asset
PriceSource::None => Ok(vec![]),
}
}
/// Calculates the price of an asset compared to some other asset through the provided trading pair.
fn trade_pair_price(
&self,
deps: Deps,
priced_asset: &AssetInfo,
address: &Addr,
pair: &[AssetInfo],
) -> AbstractResult<AssetConversion> {
let other_asset_info = pair.iter().find(|a| a != &priced_asset).unwrap();
// query assets held in pool, gives price
let pool_info = (
other_asset_info.query_balance(&deps.querier, address)?,
priced_asset.query_balance(&deps.querier, address)?,
);
// other / this
let ratio = Decimal::from_ratio(pool_info.0.u128(), pool_info.1.u128());
// Get the conversion ratio in the denom of this asset
// #other = #this * (pool_other/pool_this)
Ok(AssetConversion::new(other_asset_info.clone(), ratio))
}
/// Calculate the conversions of an LP token
/// Uses the lp token name to query pair pool for both assets
/// Returns the conversion ratio of the LP token in terms of the other asset
fn lp_conversion(
&self,
deps: Deps,
lp_asset: &AssetInfo,
pool_addr: &Addr,
pool_assets: &[AssetInfo],
) -> AbstractResult<Vec<AssetConversion>> {
let supply: Uint128;
if let AssetInfo::Cw20(addr) = lp_asset {
supply = query_cw20_supply(&deps.querier, addr)?;
} else {
return Err(StdError::generic_err("Can't have a native LP token").into());
}
pool_assets
.iter()
.map(|asset| {
let pool_balance = asset
.query_balance(&deps.querier, pool_addr.clone())
.map_err(AbstractError::from)?;
Ok(AssetConversion::new(
asset.clone(),
Decimal::from_ratio(pool_balance.u128(), supply.u128()),
))
})
.collect::<AbstractResult<Vec<AssetConversion>>>()
}
}
fn query_cw20_supply(querier: &QuerierWrapper, contract_addr: &Addr) -> AbstractResult<Uint128> {
let response: cw20::TokenInfoResponse =
querier.query(&QueryRequest::Wasm(WasmQuery::Smart {
contract_addr: contract_addr.into(),
msg: to_json_binary(&cw20::Cw20QueryMsg::TokenInfo {})?,
}))?;
Ok(response.total_supply)
}
#[cfg(test)]
mod tests {
use abstract_testing::prelude::*;
use cosmwasm_std::testing::mock_dependencies;
use speculoos::prelude::*;
use super::*;
// TODO: abstract_testing has a circular dependency with this package, and so the mockAns host is unable to be used.
mod check {
use super::*;
use crate::{
ans_host,
objects::{ans_host::AnsHostError, pool_id::PoolAddressBase},
};
#[test]
fn liquidity_token() -> AbstractResult<()> {
let mut deps = mock_dependencies();
// we cannot use the MockAnsHost because it has a circular dependency with this package
deps.querier = MockQuerierBuilder::default()
.with_contract_map_entries(
TEST_ANS_HOST,
ans_host::state::ASSET_ADDRESSES,
vec![
(
&AssetEntry::from(TEST_ASSET_1),
AssetInfo::native(TEST_ASSET_1),
),
(
&AssetEntry::from(TEST_ASSET_2),
AssetInfo::native(TEST_ASSET_2),
),
],
)
.with_contract_map_entries(
TEST_ANS_HOST,
ans_host::state::ASSET_PAIRINGS,
vec![(
&DexAssetPairing::new(TEST_ASSET_1.into(), TEST_ASSET_2.into(), TEST_DEX),
vec![PoolReference::new(
TEST_UNIQUE_ID.into(),
PoolAddressBase::Contract(Addr::unchecked(TEST_POOL_ADDR)),
)],
)],
)
.build();
let price_source = UncheckedPriceSource::LiquidityToken {};
let actual_source_res = price_source.check(
deps.as_ref(),
&AnsHost::new(Addr::unchecked(TEST_ANS_HOST)),
&AssetEntry::new(TEST_LP_TOKEN_NAME),
);
assert_that!(actual_source_res)
.is_ok()
.is_equal_to(PriceSource::LiquidityToken {
pool_address: PoolAddress::contract(Addr::unchecked(TEST_POOL_ADDR)),
pool_assets: vec![
AssetInfo::native(TEST_ASSET_1),
AssetInfo::native(TEST_ASSET_2),
],
});
Ok(())
}
#[test]
fn liquidity_token_missing_asset() -> AbstractResult<()> {
let mut deps = mock_dependencies();
deps.querier = MockQuerierBuilder::default()
.with_contract_map_key(
TEST_ANS_HOST,
ans_host::state::ASSET_ADDRESSES,
&TEST_ASSET_1.into(),
)
.with_contract_map_key(
TEST_ANS_HOST,
ans_host::state::ASSET_ADDRESSES,
&TEST_ASSET_2.into(),
)
.with_contract_map_entries(TEST_ANS_HOST, ans_host::state::ASSET_PAIRINGS, vec![])
.build();
let price_source = UncheckedPriceSource::LiquidityToken {};
let actual_source_res = price_source.check(
deps.as_ref(),
&AnsHost::new(Addr::unchecked(TEST_ANS_HOST)),
&AssetEntry::new(TEST_LP_TOKEN_NAME),
);
assert_that!(actual_source_res)
.is_err()
.is_equal_to(AbstractError::AnsHostError(AnsHostError::AssetNotFound {
asset: AssetEntry::new(TEST_ASSET_1),
ans_host: Addr::unchecked(TEST_ANS_HOST),
}));
Ok(())
}
}
mod lp_conversion {
use super::*;
#[test]
fn fail_with_native_token() -> AbstractResult<()> {
let deps = mock_dependencies();
let price_source = PriceSource::LiquidityToken {
pool_address: PoolAddress::contract(Addr::unchecked(TEST_POOL_ADDR)),
pool_assets: vec![AssetInfo::native(TEST_ASSET_1)],
};
let actual_res = price_source.lp_conversion(
deps.as_ref(),
&AssetInfo::native("aoeu"),
&Addr::unchecked(TEST_POOL_ADDR),
&[],
);
assert_that!(actual_res)
.is_err()
.is_equal_to(AbstractError::Std(StdError::generic_err(
"Can't have a native LP token",
)));
Ok(())
}
#[test]
fn gets_cw20_supply() -> AbstractResult<()> {
let mut deps = mock_dependencies();
deps.querier = MockQuerierBuilder::default()
.with_contract_item(
TEST_LP_TOKEN_ADDR,
cw20_base::state::TOKEN_INFO,
&cw20_base::state::TokenInfo {
name: "test".to_string(),
symbol: "test".to_string(),
decimals: 0,
total_supply: Uint128::from(100u128),
mint: None,
},
)
.with_smart_handler(TEST_LP_TOKEN_ADDR, |msg| {
let res = match from_json::<cw20::Cw20QueryMsg>(msg).unwrap() {
cw20::Cw20QueryMsg::TokenInfo {} => cw20::TokenInfoResponse {
name: "test".to_string(),
symbol: "test".to_string(),
decimals: 0,
total_supply: Uint128::from(100u128),
},
_ => panic!("unexpected message"),
};
Ok(to_json_binary(&res).unwrap())
})
.build();
let target_asset = AssetInfo::native(TEST_ASSET_1);
let price_source = PriceSource::LiquidityToken {
pool_address: PoolAddress::contract(Addr::unchecked(TEST_POOL_ADDR)),
pool_assets: vec![target_asset.clone()],
};
let actual_res = price_source.lp_conversion(
deps.as_ref(),
&AssetInfo::cw20(Addr::unchecked(TEST_LP_TOKEN_ADDR)),
&Addr::unchecked(TEST_POOL_ADDR),
&[target_asset.clone()],
)?;
assert_that!(actual_res).has_length(1);
assert_that!(actual_res[0]).is_equal_to(AssetConversion {
into: target_asset,
ratio: Decimal::zero(),
});
Ok(())
}
}
}