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

use std::collections::HashSet;

use anchor_spl::token::spl_token::native_mint;
use either::Either;
use solana_sdk::pubkey::Pubkey;
use typed_builder::TypedBuilder;

use crate::{serde::StringPubkey, AtomicGroup, IntoAtomicGroup};

use super::utils::prepare_ata;

/// Prepare token accounts for the owner.
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, TypedBuilder)]
pub struct PrepareTokenAccounts {
    /// Payer.
    #[builder(setter(into))]
    pub payer: StringPubkey,
    /// Owner.
    #[cfg_attr(serde, serde(default))]
    #[builder(default, setter(strip_option, into))]
    pub owner: Option<StringPubkey>,
    /// Tokens.
    #[builder(setter(into))]
    pub tokens: HashSet<StringPubkey>,
    /// Token Program ID.
    #[builder(default = StringPubkey(anchor_spl::token::ID), setter(into))]
    pub token_program: StringPubkey,
}

impl IntoAtomicGroup for PrepareTokenAccounts {
    type Hint = ();

    fn into_atomic_group(self, _hint: &Self::Hint) -> Result<AtomicGroup, crate::SolanaUtilsError> {
        let payer = self.payer.0;
        let owner = self.owner.as_deref().copied().unwrap_or(payer);
        let insts = self.tokens.iter().map(|token| {
            prepare_ata(&payer, &owner, Some(token), &self.token_program)
                .unwrap()
                .1
        });
        Ok(AtomicGroup::with_instructions(&payer, insts))
    }
}

/// Wraps the native token into its corresponding associated token account
#[cfg_attr(serde, derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, TypedBuilder)]
pub struct WrapNative {
    /// Owner.
    #[builder(setter(into))]
    pub owner: StringPubkey,
    /// Lamports.
    pub lamports: u64,
}

impl WrapNative {
    /// Native mint.
    pub const NATIVE_MINT: Pubkey = native_mint::ID;
}

/// Whether to skip the ATA preparation.
pub type SkipPreparation = bool;

impl IntoAtomicGroup for WrapNative {
    type Hint = SkipPreparation;

    fn into_atomic_group(
        self,
        skip_preparation: &Self::Hint,
    ) -> Result<AtomicGroup, crate::SolanaUtilsError> {
        use anchor_spl::token::{spl_token::instruction::sync_native, ID};
        use gmsol_programs::anchor_lang::solana_program::system_instruction::transfer;

        let owner = self.owner.0;
        let (ata, prepare) = prepare_ata(&owner, &owner, Some(&Self::NATIVE_MINT), &ID).unwrap();
        let transfer = transfer(&owner, &ata, self.lamports);
        let sync = sync_native(&ID, &ata).unwrap();

        Ok(AtomicGroup::with_instructions(
            &owner,
            if *skip_preparation {
                Either::Left([transfer, sync].into_iter())
            } else {
                Either::Right([prepare, transfer, sync].into_iter())
            },
        ))
    }
}

#[cfg(test)]
mod tests {
    use gmsol_solana_utils::transaction_builder::default_before_sign;
    use solana_sdk::pubkey::Pubkey;

    use super::*;

    #[test]
    fn prepare_token_accounts() {
        let tokens = [Pubkey::new_unique().into(), Pubkey::new_unique().into()];
        let insts = PrepareTokenAccounts::builder()
            .payer(Pubkey::new_unique())
            .tokens(tokens)
            .build()
            .into_atomic_group(&())
            .unwrap();
        assert_eq!(insts.len(), tokens.len());
        insts
            .partially_signed_transaction_with_blockhash_and_options(
                Default::default(),
                Default::default(),
                None,
                default_before_sign,
            )
            .unwrap();
    }

    #[test]
    fn wrap_native() {
        WrapNative::builder()
            .owner(Pubkey::new_unique())
            .lamports(1_000_000_000)
            .build()
            .into_atomic_group(&true)
            .unwrap()
            .partially_signed_transaction_with_blockhash_and_options(
                Default::default(),
                Default::default(),
                None,
                default_before_sign,
            )
            .unwrap();
    }
}