namada_storage 0.150.1

Namada ledger storage
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

//! Shielded tokens conversion state

use std::collections::BTreeMap;

pub use namada_core::address::Address;
use namada_core::borsh::{BorshDeserialize, BorshSerialize};
pub use namada_core::masp::MaspEpoch;
pub use namada_core::masp_primitives::asset_type::AssetType;
pub use namada_core::masp_primitives::convert::AllowedConversion;
pub use namada_core::masp_primitives::merkle_tree::FrozenCommitmentTree;
pub use namada_core::masp_primitives::sapling::Node as SaplingNode;
pub use namada_core::token::{Denomination, MaspDigitPos};
use namada_macros::BorshDeserializer;
#[cfg(feature = "migrations")]
use namada_migrations::*;

/// A representation of a leaf in the conversion tree
#[derive(Debug, BorshSerialize, BorshDeserialize, BorshDeserializer)]
pub struct ConversionLeaf {
    /// The token associated with this asset type
    pub token: Address,
    /// The denomination associated with the above toke
    pub denom: Denomination,
    /// The digit position covered by this asset type
    pub digit_pos: MaspDigitPos,
    /// The masp epoch of the asset type
    pub epoch: MaspEpoch,
    /// The actual conversion and generator
    pub conversion: AllowedConversion,
    /// The position of this leaf in the conversion tree
    pub leaf_pos: usize,
}

/// A representation of the conversion state
#[derive(
    Debug, Default, BorshSerialize, BorshDeserialize, BorshDeserializer,
)]
pub struct ConversionState {
    /// The last amount of the native token distributed
    #[deprecated = "Current native precision has been moved into the native \
                    precision storage key."]
    pub current_precision: Option<u128>,
    /// The tree currently containing all the conversions
    pub tree: FrozenCommitmentTree<SaplingNode>,
    /// Map assets to their latest conversion and position in Merkle tree
    pub assets: BTreeMap<AssetType, ConversionLeaf>,
}

/// Able to borrow conversion state.
pub trait ReadConversionState {
    /// Borrow immutable conversion state
    fn conversion_state(&self) -> &ConversionState;
}

/// Able to borrow mutable conversion state.
pub trait WithConversionState: ReadConversionState {
    /// Borrow mutable conversion state
    fn conversion_state_mut(&mut self) -> &mut ConversionState;
}