gmsol-store 0.10.0

GMX-Solana is an extension of GMX on the Solana blockchain.
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
use anchor_lang::prelude::*;
use gmsol_utils::InitSpace;

use crate::{
    constants::MARKET_DECIMALS,
    internal,
    states::{
        market::virtual_inventory::{
            VirtualInventory, VIRTUAL_INVENTORY_FOR_POSITIONS_SEED,
            VIRTUAL_INVENTORY_FOR_SWAPS_SEED,
        },
        Market, Store, TokenMapHeader, TokenMapLoader,
    },
    CoreError,
};

/// The accounts definitions for [`close_virtual_inventory`](crate::gmsol_store::close_virtual_inventory).
#[derive(Accounts)]
pub struct CloseVirtualInventory<'info> {
    /// Authority.
    #[account(mut)]
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The store wallet.
    #[account(mut, seeds = [Store::WALLET_SEED, store.key().as_ref()], bump)]
    pub store_wallet: SystemAccount<'info>,
    /// The virtual inventory account to close.
    #[account(
        mut,
        close = store_wallet,
        has_one = store,
        constraint = virtual_inventory.load()?.ref_count() == 0,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
}

impl CloseVirtualInventory<'_> {
    /// Close an unused [`VirtualInventory`] account.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(_ctx: Context<Self>) -> Result<()> {
        Ok(())
    }
}

impl<'info> internal::Authentication<'info> for CloseVirtualInventory<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

/// The accounts definitions of [`disable_virtual_inventory`](crate::gmsol_store::disable_virtual_inventory).
#[derive(Accounts)]
pub struct DisableVirtualInventory<'info> {
    /// Authority.
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The virtual inventory account to close.
    #[account(
        mut,
        has_one = store,
        constraint = !virtual_inventory.load()?.is_disabled() @ CoreError::PreconditionsAreNotMet,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
}

impl<'info> internal::Authentication<'info> for DisableVirtualInventory<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

impl DisableVirtualInventory<'_> {
    /// Disable the given [`VirtualInventory`] account.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(ctx: Context<Self>) -> Result<()> {
        ctx.accounts.virtual_inventory.load_mut()?.disable()?;
        Ok(())
    }
}

/// The accounts definitions of [`leave_disabled_virtual_inventory`](crate::gmsol_store::leave_disabled_virtual_inventory).
#[derive(Accounts)]
pub struct LeaveDisabledVirtualInventory<'info> {
    /// Authority.
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The virtual inventory account to join.
    #[account(
        mut,
        has_one = store,
        constraint = virtual_inventory.load()?.is_disabled() @ CoreError::PreconditionsAreNotMet,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
    /// The market to be added to the virtual inventory.
    #[account(mut, has_one = store)]
    pub market: AccountLoader<'info, Market>,
}

impl<'info> internal::Authentication<'info> for LeaveDisabledVirtualInventory<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

impl LeaveDisabledVirtualInventory<'_> {
    /// Leave a disabled [`VirtualInventory`] account.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(ctx: Context<Self>) -> Result<()> {
        let address = ctx.accounts.virtual_inventory.key();
        let mut market = ctx.accounts.market.load_mut()?;
        let mut virtual_inventory = ctx.accounts.virtual_inventory.load_mut()?;
        market.leave_disabled_virtual_inventory_unchecked(&address, &mut virtual_inventory)?;
        Ok(())
    }
}

/// The accounts definitions for [`create_virtual_inventory_for_swaps`](crate::gmsol_store::create_virtual_inventory_for_swaps).
#[derive(Accounts)]
#[instruction(index: u32)]
pub struct CreateVirtualInventoryForSwaps<'info> {
    /// Authority.
    #[account(mut)]
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The virtual inventory account to create.
    #[account(
        init,
        payer = authority,
        space = 8 + VirtualInventory::INIT_SPACE,
        seeds = [VIRTUAL_INVENTORY_FOR_SWAPS_SEED, store.key().as_ref(), &index.to_le_bytes()],
        bump,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
    /// The system program.
    pub system_program: Program<'info, System>,
}

impl CreateVirtualInventoryForSwaps<'_> {
    /// Create a [`VirtualInventory`] account for swaps.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(
        ctx: Context<Self>,
        index: u32,
        long_amount_decimals: u8,
        short_amount_decimals: u8,
    ) -> Result<()> {
        ctx.accounts.virtual_inventory.load_init()?.init(
            ctx.bumps.virtual_inventory,
            index,
            ctx.accounts.store.key(),
            long_amount_decimals,
            short_amount_decimals,
        );
        Ok(())
    }
}

impl<'info> internal::Authentication<'info> for CreateVirtualInventoryForSwaps<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

/// The accounts definitions for
/// [`join_virtual_inventory_for_swaps`](crate::gmsol_store::join_virtual_inventory_for_swaps).
#[derive(Accounts)]
pub struct JoinVirtualInventoryForSwaps<'info> {
    /// Authority.
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The token map account.
    #[account(has_one = store)]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
    /// The virtual inventory account to join.
    #[account(
        mut,
        seeds = [VIRTUAL_INVENTORY_FOR_SWAPS_SEED, store.key().as_ref(), &virtual_inventory.load()?.index.to_le_bytes()],
        bump = virtual_inventory.load()?.bump,
        has_one = store,
        constraint = !virtual_inventory.load()?.is_disabled() @ CoreError::PreconditionsAreNotMet,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
    /// The market to be added to the virtual inventory.
    #[account(mut, has_one = store, constraint = !market.load()?.is_pure())]
    pub market: AccountLoader<'info, Market>,
}

impl JoinVirtualInventoryForSwaps<'_> {
    /// Add the market to the given virtual inventory.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(ctx: Context<Self>) -> Result<()> {
        let address = ctx.accounts.virtual_inventory.key();
        let mut virtual_inventory = ctx.accounts.virtual_inventory.load_mut()?;
        let token_map = ctx.accounts.token_map.load_token_map()?;
        ctx.accounts
            .market
            .load_mut()?
            .join_virtual_inventory_for_swaps_unchecked(
                &address,
                &mut virtual_inventory,
                &token_map,
            )?;
        Ok(())
    }
}

impl<'info> internal::Authentication<'info> for JoinVirtualInventoryForSwaps<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

/// The accounts definitions for
/// [`leave_virtual_inventory_for_swaps`](crate::gmsol_store::leave_virtual_inventory_for_swaps).
#[derive(Accounts)]
pub struct LeaveVirtualInventoryForSwaps<'info> {
    /// Authority.
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The virtual inventory account to join.
    #[account(
        mut,
        seeds = [VIRTUAL_INVENTORY_FOR_SWAPS_SEED, store.key().as_ref(), &virtual_inventory.load()?.index.to_le_bytes()],
        bump = virtual_inventory.load()?.bump,
        has_one = store,
        constraint = !virtual_inventory.load()?.is_disabled() @ CoreError::PreconditionsAreNotMet,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
    /// The market to be added to the virtual inventory.
    #[account(mut, has_one = store, constraint = !market.load()?.is_pure())]
    pub market: AccountLoader<'info, Market>,
}

impl LeaveVirtualInventoryForSwaps<'_> {
    /// Remove the market from the given virtual inventory.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(ctx: Context<Self>) -> Result<()> {
        let address = ctx.accounts.virtual_inventory.key();
        let mut market = ctx.accounts.market.load_mut()?;
        let virtual_inventory_for_swaps = market
            .virtual_inventory_for_swaps()
            .ok_or_else(|| error!(CoreError::PreconditionsAreNotMet))?;
        require_keys_eq!(*virtual_inventory_for_swaps, address);
        let mut virtual_inventory = ctx.accounts.virtual_inventory.load_mut()?;
        market.leave_virtual_inventory_for_swaps_unchecked(&mut virtual_inventory)?;
        Ok(())
    }
}

impl<'info> internal::Authentication<'info> for LeaveVirtualInventoryForSwaps<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

/// The accounts definitions for [`create_virtual_inventory_for_positions`](crate::gmsol_store::create_virtual_inventory_for_positions).
#[derive(Accounts)]
pub struct CreateVirtualInventoryForPositions<'info> {
    /// Authority.
    #[account(mut)]
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// Index token address.
    /// CHECK: only the address of this account is used.
    pub index_token: UncheckedAccount<'info>,
    /// The virtual inventory account to create.
    #[account(
        init,
        payer = authority,
        space = 8 + VirtualInventory::INIT_SPACE,
        seeds = [
            VIRTUAL_INVENTORY_FOR_POSITIONS_SEED,
            store.key().as_ref(),
            index_token.key.as_ref(),
        ],
        bump,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
    /// The system program.
    pub system_program: Program<'info, System>,
}

impl CreateVirtualInventoryForPositions<'_> {
    /// Create a [`VirtualInventory`] account for positions.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_unchecked(ctx: Context<Self>) -> Result<()> {
        ctx.accounts.virtual_inventory.load_init()?.init(
            ctx.bumps.virtual_inventory,
            0,
            ctx.accounts.store.key(),
            MARKET_DECIMALS,
            MARKET_DECIMALS,
        );
        Ok(())
    }
}

impl<'info> internal::Authentication<'info> for CreateVirtualInventoryForPositions<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}

/// The accounts definitions for
/// [`join_virtual_inventory_for_positions`](crate::gmsol_store::join_virtual_inventory_for_positions)
/// and [`leave_virtual_inventory_for_positions`](crate::gmsol_store::leave_virtual_inventory_for_positions).
#[derive(Accounts)]
pub struct JoinOrLeaveVirtualInventoryForPositions<'info> {
    /// Authority.
    pub authority: Signer<'info>,
    /// Store account.
    pub store: AccountLoader<'info, Store>,
    /// The virtual inventory account to join.
    #[account(
        mut,
        seeds = [VIRTUAL_INVENTORY_FOR_POSITIONS_SEED, store.key().as_ref(), market.load()?.meta().index_token_mint.as_ref()],
        bump = virtual_inventory.load()?.bump,
        has_one = store,
        constraint = !virtual_inventory.load()?.is_disabled() @ CoreError::PreconditionsAreNotMet,
    )]
    pub virtual_inventory: AccountLoader<'info, VirtualInventory>,
    /// The market to be added to the virtual inventory.
    #[account(mut, has_one = store)]
    pub market: AccountLoader<'info, Market>,
}

impl JoinOrLeaveVirtualInventoryForPositions<'_> {
    /// Add the market to the given virtual inventory.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_join_unchecked(ctx: Context<Self>) -> Result<()> {
        let address = ctx.accounts.virtual_inventory.key();
        let mut virtual_inventory = ctx.accounts.virtual_inventory.load_mut()?;
        ctx.accounts
            .market
            .load_mut()?
            .join_virtual_inventory_for_positions_unchecked(&address, &mut virtual_inventory)?;
        Ok(())
    }

    /// Remove the market from the given virtual inventory.
    ///
    /// # CHECK
    /// - Only MARKET_KEEPER is allowed to invoke.
    pub(crate) fn invoke_leave_unchecked(ctx: Context<Self>) -> Result<()> {
        let address = ctx.accounts.virtual_inventory.key();
        let mut market = ctx.accounts.market.load_mut()?;
        let virtual_inventory_for_positions = market
            .virtual_inventory_for_positions()
            .ok_or_else(|| error!(CoreError::PreconditionsAreNotMet))?;
        require_keys_eq!(*virtual_inventory_for_positions, address);
        let mut virtual_inventory = ctx.accounts.virtual_inventory.load_mut()?;
        market.leave_virtual_inventory_for_positions_unchecked(&mut virtual_inventory)?;
        Ok(())
    }
}

impl<'info> internal::Authentication<'info> for JoinOrLeaveVirtualInventoryForPositions<'info> {
    fn authority(&self) -> &Signer<'info> {
        &self.authority
    }

    fn store(&self) -> &AccountLoader<'info, Store> {
        &self.store
    }
}