nado-sdk 0.3.6

Official Rust SDK for the Nado Protocol API
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
use crate::eip712_structs::{Cancellation, ListTriggerOrders};
use crate::eip712_structs::{CancellationProducts, Order};
use crate::engine::{ExecuteResponse, PlaceOrder, Status};
use crate::serialize_utils::{deserialize_i128, serialize_i128, WrappedBytes32, WrappedI128};
use ethers::types::{Bytes, H256};
use eyre::Result;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CancelReason {
    UserRequested,
    LinkedSignerChanged,
    Expired,
    AccountHealth,
    IsolatedSubaccountClosed,
    DependentOrderCancelled,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct ExecuteStatus {
    pub execute_response: ExecuteResponse,
    pub place_time: u64,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TriggerOrderStatus {
    Cancelled(CancelReason),
    Triggered(ExecuteResponse),
    InternalError(String),
    Triggering,
    WaitingPrice,
    WaitingDependency,
    // TWAP-specific statuses
    TwapExecuting {
        current_execution: u32,
        total_executions: u32,
    },
    TwapCompleted {
        executed: u32,
        total: u32,
    },
}

impl TriggerOrderStatus {
    pub fn byte(&self) -> i32 {
        (match self {
            Self::Cancelled(_) => TriggerOrderStatusType::Cancelled,
            Self::Triggered(_) => TriggerOrderStatusType::Triggered,
            Self::InternalError(_) => TriggerOrderStatusType::InternalError,
            Self::Triggering => TriggerOrderStatusType::Triggering,
            Self::WaitingPrice => TriggerOrderStatusType::WaitingPrice,
            Self::WaitingDependency => TriggerOrderStatusType::WaitingDependency,
            Self::TwapExecuting { .. } => TriggerOrderStatusType::TwapExecuting,
            Self::TwapCompleted { .. } => TriggerOrderStatusType::TwapCompleted,
        }) as i32
    }

    pub fn byte_from_str(s: &str) -> Result<i32> {
        match s {
            "cancelled" => Ok(0),
            "triggered" => Ok(1),
            "internal_error" => Ok(2),
            "triggering" => Ok(3),
            "waiting_price" => Ok(4),
            "waiting_dependency" => Ok(5),
            "twap_executing" => Ok(6),
            "twap_completed" => Ok(7),
            _ => Err(eyre::eyre!("Invalid status string")),
        }
    }

    pub fn data(&self) -> Vec<u8> {
        serde_json::to_vec(self).unwrap()
    }

    pub fn from_status_data(data: &[u8]) -> Self {
        serde_json::from_slice(data).unwrap()
    }
}

#[derive(Clone, Serialize, Deserialize, Debug)]
#[serde(rename_all = "snake_case")]
pub enum TriggerCriteria {
    PriceTrigger {
        price_requirement: PriceRequirement,
        dependency: Option<Dependency>,
    },
    TimeTrigger {
        interval: u64,
        amounts: Option<Vec<WrappedI128>>,
    },
}

#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct Dependency {
    pub digest: H256,
    pub on_partial_fill: bool, // trigger on partial fill
}

#[derive(Clone, Serialize, Deserialize, Debug)]
#[serde(rename_all = "snake_case")]
pub enum PriceRequirement {
    OraclePriceAbove(
        #[serde(
            serialize_with = "serialize_i128",
            deserialize_with = "deserialize_i128"
        )]
        i128,
    ),
    OraclePriceBelow(
        #[serde(
            serialize_with = "serialize_i128",
            deserialize_with = "deserialize_i128"
        )]
        i128,
    ),

    LastPriceAbove(
        #[serde(
            serialize_with = "serialize_i128",
            deserialize_with = "deserialize_i128"
        )]
        i128,
    ),
    LastPriceBelow(
        #[serde(
            serialize_with = "serialize_i128",
            deserialize_with = "deserialize_i128"
        )]
        i128,
    ),

    MidPriceAbove(
        #[serde(
            serialize_with = "serialize_i128",
            deserialize_with = "deserialize_i128"
        )]
        i128,
    ),

    MidPriceBelow(
        #[serde(
            serialize_with = "serialize_i128",
            deserialize_with = "deserialize_i128"
        )]
        i128,
    ),
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TriggerType {
    PriceTrigger = 0,
    TimeTrigger = 1,
    None = 2,
}

impl TriggerType {
    pub fn from_appendix(appendix: u128) -> Self {
        match appendix >> 12 & 3 {
            1 => Self::PriceTrigger,
            2 | 3 => Self::TimeTrigger,
            _ => Self::None,
        }
    }
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TriggerOrderStatusType {
    Cancelled = 0,
    Triggered = 1,
    InternalError = 2,
    Triggering = 3,
    WaitingPrice = 4,
    WaitingDependency = 5,
    TwapExecuting = 6,
    TwapCompleted = 7,
}

impl TriggerOrderStatusType {
    pub fn pending() -> Vec<Self> {
        vec![
            Self::WaitingPrice,
            Self::WaitingDependency,
            Self::TwapExecuting,
        ]
    }
    pub fn pending_byte() -> Vec<i32> {
        Self::pending().into_iter().map(|x| x as i32).collect()
    }
}

impl TriggerCriteria {
    pub fn byte(&self) -> i32 {
        match self {
            Self::PriceTrigger { .. } => 0,
            Self::TimeTrigger { .. } => 1,
        }
    }

    pub fn price_str(&self) -> Option<String> {
        match self {
            Self::PriceTrigger {
                price_requirement, ..
            } => Some(price_requirement.price_str()),
            _ => None,
        }
    }

    pub fn criteria_price_byte(&self) -> Option<i32> {
        match self {
            Self::PriceTrigger {
                price_requirement, ..
            } => Some(price_requirement.byte()),
            _ => None,
        }
    }

    pub fn dependency(&self) -> Option<[u8; 32]> {
        match self {
            Self::PriceTrigger { dependency, .. } => dependency.clone().map(|x| x.digest.0),
            _ => None,
        }
    }
}

impl PriceRequirement {
    pub fn byte(&self) -> i32 {
        match self {
            Self::OraclePriceAbove(_) => 0,
            Self::OraclePriceBelow(_) => 1,
            Self::LastPriceAbove(_) => 2,
            Self::LastPriceBelow(_) => 3,
            Self::MidPriceAbove(_) => 4,
            Self::MidPriceBelow(_) => 5,
        }
    }

    pub fn price(&self) -> i128 {
        match self {
            Self::OraclePriceAbove(price) => *price,
            Self::OraclePriceBelow(price) => *price,
            Self::LastPriceAbove(price) => *price,
            Self::LastPriceBelow(price) => *price,
            Self::MidPriceAbove(price) => *price,
            Self::MidPriceBelow(price) => *price,
        }
    }

    pub fn price_str(&self) -> String {
        // for postgresql indexing, which doesn't support i128
        format!("{:0>40}", self.price())
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct PlaceTriggerOrder {
    pub order: Order,
    pub signature: Bytes,
    pub product_id: u32,
    pub spot_leverage: Option<bool>,
    pub borrow_margin: Option<bool>,
    pub trigger: TriggerCriteria,
    pub digest: Option<H256>,
    pub id: Option<u64>,
}

impl PlaceTriggerOrder {
    pub fn to_place_order(&self) -> PlaceOrder {
        PlaceOrder {
            order: self.order.clone(),
            signature: self.signature.to_vec(),
            product_id: self.product_id,
            digest: None,
            id: self.id,
            spot_leverage: self.spot_leverage,
            borrow_margin: self.borrow_margin,
        }
    }

    pub fn order_data(&self) -> Vec<u8> {
        bincode::serialize(self).unwrap()
    }

    pub fn from_order_data(data: &[u8]) -> Self {
        bincode::deserialize(data).unwrap()
    }

    pub fn expiration(&self) -> u64 {
        self.order.expiration
    }

    pub fn is_bid(&self) -> bool {
        self.order.amount.is_positive()
    }

    pub fn trigger_amount(&self, index: u32) -> Option<i128> {
        if !self.order.is_twap_random() {
            None
        } else {
            match &self.trigger {
                TriggerCriteria::TimeTrigger { amounts, .. } => {
                    Some(amounts.as_ref().unwrap()[index as usize].0)
                }
                _ => unreachable!(),
            }
        }
    }
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct PlaceTriggerOrdersItemResponse {
    pub digest: Option<[u8; 32]>,
    pub error: Option<String>,
}

pub type PlaceTriggerOrdersResponse = Vec<PlaceTriggerOrdersItemResponse>;

#[derive(Clone, Serialize, Deserialize, Debug)]
#[serde(rename_all = "snake_case")]
// #[ts(export)]ยท
// #[ts(export_to = "tsBindings/msg/")]
pub enum Execute {
    PlaceOrder(PlaceTriggerOrder),
    PlaceOrders {
        orders: Vec<PlaceTriggerOrder>,
        stop_on_failure: Option<bool>,
    },
    CancelOrders {
        tx: Cancellation,
        signature: Bytes,
    },
    CancelProductOrders {
        tx: CancellationProducts,
        signature: Bytes,
    },
}

#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "type")]
pub enum Query {
    ListTriggerOrders {
        tx: ListTriggerOrders,
        signature: Bytes,
        product_ids: Option<Vec<u32>>,
        trigger_types: Option<Vec<TriggerType>>,
        status_types: Option<Vec<TriggerOrderStatusType>>,
        max_update_time: Option<u64>,
        max_digest: Option<WrappedBytes32>,
        digests: Option<Vec<WrappedBytes32>>,
        limit: Option<u32>,
        reduce_only: Option<bool>,
    },
    ListTwapExecutions {
        digest: WrappedBytes32,
    },
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct TriggerOrderInfo {
    pub order: PlaceTriggerOrder,
    pub status: TriggerOrderStatus,
    pub placed_at: u64,
    pub updated_at: u64,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ListTriggerOrdersResponse {
    pub orders: Vec<TriggerOrderInfo>,
}

impl ListTriggerOrdersResponse {
    pub fn contains_digest(&self, digest: H256) -> bool {
        self.orders
            .iter()
            .any(|order| order.order.digest == Some(digest))
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TwapExecutionStatusData {
    Pending,
    Executing,
    Executed {
        executed_time: i64,
        execute_response: ExecuteResponse,
    },
    Failed(String),
    Cancelled(CancelReason),
}

impl TwapExecutionStatusData {
    pub fn data(&self) -> Vec<u8> {
        serde_json::to_vec(self).unwrap()
    }

    pub fn from_status_data(data: &[u8]) -> Self {
        serde_json::from_slice(data).unwrap()
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ListTwapExecutionsResponse {
    pub executions: Vec<TwapExecutionDetail>,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct TwapExecutionDetail {
    pub execution_id: u32,
    pub scheduled_time: i64,
    pub status: TwapExecutionStatusData,
    pub updated_at: i64,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(untagged)]
pub enum QueryResponseData {
    ListTriggerOrders(ListTriggerOrdersResponse),
    ListTwapExecutions(ListTwapExecutionsResponse),
    Error(String),
}

#[derive(Clone, Debug, Serialize, Deserialize)]
// #[ts(export)]
// #[ts(export_to = "tsBindings/msgResponses/")]
#[serde(rename_all = "snake_case")]
pub struct QueryResponse {
    pub status: Status,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<QueryResponseData>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error_code: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_type: Option<String>,
}