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

use solana_instruction::Instruction;
use solana_pubkey::Pubkey;

use super::common::{derive_vault_pdas, refresh_remaining_accounts};
use super::info::VaultInfo;
use crate::instructions;
use crate::{KLEND_PROGRAM_ID, TOKEN_PROGRAM_ID};

/// Build a `deposit` instruction.
///
/// Transfers up to `max_amount` tokens from the user into the vault and
/// mints vault shares in return. PDAs and remaining accounts (reserve
/// refresh list) are derived automatically from [`VaultInfo`].
///
/// # Farms
///
/// If the vault has a share farm (`VaultState::vault_farm` is set), the shares
/// minted here are not automatically staked. To earn farm rewards the user
/// must stake them with a separate Kamino Farms instruction appended after
/// this one.
pub fn deposit(
    vault: &VaultInfo,
    user: Pubkey,
    user_token_ata: Pubkey,
    user_shares_ata: Pubkey,
    max_amount: u64,
) -> Instruction {
    let pdas = derive_vault_pdas(&vault.address);
    let remaining = refresh_remaining_accounts(vault);

    instructions::deposit::deposit(
        instructions::deposit::DepositAccounts {
            user,
            vault_state: vault.address,
            token_vault: pdas.token_vault,
            token_mint: vault.token_mint,
            base_vault_authority: pdas.base_vault_authority,
            shares_mint: pdas.shares_mint,
            user_token_ata,
            user_shares_ata,
            klend_program: KLEND_PROGRAM_ID,
            token_program: vault.token_program,
            shares_token_program: TOKEN_PROGRAM_ID,
        },
        max_amount,
        remaining,
    )
}

/// Build a `buy` instruction.
///
/// Same accounts and semantics as [`deposit`], but uses the `buy`
/// discriminator. The `max_amount` is interpreted as the maximum tokens
/// to spend. The farm note on [`deposit`] applies here too.
pub fn buy(
    vault: &VaultInfo,
    user: Pubkey,
    user_token_ata: Pubkey,
    user_shares_ata: Pubkey,
    max_amount: u64,
) -> Instruction {
    let pdas = derive_vault_pdas(&vault.address);
    let remaining = refresh_remaining_accounts(vault);

    instructions::deposit::buy(
        instructions::deposit::DepositAccounts {
            user,
            vault_state: vault.address,
            token_vault: pdas.token_vault,
            token_mint: vault.token_mint,
            base_vault_authority: pdas.base_vault_authority,
            shares_mint: pdas.shares_mint,
            user_token_ata,
            user_shares_ata,
            klend_program: KLEND_PROGRAM_ID,
            token_program: vault.token_program,
            shares_token_program: TOKEN_PROGRAM_ID,
        },
        max_amount,
        remaining,
    )
}