phoenix-sdk 0.8.0

SDK for interacting with the Phoenix program
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 phoenix::state::{SelfTradeBehavior, Side};

/// LimitOrderTemplate is a helper type for creating a limit order.
/// The template allows you to specify the price and size in commonly understood units:
/// price is the floating point price (units of USDC per unit of SOL for the SOL/USDC market), and size is in whole base units (units of SOL for the SOL/USDC market).
/// The SDK can then convert this to a limit order instruction, ready to be sent.
pub struct LimitOrderTemplate {
    // The side for the order, a Side::Bid or a Side::Ask.
    pub side: Side,

    /// The price of the order, as the commonly understood exchange price (the number of quote units to exchange for one base unit), as a floating point number.
    pub price_as_float: f64,

    /// Total number of base units, as a floating point number, to place on the book or fill at a better price.
    pub size_in_base_units: f64,

    /// How the matching engine should handle a self trade.
    pub self_trade_behavior: SelfTradeBehavior,

    /// Number of orders to match against. If this is `None` there is no limit.
    pub match_limit: Option<u64>,

    /// Client order id used to identify the order in the response to the client.
    pub client_order_id: u128,

    /// Flag for whether or not the order should only use funds that are already in the account.
    /// Using only deposited funds will allow the trader to pass in fewer accounts per instruction and
    /// save transaction space as well as compute.
    pub use_only_deposited_funds: bool,

    /// If this is set, the order will be invalid after the specified slot.
    pub last_valid_slot: Option<u64>,

    /// If this is set, the order will be invalid after the specified unix timestamp.
    pub last_valid_unix_timestamp_in_seconds: Option<u64>,

    /// Flag for whether or not to have the entire transaction fail if there are insufficient funds to place the order.
    /// When set to true and there are insufficient funds, the order will not be placed but the transaction will not immediately fail.
    pub fail_silently_on_insufficient_funds: bool,
}

/// PostOnlyOrderTemplate is a helper type for creating a post-only order, which will never be matched against existing orders.
/// The template allows you to specify the price and size in commonly understood units:
/// price is the floating point price (units of USDC per unit of SOL for the SOL/USDC market), and size is in whole base units (units of SOL for the SOL/USDC market).
/// The SDK can then convert this to a post-only order instruction, ready to be sent.
pub struct PostOnlyOrderTemplate {
    // The side for the order, a Side::Bid or a Side::Ask.
    pub side: Side,

    /// The price of the order, as the commonly understood exchange price (the number of quote units to exchange for one base unit), as a floating point number.
    pub price_as_float: f64,

    /// Total number of base units, as a floating point number, to place on the book or fill at a better price.
    pub size_in_base_units: f64,

    /// Client order id used to identify the order in the response to the client.
    pub client_order_id: u128,

    /// Flag for whether or not to reject the order if it would immediately match or amend it to the best non-crossing price.
    /// Default value is true.
    pub reject_post_only: bool,

    /// Flag for whether or not the order should only use funds that are already in the account.
    /// Using only deposited funds will allow the trader to pass in fewer accounts per instruction and
    /// save transaction space as well as compute.
    pub use_only_deposited_funds: bool,

    /// If this is set, the order will be invalid after the specified slot.
    pub last_valid_slot: Option<u64>,

    /// If this is set, the order will be invalid after the specified unix timestamp.
    pub last_valid_unix_timestamp_in_seconds: Option<u64>,

    /// Flag for whether or not to have the entire transaction fail if there are insufficient funds to place the order.
    /// When set to true and there are insufficient funds, the order will not be placed but the transaction will not immediately fail.
    pub fail_silently_on_insufficient_funds: bool,
}

/// ImmediateOrCancelOrderTemplate is a helper type for creating an immediate or cancel order.
/// The template allows you to specify the price and size in commonly understood units:
/// price is the floating point price (units of USDC per unit of SOL for the SOL/USDC market), and size is in whole base units (units of SOL for the SOL/USDC market).
/// The SDK can then convert this to a limit order instruction, ready to be sent.
///
/// Immediate-or-cancel orders will be matched against existing resting orders.
/// If the order matches fewer than `min_lots` lots, it will be cancelled.
///
/// Fill or Kill (FOK) orders are a subset of Immediate or Cancel (IOC) orders where either
/// the `num_base_lots` is equal to the `min_base_lots_to_fill` of the order, or the `num_quote_lots` is
/// equal to the `min_quote_lots_to_fill` of the order.
pub struct ImmediateOrCancelOrderTemplate {
    // The side for the order, a Side::Bid or a Side::Ask.
    pub side: Side,

    /// The most aggressive price an order can be matched at. If this value is None, then the order
    /// is treated as a market order.
    pub price_as_float: Option<f64>,

    /// The number of base units to fill against the order book. Either this parameter or the `num_quote_units`
    /// parameter must be set to a nonzero value.
    pub size_in_base_units: f64,

    /// The number of quote units to fill against the order book. Either this parameter or the `num_base_units`
    /// parameter must be set to a nonzero value.
    pub size_in_quote_units: f64,

    /// The minimum number of base units to fill against the order book. If the order does not fill
    /// this many base lots, it will be voided.
    pub min_base_units_to_fill: f64,

    /// The minimum number of quote units to fill against the order book. If the order does not fill
    /// this many quote lots, it will be voided.
    pub min_quote_units_to_fill: f64,

    /// How the matching engine should handle a self trade.
    pub self_trade_behavior: SelfTradeBehavior,

    /// Number of orders to match against. If set to `None`, there is no limit.
    pub match_limit: Option<u64>,

    /// Client order id used to identify the order in the response to the client.
    pub client_order_id: u128,

    /// Flag for whether or not the order should only use funds that are already in the account.
    /// Using only deposited funds will allow the trader to pass in less accounts per instruction and
    /// save transaction space as well as compute. This is only for traders who have a seat.
    pub use_only_deposited_funds: bool,

    /// If this is set, the order will be invalid after the specified slot.
    pub last_valid_slot: Option<u64>,

    /// If this is set, the order will be invalid after the specified unix timestamp.
    pub last_valid_unix_timestamp_in_seconds: Option<u64>,
}