ore-api 3.8.6

Future-proof electronic cash.
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use serde::{Deserialize, Serialize};
use steel::*;

use crate::state::OreAccountV4;

use super::OreAccount;

/// Treasury is a singleton account which is the mint authority for the ORE token and the authority of
/// the program's global token account.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable, Serialize, Deserialize)]
pub struct Treasury {
    // The amount of SOL collected for buy-bury operations.
    pub balance: u64,

    /// Buffer a (placeholder)
    pub buffer_a: u64,

    /// The amount of ORE in the motherlode rewards pool.
    pub motherlode: u64,

    /// The cumulative ORE distributed to miners, divided by the total unclaimed ORE at the time of distribution.
    pub miner_rewards_factor: Numeric,

    /// The cumulative ORE distributed to stakers, divided by the total stake at the time of distribution.
    #[deprecated(since = "3.8.0", note = "Staking has moved to ore-stake program")]
    pub stake_rewards_factor: Numeric,

    /// Buffer b (placeholder)
    pub buffer_b: u64,

    /// The current total amount of refined ORE mining rewards.
    pub total_refined: u64,

    /// The current total amount of ORE staking deposits.
    #[deprecated(since = "3.8.0", note = "Staking has moved to ore-stake program")]
    pub total_staked: u64,

    /// The current total amount of unclaimed ORE mining rewards.
    pub total_unclaimed: u64,
}

/// Treasury is a singleton account which is the mint authority for the ORE token and the authority of
/// the program's global token account.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable, Serialize, Deserialize)]
pub struct TreasuryV4 {
    /// The amount of ORE in the motherlode rewards pool.
    pub motherlode: u64,

    /// The cumulative ORE distributed to miners, divided by the total unclaimed ORE at the time of distribution.
    pub rewards_factor: Numeric,

    /// The current total amount of refined ORE mining rewards.
    pub total_refined: u64,

    /// The current total amount of unrefined ORE mining rewards.
    pub total_unrefined: u64,
}

account!(OreAccount, Treasury);
account!(OreAccountV4, TreasuryV4);

pub enum TreasuryAccount {
    Treasury(Treasury),
    TreasuryV4(TreasuryV4),
}

#[allow(deprecated)]
impl TreasuryAccount {
    pub fn balance(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.balance,
            TreasuryAccount::TreasuryV4(_) => 0,
        }
    }

    pub fn buffer_a(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.buffer_a,
            TreasuryAccount::TreasuryV4(_) => 0,
        }
    }

    pub fn motherlode(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.motherlode,
            TreasuryAccount::TreasuryV4(t) => t.motherlode,
        }
    }

    pub fn miner_rewards_factor(&self) -> Numeric {
        match self {
            TreasuryAccount::Treasury(t) => t.miner_rewards_factor,
            TreasuryAccount::TreasuryV4(t) => t.rewards_factor,
        }
    }

    pub fn stake_rewards_factor(&self) -> Numeric {
        match self {
            TreasuryAccount::Treasury(t) => t.stake_rewards_factor,
            TreasuryAccount::TreasuryV4(_) => Numeric::ZERO,
        }
    }

    pub fn buffer_b(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.buffer_b,
            TreasuryAccount::TreasuryV4(_) => 0,
        }
    }

    pub fn total_refined(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.total_refined,
            TreasuryAccount::TreasuryV4(t) => t.total_refined,
        }
    }

    pub fn total_staked(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.total_staked,
            TreasuryAccount::TreasuryV4(_) => 0,
        }
    }

    pub fn total_unclaimed(&self) -> u64 {
        match self {
            TreasuryAccount::Treasury(t) => t.total_unclaimed,
            TreasuryAccount::TreasuryV4(t) => t.total_unrefined,
        }
    }
}