litesvm 0.12.0

A fast and lightweight Solana VM simulator for testing solana programs
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

use {
    agave_feature_set::FeatureSet,
    litesvm::LiteSVM,
    solana_address::address,
    solana_keypair::Keypair,
    solana_message::{Instruction, Message},
    solana_native_token::LAMPORTS_PER_SOL,
    solana_program_runtime::{
        invoke_context::InvokeContext,
        solana_sbpf::{declare_builtin_function, memory_region::MemoryMapping},
    },
    solana_signer::Signer,
    solana_transaction::Transaction,
    std::path::PathBuf,
};

const CUS_TO_BURN: u64 = 1234;

declare_builtin_function!(
    /// A custom syscall to burn CUs.
    SyscallBurnCus,
    fn rust(
        invoke_context: &mut InvokeContext,
        to_burn: u64,
        _arg2: u64,
        _arg3: u64,
        _arg4: u64,
        _arg5: u64,
        _memory_mapping: &mut MemoryMapping,
    ) -> Result<u64, Box<dyn std::error::Error>> {
        assert_eq!(to_burn, CUS_TO_BURN);
        invoke_context.consume_checked(to_burn)?;
        Ok(0)
    }
);

fn read_custom_syscall_program() -> Vec<u8> {
    let mut so_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    so_path.push("test_programs/target/deploy/test_program_custom_syscall.so");
    std::fs::read(so_path).unwrap()
}

fn litesvm_ctor() -> LiteSVM {
    LiteSVM::default()
        .with_feature_set(FeatureSet::all_enabled())
        .with_builtins()
        .with_custom_syscall("sol_burn_cus", SyscallBurnCus::vm)
        .with_lamports(1_000_000u64.wrapping_mul(LAMPORTS_PER_SOL))
        .with_sysvars()
        .with_default_programs()
        .with_sigverify(true)
        .with_blockhash_check(true)
}

#[test]
pub fn test_custom_syscall() {
    let mut svm = litesvm_ctor();
    let payer_kp = Keypair::new();
    let payer_pk = payer_kp.pubkey();
    let program_id = address!("GtdambwDgHWrDJdVPBkEHGhCwokqgAoch162teUjJse2");
    svm.add_program(program_id, &read_custom_syscall_program())
        .unwrap();
    svm.airdrop(&payer_pk, 1000000000).unwrap();
    let blockhash = svm.latest_blockhash();
    let msg = Message::new_with_blockhash(
        &[Instruction {
            program_id,
            accounts: vec![],
            data: CUS_TO_BURN.to_le_bytes().to_vec(),
        }],
        Some(&payer_pk),
        &blockhash,
    );
    let tx = Transaction::new(&[payer_kp], msg, blockhash);
    let res = svm.send_transaction(tx);
    assert!(res.is_ok(), "custom syscall tx failed: {:?}", res.err());
}