Kamino Vault decoder

carbon-kamino-vault-decoder decodes the instructions and accounts of the Kamino Vault program (kvauTFR8qm1dhniz6pYuBZkuene3Hfrs1VQhVRgCNrr): 12 instructions, 2 account types. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

Other lending decoders: Jupiter Lend, Kamino Lending, marginfi v2, Meteora Vault, Sharky. To decode several in one pipeline, see lending decoders.

The serde feature derives Serialize/Deserialize on every type, postgres adds tables and processors for Postgres, and graphql adds a schema for the GraphQL server.

Usage#

This program crawls recent Kamino Vault transactions from the public RPC and prints every decoded Deposit instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-kamino-vault-decoder@2.0.0 carbon-rpc-transaction-crawler-datasource@2.0.0 carbon-log-metrics@2.0.0 env_logger tokio --features tokio/full

use {
    carbon_core::{
        error::CarbonResult, instruction::InstructionProcessorInputType, pipeline::Pipeline,
        processor::Processor,
    },
    carbon_log_metrics::LogMetrics,
    carbon_kamino_vault_decoder::{
        instructions::KaminoVaultInstruction, KaminoVaultDecoder, PROGRAM_ID,
    },
    carbon_rpc_transaction_crawler_datasource::{ConnectionConfig, Filters, RpcTransactionCrawler},
    std::sync::Arc,
};

#[tokio::main]
async fn main() -> CarbonResult<()> {
    env_logger::init();

    // Fetches the program's recent transactions over JSON-RPC, newest first.
    let datasource = RpcTransactionCrawler::new(
        "https://api.mainnet-beta.solana.com".to_string(),
        PROGRAM_ID,
        ConnectionConfig::default(),
        Filters::new(None, None, None),
        None,
    );

    Pipeline::builder()
        .datasource(datasource)
        .metrics(Arc::new(LogMetrics::new()))
        .instruction(KaminoVaultDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

impl Processor<InstructionProcessorInputType<'_, KaminoVaultInstruction>> for InstructionLogger {
    async fn process(
        &mut self,
        input: &InstructionProcessorInputType<'_, KaminoVaultInstruction>,
    ) -> CarbonResult<()> {
        let signature = input.metadata.transaction_metadata.signature;
        if let KaminoVaultInstruction::Deposit { data, accounts, .. } = input.decoded_instruction {
            println!("deposit {signature}: {data:?} user={}", accounts.user);
        }
        Ok(())
    }
}

RUST_LOG=info cargo run

Each Deposit instruction prints one line with the transaction signature and the decoded Deposit data. The public endpoint rate-limits requests, so the first lines can take a while; use your own RPC URL for anything beyond a test. See stream with RPC for the crawler options.

Decode accounts#

The transaction crawler emits transactions only. To decode accounts, use a datasource that emits account updates. This program subscribes to the program's accounts with programSubscribe on the public WebSocket endpoint and prints every decoded Reserve account as it changes. Add the datasource and the Solana RPC types it takes:

cargo add carbon-rpc-program-subscribe-datasource@2.0.0 solana-client@4.2.2

use {
    carbon_core::{
        account::AccountProcessorInputType, error::CarbonResult, pipeline::Pipeline,
        processor::Processor,
    },
    carbon_log_metrics::LogMetrics,
    carbon_kamino_vault_decoder::{accounts::KaminoVaultAccount, KaminoVaultDecoder, PROGRAM_ID},
    carbon_rpc_program_subscribe_datasource::{Filters, RpcProgramSubscribe},
    solana_client::rpc_config::{RpcAccountInfoConfig, RpcProgramAccountsConfig, UiAccountEncoding},
    std::sync::Arc,
};

#[tokio::main]
async fn main() -> CarbonResult<()> {
    env_logger::init();

    // Streams every change to an account owned by the program (programSubscribe).
    let config = RpcProgramAccountsConfig {
        account_config: RpcAccountInfoConfig {
            encoding: Some(UiAccountEncoding::Base64),
            ..Default::default()
        },
        ..Default::default()
    };
    let datasource = RpcProgramSubscribe::new(
        "wss://api.mainnet-beta.solana.com".to_string(),
        Filters::new(PROGRAM_ID, Some(config)),
    );

    Pipeline::builder()
        .datasource(datasource)
        .metrics(Arc::new(LogMetrics::new()))
        .account(KaminoVaultDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

impl Processor<AccountProcessorInputType<'_, KaminoVaultAccount>> for AccountLogger {
    async fn process(
        &mut self,
        input: &AccountProcessorInputType<'_, KaminoVaultAccount>,
    ) -> CarbonResult<()> {
        if let KaminoVaultAccount::Reserve(reserve) = &input.decoded_account.data {
            println!("reserve {}: {reserve:?}", input.metadata.pubkey);
        }
        Ok(())
    }
}

RUST_LOG=info cargo run

Each update to a Reserve account prints its address and decoded fields; the program runs until you stop it. Cargo resolves solana-client to 4.2.2, the exact version the datasource pins, so both use the same RpcProgramAccountsConfig type. To load every existing account once instead of streaming changes, see load account state.

Instructions#

Variants of KaminoVaultInstruction. Each is KaminoVaultInstruction::<Variant> { program_id, data, accounts }, where data and accounts are the types listed under the variant, exported from carbon_kamino_vault_decoder::instructions. Discriminators are the leading bytes of the instruction data, in hex.

How an instruction decodes. The decoder returns a variant only when all of these hold; otherwise the instruction is skipped and no processor is called:

1. The instruction's program ID is kvauTFR8qm1dhniz6pYuBZkuene3Hfrs1VQhVRgCNrr.
2. The data starts with the variant's discriminator, and the rest deserializes into its data type.
3. The instruction has at least as many accounts as the variant requires (the "Required accounts" count under each variant).

Accounts. They are matched by position, in the order listed. An account marked optional is None only when the instruction ends before it; Anchor programs pass the program ID as a placeholder for an omitted optional account, so check for Some(PROGRAM_ID) too. Accounts after the listed ones are in accounts.remaining as AccountMetas. The decoder doesn't record whether an account signed or was writable: read that from input.raw_instruction.accounts[i].is_signer and .is_writable, which follow the same order. It doesn't check signer, writable, owner or PDA constraints either; the program enforced those when the transaction executed, so a decoded instruction from a successful transaction already satisfied them.

Deposit#

Discriminator f223c68952e1f2b6 · data Deposit · accounts DepositInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of DepositInstructionAccounts, in account order:

GiveUpPendingFees#

Discriminator b1c878866ed99351 · data GiveUpPendingFees · accounts GiveUpPendingFeesInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of GiveUpPendingFeesInstructionAccounts, in account order:

InitializeSharesMetadata#

Discriminator 030fac72c8008320 · data InitializeSharesMetadata · accounts InitializeSharesMetadataInstructionAccounts.

Required accounts: 8; extras go to remaining.

Fields of InitializeSharesMetadataInstructionAccounts, in account order:

InitVault#

Discriminator 4d4f559621d9346a · data InitVault · accounts InitVaultInstructionAccounts.

No data fields.

Required accounts: 11; extras go to remaining.

Fields of InitVaultInstructionAccounts, in account order:

Invest#

Discriminator 0df5b467feb67904 · data Invest · accounts InvestInstructionAccounts.

No data fields.

Required accounts: 16; extras go to remaining.

Fields of InvestInstructionAccounts, in account order:

UpdateAdmin#

Discriminator a1b028d53cb8b3e4 · data UpdateAdmin · accounts UpdateAdminInstructionAccounts.

No data fields.

Required accounts: 2; extras go to remaining.

Fields of UpdateAdminInstructionAccounts, in account order:

UpdateReserveAllocation#

Discriminator 0536d5704be87525 · data UpdateReserveAllocation · accounts UpdateReserveAllocationInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of UpdateReserveAllocationInstructionAccounts, in account order:

UpdateSharesMetadata#

Discriminator 9b227aa5f589936b · data UpdateSharesMetadata · accounts UpdateSharesMetadataInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of UpdateSharesMetadataInstructionAccounts, in account order:

UpdateVaultConfig#

Discriminator 7a0315de9effee9d · data UpdateVaultConfig · accounts UpdateVaultConfigInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of UpdateVaultConfigInstructionAccounts, in account order:

Withdraw#

Discriminator b712469c946da122 · data Withdraw · accounts WithdrawInstructionAccounts.

Required accounts: 19; extras go to remaining.

Fields of WithdrawInstructionAccounts, in account order:

WithdrawFromAvailable#

Discriminator 1383709baadc2239 · data WithdrawFromAvailable · accounts WithdrawFromAvailableInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of WithdrawFromAvailableInstructionAccounts, in account order:

WithdrawPendingFees#

Discriminator 83c2c88caff4d9b7 · data WithdrawPendingFees · accounts WithdrawPendingFeesInstructionAccounts.

No data fields.

Required accounts: 16; extras go to remaining.

Fields of WithdrawPendingFeesInstructionAccounts, in account order:

Accounts#

Variants of KaminoVaultAccount. Each wraps a boxed struct from carbon_kamino_vault_decoder::accounts::<module>. decode_account only considers accounts owned by PROGRAM_ID and returns the first variant that matches.

Reserve#

Discriminator 2bf2ccca1af73b7f · accounts::reserve::Reserve.

VaultState#

Discriminator e4c452a562d2eb98 · accounts::vault_state::VaultState.

Types#

Types used by the instructions, accounts and events above, exported from carbon_kamino_vault_decoder::types.

BigFractionBytes#

Struct types::BigFractionBytes.

BorrowRateCurve#

Struct types::BorrowRateCurve.

CurvePoint#

Struct types::CurvePoint.

LastUpdate#

From the program's IDL:

Last update state

Struct types::LastUpdate.

PriceHeuristic#

Struct types::PriceHeuristic.

PythConfiguration#

Struct types::PythConfiguration.

ReserveCollateral#

From the program's IDL:

Reserve collateral

Struct types::ReserveCollateral.

ReserveConfig#

From the program's IDL:

Reserve configuration values

Struct types::ReserveConfig.

ReserveFees#

From the program's IDL:

Additional fee information on a reserve
These exist separately from interest accrual fees, and are specifically for the program owner and referral fee. The fees are paid out as a percentage of liquidity token amounts during repayments and liquidations.

Struct types::ReserveFees.

ReserveLiquidity#

From the program's IDL:

Reserve liquidity

Struct types::ReserveLiquidity.

ScopeConfiguration#

Struct types::ScopeConfiguration.

SwitchboardConfiguration#

Struct types::SwitchboardConfiguration.

TokenInfo#

Struct types::TokenInfo.

VaultAllocation#

Struct types::VaultAllocation.

VaultConfigField#

Enum types::VaultConfigField.

WithdrawalCaps#

From the program's IDL:

Reserve Withdrawal Caps State

Struct types::WithdrawalCaps.