kvault-interface 0.1.0

Instruction builders for Kamino Vault (kvault) — no anchor-lang dependency
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

use kvault_interface::discriminators::{
    compute_discriminator, identify_instruction, KvaultInstruction, BUY, DEPOSIT, INVEST,
    INVEST_WITH_MAX_AMOUNT, REDEEM_IN_KIND, SELL, WITHDRAW, WITHDRAW_FROM_AVAILABLE,
};
use kvault_interface::errors::KvaultError;
use kvault_interface::pda;
use kvault_interface::KVAULT_PROGRAM_ID;
use solana_sdk::pubkey::Pubkey;

// ---------------------------------------------------------------------------
// Discriminator tests
// ---------------------------------------------------------------------------

#[test]
fn discriminators_match_computed() {
    assert_eq!(compute_discriminator("deposit"), DEPOSIT);
    assert_eq!(compute_discriminator("buy"), BUY);
    assert_eq!(compute_discriminator("withdraw"), WITHDRAW);
    assert_eq!(compute_discriminator("sell"), SELL);
    assert_eq!(
        compute_discriminator("withdraw_from_available"),
        WITHDRAW_FROM_AVAILABLE
    );
    assert_eq!(compute_discriminator("invest"), INVEST);
    assert_eq!(
        compute_discriminator("invest_with_max_amount"),
        INVEST_WITH_MAX_AMOUNT
    );
    assert_eq!(compute_discriminator("redeem_in_kind"), REDEEM_IN_KIND);
}

#[test]
fn identify_instruction_roundtrips() {
    let cases = vec![
        (DEPOSIT, KvaultInstruction::Deposit),
        (BUY, KvaultInstruction::Buy),
        (WITHDRAW, KvaultInstruction::Withdraw),
        (SELL, KvaultInstruction::Sell),
        (
            WITHDRAW_FROM_AVAILABLE,
            KvaultInstruction::WithdrawFromAvailable,
        ),
        (INVEST, KvaultInstruction::Invest),
        (
            INVEST_WITH_MAX_AMOUNT,
            KvaultInstruction::InvestWithMaxAmount,
        ),
        (REDEEM_IN_KIND, KvaultInstruction::RedeemInKind),
    ];

    for (disc, expected) in cases {
        let mut data = disc.to_vec();
        data.extend_from_slice(&[0u8; 8]); // some trailing data
        assert_eq!(identify_instruction(&data), Some(expected));
    }
}

#[test]
fn identify_instruction_unknown() {
    assert_eq!(identify_instruction(&[0u8; 8]), None);
    assert_eq!(identify_instruction(&[0u8; 4]), None); // too short
    assert_eq!(identify_instruction(&[]), None);
}

// ---------------------------------------------------------------------------
// PDA tests
// ---------------------------------------------------------------------------

#[test]
fn pda_functions_are_deterministic() {
    let vault_state = Pubkey::new_unique();
    let reserve = Pubkey::new_unique();

    let (auth1, bump1) = pda::base_vault_authority(&KVAULT_PROGRAM_ID, &vault_state);
    let (auth2, bump2) = pda::base_vault_authority(&KVAULT_PROGRAM_ID, &vault_state);
    assert_eq!(auth1, auth2);
    assert_eq!(bump1, bump2);

    let (tv1, _) = pda::token_vault(&KVAULT_PROGRAM_ID, &vault_state);
    let (tv2, _) = pda::token_vault(&KVAULT_PROGRAM_ID, &vault_state);
    assert_eq!(tv1, tv2);

    let (sm1, _) = pda::shares_mint(&KVAULT_PROGRAM_ID, &vault_state);
    let (sm2, _) = pda::shares_mint(&KVAULT_PROGRAM_ID, &vault_state);
    assert_eq!(sm1, sm2);

    let (cv1, _) = pda::ctoken_vault(&KVAULT_PROGRAM_ID, &vault_state, &reserve);
    let (cv2, _) = pda::ctoken_vault(&KVAULT_PROGRAM_ID, &vault_state, &reserve);
    assert_eq!(cv1, cv2);

    let (gc1, _) = pda::global_config(&KVAULT_PROGRAM_ID);
    let (gc2, _) = pda::global_config(&KVAULT_PROGRAM_ID);
    assert_eq!(gc1, gc2);

    let (wr1, _) = pda::whitelisted_reserve(&KVAULT_PROGRAM_ID, &reserve);
    let (wr2, _) = pda::whitelisted_reserve(&KVAULT_PROGRAM_ID, &reserve);
    assert_eq!(wr1, wr2);

    let (ea1, _) = pda::event_authority(&KVAULT_PROGRAM_ID);
    let (ea2, _) = pda::event_authority(&KVAULT_PROGRAM_ID);
    assert_eq!(ea1, ea2);
}

#[test]
fn pda_different_inputs_different_outputs() {
    let vault1 = Pubkey::new_unique();
    let vault2 = Pubkey::new_unique();

    let (auth1, _) = pda::base_vault_authority(&KVAULT_PROGRAM_ID, &vault1);
    let (auth2, _) = pda::base_vault_authority(&KVAULT_PROGRAM_ID, &vault2);
    assert_ne!(auth1, auth2);
}

// ---------------------------------------------------------------------------
// Error tests
// ---------------------------------------------------------------------------

#[test]
fn error_code_roundtrip() {
    let errors = vec![
        KvaultError::DepositAmountsZero,
        KvaultError::MathOverflow,
        KvaultError::WithdrawAmountBelowMinimum,
        KvaultError::ReserveAlreadyExists,
        KvaultError::AdminAuthorityIncorrect,
        KvaultError::AUMDecreasedMoreThanExpected,
        KvaultError::MaxInvestAmountMustBeGreaterThanZero,
    ];

    for err in errors {
        let code = err.error_code();
        let roundtripped = KvaultError::from_error_code(code);
        assert_eq!(roundtripped, Some(err), "roundtrip failed for {err:?}");
    }
}

#[test]
fn error_code_unknown() {
    assert_eq!(KvaultError::from_error_code(5000), None);
    assert_eq!(KvaultError::from_error_code(9999), None);
    assert_eq!(KvaultError::from_error_code(0), None);
}

#[test]
fn error_display_formatting() {
    let err = KvaultError::DepositAmountsZero;
    let s = format!("{err}");
    assert_eq!(s, "Cannot deposit zero tokens");
    assert_eq!(err.error_code(), 7000);
}