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
//! Data types for tracking liquidity
use crate::prelude::*;
use anyhow::{Context, Result};
use cosmwasm_schema::cw_serde;
use cosmwasm_std::OverflowError;

/// Protocol wide stats on liquidity
#[cw_serde]
#[derive(Default)]
pub struct LiquidityStats {
    /// Collateral locked as counter collateral in the protocol
    pub locked: Collateral,
    /// Total amount of collateral available to be used as liquidity
    pub unlocked: Collateral,
    /// Total number of LP tokens
    pub total_lp: LpToken,
    /// Total number of xLP tokens
    pub total_xlp: LpToken,
}

impl LiquidityStats {
    /// Total amount of locked and unlocked collateral.
    pub fn total_collateral(&self) -> Result<Collateral, OverflowError> {
        self.locked + self.unlocked
    }

    /// Total number of LP and xLP tokens
    pub fn total_tokens(&self) -> Result<LpToken, OverflowError> {
        self.total_lp + self.total_xlp
    }

    /// Calculate the amount of collateral for a given number of LP tokens
    ///
    /// This method can fail due to arithmetic overflow. It can also fail if
    /// invariants are violated, specifically if there is 0 collateral in the
    /// pool when this is called with a non-zero amount of LP.
    ///
    /// Note that even with a non-zero input value for `lp`, due to rounding
    /// errors this function may return 0 collateral.
    pub fn lp_to_collateral(&self, lp: LpToken) -> Result<Collateral> {
        if lp.is_zero() {
            return Ok(Collateral::zero());
        }
        let total_collateral = self.total_collateral()?;

        anyhow::ensure!(
            !total_collateral.approx_eq(Collateral::zero()),
            "LiquidityStats::lp_to_collateral: no liquidity is in the pool"
        );
        let total_tokens = self.total_tokens()?;
        debug_assert_ne!(total_tokens, LpToken::zero());

        Ok(Collateral::from_decimal256(
            total_collateral
                .into_decimal256()
                .checked_mul(lp.into_decimal256())?
                .checked_div(total_tokens.into_decimal256())?,
        ))
    }

    /// Same as [Self::lp_to_collateral], but treats round-to-zero as an error.
    pub fn lp_to_collateral_non_zero(&self, lp: NonZero<LpToken>) -> Result<NonZero<Collateral>> {
        self.lp_to_collateral(lp.raw()).and_then(|c| {
            NonZero::new(c)
                .context("lp_to_collateral_non_zero: amount of backing collateral rounded to 0")
        })
    }

    /// Calculate how many LP tokens would be produced from the given collateral.
    ///
    /// If there is currently no liquidity in the pool, this will use a 1:1 ratio.
    pub fn collateral_to_lp(&self, amount: NonZero<Collateral>) -> Result<NonZero<LpToken>> {
        let total_collateral = self.total_collateral()?;

        NonZero::new(LpToken::from_decimal256(if total_collateral.is_zero() {
            debug_assert!(self.total_lp.is_zero());
            debug_assert!(self.total_xlp.is_zero());
            amount.into_decimal256()
        } else {
            self.total_tokens()?
                .into_decimal256()
                .checked_mul(amount.into_decimal256())?
                .checked_div(total_collateral.into_decimal256())?
        }))
        .context("liquidity_deposit_inner: new shares is (impossibly) 0")
    }

    /// approximate equality comparison, helpful for tests
    pub fn approx_eq(&self, other: &Self) -> bool {
        self.locked.approx_eq(other.locked)
            && self.unlocked.approx_eq(other.unlocked)
            && self.total_lp.approx_eq(other.total_lp)
            && self.total_xlp.approx_eq(other.total_xlp)
    }
}

/// Liquidity events
pub mod events {
    use super::LiquidityStats;
    use crate::prelude::*;
    use cosmwasm_std::Event;

    /// Liquidity was withdrawn from the system
    pub struct WithdrawEvent {
        /// Number of LP tokens burned
        pub burned_shares: NonZero<LpToken>,
        /// Collateral returned to the provider
        pub withdrawn_funds: NonZero<Collateral>,
        /// USD value of the collateral
        pub withdrawn_funds_usd: NonZero<Usd>,
    }

    impl From<WithdrawEvent> for cosmwasm_std::Event {
        fn from(src: WithdrawEvent) -> Self {
            cosmwasm_std::Event::new("liquidity-withdraw").add_attributes(vec![
                ("burned-shares", src.burned_shares.to_string()),
                ("withdrawn-funds", src.withdrawn_funds.to_string()),
                ("withdrawn-funds-usd", src.withdrawn_funds_usd.to_string()),
            ])
        }
    }

    /// Liquidity deposited into the protocol
    pub struct DepositEvent {
        /// Amount of collateral deposited
        pub amount: NonZero<Collateral>,
        /// Value of deposit in USD
        pub amount_usd: NonZero<Usd>,
        /// Number of tokens minted from this deposit
        pub shares: NonZero<LpToken>,
    }

    impl From<DepositEvent> for cosmwasm_std::Event {
        fn from(src: DepositEvent) -> Self {
            cosmwasm_std::Event::new("liquidity-deposit").add_attributes(vec![
                ("amount", src.amount.to_string()),
                ("amount-usd", src.amount_usd.to_string()),
                ("shares", src.shares.to_string()),
            ])
        }
    }

    /// Liquidity was locked into a position as counter collateral.
    pub struct LockEvent {
        /// Amount of liquidity that was locked
        pub amount: NonZero<Collateral>,
    }

    impl From<LockEvent> for cosmwasm_std::Event {
        fn from(src: LockEvent) -> Self {
            cosmwasm_std::Event::new("liquidity-lock")
                .add_attribute("amount", src.amount.to_string())
        }
    }

    /// Liquidity was unlocked from a position back into the unlocked pool.
    pub struct UnlockEvent {
        /// Amount of liquidity that was unlocked.
        pub amount: NonZero<Collateral>,
    }

    impl From<UnlockEvent> for cosmwasm_std::Event {
        fn from(src: UnlockEvent) -> Self {
            cosmwasm_std::Event::new("liquidity-unlock")
                .add_attribute("amount", src.amount.to_string())
        }
    }

    /// Amount of locked liquidity changed from price exposure in liquifunding.
    pub struct LockUpdateEvent {
        /// Increase or decrease in locked liquidity in the pool.
        pub amount: Signed<Collateral>,
    }

    impl From<LockUpdateEvent> for cosmwasm_std::Event {
        fn from(src: LockUpdateEvent) -> Self {
            cosmwasm_std::Event::new("liquidity-update")
                .add_attributes(vec![("amount", src.amount.to_string())])
        }
    }

    /// Provides current size of the liquidity pool
    pub struct LiquidityPoolSizeEvent {
        /// Total locked collateral
        pub locked: Collateral,
        /// Locked collateral in USD
        pub locked_usd: Usd,
        /// Total unlocked collateral
        pub unlocked: Collateral,
        /// Unlocked collateral in USD
        pub unlocked_usd: Usd,
        /// Total collateral (locked and unlocked) backing LP tokens
        pub lp_collateral: Collateral,
        /// Total collateral (locked and unlocked) backing xLP tokens
        pub xlp_collateral: Collateral,
        /// Total number of LP tokens
        pub total_lp: LpToken,
        /// Total number of xLP tokens
        pub total_xlp: LpToken,
    }

    impl LiquidityPoolSizeEvent {
        /// Generate a value from protocol stats and the current price.
        pub fn from_stats(stats: &LiquidityStats, price: &PricePoint) -> Result<Self> {
            let total_collateral = stats.total_collateral()?;
            let total_tokens = stats.total_tokens()?;
            let (lp_collateral, xlp_collateral) = if total_tokens.is_zero() {
                debug_assert_eq!(total_collateral, Collateral::zero());
                (Collateral::zero(), Collateral::zero())
            } else {
                let lp_collateral = total_collateral.into_decimal256()
                    * stats.total_lp.into_decimal256()
                    / total_tokens.into_decimal256();
                let lp_collateral = Collateral::from_decimal256(lp_collateral);
                let xlp_collateral = (total_collateral - lp_collateral)?;

                (lp_collateral, xlp_collateral)
            };

            Ok(Self {
                locked: stats.locked,
                locked_usd: price.collateral_to_usd(stats.locked),
                unlocked: stats.unlocked,
                unlocked_usd: price.collateral_to_usd(stats.unlocked),
                lp_collateral,
                xlp_collateral,
                total_lp: stats.total_lp,
                total_xlp: stats.total_xlp,
            })
        }
    }

    impl From<LiquidityPoolSizeEvent> for cosmwasm_std::Event {
        fn from(src: LiquidityPoolSizeEvent) -> Self {
            cosmwasm_std::Event::new("liquidity-pool-size").add_attributes(vec![
                ("locked", src.locked.to_string()),
                ("locked-usd", src.locked_usd.to_string()),
                ("unlocked", src.unlocked.to_string()),
                ("unlocked-usd", src.unlocked_usd.to_string()),
                ("lp-collateral", src.lp_collateral.to_string()),
                ("xlp-collateral", src.xlp_collateral.to_string()),
                ("total-lp", src.total_lp.to_string()),
                ("total-xlp", src.total_xlp.to_string()),
            ])
        }
    }

    impl TryFrom<Event> for LiquidityPoolSizeEvent {
        type Error = anyhow::Error;

        fn try_from(evt: Event) -> anyhow::Result<Self> {
            Ok(LiquidityPoolSizeEvent {
                locked: evt.decimal_attr("locked")?,
                locked_usd: evt.decimal_attr("locked-usd")?,
                unlocked: evt.decimal_attr("unlocked")?,
                unlocked_usd: evt.decimal_attr("unlocked-usd")?,
                lp_collateral: evt.decimal_attr("lp-collateral")?,
                xlp_collateral: evt.decimal_attr("xlp-collateral")?,
                total_lp: evt.decimal_attr("total-lp")?,
                total_xlp: evt.decimal_attr("total-xlp")?,
            })
        }
    }

    /// Tracks when the delta neutrality ratio has been updated.
    #[derive(Debug)]
    pub struct DeltaNeutralityRatioEvent {
        /// Total locked and unlocked liquidity in the pool
        pub total_liquidity: Collateral,
        /// Total long interest (using direction to base), in notional
        pub long_interest: Notional,
        /// Total short interest (using direction to base), in notional
        pub short_interest: Notional,
        /// Net notional: long - short
        pub net_notional: Signed<Notional>,
        /// Current notional price
        pub price_notional: Price,
        /// Current delta neutrality ratio: net-notional in collateral / total liquidity.
        pub delta_neutrality_ratio: Signed<Decimal256>,
    }

    impl From<DeltaNeutralityRatioEvent> for cosmwasm_std::Event {
        fn from(
            DeltaNeutralityRatioEvent {
                total_liquidity,
                long_interest,
                short_interest,
                net_notional,
                price_notional,
                delta_neutrality_ratio,
            }: DeltaNeutralityRatioEvent,
        ) -> Self {
            cosmwasm_std::Event::new("delta-neutrality-ratio").add_attributes(vec![
                ("total-liquidity", total_liquidity.to_string()),
                ("long-interest", long_interest.to_string()),
                ("short-interest", short_interest.to_string()),
                ("net-notional", net_notional.to_string()),
                ("price-notional", price_notional.to_string()),
                ("delta-neutrality-ratio", delta_neutrality_ratio.to_string()),
            ])
        }
    }

    impl TryFrom<Event> for DeltaNeutralityRatioEvent {
        type Error = anyhow::Error;

        fn try_from(evt: Event) -> anyhow::Result<Self> {
            Ok(DeltaNeutralityRatioEvent {
                total_liquidity: evt.decimal_attr("total-liquidity")?,
                long_interest: evt.decimal_attr("long-interest")?,
                short_interest: evt.decimal_attr("short-interest")?,
                net_notional: evt.number_attr("net-notional")?,
                price_notional: Price::try_from_number(evt.number_attr("price-notional")?)?,
                delta_neutrality_ratio: evt.number_attr("delta-neutrality-ratio")?,
            })
        }
    }
}