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
//! Represents the native coin or CW20 used for collateral in a market.
use crate::contracts::{
    cw20::entry::{
        BalanceResponse as Cw20BalanceResponse, ExecuteMsg as Cw20ExecuteMsg,
        QueryMsg as Cw20QueryMsg,
    },
    market::entry::ExecuteMsg as MarketExecuteMsg,
};
use crate::prelude::*;

use cosmwasm_std::{
    to_json_binary, Addr, BankMsg, Coin, CosmosMsg, Decimal256, QuerierWrapper, WasmMsg,
};
use serde::Serialize;

/// The number of decimal places for tokens may vary
/// and there is a smart query cost for deriving it at runtime
/// so we grab the info at init time and then store it as a full-fledged token
#[cw_serde]
pub enum TokenInit {
    /// A cw20 address. Decimal places will be derived.
    Cw20 {
        /// Address of the CW20 contract
        addr: RawAddr,
    },

    /// Native currency. May cover some IBC tokens too
    Native {
        /// Denom used within the chain for this native coin
        denom: String,
        /// Number of decimal points
        decimal_places: u8,
    },
}

impl From<Token> for TokenInit {
    fn from(src: Token) -> Self {
        match src {
            Token::Native {
                denom,
                decimal_places,
            } => Self::Native {
                denom,
                decimal_places,
            },
            Token::Cw20 { addr, .. } => Self::Cw20 { addr },
        }
    }
}

/// The overall ideas of the Token API are:
/// 1. use the Number type, not u128 or Uint128
/// 2. abstract over the Cw20/Native variants
///
/// At the end of the day, call transfer/query with
/// the same business logic as contract math
/// and don't worry at all about conversions or addresses/denoms
#[cw_serde]
#[derive(Eq)]
pub enum Token {
    /// An asset controlled by a CW20 token.
    Cw20 {
        /// Address of the contract
        addr: RawAddr,
        /// Decimals places used by the contract
        decimal_places: u8,
    },

    /// Native coin on the blockchain
    Native {
        /// Native coin denom string
        denom: String,
        /// Decimal places used by the asset
        decimal_places: u8,
    },
}

impl Token {
    pub(crate) fn name(&self) -> String {
        match self {
            Self::Native { denom, .. } => {
                format!("native-{}", denom)
            }
            Self::Cw20 { addr, .. } => {
                format!("cw20-{}", addr)
            }
        }
    }

    pub(crate) fn decimal_places(&self) -> u8 {
        match self {
            Self::Native { decimal_places, .. } => *decimal_places,
            Self::Cw20 { decimal_places, .. } => *decimal_places,
        }
    }
    /// This is the usual function to call for transferring money
    /// the result can simply be added as a Message to any Response
    /// the amount is expressed as Number such that it mirrors self.query_balance()
    pub fn into_transfer_msg(
        &self,
        recipient: &Addr,
        amount: NonZero<Collateral>,
    ) -> Result<Option<CosmosMsg>> {
        match self {
            Self::Native { .. } => {
                let coin = self.into_native_coin(amount.into_number_gt_zero())?;

                match coin {
                    Some(coin) => Ok(Some(CosmosMsg::Bank(BankMsg::Send {
                        to_address: recipient.to_string(),
                        amount: vec![coin],
                    }))),

                    None => Ok(None),
                }
            }
            Self::Cw20 { addr, .. } => {
                let msg = self.into_cw20_execute_transfer_msg(recipient, amount)?;

                match msg {
                    Some(msg) => {
                        let msg = to_json_binary(&msg)?;

                        Ok(Some(CosmosMsg::Wasm(WasmMsg::Execute {
                            contract_addr: addr.to_string(),
                            msg,
                            funds: Vec::new(),
                        })))
                    }
                    None => Ok(None),
                }
            }
        }
    }

    /// Get the balance - this is expressed a Collateral
    /// such that it mirrors self.into_transfer_msg()
    pub fn query_balance(&self, querier: &QuerierWrapper, user_addr: &Addr) -> Result<Collateral> {
        self.query_balance_dec(querier, user_addr)
            .map(Collateral::from_decimal256)
    }

    /// Get the balance - this is expressed as Decimal256
    /// such that it mirrors self.into_transfer_msg()
    pub fn query_balance_dec(
        &self,
        querier: &QuerierWrapper,
        user_addr: &Addr,
    ) -> Result<Decimal256> {
        self.from_u128(match self {
            Self::Cw20 { addr, .. } => {
                let resp: Cw20BalanceResponse = querier.query_wasm_smart(
                    addr.as_str(),
                    &Cw20QueryMsg::Balance {
                        address: user_addr.to_string().into(),
                    },
                )?;

                resp.balance.u128()
            }
            Self::Native { denom, .. } => {
                let coin = querier.query_balance(user_addr, denom)?;
                coin.amount.u128()
            }
        })
    }

    /// helper function
    ///
    /// given a u128, typically via a native Coin.amount or Cw20 amount
    /// get the Decimal256 representation according to the WalletSource's config
    ///
    /// this is essentially the inverse of self.into_u128()
    pub fn from_u128(&self, amount: u128) -> Result<Decimal256> {
        Decimal256::from_atomics(amount, self.decimal_places().into()).map_err(|e| e.into())
    }

    /// helper function
    ///
    /// given a number, typically via business logic and client API
    /// get the u128 representation, e.g. for Coin or Cw20
    /// according to the WalletSource's config
    ///
    /// this will only return None if the amount is zero (or rounds to 0)
    /// which then bubbles up into other methods that build on this
    ///
    /// this is essentially the inverse of self.from_u128()
    pub fn into_u128(&self, amount: Decimal256) -> Result<Option<u128>> {
        let value: u128 = amount
            .into_number()
            .to_u128_with_precision(self.decimal_places().into())
            .ok_or_else(|| {
                anyhow!(PerpError::new(
                    ErrorId::Conversion,
                    ErrorDomain::Wallet,
                    format!("{} unable to convert {amount} to u128!", self.name(),)
                ))
            })?;

        if value > 0 {
            Ok(Some(value))
        } else {
            Ok(None)
        }
    }

    /// helper function
    ///
    /// when we know for a fact we have a WalletSource::native
    /// we can get a Coin from a Number amount
    pub fn into_native_coin(&self, amount: NumberGtZero) -> Result<Option<Coin>> {
        match self {
            Self::Native { denom, .. } => {
                Ok(self
                    .into_u128(amount.into_decimal256())?
                    .map(|amount| Coin {
                        denom: denom.clone(),
                        amount: amount.into(),
                    }))
            }
            Self::Cw20 { .. } => Err(anyhow!(PerpError::new(
                ErrorId::NativeFunds,
                ErrorDomain::Wallet,
                format!("{} cannot be turned into a native coin", self.name())
            ))),
        }
    }

    /// Round down to the supported precision of this token
    pub fn round_down_to_precision(&self, amount: Collateral) -> Result<Collateral> {
        self.from_u128(
            self.into_u128(amount.into_decimal256())?
                .unwrap_or_default(),
        )
        .map(Collateral::from_decimal256)
    }

    /// helper function
    ///
    /// when we know for a fact we have a WalletSource::Cw20
    /// we can get a Send Execute messge from a Number amount
    pub fn into_cw20_execute_send_msg<T: Serialize>(
        &self,
        contract: &Addr,
        amount: Collateral,
        submsg: &T,
    ) -> Result<Option<Cw20ExecuteMsg>> {
        match self {
            Self::Native { .. } => Err(anyhow!(PerpError::new(
                ErrorId::Cw20Funds,
                ErrorDomain::Wallet,
                format!("{} cannot be turned into a cw20 message", self.name())
            ))),
            Self::Cw20 { .. } => {
                let msg = to_json_binary(submsg)?;
                Ok(self
                    .into_u128(amount.into_decimal256())?
                    .map(|amount| Cw20ExecuteMsg::Send {
                        contract: contract.into(),
                        amount: amount.into(),
                        msg,
                    }))
            }
        }
    }

    /// helper function
    ///
    /// when we know for a fact we have a WalletSource::Cw20
    /// we can get a Transfer Execute messge from a Number amount
    pub fn into_cw20_execute_transfer_msg(
        &self,
        recipient: &Addr,
        amount: NonZero<Collateral>,
    ) -> Result<Option<Cw20ExecuteMsg>> {
        match self {
            Self::Native { .. } => Err(anyhow!(PerpError::new(
                ErrorId::Cw20Funds,
                ErrorDomain::Wallet,
                format!("{} cannot be turned into a cw20 message", self.name())
            ))),
            Self::Cw20 { .. } => Ok(self.into_u128(amount.into_decimal256())?.map(|amount| {
                Cw20ExecuteMsg::Transfer {
                    recipient: recipient.into(),
                    amount: amount.into(),
                }
            })),
        }
    }

    /// perps-specific use-case for executing a market message with funds
    pub fn into_market_execute_msg(
        &self,
        market_addr: &Addr,
        amount: Collateral,
        execute_msg: MarketExecuteMsg,
    ) -> Result<WasmMsg> {
        self.into_execute_msg(market_addr, amount, &execute_msg)
    }

    /// helper to create an execute message with funds
    pub fn into_execute_msg<T: Serialize + std::fmt::Debug>(
        &self,
        contract_addr: &Addr,
        amount: Collateral,
        execute_msg: &T,
    ) -> Result<WasmMsg> {
        match self.clone() {
            Self::Cw20 { addr, .. } => {
                let msg = self
                    .into_cw20_execute_send_msg(contract_addr, amount, &execute_msg)
                    .map_err(|err| {
                        let downcast = err
                            .downcast_ref::<PerpError>()
                            .map(|item| item.description.clone());
                        let msg = format!("{downcast:?} (exec inner msg: {execute_msg:?})!");
                        anyhow!(PerpError::new(
                            ErrorId::Conversion,
                            ErrorDomain::Wallet,
                            msg
                        ))
                    })?;

                match msg {
                    Some(msg) => Ok(WasmMsg::Execute {
                        contract_addr: addr.into_string(),
                        msg: to_json_binary(&msg)?,
                        funds: Vec::new(),
                    }),
                    None => {
                        // no funds, so just send the execute_msg directly
                        // to the contract
                        Ok(WasmMsg::Execute {
                            contract_addr: contract_addr.to_string(),
                            msg: to_json_binary(&execute_msg)?,
                            funds: Vec::new(),
                        })
                    }
                }
            }
            Self::Native { .. } => {
                let funds = if amount.is_zero() {
                    Vec::new()
                } else {
                    let amount = NumberGtZero::new(amount.into_decimal256())
                        .context("Unable to convert amount into NumberGtZero")?;
                    let coin = self
                        .into_native_coin(amount)
                        .map_err(|err| {
                            let downcast = err
                                .downcast_ref::<PerpError>()
                                .map(|item| item.description.clone());
                            let msg = format!("{downcast:?} (exec inner msg: {execute_msg:?})!");
                            anyhow!(PerpError::new(
                                ErrorId::Conversion,
                                ErrorDomain::Wallet,
                                msg
                            ))
                        })?
                        .unwrap();

                    vec![coin]
                };

                let execute_msg = to_json_binary(&execute_msg)?;

                Ok(WasmMsg::Execute {
                    contract_addr: contract_addr.to_string(),
                    msg: execute_msg,
                    funds,
                })
            }
        }
    }

    /// Validates that the given collateral doesn't require more precision
    /// than what the token supports
    pub fn validate_collateral(&self, value: NonZero<Collateral>) -> Result<NonZero<Collateral>> {
        let value_decimal256 = value.into_decimal256();

        if let Some(value_128) = self.into_u128(value_decimal256)? {
            let value_truncated = self.from_u128(value_128)?;
            if value_truncated == value_decimal256 {
                return Ok(value);
            }
        }

        let msg = format!("Token Collateral must be as precise as the Token (is {}, only {} decimal places supported)", value, self.decimal_places());
        Err(anyhow!(PerpError::new(
            ErrorId::Conversion,
            ErrorDomain::Wallet,
            msg
        )))
    }
}