Gavel decoder

carbon-gavel-decoder decodes the instructions and accounts of the Gavel program (srAMMzfVHVAtgSJc8iH6CfKzuWuUTzLHVCE81QU1rgi): 10 instructions, 2 account types. 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, Heaven, Jupiter Limit Order, Jupiter Limit Order v2, Kamino Limit Order, 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 Gavel transactions from the public RPC and prints every decoded Swap instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-gavel-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_gavel_decoder::{instructions::GavelInstruction, GavelDecoder, 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(GavelDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each Swap instruction prints one line with the transaction signature and the decoded Swap 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 LpPositionAccount 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_gavel_decoder::{accounts::GavelAccount, GavelDecoder, 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(GavelDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

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

RUST_LOG=info cargo run

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

AddLiquidity#

Discriminator 01 · data AddLiquidity · accounts AddLiquidityInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AddLiquidityInstructionAccounts, in account order:

InitializeLpPosition#

Discriminator 05 · data InitializeLpPosition · accounts InitializeLpPositionInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of InitializeLpPositionInstructionAccounts, in account order:

InitializePool#

Discriminator 06 · data InitializePool · accounts InitializePoolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of InitializePoolInstructionAccounts, in account order:

Log#

Discriminator 08 · data Log · accounts LogInstructionAccounts.

No data fields.

Required accounts: 1; extras go to remaining.

Fields of LogInstructionAccounts, in account order:

RemoveLiquidity#

Discriminator 02 · data RemoveLiquidity · accounts RemoveLiquidityInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of RemoveLiquidityInstructionAccounts, in account order:

RenounceLiquidity#

Discriminator 03 · data RenounceLiquidity · accounts RenounceLiquidityInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of RenounceLiquidityInstructionAccounts, in account order:

Swap#

Discriminator 00 · data Swap · accounts SwapInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of SwapInstructionAccounts, in account order:

TransferLiquidity#

Discriminator 09 · data TransferLiquidity · accounts TransferLiquidityInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of TransferLiquidityInstructionAccounts, in account order:

WithdrawLpFees#

Discriminator 04 · data WithdrawLpFees · accounts WithdrawLpFeesInstructionAccounts.

No data fields.

Required accounts: 9; extras go to remaining.

Fields of WithdrawLpFeesInstructionAccounts, in account order:

WithdrawProtocolFees#

Discriminator 07 · data WithdrawProtocolFees · accounts WithdrawProtocolFeesInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of WithdrawProtocolFeesInstructionAccounts, in account order:

Accounts#

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

LpPositionAccount#

No discriminator (matched by Borsh layout) · accounts::lp_position_account::LpPositionAccount.

PoolAccount#

No discriminator (matched by Borsh layout) · accounts::pool_account::PoolAccount.

Types#

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

AddLiquidityEvent#

Struct types::AddLiquidityEvent.

AddLiquidityIxParams#

Struct types::AddLiquidityIxParams.

Amm#

Struct types::Amm.

InitializeLpPositionEvent#

Struct types::InitializeLpPositionEvent.

InitializePoolEvent#

Struct types::InitializePoolEvent.

InitializePoolIxParams#

Struct types::InitializePoolIxParams.

LpPosition#

Struct types::LpPosition.

PendingSharesToVest#

Struct types::PendingSharesToVest.

PlasmaEvent#

Enum types::PlasmaEvent.

PlasmaEventHeader#

Struct types::PlasmaEventHeader.

PoolHeader#

Struct types::PoolHeader.

ProtocolFeeRecipient#

Struct types::ProtocolFeeRecipient.

ProtocolFeeRecipientParams#

Struct types::ProtocolFeeRecipientParams.

ProtocolFeeRecipients#

Struct types::ProtocolFeeRecipients.

RemoveLiquidityEvent#

Struct types::RemoveLiquidityEvent.

RemoveLiquidityIxParams#

Struct types::RemoveLiquidityIxParams.

RenounceLiquidityEvent#

Struct types::RenounceLiquidityEvent.

RenounceLiquidityIxParams#

Struct types::RenounceLiquidityIxParams.

Side#

Enum types::Side.

SwapEvent#

Struct types::SwapEvent.

SwapIxParams#

Struct types::SwapIxParams.

SwapResult#

Struct types::SwapResult.

SwapType#

Enum types::SwapType.

TokenParams#

Struct types::TokenParams.

WithdrawLpFeesEvent#

Struct types::WithdrawLpFeesEvent.

WithdrawProtocolFeesEvent#

Struct types::WithdrawProtocolFeesEvent.