Kamino Limit Order decoder

carbon-kamino-limit-order-decoder decodes the instructions, accounts and events of the Kamino Limit Order program (LiMoM9rMhrdYrfzUCxQppvxCSG1FcrUK9G8uLq4A1GF): 15 instructions, 3 account types, 2 events. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

Other DEX and AMM decoders: BonkSwap, FluxBeam, Gavel, Heaven, Jupiter Limit Order, Jupiter Limit Order v2, Lifinity AMM v2, Meteora DAMM v2, Meteora DLMM, Meteora Pools, OpenBook v2, Orca Whirlpools, PancakeSwap, Phoenix v1, PumpSwap, Raydium AMM v4, Raydium CLMM, Raydium CPMM, Raydium Stable Swap, Stabble Stable Swap, Stabble Weighted Swap. To decode several in one pipeline, see dEX and AMM 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 Limit Order transactions from the public RPC and prints every decoded AssertUserSwapBalancesEnd instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-kamino-limit-order-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_limit_order_decoder::{
        instructions::KaminoLimitOrderInstruction, KaminoLimitOrderDecoder, 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(KaminoLimitOrderDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each AssertUserSwapBalancesEnd instruction prints one line with the transaction signature and the decoded AssertUserSwapBalancesEnd 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.

Events published with Anchor's emit_cpi! arrive as the CpiEvent instruction. Match them with KaminoLimitOrderInstruction::CpiEvent { data: CpiEvent::OrderDisplay(event), .. } (import instructions::CpiEvent); see Events. If CpiEvent never arrives, the program logs its events with emit! instead: decode them with decode_log_events.

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_limit_order_decoder::{
        accounts::KaminoLimitOrderAccount, KaminoLimitOrderDecoder, 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(KaminoLimitOrderDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

impl Processor<AccountProcessorInputType<'_, KaminoLimitOrderAccount>> for AccountLogger {
    async fn process(
        &mut self,
        input: &AccountProcessorInputType<'_, KaminoLimitOrderAccount>,
    ) -> CarbonResult<()> {
        if let KaminoLimitOrderAccount::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 KaminoLimitOrderInstruction. Each is KaminoLimitOrderInstruction::<Variant> { program_id, data, accounts }, where data and accounts are the types listed under the variant, exported from carbon_kamino_limit_order_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 LiMoM9rMhrdYrfzUCxQppvxCSG1FcrUK9G8uLq4A1GF.
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.

AssertUserSwapBalancesEnd#

Discriminator a39dae5d1c7ffa88 · data AssertUserSwapBalancesEnd · accounts AssertUserSwapBalancesEndInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of AssertUserSwapBalancesEndInstructionAccounts, in account order:

AssertUserSwapBalancesStart#

Discriminator 5ff1e2c1d6af8e8b · data AssertUserSwapBalancesStart · accounts AssertUserSwapBalancesStartInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of AssertUserSwapBalancesStartInstructionAccounts, in account order:

CloseOrderAndClaimTip#

Discriminator f41b0ce22df7e62b · data CloseOrderAndClaimTip · accounts CloseOrderAndClaimTipInstructionAccounts.

No data fields.

Required accounts: 12; extras go to remaining.

Fields of CloseOrderAndClaimTipInstructionAccounts, in account order:

CreateOrder#

Discriminator 8d3625cfedd2fad7 · data CreateOrder · accounts CreateOrderInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of CreateOrderInstructionAccounts, in account order:

FlashTakeOrderEnd#

Discriminator cef2d7bb8621e094 · data FlashTakeOrderEnd · accounts FlashTakeOrderEndInstructionAccounts.

Required accounts: 23; extras go to remaining.

Fields of FlashTakeOrderEndInstructionAccounts, in account order:

FlashTakeOrderStart#

Discriminator 7e35b00f276761f3 · data FlashTakeOrderStart · accounts FlashTakeOrderStartInstructionAccounts.

Required accounts: 23; extras go to remaining.

Fields of FlashTakeOrderStartInstructionAccounts, in account order:

InitializeGlobalConfig#

Discriminator 71d87a83e1d11637 · data InitializeGlobalConfig · accounts InitializeGlobalConfigInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of InitializeGlobalConfigInstructionAccounts, in account order:

InitializeVault#

Discriminator 30bfa32c47813fa4 · data InitializeVault · accounts InitializeVaultInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of InitializeVaultInstructionAccounts, in account order:

LogUserSwapBalancesEnd#

Discriminator 8c2ac65293902c71 · data LogUserSwapBalancesEnd · accounts LogUserSwapBalancesEndInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of LogUserSwapBalancesEndInstructionAccounts, in account order:

LogUserSwapBalancesStart#

Discriminator 856c170fe2d7b05f · data LogUserSwapBalancesStart · accounts LogUserSwapBalancesStartInstructionAccounts.

No data fields.

Required accounts: 13; extras go to remaining.

Fields of LogUserSwapBalancesStartInstructionAccounts, in account order:

TakeOrder#

Discriminator a3d014acdf41ffe4 · data TakeOrder · accounts TakeOrderInstructionAccounts.

Required accounts: 23; extras go to remaining.

Fields of TakeOrderInstructionAccounts, 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:

UpdateOrder#

Discriminator 3608d0cf2286efa8 · data UpdateOrder · accounts UpdateOrderInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of UpdateOrderInstructionAccounts, in account order:

WithdrawHostTip#

Discriminator 8cf669a550558f12 · data WithdrawHostTip · accounts WithdrawHostTipInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of WithdrawHostTipInstructionAccounts, in account order:

CpiEvent#

Anchor self-CPI that carries one of the program's events. data is the CpiEvent enum.

Discriminator e445a52e51cb9a1d · data CpiEvent · accounts CpiEventInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CpiEventInstructionAccounts, in account order:

Accounts#

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

GlobalConfig#

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

Order#

Discriminator 86addfb94d561c33 · accounts::order::Order.

UserSwapBalancesState#

Discriminator 8ce4983ee71bf5c6 · accounts::user_swap_balances_state::UserSwapBalancesState.

Events#

Variants of instructions::CpiEvent, decoded from the CpiEvent instruction. Each wraps a struct from carbon_kamino_limit_order_decoder::events::<module>. The discriminator is the 8-byte event discriminator that follows the e445a52e51cb9a1d CPI-event tag.

OrderDisplay#

Discriminator 5c65069ef898f13c · events::order_display::OrderDisplayEvent.

UserSwapBalanceDiffs#

Discriminator 8bcb231f19083e8f · events::user_swap_balance_diffs::UserSwapBalanceDiffsEvent.

Types#

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

OrderDisplay#

Struct types::OrderDisplay. Same fields as the OrderDisplay event.

OrderStatus#

Enum types::OrderStatus.

OrderType#

Enum types::OrderType.

UpdateGlobalConfigMode#

Enum types::UpdateGlobalConfigMode.

UpdateGlobalConfigValue#

Enum types::UpdateGlobalConfigValue.

UpdateOrderMode#

Enum types::UpdateOrderMode.

UserSwapBalanceDiffs#

Struct types::UserSwapBalanceDiffs. Same fields as the UserSwapBalanceDiffs event.