nym-types 1.20.4

Nym common types
Documentation 
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

use crate::currency::DecCoin;
use nym_validator_client::nyxd::Fee;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "generate-ts", derive(ts_rs::TS))]
#[cfg_attr(
    feature = "generate-ts",
    ts(export, export_to = "ts-packages/types/src/types/rust/FeeDetails.ts")
)]
pub struct FeeDetails {
    // expected to be used by the wallet in order to display detailed fee information to the user
    pub amount: Option<DecCoin>,
    #[cfg_attr(feature = "generate-ts", ts(as = "ts_type_helpers::Fee"))]
    pub fee: Fee,
}

impl FeeDetails {
    pub fn new(amount: Option<DecCoin>, fee: Fee) -> Self {
        FeeDetails { amount, fee }
    }
}

// this should really be sealed and NEVER EVER used as "normal" types,
// but due to our typescript requirements, we have to expose it to generate
// the types...
#[cfg(feature = "generate-ts")]
pub mod ts_type_helpers {
    use nym_validator_client::nyxd::GasAdjustment;
    use serde::{Deserialize, Serialize};

    #[derive(Debug, Clone, Serialize, Deserialize, ts_rs::TS)]
    #[ts(export, export_to = "ts-packages/types/src/types/rust/Fee.ts")]
    pub enum Fee {
        Manual(CosmosFee),
        Auto(Option<GasAdjustment>),
    }

    #[derive(Debug, Clone, Serialize, Deserialize, ts_rs::TS)]
    #[ts(export, export_to = "ts-packages/types/src/types/rust/CosmosFee.ts")]
    // this should corresponds to cosmrs::tx::Fee
    // IMPORTANT NOTE: this should work as of cosmrs 0.7.1 due to their `FromStr` implementations
    // on the type. The below struct might have to get readjusted if we update cosmrs!!
    pub struct CosmosFee {
        amount: Vec<Coin>,
        gas_limit: u64,
        payer: Option<String>,
        granter: Option<String>,
    }

    // Note: I've got a feeling this one will bite us hard at some point...
    #[derive(Debug, Clone, Serialize, Deserialize, ts_rs::TS)]
    #[ts(export, export_to = "ts-packages/types/src/types/rust/Coin.ts")]
    // this should corresponds to cosmrs::Coin
    // IMPORTANT NOTE: this should work as of cosmrs 0.7.1 due to their `FromStr` implementations
    // on the type. The below struct might have to get readjusted if we update cosmrs!!
    pub struct Coin {
        denom: String,
        // this is not entirely true, but for the purposes
        // of ts_rs, it's sufficient for the time being
        amount: u64,
    }
}