Kamino Farms decoder

carbon-kamino-farms-decoder decodes the instructions and accounts of the Kamino Farms program (FarmsPZpWu9i7Kky8tPN37rs2TpmMrAZrC7S7vJa91Hr): 26 instructions, 4 account types. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

More program decoders without a category: Jupiter DCA, Pump Fees, Raydium Liquidity Locking, Swig. To decode several in one pipeline, see other program 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 Farms transactions from the public RPC and prints every decoded AddRewards instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-kamino-farms-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_farms_decoder::{
        instructions::KaminoFarmsInstruction, KaminoFarmsDecoder, 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(KaminoFarmsDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each AddRewards instruction prints one line with the transaction signature and the decoded AddRewards 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 GlobalConfig 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_farms_decoder::{accounts::KaminoFarmsAccount, KaminoFarmsDecoder, 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(KaminoFarmsDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

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

RUST_LOG=info cargo run

Each update to a GlobalConfig 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 KaminoFarmsInstruction. Each is KaminoFarmsInstruction::<Variant> { program_id, data, accounts }, where data and accounts are the types listed under the variant, exported from carbon_kamino_farms_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 FarmsPZpWu9i7Kky8tPN37rs2TpmMrAZrC7S7vJa91Hr.
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.

AddRewards#

Discriminator 58ba19e326895117 · data AddRewards · accounts AddRewardsInstructionAccounts.

Required accounts: 8; extras go to remaining.

Fields of AddRewardsInstructionAccounts, in account order:

DepositToFarmVault#

Discriminator 83a6405e6cd572b7 · data DepositToFarmVault · accounts DepositToFarmVaultInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of DepositToFarmVaultInstructionAccounts, in account order:

HarvestReward#

Discriminator 44c8e4e9b820e2bc · data HarvestReward · accounts HarvestRewardInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of HarvestRewardInstructionAccounts, in account order:

IdlMissingTypes#

Discriminator 8250269950d4b6fd · data IdlMissingTypes · accounts IdlMissingTypesInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of IdlMissingTypesInstructionAccounts, in account order:

InitializeFarm#

Discriminator fc1cb9acf44a75a5 · data InitializeFarm · accounts InitializeFarmInstructionAccounts.

No data fields.

Required accounts: 9; extras go to remaining.

Fields of InitializeFarmInstructionAccounts, in account order:

InitializeFarmDelegated#

Discriminator fa546519334dcc5b · data InitializeFarmDelegated · accounts InitializeFarmDelegatedInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of InitializeFarmDelegatedInstructionAccounts, in account order:

InitializeGlobalConfig#

Discriminator 71d87a83e1d11637 · data InitializeGlobalConfig · accounts InitializeGlobalConfigInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of InitializeGlobalConfigInstructionAccounts, in account order:

InitializeReward#

Discriminator 5f87c0c4f281e644 · data InitializeReward · accounts InitializeRewardInstructionAccounts.

No data fields.

Required accounts: 11; extras go to remaining.

Fields of InitializeRewardInstructionAccounts, in account order:

InitializeUser#

Discriminator 6f11b9fa3c7a26fe · data InitializeUser · accounts InitializeUserInstructionAccounts.

No data fields.

Required accounts: 8; extras go to remaining.

Fields of InitializeUserInstructionAccounts, in account order:

RefreshFarm#

Discriminator d6838ab790c2ac2a · data RefreshFarm · accounts RefreshFarmInstructionAccounts.

No data fields.

Required accounts: 1 (2 listed); extras go to remaining.

Fields of RefreshFarmInstructionAccounts, in account order:

RefreshUserState#

Discriminator 01870c3ef38c4d6c · data RefreshUserState · accounts RefreshUserStateInstructionAccounts.

No data fields.

Required accounts: 2 (3 listed); extras go to remaining.

Fields of RefreshUserStateInstructionAccounts, in account order:

RewardUserOnce#

Discriminator db8939165eba6072 · data RewardUserOnce · accounts RewardUserOnceInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of RewardUserOnceInstructionAccounts, in account order:

SetStakeDelegated#

Discriminator 49abb84b1e38c6df · data SetStakeDelegated · accounts SetStakeDelegatedInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetStakeDelegatedInstructionAccounts, in account order:

Stake#

Discriminator ceb0ca12c8d1b36c · data Stake · accounts StakeInstructionAccounts.

Required accounts: 8; extras go to remaining.

Fields of StakeInstructionAccounts, in account order:

TransferOwnership#

Discriminator 41b1d749352d632f · data TransferOwnership · accounts TransferOwnershipInstructionAccounts.

No data fields.

Required accounts: 9; extras go to remaining.

Fields of TransferOwnershipInstructionAccounts, in account order:

Unstake#

Discriminator 5a5f6b2acd7c32e1 · data Unstake · accounts UnstakeInstructionAccounts.

Required accounts: 3 (4 listed); extras go to remaining.

Fields of UnstakeInstructionAccounts, in account order:

UpdateFarmAdmin#

Discriminator 142588137aef2482 · data UpdateFarmAdmin · accounts UpdateFarmAdminInstructionAccounts.

No data fields.

Required accounts: 2; extras go to remaining.

Fields of UpdateFarmAdminInstructionAccounts, in account order:

UpdateFarmConfig#

Discriminator d6b0bcf4cb3be6cf · data UpdateFarmConfig · accounts UpdateFarmConfigInstructionAccounts.

Required accounts: 2 (3 listed); extras go to remaining.

Fields of UpdateFarmConfigInstructionAccounts, in account order:

UpdateGlobalConfig#

Discriminator a45482bd6f3afac8 · data UpdateGlobalConfig · accounts UpdateGlobalConfigInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of UpdateGlobalConfigInstructionAccounts, in account order:

UpdateGlobalConfigAdmin#

Discriminator b85717c19ceeaf77 · data UpdateGlobalConfigAdmin · accounts UpdateGlobalConfigAdminInstructionAccounts.

No data fields.

Required accounts: 2; extras go to remaining.

Fields of UpdateGlobalConfigAdminInstructionAccounts, in account order:

UpdateSecondDelegatedAuthority#

Discriminator 7f1a06b5cbf87540 · data UpdateSecondDelegatedAuthority · accounts UpdateSecondDelegatedAuthorityInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of UpdateSecondDelegatedAuthorityInstructionAccounts, in account order:

WithdrawFromFarmVault#

Discriminator 165280fa564f7c4e · data WithdrawFromFarmVault · accounts WithdrawFromFarmVaultInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of WithdrawFromFarmVaultInstructionAccounts, in account order:

WithdrawReward#

Discriminator bfbbb0890919bbf4 · data WithdrawReward · accounts WithdrawRewardInstructionAccounts.

Required accounts: 8; extras go to remaining.

Fields of WithdrawRewardInstructionAccounts, in account order:

WithdrawSlashedAmount#

Discriminator cad9434aac168cd8 · data WithdrawSlashedAmount · accounts WithdrawSlashedAmountInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of WithdrawSlashedAmountInstructionAccounts, in account order:

WithdrawTreasury#

Discriminator 283f7a9e90d85360 · data WithdrawTreasury · accounts WithdrawTreasuryInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of WithdrawTreasuryInstructionAccounts, in account order:

WithdrawUnstakedDeposits#

Discriminator 2466bb31dc248443 · data WithdrawUnstakedDeposits · accounts WithdrawUnstakedDepositsInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of WithdrawUnstakedDepositsInstructionAccounts, in account order:

Accounts#

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

FarmState#

Discriminator c666d84a3f42a3be · accounts::farm_state::FarmState.

GlobalConfig#

Discriminator 95089ccaa0fcb0d9 · accounts::global_config::GlobalConfig.

OraclePrices#

Discriminator 598076dd0648b492 · accounts::oracle_prices::OraclePrices.

UserState#

Discriminator 48b155f94ca7ba7e · accounts::user_state::UserState.

Types#

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

DatedPrice#

Struct types::DatedPrice.

FarmConfigOption#

Enum types::FarmConfigOption.

GlobalConfigOption#

Enum types::GlobalConfigOption.

LockingMode#

Enum types::LockingMode.

Price#

Struct types::Price.

RewardInfo#

Struct types::RewardInfo.

RewardPerTimeUnitPoint#

Struct types::RewardPerTimeUnitPoint.

RewardScheduleCurve#

Struct types::RewardScheduleCurve.

RewardType#

Enum types::RewardType.

TimeUnit#

Enum types::TimeUnit.

TokenInfo#

Struct types::TokenInfo.