dg_xch_core 2.1.1

Core library containing type/error definitions, CLVM tools, Consensus and Pool definitions
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
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

use crate::blockchain::proof_of_space::ProofOfSpace;
use crate::blockchain::sized_bytes::{Bytes32, Bytes48, Bytes96};

use crate::constants::{FARMING_TO_POOL, LEAVING_POOL, SELF_POOLING};
use dg_xch_macros::ChiaSerial;
use serde::{Deserialize, Serialize};
use time::OffsetDateTime;

#[derive(ChiaSerial, Copy, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub enum PoolSingletonState {
    SelfPooling = SELF_POOLING as isize,
    LeavingPool = LEAVING_POOL as isize,
    FarmingToPool = FARMING_TO_POOL as isize,
    Unknown = 0,
}
impl From<u8> for PoolSingletonState {
    fn from(byte: u8) -> Self {
        match byte {
            SELF_POOLING => PoolSingletonState::SelfPooling,
            LEAVING_POOL => PoolSingletonState::LeavingPool,
            FARMING_TO_POOL => PoolSingletonState::FarmingToPool,
            _ => PoolSingletonState::Unknown,
        }
    }
}

#[derive(ChiaSerial, Copy, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub enum PoolErrorCode {
    RevertedSignagePoint = 1,
    TooLate = 2,
    NotFound = 3,
    InvalidProof = 4,
    ProofNotGoodEnough = 5,
    InvalidDifficulty = 6,
    InvalidSignature = 7,
    ServerException = 8,
    InvalidP2SingletonPuzzleHash = 9,
    FarmerNotKnown = 10,
    FarmerAlreadyKnown = 11,
    InvalidAuthenticationToken = 12,
    InvalidPayoutInstructions = 13,
    InvalidSingleton = 14,
    DelayTimeTooShort = 15,
    RequestFailed = 16,
}
impl From<u8> for PoolErrorCode {
    fn from(byte: u8) -> Self {
        match byte {
            1 => PoolErrorCode::RevertedSignagePoint,
            2 => PoolErrorCode::TooLate,
            3 => PoolErrorCode::NotFound,
            4 => PoolErrorCode::InvalidProof,
            5 => PoolErrorCode::ProofNotGoodEnough,
            6 => PoolErrorCode::InvalidDifficulty,
            7 => PoolErrorCode::InvalidSignature,
            8 => PoolErrorCode::ServerException,
            9 => PoolErrorCode::InvalidP2SingletonPuzzleHash,
            10 => PoolErrorCode::FarmerNotKnown,
            11 => PoolErrorCode::FarmerAlreadyKnown,
            12 => PoolErrorCode::InvalidAuthenticationToken,
            13 => PoolErrorCode::InvalidPayoutInstructions,
            14 => PoolErrorCode::InvalidSingleton,
            15 => PoolErrorCode::DelayTimeTooShort,
            _ => PoolErrorCode::RequestFailed,
        }
    }
}
#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PoolError {
    pub error_code: u8,        //Min Version 0.0.34
    pub error_message: String, //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct AuthenticationPayload {
    pub method_name: String,         //Min Version 0.0.34
    pub launcher_id: Bytes32,        //Min Version 0.0.34
    pub target_puzzle_hash: Bytes32, //Min Version 0.0.34
    pub authentication_token: u64,   //Min Version 0.0.34
}
#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct GetPoolInfoResponse {
    pub name: String,                     //Min Version 0.0.34
    pub logo_url: String,                 //Min Version 0.0.34
    pub minimum_difficulty: u64,          //Min Version 0.0.34
    pub relative_lock_height: u32,        //Min Version 0.0.34
    pub protocol_version: u8,             //Min Version 0.0.34
    pub fee: String,                      //Min Version 0.0.34
    pub description: String,              //Min Version 0.0.34
    pub target_puzzle_hash: Bytes32,      //Min Version 0.0.34
    pub authentication_token_timeout: u8, //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PostPartialPayload {
    pub launcher_id: Bytes32,         //Min Version 0.0.34
    pub authentication_token: u64,    //Min Version 0.0.34
    pub proof_of_space: ProofOfSpace, //Min Version 0.0.34
    pub sp_hash: Bytes32,             //Min Version 0.0.34
    pub end_of_sub_slot: bool,        //Min Version 0.0.34
    pub harvester_id: Bytes32,        //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PostPartialRequest {
    pub payload: PostPartialPayload,  //Min Version 0.0.34
    pub aggregate_signature: Bytes96, //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PostPartialResponse {
    pub new_difficulty: u64, //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct GetFarmerRequest {
    pub launcher_id: Bytes32,      //Min Version 0.0.34
    pub authentication_token: u64, //Min Version 0.0.34
    pub signature: Bytes96,        //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct GetFarmerResponse {
    pub authentication_public_key: Bytes48, //Min Version 0.0.34
    pub payout_instructions: String,        //Min Version 0.0.34
    pub current_difficulty: u64,            //Min Version 0.0.34
    pub current_points: u64,                //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PostFarmerPayload {
    pub launcher_id: Bytes32,               //Min Version 0.0.34
    pub authentication_token: u64,          //Min Version 0.0.34
    pub authentication_public_key: Bytes48, //Min Version 0.0.34
    pub payout_instructions: String,        //Min Version 0.0.34
    pub suggested_difficulty: Option<u64>,  //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PostFarmerRequest {
    pub payload: PostFarmerPayload, //Min Version 0.0.34
    pub signature: Bytes96,         //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PostFarmerResponse {
    pub welcome_message: String, //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PutFarmerPayload {
    pub launcher_id: Bytes32,                       //Min Version 0.0.34
    pub authentication_token: u64,                  //Min Version 0.0.34
    pub authentication_public_key: Option<Bytes48>, //Min Version 0.0.34
    pub payout_instructions: Option<String>,        //Min Version 0.0.34
    pub suggested_difficulty: Option<u64>,          //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PutFarmerRequest {
    pub payload: PutFarmerPayload, //Min Version 0.0.34
    pub signature: Bytes96,        //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PutFarmerResponse {
    pub authentication_public_key: Option<bool>, //Min Version 0.0.34
    pub payout_instructions: Option<bool>,       //Min Version 0.0.34
    pub suggested_difficulty: Option<bool>,      //Min Version 0.0.34
}

#[derive(ChiaSerial, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct ErrorResponse {
    pub error_code: u16,               //Min Version 0.0.34
    pub error_message: Option<String>, //Min Version 0.0.34
}

#[allow(clippy::cast_sign_loss)]
#[must_use]
pub fn get_current_authentication_token(timeout: u8) -> u64 {
    let now: u64 = OffsetDateTime::now_utc().unix_timestamp() as u64;
    now / 60 / u64::from(timeout)
}

#[must_use]
pub fn validate_authentication_token(token: u64, timeout: u8) -> bool {
    let cur_token = get_current_authentication_token(timeout);
    let dif = if token > cur_token {
        token - cur_token
    } else {
        cur_token - token
    };
    dif <= u64::from(timeout)
}