namada_shielded_token 0.150.1

Namada shielded token
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
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

use namada_core::address::{self, Address};
use namada_core::arith::checked;
use namada_core::masp::TokenMap;
use namada_core::token;
use namada_core::token::Amount;
use namada_core::uint::Uint;
use namada_systems::trans_token;

use crate::storage_key::*;
use crate::{Result, ResultExt, ShieldedParams, StorageRead, StorageWrite};

/// Initialize parameters for the token in storage during the genesis block.
pub fn write_params<S, TransToken>(
    params: &ShieldedParams,
    storage: &mut S,
    token: &Address,
    denom: &token::Denomination,
) -> Result<()>
where
    S: StorageRead + StorageWrite,
    TransToken: trans_token::Keys,
{
    let ShieldedParams {
        max_reward_rate: max_rate,
        kd_gain_nom,
        kp_gain_nom,
        locked_amount_target,
    } = params;
    storage.write(
        &masp_last_inflation_key::<TransToken>(token),
        Amount::zero(),
    )?;
    storage.write(
        &masp_last_locked_amount_key::<TransToken>(token),
        Amount::zero(),
    )?;
    storage.write(&masp_max_reward_rate_key::<TransToken>(token), max_rate)?;
    storage.write(&masp_kp_gain_key::<TransToken>(token), kp_gain_nom)?;
    storage.write(&masp_kd_gain_key::<TransToken>(token), kd_gain_nom)?;

    let locked_amount_target = Uint::from(*locked_amount_target);
    let raw_target = checked!(
        locked_amount_target * (Uint::from(10) ^ Uint::from(denom.0))
    )?;
    let raw_target = Amount::from_uint(raw_target, 0).into_storage_result()?;
    storage.write(
        &masp_locked_amount_target_key::<TransToken>(token),
        raw_target,
    )?;
    Ok(())
}

/// Mint MASP rewards tokens and increment the stored total rewards.
pub fn mint_rewards<S, TransToken>(
    storage: &mut S,
    amount: token::Amount,
) -> Result<()>
where
    S: StorageRead + StorageWrite,
    TransToken: trans_token::Write<S>,
{
    let native_token = storage.get_native_token()?;
    TransToken::credit_tokens(storage, &native_token, &address::MASP, amount)?;

    let total_rewards_key = masp_total_rewards();
    let mut total_rewards = read_total_rewards(storage)?;
    checked!(total_rewards += amount)?;
    storage.write(&total_rewards_key, total_rewards)
}

/// Read the total rewards minted by MASP.
pub fn read_total_rewards<S>(storage: &S) -> Result<token::Amount>
where
    S: StorageRead,
{
    let total_rewards_key = masp_total_rewards();
    let total_rewards: token::Amount =
        storage.read(&total_rewards_key)?.unwrap_or_default();
    Ok(total_rewards)
}

/// Read the undated balance of the given token in the MASP.
pub fn read_undated_balance<S>(
    storage: &S,
    token_address: &Address,
) -> Result<token::Amount>
where
    S: StorageRead,
{
    let undated_balance_key = masp_undated_balance_key(token_address);
    let undated_balance: token::Amount =
        storage.read(&undated_balance_key)?.unwrap_or_default();
    Ok(undated_balance)
}

/// Read the masp token map.
pub fn read_token_map<S>(storage: &S) -> Result<TokenMap>
where
    S: StorageRead,
{
    let token_map_key = masp_token_map_key();
    Ok(storage.read(&token_map_key)?.unwrap_or_default())
}

/// Write a new masp token map.
pub fn write_token_map<S>(storage: &mut S, token_map: TokenMap) -> Result<()>
where
    S: StorageWrite,
{
    let token_map_key = masp_token_map_key();
    storage.write(&token_map_key, token_map)
}