Oracle

Contract that holds price fetching information for assets

This contract queries Osmosis TWAP and Pyth network for prices. It has two paths for getting prices, either Pyth-only or Osmosis TWAP + Pyth's OSMO/USD. The latter option uses OSMO denominated TWAP prices that are then used later to produce USD(-par) prices && is necessary for bridged/wrapped tokens so the protocol can accurately price risk between variants (ex: Axelar USDC vs Wormhole USDC vs Noble native USDC). The Pyth OSMO/USD price is prioritized, if unavailable it medianizes the USD-par TWAP prices from Osmosis to denominate prices in. This means CDT, the Positions contract's debt token, flips betweem USD and USD-par (USDC initially) pegs depending on USD's price availability.

Notes:

• When the final quote price of the pools_for_osmo_twap isn't uosmo, the oracle will attempt to use its own pricing info to convert said price into USD. Ex: milkTIA's quote in TIA will query the oracle for TIA's price to end with a USD price

InstantiateMsg

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct InstantiateMsg {
    pub owner: Option<String>,
    pub positions_contract: Option<String>,
    pub osmosis_proxy_contract: Option<String>,
    pub oracle_contract: Option<String>,
}

Key	Type	Description
*owner	String	Contract owner, defaults to info.sender
*positions_contract	String	Positions contract address
*osmosis_proxy_contract	String	Osmosis Proxy contract
*oracle_contract	String	Oracle contract

* = optional

ExecuteMsg

UpdateConfig

Updates contract configuration

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    UpdateConfig {
        owner: Option<String>,
        positions_contract: Option<String>,
        osmosis_proxy_contract: Option<String>,
        osmo_usd_pyth_feed_id: Option<PriceIdentifier>,
        pyth_osmosis_address: Option<String>,
        pools_for_usd_par_twap: Option<Vec<TWAPPoolInfo>>,
    }
}

pub struct PriceIdentifier(
    #[serde(with = "hex")]
    #[schemars(with = "String")]
    [u8; 32],
);

pub struct TWAPPoolInfo {
    pub pool_id: u64,
    pub base_asset_denom: String,
    pub quote_asset_denom: String,
}

Key	Type	Description
*owner	String	Contract owner
*positions_contract	String	Position's contract address
*osmosis_proxy_contract	String	Osmosis Proxy contract
*osmo_usd_pyth_feed_id	PriceIdentifier	OSMO/USD Pyth price feed id
*pyth_osmosis_address	String	Pyth Network's oracle contract address
*pools_for_usd_par_twap	TWAPPoolInfo	Osmosis pools for OSMO/USD-par TWAP

* = optional

AddAsset

Add Asset oracle information to the contract

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    AddAsset {
        asset_info: AssetInfo,
        oracle_info: AssetOracleInfo,
    }
}

pub enum AssetInfo {
    Token {
        address: Addr,
    },
    NativeToken {
        denom: String,
    },
}

pub struct AssetOracleInfo {
    pub basket_id: Uint128,
    pub pyth_price_feed_id: Option<String>,
    pub pools_for_osmo_twap: Vec<TWAPPoolInfo>,
    pub is_usd_par: bool,
    pub lp_pool_info: Option<PoolInfo>,
    pub decimals: u64,
}

pub struct TWAPPoolInfo {
    pub pool_id: u64,
    pub base_asset_denom: String,
    pub quote_asset_denom: String,
 }

Key	Type	Description
asset_info	AssetInfo	Asset info
oracle_info	AssetOracleInfo	Oracle info for added asset

EditAsset

Replace existing asset oracle info

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
    EditAsset {
        asset_info: AssetInfo,
        oracle_info: Option<AssetOracleInfo>,
        remove: bool,
    }
}

Key	Type	Description
asset_info	AssetInfo	Asset info
*oracle_info	AssetOracleInfo	Asset oracle info
remove	bool	Toggle to remove asset

* = optional

QueryMsg

Config

Returns contract configuration

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Config {}
}

pub struct Config {
    pub owner: Addr,
    pub positions_contract: Option<Addr>,
}

Price

Returns list of asset prices and average price

#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Price {
        asset_info: AssetInfo,
        twap_timeframe: u64, 
        oracle_time_limit: u64,
        basket_id: Option<Uint128>,
    }
}

pub struct PriceResponse {
    pub prices: Vec<PriceInfo>, 
    pub price: Decimal,
    pub is_LP: bool,
}

Key	Type	Description
asset_info	AssetInfo	Asset info
twap_timeframe	u64	TWAP timeframe (in days) for TWAP prices
oracle_time_limit	u64	Pyth Oracle time limit in seconds
*basket_id	Uint128	Basket_id to select oracle quote asset for CDT

* = optional

Prices

Returns list of PriceResponse for list of assets

#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Prices {
        asset_infos: Vec<AssetInfo>,
        twap_timeframe: u64,
        oracle_time_limit: u64,
    }
}

pub struct PriceResponse {
    pub prices: Vec<PriceInfo>, 
    pub price: Decimal,
    pub is_LP: bool,
}

Key	Type	Description
asset_info	Vec<AssetInfo>	Asset infos
twap_timeframe	u64	TWAP timeframe (in days) for TWAP prices
oracle_time_limit	u64	Pyth Oracle time limit in seconds

Assets

Returns list of oracle info for a list of assets

#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
    Assets {
        asset_infos: Vec<AssetInfo>,
    }
}

//Vec of 
pub struct AssetResponse {
    pub asset_info: AssetInfo,
    pub oracle_info: AssetOracleInfo,
}

Key	Type	Description
asset_infos	Vec<AssetInfo>	List of Asset Info