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
//! JS binding for [`Simulator`].

use std::{ops::Deref, sync::Arc};

use gmsol_model::price::Price;
use gmsol_programs::gmsol_store::types::{
    CreateDepositParams, CreateGlvDepositParams, CreateGlvWithdrawalParams, CreateShiftParams,
    CreateWithdrawalParams,
};
use solana_sdk::pubkey::Pubkey;
use tsify_next::Tsify;
use wasm_bindgen::prelude::*;

use crate::{
    glv::{GlvCalculator, GlvStatus},
    js::glv::JsGlvModel,
    market::Value,
    serde::StringPubkey,
    simulation::{order::UpdatePriceOptions, SimulationOptions, Simulator},
};

use crate::js::{
    market::JsMarketModel, position::JsPosition, virtual_inventory::JsVirtualInventoryModel,
};

use super::{
    deposit::{JsDepositSimulationOutput, SimulateDepositArgs},
    glv_deposit::{JsGlvDepositSimulationOutput, SimulateGlvDepositArgs},
    glv_withdrawal::{JsGlvWithdrawalSimulationOutput, SimulateGlvWithdrawalArgs},
    order::{JsOrderSimulationOutput, SimulateOrderArgs},
    shift::{JsShiftSimulationOutput, SimulateShiftArgs},
    withdrawal::{JsWithdrawalSimulationOutput, SimulateWithdrawalArgs},
};

/// A JS binding for [`Simulator`].
#[wasm_bindgen(js_name = Simulator)]
#[derive(Clone)]
pub struct JsSimulator {
    simulator: Simulator,
    disable_vis: bool,
}

impl From<Simulator> for JsSimulator {
    fn from(simulator: Simulator) -> Self {
        Self {
            simulator,
            disable_vis: false,
        }
    }
}

impl Deref for JsSimulator {
    type Target = Simulator;

    fn deref(&self) -> &Self::Target {
        &self.simulator
    }
}

/// Arguments for GLV status calculations.
#[derive(Debug, serde::Serialize, serde::Deserialize, Tsify)]
#[tsify(into_wasm_abi, from_wasm_abi)]
pub struct GetGlvStatusArgs {
    glv_token: StringPubkey,
}

/// Arguments for GLV status calculations.
#[derive(Debug, serde::Serialize, serde::Deserialize, Tsify)]
#[tsify(into_wasm_abi, from_wasm_abi)]
pub struct GetGlvTokenValueArgs {
    glv_token: StringPubkey,
    amount: u128,
    maximize: bool,
}

#[wasm_bindgen(js_class = Simulator)]
impl JsSimulator {
    /// Get market by its market token.
    pub fn get_market(&self, market_token: &str) -> crate::Result<Option<JsMarketModel>> {
        Ok(self
            .simulator
            .get_market(&market_token.parse()?)
            .map(|market| market.clone().into()))
    }

    /// Get price for the given token.
    pub fn get_price(&self, token: &str) -> crate::Result<Option<Value>> {
        Ok(self.simulator.get_price(&token.parse()?).map(|p| Value {
            min: p.min,
            max: p.max,
        }))
    }

    /// Get GLV by its GLV token.
    pub fn get_glv(&self, glv_token: &str) -> crate::Result<Option<JsGlvModel>> {
        Ok(self
            .simulator
            .get_glv(&glv_token.parse()?)
            .map(|glv| glv.clone().into()))
    }

    /// Upsert the prices for the given token.
    pub fn insert_price(&mut self, token: &str, price: Value) -> crate::Result<()> {
        let token = token.parse()?;
        let price = Arc::new(Price {
            min: price.min,
            max: price.max,
        });
        self.simulator.insert_price(&token, price)?;
        Ok(())
    }

    /// Upsert a GLV model.
    pub fn insert_glv(&mut self, glv: &JsGlvModel) -> crate::Result<()> {
        self.simulator.insert_glv(glv.model.clone());
        Ok(())
    }

    /// Insert a virtual inventory model.
    pub fn insert_vi(
        &mut self,
        vi_address: &str,
        vi: &JsVirtualInventoryModel,
    ) -> crate::Result<()> {
        let vi_address = vi_address.parse()?;
        self.simulator.insert_vi(vi_address, vi.model.clone());
        Ok(())
    }

    /// Get virtual inventory model by address.
    pub fn get_vi(&self, vi_address: &str) -> crate::Result<Option<JsVirtualInventoryModel>> {
        let vi_address = vi_address.parse()?;
        Ok(self
            .simulator
            .get_vi(&vi_address)
            .map(|vi| vi.clone().into()))
    }

    /// Set whether to disable virtual inventories for simulations.
    pub fn set_disable_vis(&mut self, disable: bool) {
        self.disable_vis = disable;
    }

    /// Get whether virtual inventories are disabled.
    pub fn disable_vis(&self) -> bool {
        self.disable_vis
    }

    /// Simulate an order execution.
    pub fn simulate_order(
        &mut self,
        args: SimulateOrderArgs,
        position: Option<JsPosition>,
    ) -> crate::Result<JsOrderSimulationOutput> {
        let SimulateOrderArgs {
            kind,
            params,
            collateral_or_swap_out_token,
            pay_token,
            receive_token,
            swap_path,
            prefer_swap_out_token_update,
            skip_limit_price_validation,
            limit_swap_slippage,
            update_prices_for_limit_order,
        } = args;
        let swap_path = convert_swap_path(swap_path.as_deref());
        let mut simulation = self
            .simulator
            .simulate_order(kind, &params, &collateral_or_swap_out_token)
            .pay_token(pay_token.as_deref())
            .receive_token(receive_token.as_deref())
            .position(position.as_ref().map(|p| &p.position))
            .swap_path(&swap_path)
            .build();

        if update_prices_for_limit_order.unwrap_or_default() {
            simulation = simulation.update_prices(UpdatePriceOptions {
                prefer_swap_in_token_update: !prefer_swap_out_token_update.unwrap_or_default(),
                limit_swap_slippage,
            })?;
        }

        let output = simulation.execute_with_options(SimulationOptions {
            skip_limit_price_validation: skip_limit_price_validation.unwrap_or_default(),
            disable_vis: self.disable_vis,
        })?;
        Ok(JsOrderSimulationOutput { output })
    }

    /// Simulate a deposit execution.
    pub fn simulate_deposit(
        &mut self,
        args: SimulateDepositArgs,
    ) -> crate::Result<JsDepositSimulationOutput> {
        let SimulateDepositArgs { params } = args;

        let long_swap_path = convert_swap_path(params.long_swap_path.as_deref());
        let short_swap_path = convert_swap_path(params.short_swap_path.as_deref());
        let market_token = &params.market_token;
        let long_pay_token = &params.long_pay_token;
        let short_pay_token = &params.short_pay_token;
        let params = CreateDepositParams {
            execution_lamports: 0,
            long_token_swap_length: long_swap_path.len().try_into()?,
            short_token_swap_length: short_swap_path.len().try_into()?,
            initial_long_token_amount: params.long_pay_amount.unwrap_or_default().try_into()?,
            initial_short_token_amount: params.short_pay_amount.unwrap_or_default().try_into()?,
            min_market_token_amount: params.min_receive_amount.unwrap_or_default().try_into()?,
            should_unwrap_native_token: !params.skip_unwrap_native_on_receive.unwrap_or_default(),
        };

        let output = self
            .simulator
            .simulate_deposit(market_token, &params)
            .long_pay_token(long_pay_token.as_deref())
            .long_swap_path(&long_swap_path)
            .short_pay_token(short_pay_token.as_deref())
            .short_swap_path(&short_swap_path)
            .build()
            .execute_with_options(SimulationOptions {
                skip_limit_price_validation: false,
                disable_vis: self.disable_vis,
            })?;

        Ok(JsDepositSimulationOutput { output })
    }

    /// Simulate a withdrawal execution.
    pub fn simulate_withdrawal(
        &mut self,
        args: SimulateWithdrawalArgs,
    ) -> crate::Result<JsWithdrawalSimulationOutput> {
        let SimulateWithdrawalArgs { params } = args;

        let long_swap_path = convert_swap_path(params.long_swap_path.as_deref());
        let short_swap_path = convert_swap_path(params.short_swap_path.as_deref());
        let market_token = &params.market_token;
        let long_receive_token = &params.long_receive_token;
        let short_receive_token = &params.short_receive_token;
        let params = CreateWithdrawalParams {
            execution_lamports: 0,
            long_token_swap_path_length: long_swap_path.len().try_into()?,
            short_token_swap_path_length: short_swap_path.len().try_into()?,
            market_token_amount: params.market_token_amount.unwrap_or_default().try_into()?,
            min_long_token_amount: params
                .min_long_receive_amount
                .unwrap_or_default()
                .try_into()?,
            min_short_token_amount: params
                .min_short_receive_amount
                .unwrap_or_default()
                .try_into()?,
            should_unwrap_native_token: !params.skip_unwrap_native_on_receive.unwrap_or_default(),
        };

        let output = self
            .simulator
            .simulate_withdrawal(market_token, &params)
            .long_receive_token(long_receive_token.as_deref())
            .long_swap_path(&long_swap_path)
            .short_receive_token(short_receive_token.as_deref())
            .short_swap_path(&short_swap_path)
            .build()
            .execute_with_options(SimulationOptions {
                skip_limit_price_validation: false,
                disable_vis: self.disable_vis,
            })?;

        Ok(JsWithdrawalSimulationOutput { output })
    }

    /// Simulate a shift execution.
    pub fn simulate_shift(
        &mut self,
        args: SimulateShiftArgs,
    ) -> crate::Result<JsShiftSimulationOutput> {
        let SimulateShiftArgs { params } = args;

        let from_market_token = &params.from_market_token;
        let to_market_token = &params.to_market_token;
        let params = CreateShiftParams {
            execution_lamports: 0,
            from_market_token_amount: params
                .from_market_token_amount
                .unwrap_or_default()
                .try_into()?,
            min_to_market_token_amount: params
                .min_to_market_token_amount
                .unwrap_or_default()
                .try_into()?,
        };

        let output = self
            .simulator
            .simulate_shift(from_market_token, to_market_token, &params)
            .build()
            .execute_with_options(SimulationOptions {
                skip_limit_price_validation: false,
                disable_vis: self.disable_vis,
            })?;

        Ok(JsShiftSimulationOutput { output })
    }

    /// Simulate a GLV deposit execution.
    pub fn simulate_glv_deposit(
        &mut self,
        args: SimulateGlvDepositArgs,
    ) -> crate::Result<JsGlvDepositSimulationOutput> {
        let SimulateGlvDepositArgs { params } = args;

        let long_swap_path = convert_swap_path(params.long_swap_path.as_deref());
        let short_swap_path = convert_swap_path(params.short_swap_path.as_deref());
        let glv_token = &params.glv_token;
        let market_token = &params.market_token;
        let long_pay_token = &params.long_pay_token;
        let short_pay_token = &params.short_pay_token;
        let params = CreateGlvDepositParams {
            execution_lamports: 0,
            long_token_swap_length: long_swap_path.len().try_into()?,
            short_token_swap_length: short_swap_path.len().try_into()?,
            initial_long_token_amount: params.long_pay_amount.unwrap_or_default().try_into()?,
            initial_short_token_amount: params.short_pay_amount.unwrap_or_default().try_into()?,
            market_token_amount: params.market_token_amount.unwrap_or_default().try_into()?,
            min_market_token_amount: params
                .min_market_token_amount
                .unwrap_or_default()
                .try_into()?,
            min_glv_token_amount: params.min_receive_amount.unwrap_or_default().try_into()?,
            should_unwrap_native_token: !params.skip_unwrap_native_on_receive.unwrap_or_default(),
        };

        let output = self
            .simulator
            .simulate_glv_deposit(glv_token, market_token, &params)
            .long_pay_token(long_pay_token.as_deref())
            .long_swap_path(&long_swap_path)
            .short_pay_token(short_pay_token.as_deref())
            .short_swap_path(&short_swap_path)
            .build()
            .execute_with_options(SimulationOptions {
                skip_limit_price_validation: false,
                disable_vis: self.disable_vis,
            })?;

        Ok(JsGlvDepositSimulationOutput { output })
    }

    /// Simulate a GLV withdrawal execution.
    pub fn simulate_glv_withdrawal(
        &mut self,
        args: SimulateGlvWithdrawalArgs,
    ) -> crate::Result<JsGlvWithdrawalSimulationOutput> {
        let SimulateGlvWithdrawalArgs { params } = args;

        let long_swap_path = convert_swap_path(params.long_swap_path.as_deref());
        let short_swap_path = convert_swap_path(params.short_swap_path.as_deref());
        let glv_token = &params.glv_token;
        let market_token = &params.market_token;
        let long_receive_token = &params.long_receive_token;
        let short_receive_token = &params.short_receive_token;
        let params = CreateGlvWithdrawalParams {
            execution_lamports: 0,
            long_token_swap_length: long_swap_path.len().try_into()?,
            short_token_swap_length: short_swap_path.len().try_into()?,
            glv_token_amount: params.glv_token_amount.unwrap_or_default().try_into()?,
            min_final_long_token_amount: params
                .min_long_receive_amount
                .unwrap_or_default()
                .try_into()?,
            min_final_short_token_amount: params
                .min_short_receive_amount
                .unwrap_or_default()
                .try_into()?,
            should_unwrap_native_token: !params.skip_unwrap_native_on_receive.unwrap_or_default(),
        };

        let output = self
            .simulator
            .simulate_glv_withdrawal(glv_token, market_token, &params)
            .long_receive_token(long_receive_token.as_deref())
            .long_swap_path(&long_swap_path)
            .short_receive_token(short_receive_token.as_deref())
            .short_swap_path(&short_swap_path)
            .build()
            .execute_with_options(SimulationOptions {
                skip_limit_price_validation: false,
                disable_vis: self.disable_vis,
            })?;

        Ok(JsGlvWithdrawalSimulationOutput { output })
    }

    /// Create a clone of this simulator.
    #[wasm_bindgen(js_name = clone)]
    pub fn js_clone(&self) -> Self {
        self.clone()
    }

    /// Calculates GLV status.
    pub fn get_glv_status(&self, args: GetGlvStatusArgs) -> crate::Result<GlvStatus> {
        self.simulator.get_glv_status(&args.glv_token)
    }

    /// Calculates GLV token value.
    pub fn get_glv_token_value(&self, args: GetGlvTokenValueArgs) -> crate::Result<u128> {
        self.simulator
            .get_glv_token_value(&args.glv_token, args.amount.try_into()?, args.maximize)
    }
}

fn convert_swap_path(swap_path: Option<&[StringPubkey]>) -> Vec<Pubkey> {
    swap_path
        .map(|path| path.iter().map(|p| **p).collect::<Vec<_>>())
        .unwrap_or_default()
}