gmsol-sdk 0.9.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
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
use anchor_spl::associated_token::{self, get_associated_token_address_with_program_id};
use gmsol_programs::gmsol_store::client::args;
use gmsol_programs::gmsol_store::types::CreateOrderParams as StoreCreateOrderParams;
use gmsol_programs::gmsol_store::{client::accounts, types::OrderKind};
use gmsol_solana_utils::client_traits::FromRpcClientWith;
use gmsol_solana_utils::ProgramExt;
use solana_sdk::system_program;
use solana_sdk::{instruction::AccountMeta, pubkey::Pubkey};
use typed_builder::TypedBuilder;

use crate::builders::callback::{Callback, CallbackParams};
use crate::builders::{
    utils::{generate_nonce, prepare_ata},
    NonceBytes, StoreProgram,
};
use crate::builders::{MarketTokenIxBuilder, PoolTokenHint, StoreProgramIxBuilder};
use crate::serde::StringPubkey;
use crate::{AtomicGroup, IntoAtomicGroup};

use super::{PreparePosition, MIN_EXECUTION_LAMPORTS_FOR_ORDER};

/// Create Order Kind.
#[cfg_attr(js, derive(tsify_next::Tsify))]
#[cfg_attr(js, tsify(from_wasm_abi))]
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, Copy)]
pub enum CreateOrderKind {
    /// Market Swap.
    MarketSwap,
    /// Market Increase.
    MarketIncrease,
    /// Market Decrease.
    MarketDecrease,
    /// Limit Swap.
    LimitSwap,
    /// Limit Increase.
    LimitIncrease,
    /// Limit Decrease.
    LimitDecrease,
    /// Stop-loss Decrease.
    StopLossDecrease,
}

impl From<CreateOrderKind> for OrderKind {
    fn from(kind: CreateOrderKind) -> Self {
        match kind {
            CreateOrderKind::MarketSwap => Self::MarketSwap,
            CreateOrderKind::MarketIncrease => Self::MarketIncrease,
            CreateOrderKind::MarketDecrease => Self::MarketDecrease,
            CreateOrderKind::LimitSwap => Self::LimitSwap,
            CreateOrderKind::LimitIncrease => Self::LimitIncrease,
            CreateOrderKind::LimitDecrease => Self::LimitDecrease,
            CreateOrderKind::StopLossDecrease => Self::StopLossDecrease,
        }
    }
}

impl CreateOrderKind {
    /// Returns whether the order kind is "swap".
    pub fn is_swap(&self) -> bool {
        matches!(self, Self::MarketSwap | Self::LimitSwap)
    }

    /// Returns whether the order kind is "increase".
    pub fn is_increase(&self) -> bool {
        matches!(self, Self::MarketIncrease | Self::LimitIncrease)
    }

    /// Returns whether the ordr kind is "decrease".
    pub fn is_decrease(&self) -> bool {
        matches!(
            self,
            Self::MarketDecrease | Self::LimitDecrease | Self::StopLossDecrease
        )
    }
}

/// Swap type for decreasing position.
#[cfg_attr(js, derive(tsify_next::Tsify))]
#[cfg_attr(js, tsify(from_wasm_abi))]
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, Copy)]
pub enum DecreasePositionSwapType {
    /// Do not swap.
    NoSwap,
    /// Swap PnL token to collateral token.
    PnlTokenToCollateralToken,
    /// Swap collateral token to PnL token.
    CollateralToPnlToken,
}

impl From<DecreasePositionSwapType>
    for gmsol_programs::gmsol_store::types::DecreasePositionSwapType
{
    fn from(ty: DecreasePositionSwapType) -> Self {
        match ty {
            DecreasePositionSwapType::NoSwap => Self::NoSwap,
            DecreasePositionSwapType::PnlTokenToCollateralToken => Self::PnlTokenToCollateralToken,
            DecreasePositionSwapType::CollateralToPnlToken => Self::CollateralToPnlToken,
        }
    }
}

impl From<DecreasePositionSwapType>
    for gmsol_model::action::decrease_position::DecreasePositionSwapType
{
    fn from(ty: DecreasePositionSwapType) -> Self {
        match ty {
            DecreasePositionSwapType::NoSwap => Self::NoSwap,
            DecreasePositionSwapType::PnlTokenToCollateralToken => Self::PnlTokenToCollateralToken,
            DecreasePositionSwapType::CollateralToPnlToken => Self::CollateralToPnlToken,
        }
    }
}

/// Parameters for creating an order.
#[cfg_attr(js, derive(tsify_next::Tsify))]
#[cfg_attr(js, tsify(from_wasm_abi))]
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, TypedBuilder)]
pub struct CreateOrderParams {
    /// The market token of the market in which the order will be created.
    #[builder(setter(into))]
    pub market_token: StringPubkey,
    /// Whether the order is for a long or short position.
    pub is_long: bool,
    /// Delta size in USD.
    pub size: u128,
    /// Delta amount of tokens:
    /// - For increase / swap orders, it is the amount of pay tokens.
    /// - For decrease orders, it is the amount of collateral tokens to withdraw.
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub amount: u128,
    /// Minimum amount or value of output tokens.
    ///
    /// - Minimum collateral amount for increase-position orders after swap.
    /// - Minimum swap-out amount for swap orders.
    /// - Minimum output value for decrease-position orders.
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub min_output: u128,
    /// Trigger price (in unit price).
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option))]
    pub trigger_price: Option<u128>,
    /// Acceptable price (in unit price).
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option))]
    pub acceptable_price: Option<u128>,
    /// Decrease Position Swap Type.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option))]
    pub decrease_position_swap_type: Option<DecreasePositionSwapType>,
    /// Timestamp from which the order becomes valid.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option))]
    pub valid_from_ts: Option<i64>,
}

/// Builder for the `create_order` instruction.
#[cfg_attr(js, derive(tsify_next::Tsify))]
#[cfg_attr(js, tsify(from_wasm_abi))]
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, TypedBuilder)]
pub struct CreateOrder {
    /// Program.
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub program: StoreProgram,
    /// Payer (a.k.a. owner).
    #[builder(setter(into))]
    pub payer: StringPubkey,
    /// Reciever.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option, into))]
    pub receiver: Option<StringPubkey>,
    /// Nonce for the order.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option, into))]
    pub nonce: Option<NonceBytes>,
    /// Execution fee paid to the keeper in lamports.
    #[cfg_attr(serde, serde(default = "default_execution_lamports"))]
    #[builder(default = MIN_EXECUTION_LAMPORTS_FOR_ORDER)]
    pub execution_lamports: u64,
    /// Order Kind.
    pub kind: CreateOrderKind,
    /// Collateral or swap out token.
    #[builder(setter(into))]
    pub collateral_or_swap_out_token: StringPubkey,
    /// Order Parameters.
    pub params: CreateOrderParams,
    /// Pay token.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(into))]
    pub pay_token: Option<StringPubkey>,
    /// Pay token account.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(into))]
    pub pay_token_account: Option<StringPubkey>,
    /// Receive token.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(into))]
    pub receive_token: Option<StringPubkey>,
    /// Swap path.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(into))]
    pub swap_path: Vec<StringPubkey>,
    /// Whether to unwrap the native token when receiving (e.g., convert WSOL to SOL).
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub unwrap_native_on_receive: bool,
    /// Callback.
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub callback: Option<Callback>,
    /// Whether to skip position account creation.
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub skip_position_creation: bool,
    /// Whether to force position account creation.
    #[cfg_attr(serde, serde(default))]
    #[builder(default)]
    pub force_position_creation: bool,
}

#[cfg(serde)]
fn default_execution_lamports() -> u64 {
    MIN_EXECUTION_LAMPORTS_FOR_ORDER
}

impl CreateOrder {
    fn is_collateral_or_swap_out_token_long(
        &self,
        hint: &CreateOrderHint,
    ) -> Result<bool, crate::SolanaUtilsError> {
        let token = &*self.collateral_or_swap_out_token;
        hint.is_collateral_long(token)
    }
}

/// Hint for [`CreateOrder`].
#[cfg_attr(js, derive(tsify_next::Tsify))]
#[cfg_attr(js, tsify(from_wasm_abi))]
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, TypedBuilder)]
pub struct CreateOrderHint {
    /// Long token.
    #[builder(setter(into))]
    pub long_token: StringPubkey,
    /// Short token.
    #[builder(setter(into))]
    pub short_token: StringPubkey,
}

impl CreateOrderHint {
    /// Returns whether the given token is long token or short token.
    /// # Errors
    /// - Returns Error if the given `collateral` is not one of the specified long or short tokens.
    pub fn is_collateral_long(&self, collateral: &Pubkey) -> Result<bool, crate::SolanaUtilsError> {
        PoolTokenHint {
            long_token: self.long_token,
            short_token: self.short_token,
        }
        .is_collateral_long(collateral)
    }
}

impl IntoAtomicGroup for CreateOrder {
    type Hint = CreateOrderHint;

    fn into_atomic_group(self, hint: &Self::Hint) -> Result<AtomicGroup, crate::SolanaUtilsError> {
        let owner = self.payer.0;

        let mut insts = AtomicGroup::new(&owner);

        let receiver = self.receiver.as_deref().copied().unwrap_or(owner);
        let nonce = self.nonce.unwrap_or_else(generate_nonce);
        let order = self.program.find_order_address(&owner, &nonce);
        let token_program_id = anchor_spl::token::ID;

        let collateral_or_swap_out_token = self.collateral_or_swap_out_token.0;
        let is_collateral_or_swap_out_token_long =
            self.is_collateral_or_swap_out_token_long(hint)?;

        let (pay_token, receive_token, long_token, short_token, is_position_order) = match self.kind
        {
            CreateOrderKind::MarketSwap | CreateOrderKind::LimitSwap => {
                if let Some(receive_token) = self.receive_token {
                    if receive_token.0 != collateral_or_swap_out_token {
                        return Err(crate::SolanaUtilsError::custom("invalid `receive_token`: it must be the same as `collateral_or_swap_out_token` for swap orders if provided"));
                    }
                }
                (
                    Some(
                        self.pay_token
                            .as_deref()
                            .copied()
                            .unwrap_or(collateral_or_swap_out_token),
                    ),
                    Some(collateral_or_swap_out_token),
                    None,
                    None,
                    false,
                )
            }
            CreateOrderKind::MarketIncrease | CreateOrderKind::LimitIncrease => (
                Some(
                    self.pay_token
                        .as_deref()
                        .copied()
                        .unwrap_or(collateral_or_swap_out_token),
                ),
                None,
                Some(hint.long_token.0),
                Some(hint.short_token.0),
                true,
            ),
            CreateOrderKind::MarketDecrease
            | CreateOrderKind::LimitDecrease
            | CreateOrderKind::StopLossDecrease => (
                None,
                Some(
                    self.receive_token
                        .as_deref()
                        .copied()
                        .unwrap_or(collateral_or_swap_out_token),
                ),
                Some(hint.long_token.0),
                Some(hint.short_token.0),
                true,
            ),
        };

        let pay_token_account = pay_token.as_ref().map(|token| {
            self.pay_token_account
                .as_deref()
                .copied()
                .unwrap_or_else(|| {
                    get_associated_token_address_with_program_id(&owner, token, &token_program_id)
                })
        });
        let (pay_token_escrow, prepare) =
            prepare_ata(&owner, &order, pay_token.as_ref(), &token_program_id).unzip();
        insts.extend(prepare);
        let (receive_token_escrow, prepare) =
            prepare_ata(&owner, &order, receive_token.as_ref(), &token_program_id).unzip();
        insts.extend(prepare);
        let (long_token_escrow, prepare) =
            prepare_ata(&owner, &order, long_token.as_ref(), &token_program_id).unzip();
        insts.extend(prepare);
        let (short_token_escrow, prepare) =
            prepare_ata(&owner, &order, short_token.as_ref(), &token_program_id).unzip();
        insts.extend(prepare);

        let market = self.program.find_market_address(&self.params.market_token);
        let user = self.program.find_user_address(&owner);
        let position = (is_position_order).then(|| {
            self.program.find_position_address(
                &owner,
                &self.params.market_token,
                &collateral_or_swap_out_token,
                self.params.is_long,
            )
        });
        let params = &self.params;
        let swap_markets = self
            .swap_path
            .iter()
            .map(|mint| AccountMeta {
                pubkey: self.program.find_market_address(mint),
                is_signer: false,
                is_writable: false,
            })
            .collect::<Vec<_>>();

        let params = StoreCreateOrderParams {
            kind: self.kind.into(),
            decrease_position_swap_type: params.decrease_position_swap_type.map(Into::into),
            execution_lamports: self.execution_lamports,
            swap_path_length: self.swap_path.len() as u8,
            initial_collateral_delta_amount: self
                .params
                .amount
                .try_into()
                .map_err(crate::SolanaUtilsError::custom)?,
            size_delta_value: self.params.size,
            is_long: self.params.is_long,
            is_collateral_long: is_collateral_or_swap_out_token_long,
            min_output: Some(self.params.min_output),
            trigger_price: self.params.trigger_price,
            acceptable_price: self.params.acceptable_price,
            should_unwrap_native_token: self.unwrap_native_on_receive,
            valid_from_ts: self.params.valid_from_ts,
        };

        if is_position_order && self.skip_position_creation && self.force_position_creation {
            return Err(crate::SolanaUtilsError::custom(
                "invalid parameters: `skip_position_creation` and `force_position_creation` are both set",
            ));
        }

        if (is_position_order && !self.skip_position_creation)
            && (self.kind.is_increase() || self.force_position_creation)
        {
            let prepare = PreparePosition::builder()
                .program(self.program.clone())
                .collateral_token(collateral_or_swap_out_token)
                .execution_lamports(self.execution_lamports)
                .kind(self.kind)
                .params(self.params.clone())
                .payer(self.payer)
                .should_unwrap_native_token(params.should_unwrap_native_token)
                .swap_path_length(params.swap_path_length)
                .build()
                .into_atomic_group(hint)?;
            insts.merge(prepare);
        }

        let CallbackParams {
            callback_version,
            callback_authority,
            callback_program,
            callback_shared_data_account,
            callback_partitioned_data_account,
        } = self.program.get_callback_params(self.callback.as_ref());

        let create = self
            .program
            .anchor_instruction(args::CreateOrderV2 {
                nonce: nonce.to_bytes(),
                params,
                callback_version,
            })
            .anchor_accounts(
                accounts::CreateOrderV2 {
                    owner,
                    receiver,
                    store: self.program.store.0,
                    market,
                    user,
                    order,
                    position,
                    initial_collateral_token: pay_token,
                    final_output_token: receive_token.unwrap_or(collateral_or_swap_out_token),
                    long_token,
                    short_token,
                    initial_collateral_token_escrow: pay_token_escrow,
                    final_output_token_escrow: receive_token_escrow,
                    long_token_escrow,
                    short_token_escrow,
                    initial_collateral_token_source: pay_token_account,
                    system_program: system_program::ID,
                    token_program: token_program_id,
                    associated_token_program: associated_token::ID,
                    event_authority: self.program.find_event_authority_address(),
                    program: self.program.id.0,
                    callback_authority,
                    callback_program,
                    callback_shared_data_account,
                    callback_partitioned_data_account,
                },
                true,
            )
            .anchor_accounts(swap_markets, false)
            .build();

        insts.add(create);

        Ok(insts)
    }
}

impl StoreProgramIxBuilder for CreateOrder {
    fn store_program(&self) -> &StoreProgram {
        &self.program
    }
}

impl MarketTokenIxBuilder for CreateOrder {
    fn market_token(&self) -> &Pubkey {
        &self.params.market_token
    }
}

impl FromRpcClientWith<CreateOrder> for CreateOrderHint {
    async fn from_rpc_client_with<'a>(
        builder: &'a CreateOrder,
        client: &'a impl gmsol_solana_utils::client_traits::RpcClient,
    ) -> gmsol_solana_utils::Result<Self> {
        let hint = PoolTokenHint::from_rpc_client_with(builder, client).await?;
        Ok(Self {
            long_token: hint.long_token,
            short_token: hint.short_token,
        })
    }
}

#[cfg(test)]
mod tests {

    #[cfg(not(target_arch = "wasm32"))]
    use tokio::test as async_test;

    #[cfg(target_arch = "wasm32")]
    use wasm_bindgen_test::wasm_bindgen_test as async_test;

    use gmsol_solana_utils::{
        client_traits::GenericRpcClient, cluster::Cluster, transaction_builder::default_before_sign,
    };
    use solana_sdk::pubkey::Pubkey;

    use super::*;

    #[test]
    fn create_order() -> crate::Result<()> {
        let long_token = Pubkey::new_unique();
        let short_token = Pubkey::new_unique();
        let params = CreateOrderParams::builder()
            .market_token(Pubkey::new_unique())
            .is_long(true)
            .size(1_000 * crate::constants::MARKET_USD_UNIT)
            .build();
        CreateOrder::builder()
            .payer(Pubkey::new_unique())
            .kind(CreateOrderKind::MarketIncrease)
            .collateral_or_swap_out_token(long_token)
            .params(params)
            .swap_path([Pubkey::new_unique().into()])
            .build()
            .into_atomic_group(
                &CreateOrderHint::builder()
                    .long_token(long_token)
                    .short_token(short_token)
                    .build(),
            )?
            .partially_signed_transaction_with_blockhash_and_options(
                Default::default(),
                Default::default(),
                None,
                default_before_sign,
            )?;
        Ok(())
    }

    #[async_test]
    async fn create_order_with_rpc() -> crate::Result<()> {
        let market_token: Pubkey = "5sdFW7wrKsxxYHMXoqDmNHkGyCWsbLEFb1x1gzBBm4Hx".parse()?;
        let wsol: Pubkey = "So11111111111111111111111111111111111111112".parse()?;

        let cluster = Cluster::Devnet;
        let client = GenericRpcClient::new(cluster.url());

        let params = CreateOrderParams::builder()
            .market_token(market_token)
            .is_long(true)
            .size(1_000 * crate::constants::MARKET_USD_UNIT)
            .build();
        CreateOrder::builder()
            .payer(Pubkey::new_unique())
            .kind(CreateOrderKind::MarketIncrease)
            .collateral_or_swap_out_token(wsol)
            .params(params)
            .swap_path([Pubkey::new_unique().into()])
            .build()
            .into_atomic_group_with_rpc_client(&client)
            .await?
            .partially_signed_transaction_with_blockhash_and_options(
                Default::default(),
                Default::default(),
                None,
                default_before_sign,
            )?;

        Ok(())
    }
}