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
use borsh::{BorshDeserialize, BorshSerialize};
use solana_program::{
    instruction::{AccountMeta, Instruction},
    pubkey::Pubkey,
};

pub use crate::processor::{cancel_order, close_market, consume_events, create_market, new_order};
#[derive(BorshDeserialize, BorshSerialize)]
/// Describes all possible instructions and their required accounts
pub enum AgnosticOrderbookInstruction {
    /// Create and initialize a new orderbook market
    ///
    /// Required accounts
    ///
    /// | index | writable | signer | description                      |
    /// |-------|----------|--------|----------------------------------|
    /// | 0     | ✅       | ❌     | The market account               |
    /// | 1     | ✅       | ❌     | A zeroed out event queue account |
    /// | 2     | ✅       | ❌     | A zeroed out bids account        |
    /// | 3     | ✅       | ❌     | A zeroed out asks account        |
    CreateMarket(create_market::Params),
    /// Execute a new order on the orderbook.
    ///
    /// Depending on the provided parameters, the program will attempt to match the order with existing entries
    /// in the orderbook, and then optionally post the remaining order.
    ///
    /// Required accounts
    ///
    ///
    /// | index | writable | signer | description             |
    /// |-------|----------|--------|-------------------------|
    /// | 0     | ✅       | ❌     | The market account      |
    /// | 1     | ✅       | ❌     | The event queue account |
    /// | 2     | ✅       | ❌     | The bids account        |
    /// | 3     | ✅       | ❌     | The asks account        |
    /// | 4     | ❌       | ✅     | The caller authority    |
    NewOrder(new_order::Params),
    /// Pop a series of events off the event queue.
    ///
    /// Required accounts
    ///
    /// | index | writable | signer | description                  |
    /// |-------|----------|--------|------------------------------|
    /// | 0     | ✅       | ❌     | The market account           |
    /// | 1     | ✅       | ❌     | The event queue account      |
    /// | 3     | ❌       | ✅     | The caller authority         |
    /// | 4     | ✅       | ❌     | The reward target account    |
    /// | 5     | ❌       | ❌     | The MSRM token account       |
    /// | 6     | ❌       | ✅     | The MSRM token account owner |
    ConsumeEvents(consume_events::Params),
    /// Cancel an existing order in the orderbook.
    ///
    /// Required accounts
    ///
    /// | index | writable | signer | description             |
    /// |-------|----------|--------|-------------------------|
    /// | 0     | ✅       | ❌     | The market account      |
    /// | 1     | ✅       | ❌     | The event queue account |
    /// | 2     | ✅       | ❌     | The bids account        |
    /// | 3     | ✅       | ❌     | The asks account        |
    /// | 4     | ❌       | ✅     | The caller authority    |
    CancelOrder(cancel_order::Params),
    /// Close and existing market.
    ///
    /// Required accounts
    ///
    /// | index | writable | signer   | description                 |
    /// |-------|----------|----------|-----------------------------|
    /// | 0     | ✅        | ❌      | The market account          |
    /// | 1     | ✅        | ❌      | The event queue account     |
    /// | 2     | ✅        | ❌      | The bids account            |
    /// | 3     | ✅        | ❌      | The asks account            |
    /// | 4     | ❌        | ✅      | The caller authority        |
    /// | 5     | ✅        | ❌      | The lamports target account |
    CloseMarket,
}

/**
Create and initialize a new orderbook market

The event_queue, bids, and asks accounts should be freshly allocated or zeroed out accounts.

* The market account will only contain a [`MarketState`](`crate::state::MarketState`) object and should be sized appropriately.

* The event queue will contain an [`EventQueueHeader`](`crate::state::EventQueueHeader`) object followed by a return register sized for a [`OrderSummary`](`crate::orderbook::OrderSummary`)
(size of [`ORDER_SUMMARY_SIZE`](`crate::orderbook::ORDER_SUMMARY_SIZE`)) and then a series of events [`Event`](`crate::state::Event`). The serialized size of an [`Event`](`crate::state::Event`) object
is given by [`compute_slot_size`](`crate::state::Event::compute_slot_size`) The size of the queue should be determined
accordingly.

* The asks and bids accounts will contain a header of size [`SLAB_HEADER_LEN`][`crate::critbit::SLAB_HEADER_LEN`] followed by a series of slots of size
[`compute_slot_size(callback_info_len)`][`crate::critbit::Slab::compute_slot_size`].
*/
pub fn create_market(
    agnostic_orderbook_program_id: Pubkey,
    market_account: Pubkey,
    event_queue: Pubkey,
    bids: Pubkey,
    asks: Pubkey,
    create_market_params: create_market::Params,
) -> Instruction {
    let instruction_data = AgnosticOrderbookInstruction::CreateMarket(create_market_params);
    let data = instruction_data.try_to_vec().unwrap();
    let accounts = vec![
        AccountMeta::new(market_account, false),
        AccountMeta::new(event_queue, false),
        AccountMeta::new(bids, false),
        AccountMeta::new(asks, false),
    ];

    Instruction {
        program_id: agnostic_orderbook_program_id,
        accounts,
        data,
    }
}
/**
Execute a new order on the orderbook.

Depending on the provided parameters, the program will attempt to match the order with existing entries
in the orderbook, and then optionally post the remaining order.
*/
pub fn new_order(
    agnostic_orderbook_program_id: Pubkey,
    market_account: Pubkey,
    caller_authority: Pubkey,
    event_queue: Pubkey,
    bids: Pubkey,
    asks: Pubkey,
    new_order_params: new_order::Params,
) -> Instruction {
    let data = AgnosticOrderbookInstruction::NewOrder(new_order_params)
        .try_to_vec()
        .unwrap();
    let accounts = vec![
        AccountMeta::new(market_account, false),
        AccountMeta::new(event_queue, false),
        AccountMeta::new(bids, false),
        AccountMeta::new(asks, false),
        AccountMeta::new_readonly(caller_authority, true),
    ];

    Instruction {
        program_id: agnostic_orderbook_program_id,
        accounts,
        data,
    }
}

/// Cancel an existing order in the orderbook.
pub fn cancel_order(
    agnostic_orderbook_program_id: Pubkey,
    market_account: Pubkey,
    caller_authority: Pubkey,
    event_queue: Pubkey,
    bids: Pubkey,
    asks: Pubkey,
    cancel_order_params: cancel_order::Params,
) -> Instruction {
    let data = AgnosticOrderbookInstruction::CancelOrder(cancel_order_params)
        .try_to_vec()
        .unwrap();
    let accounts = vec![
        AccountMeta::new(market_account, false),
        AccountMeta::new(event_queue, false),
        AccountMeta::new(bids, false),
        AccountMeta::new(asks, false),
        AccountMeta::new_readonly(caller_authority, true),
    ];

    Instruction {
        program_id: agnostic_orderbook_program_id,
        accounts,
        data,
    }
}

/// Pop a series of events off the event queue.
#[allow(clippy::clippy::too_many_arguments)]
pub fn consume_events(
    agnostic_orderbook_program_id: Pubkey,
    market_account: Pubkey,
    caller_authority: Pubkey,
    event_queue: Pubkey,
    reward_target: Pubkey,
    msrm_token_account: Pubkey,
    msrm_token_account_owner: Pubkey,
    consume_events_params: consume_events::Params,
) -> Instruction {
    let data = AgnosticOrderbookInstruction::ConsumeEvents(consume_events_params)
        .try_to_vec()
        .unwrap();
    let accounts = vec![
        AccountMeta::new(market_account, false),
        AccountMeta::new(event_queue, false),
        AccountMeta::new_readonly(caller_authority, true),
        AccountMeta::new(reward_target, false),
        AccountMeta::new_readonly(msrm_token_account, false),
        AccountMeta::new_readonly(msrm_token_account_owner, true),
    ];

    Instruction {
        program_id: agnostic_orderbook_program_id,
        accounts,
        data,
    }
}

/// Close and existing market.
#[allow(clippy::clippy::too_many_arguments)]
pub fn close_market(
    agnostic_orderbook_program_id: Pubkey,
    market: Pubkey,
    event_queue: Pubkey,
    bids: Pubkey,
    asks: Pubkey,
    authority: Pubkey,
    lamports_target_account: Pubkey,
) -> Instruction {
    let data = AgnosticOrderbookInstruction::CloseMarket
        .try_to_vec()
        .unwrap();
    let accounts = vec![
        AccountMeta::new(market, false),
        AccountMeta::new(event_queue, false),
        AccountMeta::new(bids, false),
        AccountMeta::new(asks, false),
        AccountMeta::new_readonly(authority, true),
        AccountMeta::new(lamports_target_account, false),
    ];

    Instruction {
        program_id: agnostic_orderbook_program_id,
        accounts,
        data,
    }
}