templar_common/market/
mod.rs

1use std::collections::HashMap;
2use std::num::NonZeroU16;
3
4use near_sdk::{near, AccountId};
5
6use crate::{
7    asset::{BorrowAssetAmount, CollateralAssetAmount},
8    number::Decimal,
9};
10mod configuration;
11pub use configuration::{MarketConfiguration, ValidAmountRange, APY_LIMIT};
12mod external;
13pub use external::*;
14mod r#impl;
15pub use r#impl::*;
16mod price_oracle_configuration;
17pub use price_oracle_configuration::PriceOracleConfiguration;
18
19pub mod error {
20    pub use super::configuration::error::*;
21    pub use super::price_oracle_configuration::error::*;
22}
23
24#[derive(Clone, Debug)]
25#[near(serializers = [borsh, json])]
26pub struct BorrowAssetMetrics {
27    pub available: BorrowAssetAmount,
28    pub deposited_active: BorrowAssetAmount,
29    pub deposited_incoming: HashMap<u32, BorrowAssetAmount>,
30    pub borrowed: BorrowAssetAmount,
31}
32
33#[derive(Clone, Debug, PartialEq, Eq)]
34#[near(serializers = [json, borsh])]
35pub struct YieldWeights {
36    pub supply: NonZeroU16,
37    pub r#static: HashMap<AccountId, u16>,
38}
39
40impl YieldWeights {
41    /// # Panics
42    /// - If `supply` is zero.
43    #[allow(clippy::unwrap_used, reason = "Only used during initial construction")]
44    pub fn new_with_supply_weight(supply: u16) -> Self {
45        Self {
46            supply: supply.try_into().unwrap(),
47            r#static: HashMap::new(),
48        }
49    }
50
51    #[must_use]
52    pub fn with_static(mut self, account_id: AccountId, weight: u16) -> Self {
53        self.r#static.insert(account_id, weight);
54        self
55    }
56
57    pub fn total_weight(&self) -> NonZeroU16 {
58        self.r#static
59            .values()
60            .try_fold(self.supply, |a, b| a.checked_add(*b))
61            .unwrap_or_else(|| crate::panic_with_message("Total weight overflow"))
62    }
63
64    pub fn static_share(&self, account_id: &AccountId) -> Decimal {
65        self.r#static
66            .get(account_id)
67            .map_or(Decimal::ZERO, |weight| {
68                Decimal::from(*weight) / u16::from(self.total_weight())
69            })
70    }
71}
72
73/// Parsed from the string parameter `msg` passed by `*_transfer_call` to
74/// `*_on_transfer` calls.
75#[near(serializers = [json])]
76pub enum DepositMsg {
77    /// Add the attached tokens to the sender's supply position's deposit.
78    Supply,
79    /// Add the attached tokens to the sender's borrow position's collateral
80    /// deposit.
81    Collateralize,
82    /// Use the attached tokens to pay down the sender's borrow position's
83    /// liability (sans fees).
84    Repay,
85    /// Use the attached tokens to pay down a specified borrow position's
86    /// liability (sans fees).
87    RepayAccount(RepayAccountMsg),
88    /// Liquidate an account that is below the configured liquidation
89    /// collateralization ratio threshold.
90    Liquidate(LiquidateMsg),
91}
92
93impl DepositMsg {
94    pub fn expects_borrow_asset(&self) -> bool {
95        match self {
96            Self::Supply | Self::Repay | Self::RepayAccount(..) | Self::Liquidate(..) => true,
97            Self::Collateralize => false,
98        }
99    }
100}
101
102/// Indicate an account to repay.
103#[near(serializers = [json])]
104pub struct RepayAccountMsg {
105    pub account_id: AccountId,
106}
107
108/// Indicate an account to liquidate.
109#[near(serializers = [json])]
110pub struct LiquidateMsg {
111    pub account_id: AccountId,
112    /// How much collateral to liquidate?
113    /// Attempts to liquidate the whole position if `None`.
114    pub amount: Option<CollateralAssetAmount>,
115}
116
117#[derive(Clone, Debug)]
118#[near(serializers = [json, borsh])]
119pub struct Withdrawal {
120    pub account_id: AccountId,
121    pub amount_to_account: BorrowAssetAmount,
122    pub amount_to_fees: BorrowAssetAmount,
123}