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
#![allow(clippy::too_many_arguments)]
use crate::processor::close_account;
pub use crate::processor::{
cancel_order, close_market, consume_events, create_market, initialize_account, new_order,
settle, swap, sweep_fees, update_royalties,
};
use bonfida_utils::InstructionsAccount;
use num_derive::{FromPrimitive, ToPrimitive};
use solana_program::{instruction::Instruction, pubkey::Pubkey};
#[derive(Clone, Copy, FromPrimitive, ToPrimitive)]
/// Describes all possible instructions and their required accounts
pub enum DexInstruction {
/// Creates a new DEX market
///
/// | Index | Writable | Signer | Description |
/// | ------------------------------------------------------- |
/// | 0 | ✅ | ❌ | The market account |
/// | 1 | ✅ | ❌ | The orderbook account |
/// | 2 | ❌ | ❌ | The base vault account |
/// | 3 | ❌ | ❌ | The quote vault account |
/// | 4 | ❌ | ❌ | The market admin account |
/// | 5 | ✅ | ❌ | The AOB event queue account |
/// | 6 | ✅ | ❌ | The AOB asks account |
/// | 7 | ✅ | ❌ | The AOB bids account |
/// | 8 | ❌ | ❌ | The metaplex token metadata |
CreateMarket,
/// Execute a new order instruction. Supported types include Limit, IOC, FOK, or Post only.
///
/// | Index | Writable | Signer | Description |
/// | -------------------------------------------------------------------------------------------------------------- |
/// | 0 | ❌ | ❌ | The SPL token program |
/// | 1 | ❌ | ❌ | The system program |
/// | 2 | ✅ | ❌ | The DEX market |
/// | 3 | ✅ | ❌ | The orderbook |
/// | 4 | ✅ | ❌ | The AOB event queue |
/// | 5 | ✅ | ❌ | The AOB bids shared memory |
/// | 6 | ✅ | ❌ | The AOB asks shared memory |
/// | 7 | ✅ | ❌ | The base token vault |
/// | 8 | ✅ | ❌ | The quote token vault |
/// | 9 | ✅ | ❌ | The DEX user account |
/// | 10 | ✅ | ❌ | The user source token account |
/// | 11 | ✅ | ✅ | The user wallet |
/// | 12 | ❌ | ❌ | The optional SRM or MSRM discount token account (must be owned by the user wallet) |
/// | 13 | ✅ | ❌ | The optional referrer's token account which will receive a 20% cut of the fees |
NewOrder,
///
/// | Index | Writable | Signer | Description |
/// | -------------------------------------------------------------------------------------------------------------- |
/// | 0 | ❌ | ❌ | The SPL token program |
/// | 1 | ❌ | ❌ | The system program |
/// | 2 | ✅ | ❌ | The DEX market |
/// | 3 | ✅ | ❌ | The orderbook |
/// | 4 | ✅ | ❌ | The AOB event queue |
/// | 5 | ✅ | ❌ | The AOB bids shared memory |
/// | 6 | ✅ | ❌ | The AOB asks shared memory |
/// | 7 | ✅ | ❌ | The base token vault |
/// | 8 | ✅ | ❌ | The quote token vault |
/// | 9 | ❌ | ❌ | The DEX market signer |
/// | 10 | ✅ | ❌ | The user base token account |
/// | 11 | ✅ | ❌ | The user quote token account |
/// | 12 | ✅ | ✅ | The user wallet |
/// | 13 | ❌ | ❌ | The optional SRM or MSRM discount token account (must be owned by the user wallet) |
/// | 14 | ✅ | ❌ | The optional referrer's token account which will receive a 20% cut of the fees |
Swap,
/// Cancel an existing order and remove it from the orderbook.
///
/// | Index | Writable | Signer | Description |
/// | ------------------------------------------------------ |
/// | 0 | ❌ | ❌ | The DEX market |
/// | 1 | ✅ | ❌ | The orderbook |
/// | 2 | ✅ | ❌ | The AOB event queue |
/// | 3 | ✅ | ❌ | The AOB bids shared memory |
/// | 4 | ✅ | ❌ | The AOB asks shared memory |
/// | 5 | ✅ | ❌ | The DEX user account |
/// | 6 | ❌ | ✅ | The user wallet |
CancelOrder,
/// Crank the processing of DEX events.
///
/// | Index | Writable | Signer | Description |
/// | --------------------------------------------------------- |
/// | 0 | ✅ | ❌ | The DEX market |
/// | 1 | ✅ | ❌ | The orderbook |
/// | 2 | ✅ | ❌ | The AOB event queue |
/// | 3 | ✅ | ❌ | The reward target |
/// | 4..4 + N | ✅ | ❌ | The relevant user accounts |
ConsumeEvents,
/// Extract available base and quote token assets from a user account
///
/// | Index | Writable | Signer | Description |
/// | --------------------------------------------------------------- |
/// | 0 | ❌ | ❌ | The spl token program |
/// | 1 | ❌ | ❌ | The DEX market |
/// | 2 | ✅ | ❌ | The base token vault |
/// | 3 | ✅ | ❌ | The quote token vault |
/// | 4 | ❌ | ❌ | The DEX market signer account |
/// | 5 | ✅ | ❌ | The DEX user account |
/// | 6 | ❌ | ✅ | The DEX user account owner wallet |
/// | 7 | ✅ | ❌ | The destination base token account |
/// | 8 | ✅ | ❌ | The destination quote token account |
Settle,
/// Initialize a new user account
///
/// | Index | Writable | Signer | Description |
/// | ---------------------------------------------------------- |
/// | 0 | ❌ | ❌ | The system program |
/// | 1 | ✅ | ❌ | The user account to initialize |
/// | 2 | ❌ | ✅ | The owner of the user account |
/// | 3 | ✅ | ✅ | The fee payer |
InitializeAccount,
/// Extract accumulated fees from the market. This is an admin instruction
///
/// | Index | Writable | Signer | Description |
/// | ------------------------------------------------------------ |
/// | 0 | ✅ | ❌ | The DEX market |
/// | 1 | ❌ | ❌ | The DEX market signer |
/// | 2 | ✅ | ❌ | The market quote token vault |
/// | 3 | ✅ | ❌ | The destination token account |
/// | 4 | ❌ | ❌ | The spl token program |
/// | 5 | ❌ | ❌ | The metadata account |
/// | 6..6 + N | ✅ | ❌ | The creator token account |
SweepFees,
/// Close an inactive and empty user account
///
/// | Index | Writable | Signer | Description |
/// | ------------------------------------------------------------------ |
/// | 0 | ✅ | ❌ | The user account to close |
/// | 1 | ❌ | ✅ | The owner of the user account to close |
/// | 2 | ✅ | ❌ | The target lamports account |
CloseAccount,
/// Close an existing market
///
/// | Index | Writable | Signer | Description |
/// | ---------------------------------------------------------- |
/// | 0 | ✅ | ❌ | The market account |
/// | 1 | ✅ | ❌ | The market base vault account |
/// | 2 | ✅ | ❌ | The market quote vault account |
/// | 3 | ✅ | ❌ | The AOB orderbook account |
/// | 4 | ✅ | ❌ | The AOB event queue account |
/// | 5 | ✅ | ❌ | The AOB bids account |
/// | 6 | ✅ | ❌ | The AOB asks account |
/// | 7 | ❌ | ✅ | The makret admin account |
/// | 8 | ✅ | ❌ | The target lamports account |
/// | 9 | ❌ | ❌ | The market signer |
/// | 10 | ❌ | ❌ | The SPL token program ID |
CloseMarket,
/// Update market royalties.
///
/// | Index | Writable | Signer | Description |
/// | --------------------------------------------------- |
/// | 0 | ✅ | ❌ | The DEX market |
/// | 1 | ❌ | ❌ | The event queue account |
/// | 2 | ❌ | ❌ | The AOB market account |
/// | 3 | ❌ | ❌ | The token metadata |
UpdateRoyalties,
}
/// Create a new DEX market
///
/// The asset agnostic orderbook must be properly initialized beforehand.
pub fn create_market(
program_id: Pubkey,
accounts: create_market::Accounts<Pubkey>,
params: create_market::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::CreateMarket as u8, params)
}
///
pub fn new_order(
program_id: Pubkey,
accounts: new_order::Accounts<Pubkey>,
params: new_order::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::NewOrder as u8, params)
}
/// Execute a swap on the orderbook.
pub fn swap(
program_id: Pubkey,
accounts: swap::Accounts<Pubkey>,
params: swap::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::Swap as u8, params)
}
/// Cancel an existing order and remove it from the orderbook.
pub fn cancel_order(
program_id: Pubkey,
accounts: cancel_order::Accounts<Pubkey>,
params: cancel_order::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::CancelOrder as u8, params)
}
/// Crank the processing of DEX events.
pub fn consume_events(
program_id: Pubkey,
accounts: consume_events::Accounts<Pubkey>,
params: consume_events::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::ConsumeEvents as u8, params)
}
/// Extract available base and quote token assets from a user account
pub fn settle(
program_id: Pubkey,
accounts: settle::Accounts<Pubkey>,
params: settle::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::Settle as u8, params)
}
/// Initialize a new user account
pub fn initialize_account(
program_id: Pubkey,
accounts: initialize_account::Accounts<Pubkey>,
params: initialize_account::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::InitializeAccount as u8, params)
}
/// Extract accumulated fees from the market. This is an admin instruction
pub fn sweep_fees(
program_id: Pubkey,
accounts: sweep_fees::Accounts<Pubkey>,
params: sweep_fees::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::SweepFees as u8, params)
}
/// Close an inactive and fully settled account
pub fn close_account(
program_id: Pubkey,
accounts: close_account::Accounts<Pubkey>,
params: close_account::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::CloseAccount as u8, params)
}
/// Close an existing market
pub fn close_market(
program_id: Pubkey,
accounts: close_market::Accounts<Pubkey>,
params: close_market::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::CloseMarket as u8, params)
}
///
pub fn update_royalties(
program_id: Pubkey,
accounts: update_royalties::Accounts<Pubkey>,
params: update_royalties::Params,
) -> Instruction {
accounts.get_instruction_cast(program_id, DexInstruction::UpdateRoyalties as u8, params)
}