hopper-solana 0.1.0

Solana integration layer for Hopper. SPL Token/Mint zero-copy readers, Token-2022 screening, CPI guards, token account helpers.
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
//! Typed CPI wrappers for system, token, Token-2022, and ATA operations.
//!
//! Thin `#[inline]` functions over `hopper-system` and `hopper-token` with
//! semantically named arguments. Complement the low-level
//! `HopperCpi`/`HopperCpiBuf` builders for standard operations.

#[cfg(feature = "legacy-token-instructions")]
use hopper_runtime::error::ProgramError;
use hopper_runtime::instruction::{InstructionAccount, InstructionView, Signer};
use hopper_runtime::{AccountView, Address, ProgramResult};

use crate::constants::{ATA_PROGRAM_ID, TOKEN_2022_PROGRAM_ID};

// ────────────────────────────────────────────────────────────────────
// System Program
// ────────────────────────────────────────────────────────────────────

/// Create a new account owned by `owner` with `space` bytes.
#[inline]
pub fn create_account<'a>(
    payer: &'a AccountView,
    new_account: &'a AccountView,
    lamports: u64,
    space: u64,
    owner: &'a Address,
) -> ProgramResult {
    hopper_system::CreateAccount {
        from: payer,
        to: new_account,
        lamports,
        space,
        owner,
    }
    .invoke()
}

/// Create a new account with PDA signer seeds.
#[inline]
pub fn create_account_signed<'a>(
    payer: &'a AccountView,
    new_account: &'a AccountView,
    lamports: u64,
    space: u64,
    owner: &'a Address,
    signers: &[Signer],
) -> ProgramResult {
    hopper_system::CreateAccount {
        from: payer,
        to: new_account,
        lamports,
        space,
        owner,
    }
    .invoke_signed(signers)
}

/// Transfer lamports between accounts.
#[inline]
pub fn transfer_sol<'a>(
    from: &'a AccountView,
    to: &'a AccountView,
    lamports: u64,
) -> ProgramResult {
    hopper_system::Transfer { from, to, lamports }.invoke()
}

/// Transfer lamports with PDA signer seeds.
#[inline]
pub fn transfer_sol_signed<'a>(
    from: &'a AccountView,
    to: &'a AccountView,
    lamports: u64,
    signers: &[Signer],
) -> ProgramResult {
    hopper_system::Transfer { from, to, lamports }.invoke_signed(signers)
}

/// Assign account ownership to a new program.
#[inline]
pub fn assign<'a>(account: &'a AccountView, owner: &'a Address) -> ProgramResult {
    hopper_system::Assign { account, owner }.invoke()
}

/// Allocate space in an account (without changing owner).
#[inline]
pub fn allocate(account: &AccountView, space: u64) -> ProgramResult {
    hopper_system::Allocate { account, space }.invoke()
}

// ────────────────────────────────────────────────────────────────────
// SPL Token (via hopper-token)
// ────────────────────────────────────────────────────────────────────

/// Transfer SPL tokens between token accounts.
///
/// Prefer [`token_transfer_checked`] for the Token-2022-safe path
/// (adds mint + decimals validation at CPI time). This unchecked
/// variant remains available for pre-Token-2022 deployments.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_transfer_checked for Token-2022 safety (mint + decimals validation)"
)]
#[allow(deprecated)]
#[inline]
pub fn token_transfer<'a>(
    source: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    hopper_token::Transfer {
        from: source,
        to: destination,
        authority,
        amount,
    }
    .invoke()
}

/// Transfer SPL tokens between token accounts with mint + decimals
/// validation (Token-2022-safe).
///
/// The SPL token program rejects the CPI if the mint's stored
/// decimals disagree with the supplied value, which defends against
/// wrong-mint attacks where the caller passed a different mint than
/// the account expects.
#[inline]
pub fn token_transfer_checked<'a>(
    source: &'a AccountView,
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
) -> ProgramResult {
    hopper_token::TransferChecked {
        from: source,
        mint,
        to: destination,
        authority,
        amount,
        decimals,
    }
    .invoke()
}

/// `token_transfer_checked` with explicit PDA signer seeds.
#[inline]
pub fn token_transfer_checked_signed<'a>(
    source: &'a AccountView,
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::TransferChecked {
        from: source,
        mint,
        to: destination,
        authority,
        amount,
        decimals,
    }
    .invoke_signed(signers)
}

/// Transfer SPL tokens with PDA signer seeds.
///
/// Prefer [`token_transfer_checked_signed`] for Token-2022 safety.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_transfer_checked_signed for Token-2022 safety"
)]
#[allow(deprecated)]
#[inline]
pub fn token_transfer_signed<'a>(
    source: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::Transfer {
        from: source,
        to: destination,
        authority,
        amount,
    }
    .invoke_signed(signers)
}

/// Mint tokens to a destination token account.
///
/// Prefer [`token_mint_to_checked`] for Token-2022 safety.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_mint_to_checked for Token-2022 safety (mint + decimals validation)"
)]
#[allow(deprecated)]
#[inline]
pub fn token_mint_to<'a>(
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    hopper_token::MintTo {
        mint,
        account: destination,
        mint_authority: authority,
        amount,
    }
    .invoke()
}

/// Mint tokens with PDA signer seeds.
///
/// Prefer [`token_mint_to_checked_signed`] for Token-2022 safety.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_mint_to_checked_signed for Token-2022 safety"
)]
#[allow(deprecated)]
#[inline]
pub fn token_mint_to_signed<'a>(
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::MintTo {
        mint,
        account: destination,
        mint_authority: authority,
        amount,
    }
    .invoke_signed(signers)
}

/// Mint tokens with mint + decimals validation (Token-2022-safe).
#[inline]
pub fn token_mint_to_checked<'a>(
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
) -> ProgramResult {
    hopper_token::MintToChecked {
        mint,
        account: destination,
        mint_authority: authority,
        amount,
        decimals,
    }
    .invoke()
}

/// `token_mint_to_checked` with explicit PDA signer seeds.
#[inline]
pub fn token_mint_to_checked_signed<'a>(
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::MintToChecked {
        mint,
        account: destination,
        mint_authority: authority,
        amount,
        decimals,
    }
    .invoke_signed(signers)
}

/// Burn tokens from a token account.
///
/// Prefer [`token_burn_checked`] for Token-2022 safety.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_burn_checked for Token-2022 safety (mint + decimals validation)"
)]
#[allow(deprecated)]
#[inline]
pub fn token_burn<'a>(
    token_account: &'a AccountView,
    mint: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    hopper_token::Burn {
        account: token_account,
        mint,
        authority,
        amount,
    }
    .invoke()
}

/// Burn tokens with PDA signer seeds.
///
/// Prefer [`token_burn_checked_signed`] for Token-2022 safety.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_burn_checked_signed for Token-2022 safety"
)]
#[allow(deprecated)]
#[inline]
pub fn token_burn_signed<'a>(
    token_account: &'a AccountView,
    mint: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::Burn {
        account: token_account,
        mint,
        authority,
        amount,
    }
    .invoke_signed(signers)
}

/// Burn tokens with mint + decimals validation (Token-2022-safe).
#[inline]
pub fn token_burn_checked<'a>(
    token_account: &'a AccountView,
    mint: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
) -> ProgramResult {
    hopper_token::BurnChecked {
        account: token_account,
        mint,
        authority,
        amount,
        decimals,
    }
    .invoke()
}

/// `token_burn_checked` with explicit PDA signer seeds.
#[inline]
pub fn token_burn_checked_signed<'a>(
    token_account: &'a AccountView,
    mint: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::BurnChecked {
        account: token_account,
        mint,
        authority,
        amount,
        decimals,
    }
    .invoke_signed(signers)
}

/// Close a token account, returning remaining lamports to destination.
#[inline]
pub fn token_close_account<'a>(
    token_account: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
) -> ProgramResult {
    hopper_token::CloseAccount {
        account: token_account,
        destination,
        authority,
    }
    .invoke()
}

/// Close a token account with PDA signer seeds.
#[inline]
pub fn token_close_account_signed<'a>(
    token_account: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    signers: &[Signer],
) -> ProgramResult {
    hopper_token::CloseAccount {
        account: token_account,
        destination,
        authority,
    }
    .invoke_signed(signers)
}

/// Approve a delegate for a token account.
///
/// Prefer [`token_approve_checked`] for Token-2022 safety.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_approve_checked for Token-2022 safety (mint + decimals validation)"
)]
#[allow(deprecated)]
#[inline]
pub fn token_approve<'a>(
    token_account: &'a AccountView,
    delegate: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    hopper_token::Approve {
        source: token_account,
        delegate,
        authority,
        amount,
    }
    .invoke()
}

/// Approve a delegate with mint + decimals validation (Token-2022-safe).
#[inline]
pub fn token_approve_checked<'a>(
    token_account: &'a AccountView,
    mint: &'a AccountView,
    delegate: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    decimals: u8,
) -> ProgramResult {
    hopper_token::ApproveChecked {
        source: token_account,
        mint,
        delegate,
        authority,
        amount,
        decimals,
    }
    .invoke()
}

/// Revoke a delegate from a token account.
#[inline]
pub fn token_revoke<'a>(
    token_account: &'a AccountView,
    authority: &'a AccountView,
) -> ProgramResult {
    hopper_token::Revoke {
        source: token_account,
        authority,
    }
    .invoke()
}

// ────────────────────────────────────────────────────────────────────
// Checked Transfer (with mint verification)
// ────────────────────────────────────────────────────────────────────

/// Transfer SPL tokens with mint validation.
///
/// Reads both token accounts' mint fields and verifies they match
/// before performing the transfer. Catches mint mismatch bugs at
/// the CPI boundary.
///
/// Prefer [`token_transfer_checked`] (SPL's `TransferChecked` at CPI
/// level) over this host-side mint-match check. This function
/// remains for pre-Token-2022 deployments; new code should route
/// through the runtime-level checked variant.
#[cfg(feature = "legacy-token-instructions")]
#[deprecated(
    since = "0.2.0",
    note = "use token_transfer_checked (SPL TransferChecked CPI) for Token-2022 safety"
)]
#[allow(deprecated)]
#[inline]
pub fn checked_token_transfer<'a>(
    source: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    let source_data = source.try_borrow()?;
    let dest_data = destination.try_borrow()?;

    let source_mint = crate::token::token_account_mint(&source_data)?;
    let dest_mint = crate::token::token_account_mint(&dest_data)?;
    if source_mint != dest_mint {
        return Err(ProgramError::InvalidAccountData);
    }

    hopper_token::Transfer {
        from: source,
        to: destination,
        authority,
        amount,
    }
    .invoke()
}

// ────────────────────────────────────────────────────────────────────
// Token-2022 (via hopper-token-2022)
// ────────────────────────────────────────────────────────────────────

/// Transfer Token-2022 tokens between token accounts.
#[inline]
pub fn token_2022_transfer<'a>(
    source: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    token_2022_transfer_signed(source, destination, authority, amount, &[])
}

/// Transfer Token-2022 tokens with PDA signer seeds.
#[inline]
pub fn token_2022_transfer_signed<'a>(
    source: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    signers: &[Signer],
) -> ProgramResult {
    let mut data = [0u8; 9];
    data[0] = 3;
    data[1..9].copy_from_slice(&amount.to_le_bytes());

    let accounts = [
        InstructionAccount::writable(source.address()),
        InstructionAccount::writable(destination.address()),
        InstructionAccount::readonly_signer(authority.address()),
    ];
    let views = [source, destination, authority];
    let instruction = InstructionView {
        program_id: &TOKEN_2022_PROGRAM_ID,
        data: &data,
        accounts: &accounts,
    };

    hopper_runtime::cpi::invoke_signed(&instruction, &views, signers)
}

/// Mint Token-2022 tokens to a destination token account.
#[inline]
pub fn token_2022_mint_to<'a>(
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    token_2022_mint_to_signed(mint, destination, authority, amount, &[])
}

/// Mint Token-2022 tokens with PDA signer seeds.
#[inline]
pub fn token_2022_mint_to_signed<'a>(
    mint: &'a AccountView,
    destination: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
    signers: &[Signer],
) -> ProgramResult {
    let mut data = [0u8; 9];
    data[0] = 7;
    data[1..9].copy_from_slice(&amount.to_le_bytes());

    let accounts = [
        InstructionAccount::writable(mint.address()),
        InstructionAccount::writable(destination.address()),
        InstructionAccount::readonly_signer(authority.address()),
    ];
    let views = [mint, destination, authority];
    let instruction = InstructionView {
        program_id: &TOKEN_2022_PROGRAM_ID,
        data: &data,
        accounts: &accounts,
    };

    hopper_runtime::cpi::invoke_signed(&instruction, &views, signers)
}

/// Burn Token-2022 tokens from a token account.
#[inline]
pub fn token_2022_burn<'a>(
    token_account: &'a AccountView,
    mint: &'a AccountView,
    authority: &'a AccountView,
    amount: u64,
) -> ProgramResult {
    let mut data = [0u8; 9];
    data[0] = 8;
    data[1..9].copy_from_slice(&amount.to_le_bytes());

    let accounts = [
        InstructionAccount::writable(token_account.address()),
        InstructionAccount::writable(mint.address()),
        InstructionAccount::readonly_signer(authority.address()),
    ];
    let views = [token_account, mint, authority];
    let instruction = InstructionView {
        program_id: &TOKEN_2022_PROGRAM_ID,
        data: &data,
        accounts: &accounts,
    };

    hopper_runtime::cpi::invoke(&instruction, &views)
}

/// Create an associated token account.
#[inline]
pub fn ata_create<'a>(
    payer: &'a AccountView,
    associated_account: &'a AccountView,
    wallet: &'a AccountView,
    mint: &'a AccountView,
    system_program: &'a AccountView,
    token_program: &'a AccountView,
) -> ProgramResult {
    let data = [0u8];
    let accounts = [
        InstructionAccount::writable_signer(payer.address()),
        InstructionAccount::writable(associated_account.address()),
        InstructionAccount::readonly(wallet.address()),
        InstructionAccount::readonly(mint.address()),
        InstructionAccount::readonly(system_program.address()),
        InstructionAccount::readonly(token_program.address()),
    ];
    let views = [
        payer,
        associated_account,
        wallet,
        mint,
        system_program,
        token_program,
    ];
    let instruction = InstructionView {
        program_id: &ATA_PROGRAM_ID,
        data: &data,
        accounts: &accounts,
    };

    hopper_runtime::cpi::invoke(&instruction, &views)
}

/// Create an associated token account idempotently.
#[inline]
pub fn ata_create_idempotent<'a>(
    payer: &'a AccountView,
    associated_account: &'a AccountView,
    wallet: &'a AccountView,
    mint: &'a AccountView,
    system_program: &'a AccountView,
    token_program: &'a AccountView,
) -> ProgramResult {
    let data = [1u8];
    let accounts = [
        InstructionAccount::writable_signer(payer.address()),
        InstructionAccount::writable(associated_account.address()),
        InstructionAccount::readonly(wallet.address()),
        InstructionAccount::readonly(mint.address()),
        InstructionAccount::readonly(system_program.address()),
        InstructionAccount::readonly(token_program.address()),
    ];
    let views = [
        payer,
        associated_account,
        wallet,
        mint,
        system_program,
        token_program,
    ];
    let instruction = InstructionView {
        program_id: &ATA_PROGRAM_ID,
        data: &data,
        accounts: &accounts,
    };

    hopper_runtime::cpi::invoke(&instruction, &views)
}

/// Recover a nested associated token account.
#[inline]
pub fn ata_recover_nested<'a>(
    nested_associated_account: &'a AccountView,
    nested_token_mint: &'a AccountView,
    destination_associated_account: &'a AccountView,
    owner_associated_account: &'a AccountView,
    owner_token_mint: &'a AccountView,
    wallet: &'a AccountView,
    token_program: &'a AccountView,
) -> ProgramResult {
    let data = [2u8];
    let accounts = [
        InstructionAccount::writable(nested_associated_account.address()),
        InstructionAccount::readonly(nested_token_mint.address()),
        InstructionAccount::writable(destination_associated_account.address()),
        InstructionAccount::readonly(owner_associated_account.address()),
        InstructionAccount::readonly(owner_token_mint.address()),
        InstructionAccount::writable_signer(wallet.address()),
        InstructionAccount::readonly(token_program.address()),
    ];
    let views = [
        nested_associated_account,
        nested_token_mint,
        destination_associated_account,
        owner_associated_account,
        owner_token_mint,
        wallet,
        token_program,
    ];
    let instruction = InstructionView {
        program_id: &ATA_PROGRAM_ID,
        data: &data,
        accounts: &accounts,
    };

    hopper_runtime::cpi::invoke(&instruction, &views)
}