spl-token-client 0.18.0

SPL-Token Rust Client
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

mod program_test;
use {
    program_test::{TestContext, TokenContext},
    solana_program_test::{
        tokio::{self, sync::Mutex},
        ProgramTestContext,
    },
    solana_sdk::{
        instruction::InstructionError,
        pubkey::Pubkey,
        signature::Signer,
        transaction::{Transaction, TransactionError},
        transport::TransportError,
    },
    solana_system_interface::instruction as system_instruction,
    spl_token_2022_interface::{
        error::TokenError,
        extension::{memo_transfer::MemoTransfer, BaseStateWithExtensions, ExtensionType},
    },
    spl_token_client::token::TokenError as TokenClientError,
    std::sync::Arc,
};

async fn test_memo_transfers(
    context: Arc<Mutex<ProgramTestContext>>,
    token_context: TokenContext,
    alice_account: Pubkey,
    bob_account: Pubkey,
) {
    let TokenContext {
        mint_authority,
        token,
        alice,
        bob,
        ..
    } = token_context;

    // mint tokens
    token
        .mint_to(
            &alice_account,
            &mint_authority.pubkey(),
            4242,
            &[&mint_authority],
        )
        .await
        .unwrap();

    // require memo transfers into bob_account
    token
        .enable_required_transfer_memos(&bob_account, &bob.pubkey(), &[&bob])
        .await
        .unwrap();

    let bob_state = token.get_account_info(&bob_account).await.unwrap();
    let extension = bob_state.get_extension::<MemoTransfer>().unwrap();
    assert!(bool::from(extension.require_incoming_transfer_memos));

    // attempt to transfer from alice to bob without memo
    let err = token
        .transfer(&alice_account, &bob_account, &alice.pubkey(), 10, &[&alice])
        .await
        .unwrap_err();
    assert_eq!(
        err,
        TokenClientError::Client(Box::new(TransportError::TransactionError(
            TransactionError::InstructionError(
                0,
                InstructionError::Custom(TokenError::NoMemo as u32)
            )
        )))
    );
    let bob_state = token.get_account_info(&bob_account).await.unwrap();
    assert_eq!(bob_state.base.amount, 0);

    // attempt to transfer from bob to bob without memo
    let err = token
        .transfer(&bob_account, &bob_account, &bob.pubkey(), 0, &[&bob])
        .await
        .unwrap_err();
    assert_eq!(
        err,
        TokenClientError::Client(Box::new(TransportError::TransactionError(
            TransactionError::InstructionError(
                0,
                InstructionError::Custom(TokenError::NoMemo as u32)
            )
        )))
    );
    let bob_state = token.get_account_info(&bob_account).await.unwrap();
    assert_eq!(bob_state.base.amount, 0);

    // attempt to transfer from alice to bob with misplaced memo, v1 and current
    let mut memo_ix = spl_memo_interface::instruction::build_memo(
        &spl_memo_interface::v3::id(),
        &[240, 159, 166, 150],
        &[],
    );
    for program_id in [spl_memo_interface::v3::id(), spl_memo_interface::v1::id()] {
        let ctx = context.lock().await;
        memo_ix.program_id = program_id;
        #[allow(deprecated)]
        let instructions = vec![
            memo_ix.clone(),
            system_instruction::transfer(&ctx.payer.pubkey(), &alice.pubkey(), 42),
            spl_token_2022_interface::instruction::transfer(
                &spl_token_2022_interface::id(),
                &alice_account,
                &bob_account,
                &alice.pubkey(),
                &[],
                10,
            )
            .unwrap(),
        ];
        let tx = Transaction::new_signed_with_payer(
            &instructions,
            Some(&ctx.payer.pubkey()),
            &[&ctx.payer, &alice],
            ctx.last_blockhash,
        );
        let err = ctx
            .banks_client
            .process_transaction(tx)
            .await
            .unwrap_err()
            .unwrap();
        drop(ctx);
        assert_eq!(
            err,
            TransactionError::InstructionError(
                2,
                InstructionError::Custom(TokenError::NoMemo as u32)
            )
        );
        let bob_state = token.get_account_info(&bob_account).await.unwrap();
        assert_eq!(bob_state.base.amount, 0);
    }

    // transfer with memo
    token
        .with_memo("🦖", vec![alice.pubkey()])
        .transfer(&alice_account, &bob_account, &alice.pubkey(), 10, &[&alice])
        .await
        .unwrap();
    let bob_state = token.get_account_info(&bob_account).await.unwrap();
    assert_eq!(bob_state.base.amount, 10);

    // transfer with memo v1
    let ctx = context.lock().await;
    memo_ix.program_id = spl_memo_interface::v1::id();
    #[allow(deprecated)]
    let instructions = vec![
        memo_ix,
        spl_token_2022_interface::instruction::transfer(
            &spl_token_2022_interface::id(),
            &alice_account,
            &bob_account,
            &alice.pubkey(),
            &[],
            11,
        )
        .unwrap(),
    ];
    let tx = Transaction::new_signed_with_payer(
        &instructions,
        Some(&ctx.payer.pubkey()),
        &[&ctx.payer, &alice],
        ctx.last_blockhash,
    );
    ctx.banks_client.process_transaction(tx).await.unwrap();
    drop(ctx);
    let bob_state = token.get_account_info(&bob_account).await.unwrap();
    assert_eq!(bob_state.base.amount, 21);

    // stop requiring memo transfers into bob_account
    token
        .disable_required_transfer_memos(&bob_account, &bob.pubkey(), &[&bob])
        .await
        .unwrap();

    // transfer from alice to bob without memo
    token
        .transfer(&alice_account, &bob_account, &alice.pubkey(), 12, &[&alice])
        .await
        .unwrap();
    let bob_state = token.get_account_info(&bob_account).await.unwrap();
    assert_eq!(bob_state.base.amount, 33);
}

#[tokio::test]
async fn require_memo_transfers_without_realloc() {
    let mut context = TestContext::new().await;
    context.init_token_with_mint(vec![]).await.unwrap();
    let token_context = context.token_context.unwrap();

    // create token accounts
    token_context
        .token
        .create_auxiliary_token_account(&token_context.alice, &token_context.alice.pubkey())
        .await
        .unwrap();
    let alice_account = token_context.alice.pubkey();
    token_context
        .token
        .create_auxiliary_token_account_with_extension_space(
            &token_context.bob,
            &token_context.bob.pubkey(),
            vec![ExtensionType::MemoTransfer],
        )
        .await
        .unwrap();
    let bob_account = token_context.bob.pubkey();

    test_memo_transfers(context.context, token_context, alice_account, bob_account).await;
}

#[tokio::test]
async fn require_memo_transfers_with_realloc() {
    let mut context = TestContext::new().await;
    context.init_token_with_mint(vec![]).await.unwrap();
    let token_context = context.token_context.unwrap();

    // create token accounts
    token_context
        .token
        .create_auxiliary_token_account(&token_context.alice, &token_context.alice.pubkey())
        .await
        .unwrap();
    let alice_account = token_context.alice.pubkey();
    token_context
        .token
        .create_auxiliary_token_account(&token_context.bob, &token_context.bob.pubkey())
        .await
        .unwrap();
    let bob_account = token_context.bob.pubkey();
    token_context
        .token
        .reallocate(
            &token_context.bob.pubkey(),
            &token_context.bob.pubkey(),
            &[ExtensionType::MemoTransfer],
            &[&token_context.bob],
        )
        .await
        .unwrap();

    test_memo_transfers(context.context, token_context, alice_account, bob_account).await;
}