af-iperps 0.46.0

Move types for the `Perpetuals` package
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

//! Helpers for stop orders.

use af_utilities::IFixed;
use fastcrypto::hash::{Blake2b256, HashFunction};
use serde::{Deserialize, Serialize};
use sui_framework_sdk::object::ID;

use crate::order_helpers::{OrderType, Side};

pub trait StopOrderTicketDetails {
    /// Pure transaction input to use when calling `create_stop_order_ticket`.
    fn encrypted_details(&self, salt: Vec<u8>) -> Result<Vec<u8>, sui_sdk_types::bcs::Error>
    where
        Self: serde::Serialize,
    {
        let mut bytes = sui_sdk_types::bcs::ToBcs::to_bcs(&self)?;
        bytes.extend(salt);
        Ok(Blake2b256::digest(bytes).to_vec())
    }
}

/// The details to be hashed for the `encrypted_details` argument of `create_stop_order_ticket`.
#[derive(Debug, serde::Serialize)]
pub struct SLTPDetails {
    pub clearing_house_id: ID,
    /// The `Clock` value after (>=) which the order isn't valid anymore
    pub expire_timestamp: Option<u64>,
    /// `true` if limit order, `false` if market order
    pub is_limit_order: bool,
    /// Optional stop loss price
    pub stop_loss_price: Option<IFixed>,
    /// Optional take profit price
    pub take_profit_price: Option<IFixed>,
    /// `true` if position is short, `false` if position is long
    pub position_is_ask: bool,
    pub size: u64,
    /// Can be set at random value if `is_limit_order` is false
    pub price: u64,
    /// Can be set at random value if `is_limit_order` is false
    pub order_type: OrderType,
}

impl StopOrderTicketDetails for SLTPDetails {}

/// The details to be hashed for the `encrypted_details` argument of `create_stop_order_ticket`.
#[derive(Debug, serde::Serialize)]
pub struct StandaloneDetails {
    pub clearing_house_id: ID,
    /// The `Clock` value after (>=) which the order isn't valid anymore
    pub expire_timestamp: Option<u64>,
    /// `true` if limit order, `false` if market order
    pub is_limit_order: bool,
    pub stop_index_price: IFixed,
    /// `true` if the order can be placed when oracle index price is >= than
    /// chosen `stop_index_price`
    pub ge_stop_index_price: bool,
    pub side: Side,
    pub size: u64,
    /// Can be set at random value if `is_limit_order` is false
    pub price: u64,
    /// Can be set at random value if `is_limit_order` is false
    pub order_type: OrderType,
    pub reduce_only: bool,
}

impl StopOrderTicketDetails for StandaloneDetails {}

#[derive(Clone, Copy, Debug, clap::ValueEnum, Serialize, Deserialize)]
#[serde(into = "u64")]
pub enum StopOrderType {
    /// Stop-Loss / Take-Profit type, aimed to reduce position
    SLTP,
    /// Standard stop order, without restrictions
    Standalone,
}

impl From<StopOrderType> for u64 {
    fn from(value: StopOrderType) -> Self {
        match value {
            StopOrderType::SLTP => 0,
            StopOrderType::Standalone => 1,
        }
    }
}

#[derive(thiserror::Error, Debug)]
#[error("Invalid stop order type value")]
pub struct InvalidStopOrderTypeValue;

impl TryFrom<u64> for StopOrderType {
    type Error = InvalidStopOrderTypeValue;

    fn try_from(value: u64) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(Self::SLTP),
            1 => Ok(Self::Standalone),
            _ => Err(InvalidStopOrderTypeValue),
        }
    }
}