gmsol-store 0.5.0

GMX-Solana is an extension of GMX on the Solana blockchain.
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use anchor_lang::prelude::*;
use anchor_spl::token::Mint;

use crate::{
    states::{
        FeedConfig, PriceProviderKind, Store, TokenConfigExt, TokenMapAccess, TokenMapAccessMut,
        TokenMapHeader, TokenMapLoader, UpdateTokenConfigParams,
    },
    utils::internal,
    CoreError,
};

/// The accounts definition for [`initialize_token_map`](crate::gmsol_store::initialize_token_map).
///
/// [*See also the documentation for the instruction.*](crate::gmsol_store::initialize_token_map)
#[derive(Accounts)]
pub struct InitializeTokenMap<'info> {
    /// The payer.
    #[account(mut)]
    pub payer: Signer<'info>,
    /// The store account for the token map.
    pub store: AccountLoader<'info, Store>,
    /// The token map account to be initialized.
    #[account(
        init,
        payer = payer,
        space = 8 + TokenMapHeader::space(0),
    )]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
    /// The system program.
    pub system_program: Program<'info, System>,
}

/// Initialize a new token map.
pub(crate) fn initialize_token_map(ctx: Context<InitializeTokenMap>) -> Result<()> {
    ctx.accounts.token_map.load_init()?.store = ctx.accounts.store.key();
    Ok(())
}

/// The accounts definition for [`push_to_token_map`](crate::gmsol_store::push_to_token_map).
#[derive(Accounts)]
pub struct PushToTokenMap<'info> {
    /// The authority of the instruction.
    #[account(mut)]
    pub authority: Signer<'info>,
    /// The store that owns the token map.
    pub store: AccountLoader<'info, Store>,
    /// The token map to push config to.
    #[account(
        mut,
        has_one = store,
    )]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
    /// The token to push config for.
    pub token: Account<'info, Mint>,
    /// The system program.
    pub system_program: Program<'info, System>,
}

/// Push a new token config to the token map.
///
/// ## CHECK
/// - Only [`MARKET_KEEPER`](crate::states::RoleKey::MARKET_KEEPER) can perform this action.
pub(crate) fn unchecked_push_to_token_map(
    ctx: Context<PushToTokenMap>,
    name: &str,
    builder: UpdateTokenConfigParams,
    enable: bool,
    new: bool,
) -> Result<()> {
    let token = ctx.accounts.token.key();
    let token_decimals = ctx.accounts.token.decimals;
    do_push_token_map(
        ctx.accounts.authority.to_account_info(),
        &ctx.accounts.token_map,
        ctx.accounts.system_program.to_account_info(),
        false,
        name,
        &token,
        token_decimals,
        builder,
        enable,
        new,
    )
}

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

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

/// The accounts definition for
/// [`push_to_token_map_synthetic`](crate::gmsol_store::push_to_token_map_synthetic).
///
/// [*See also the documentation for the instruction.*](crate::gmsol_store::push_to_token_map_synthetic)
#[derive(Accounts)]
pub struct PushToTokenMapSynthetic<'info> {
    /// The authority of the instruction.
    #[account(mut)]
    pub authority: Signer<'info>,
    /// The store that owns the token map.
    pub store: AccountLoader<'info, Store>,
    /// The token map to push config to.
    #[account(mut, has_one = store)]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
    /// The system program.
    pub system_program: Program<'info, System>,
}

/// Push a new synthetic token config to the token map.
///
/// ## CHECK
/// - Only [`MARKET_KEEPER`](crate::states::RoleKey::MARKET_KEEPER) can perform this action.
pub(crate) fn unchecked_push_to_token_map_synthetic(
    ctx: Context<PushToTokenMapSynthetic>,
    name: &str,
    token: Pubkey,
    token_decimals: u8,
    builder: UpdateTokenConfigParams,
    enable: bool,
    new: bool,
) -> Result<()> {
    do_push_token_map(
        ctx.accounts.authority.to_account_info(),
        &ctx.accounts.token_map,
        ctx.accounts.system_program.to_account_info(),
        true,
        name,
        &token,
        token_decimals,
        builder,
        enable,
        new,
    )
}

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

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

/// The accounts definition for [`toggle_token_config`](crate::gmsol_store::toggle_token_config).
///
/// [*See also the documentation for the instruction.*](crate::gmsol_store::toggle_token_config)
#[derive(Accounts)]
pub struct ToggleTokenConfig<'info> {
    /// The authority of the instruction.
    pub authority: Signer<'info>,
    /// The store that owns the token map.
    pub store: AccountLoader<'info, Store>,
    /// The token map to update.
    #[account(
        mut,
        has_one = store,
    )]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
}

/// Toggle the config for the given token.
///
/// ## CHECK
/// - Only [`MARKET_KEEPER`](crate::states::RoleKey::MARKET_KEEPER) can perform this action.
pub(crate) fn unchecked_toggle_token_config(
    ctx: Context<ToggleTokenConfig>,
    token: Pubkey,
    enable: bool,
) -> Result<()> {
    ctx.accounts
        .token_map
        .load_token_map_mut()?
        .get_mut(&token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .set_enabled(enable);
    Ok(())
}

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

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

/// The accounts definition for [`set_expected_provider`](crate::gmsol_store::set_expected_provider).
///
/// [*See also the documentation for the instruction.*](crate::gmsol_store::set_expected_provider)
#[derive(Accounts)]
pub struct SetExpectedProvider<'info> {
    /// The authority of the instruction.
    pub authority: Signer<'info>,
    /// The store that owns the token map.
    pub store: AccountLoader<'info, Store>,
    /// The token map to update.
    #[account(mut, has_one = store)]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
}

/// Set the expected provider for the given token.
///
/// ## CHECK
/// - Only [`MARKET_KEEPER`](crate::states::RoleKey::MARKET_KEEPER) can perform this action.
pub(crate) fn unchecked_set_expected_provider(
    ctx: Context<SetExpectedProvider>,
    token: Pubkey,
    provider: PriceProviderKind,
) -> Result<()> {
    let mut token_map = ctx.accounts.token_map.load_token_map_mut()?;

    let config = token_map
        .get_mut(&token)
        .ok_or_else(|| error!(CoreError::NotFound))?;

    require_neq!(
        config.expected_provider().map_err(CoreError::from)?,
        provider,
        CoreError::PreconditionsAreNotMet
    );

    config.set_expected_provider(provider);
    Ok(())
}

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

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

/// The accounts definition for [`set_feed_config`](crate::gmsol_store::set_feed_config).
///
/// [*See also the documentation for the instruction.*](crate::gmsol_store::set_feed_config)
#[derive(Accounts)]
pub struct SetFeedConfig<'info> {
    /// The authority of the instruction.
    pub authority: Signer<'info>,
    /// The store that owns the token map.
    pub store: AccountLoader<'info, Store>,
    /// The token map to update.
    #[account(mut, has_one = store)]
    pub token_map: AccountLoader<'info, TokenMapHeader>,
}

/// Set feed config for the given token.
///
/// ## CHECK
/// - Only [`MARKET_KEEPER`](crate::states::RoleKey::MARKET_KEEPER) can perform this action.
pub(crate) fn unchecked_set_feed_config(
    ctx: Context<SetFeedConfig>,
    token: Pubkey,
    provider: &PriceProviderKind,
    feed: Pubkey,
    timestamp_adjustment: u32,
) -> Result<()> {
    ctx.accounts
        .token_map
        .load_token_map_mut()?
        .get_mut(&token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .set_feed_config(
            provider,
            FeedConfig::new(feed).with_timestamp_adjustment(timestamp_adjustment),
        )
        .map_err(CoreError::from)
        .map_err(|err| error!(err))
}

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

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

/// The accounts definition of the instructions to read token map.
#[derive(Accounts)]
pub struct ReadTokenMap<'info> {
    /// Token map.
    pub token_map: AccountLoader<'info, TokenMapHeader>,
}

/// Check if the config of the given token is enabled.
pub(crate) fn is_token_config_enabled(ctx: Context<ReadTokenMap>, token: &Pubkey) -> Result<bool> {
    ctx.accounts
        .token_map
        .load_token_map()?
        .get(token)
        .map(|config| config.is_enabled())
        .ok_or_else(|| error!(CoreError::NotFound))
}

/// Get expected provider for the given token.
pub(crate) fn token_expected_provider(
    ctx: Context<ReadTokenMap>,
    token: &Pubkey,
) -> Result<PriceProviderKind> {
    ctx.accounts
        .token_map
        .load_token_map()?
        .get(token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .expected_provider()
        .map_err(CoreError::from)
        .map_err(|err| error!(err))
}

/// Get feed address of the price provider of the given token.
pub(crate) fn token_feed(
    ctx: Context<ReadTokenMap>,
    token: &Pubkey,
    provider: &PriceProviderKind,
) -> Result<Pubkey> {
    ctx.accounts
        .token_map
        .load_token_map()?
        .get(token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .get_feed(provider)
        .map_err(CoreError::from)
        .map_err(|err| error!(err))
}

/// Get timestamp adjustemnt of the given token.
pub(crate) fn token_timestamp_adjustment(
    ctx: Context<ReadTokenMap>,
    token: &Pubkey,
    provider: &PriceProviderKind,
) -> Result<u32> {
    ctx.accounts
        .token_map
        .load_token_map()?
        .get(token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .timestamp_adjustment(provider)
        .map_err(CoreError::from)
        .map_err(|err| error!(err))
}

/// Get the name of the given token.
pub(crate) fn token_name(ctx: Context<ReadTokenMap>, token: &Pubkey) -> Result<String> {
    ctx.accounts
        .token_map
        .load_token_map()?
        .get(token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .name()
        .map(|s| s.to_owned())
        .map_err(CoreError::from)
        .map_err(|err| error!(err))
}

/// Get the decimals of the given token.
pub(crate) fn token_decimals(ctx: Context<ReadTokenMap>, token: &Pubkey) -> Result<u8> {
    Ok(ctx
        .accounts
        .token_map
        .load_token_map()?
        .get(token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .token_decimals())
}

/// Get the price precision of the given token.
pub(crate) fn token_precision(ctx: Context<ReadTokenMap>, token: &Pubkey) -> Result<u8> {
    Ok(ctx
        .accounts
        .token_map
        .load_token_map()?
        .get(token)
        .ok_or_else(|| error!(CoreError::NotFound))?
        .precision())
}

#[allow(clippy::too_many_arguments)]
fn do_push_token_map<'info>(
    authority: AccountInfo<'info>,
    token_map_loader: &AccountLoader<'info, TokenMapHeader>,
    system_program: AccountInfo<'info>,
    synthetic: bool,
    name: &str,
    token: &Pubkey,
    token_decimals: u8,
    builder: UpdateTokenConfigParams,
    enable: bool,
    new: bool,
) -> Result<()> {
    // Note: We have to do the realloc manually because the current implementation of
    // the `realloc` constraint group will throw an error on the following statement:
    // `realloc = 8 + token_map.load()?.space_after_push()?`.
    // The cause of the error is that the generated code directly inserts the above statement
    // into the realloc method, leading to an `already borrowed` error.
    {
        let new_space = 8 + token_map_loader.load()?.space_after_push()?;
        let current_space = token_map_loader.as_ref().data_len();
        let current_lamports = token_map_loader.as_ref().lamports();
        let new_rent_minimum = Rent::get()?.minimum_balance(new_space);
        // Only realloc when we need more space.
        if new_space > current_space {
            if current_lamports < new_rent_minimum {
                anchor_lang::system_program::transfer(
                    CpiContext::new(
                        system_program,
                        anchor_lang::system_program::Transfer {
                            from: authority,
                            to: token_map_loader.to_account_info(),
                        },
                    ),
                    new_rent_minimum.saturating_sub(current_lamports),
                )?;
            }
            token_map_loader.as_ref().realloc(new_space, false)?;
        }
    }

    let mut token_map = token_map_loader.load_token_map_mut()?;
    token_map.push_with(
        token,
        |config| config.update(name, synthetic, token_decimals, builder, enable, new),
        new,
    )?;
    Ok(())
}