BonkSwap decoder

carbon-bonkswap-decoder decodes the instructions and accounts of the BonkSwap program (BSwp6bEBihVLdqJRKGgzjcGLHkcTuzmSo1TQkHepzH8p): 19 instructions, 5 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: FluxBeam, Gavel, 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 BonkSwap transactions from the public RPC and prints every decoded Swap instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-bonkswap-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_bonkswap_decoder::{instructions::BonkswapInstruction, BonkswapDecoder, 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(BonkswapDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

impl Processor<InstructionProcessorInputType<'_, BonkswapInstruction>> for InstructionLogger {
    async fn process(
        &mut self,
        input: &InstructionProcessorInputType<'_, BonkswapInstruction>,
    ) -> CarbonResult<()> {
        let signature = input.metadata.transaction_metadata.signature;
        if let BonkswapInstruction::Swap { data, accounts, .. } = input.decoded_instruction {
            println!("swap {signature}: {data:?} state={}", accounts.state);
        }
        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 Pool 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_bonkswap_decoder::{accounts::BonkswapAccount, BonkswapDecoder, 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(BonkswapDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

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

RUST_LOG=info cargo run

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

AddSupply#

Discriminator 50664639eb58ef08 · data AddSupply · accounts AddSupplyInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of AddSupplyInstructionAccounts, in account order:

AddTokens#

Discriminator 1cda1ed1af9b99f0 · data AddTokens · accounts AddTokensInstructionAccounts.

Required accounts: 25; extras go to remaining.

Fields of AddTokensInstructionAccounts, in account order:

ClosePool#

Discriminator 8cbdd117ef3eef0b · data ClosePool · accounts ClosePoolInstructionAccounts.

No data fields.

Required accounts: 15; extras go to remaining.

Fields of ClosePoolInstructionAccounts, in account order:

CreateDualFarm#

Discriminator 2ab4678ace2bd062 · data CreateDualFarm · accounts CreateDualFarmInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of CreateDualFarmInstructionAccounts, in account order:

CreateFarm#

Discriminator 4a3b80a057ae99c2 · data CreateFarm · accounts CreateFarmInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of CreateFarmInstructionAccounts, in account order:

CreatePool#

Discriminator e992d18ecf6840bc · data CreatePool · accounts CreatePoolInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of CreatePoolInstructionAccounts, in account order:

CreateProvider#

Discriminator 4a35d3ae26a8e3b1 · data CreateProvider · accounts CreateProviderInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of CreateProviderInstructionAccounts, in account order:

CreateState#

Discriminator d6d3d14f6b69f7de · data CreateState · accounts CreateStateInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of CreateStateInstructionAccounts, in account order:

CreateTripleFarm#

Discriminator 9a1ab49112c987ab · data CreateTripleFarm · accounts CreateTripleFarmInstructionAccounts.

Required accounts: 19; extras go to remaining.

Fields of CreateTripleFarmInstructionAccounts, in account order:

ResetFarm#

Discriminator 2f4de97576373d71 · data ResetFarm · accounts ResetFarmInstructionAccounts.

No data fields.

Required accounts: 17; extras go to remaining.

Fields of ResetFarmInstructionAccounts, in account order:

Swap#

Discriminator f8c69e91e17587c8 · data Swap · accounts SwapInstructionAccounts.

Required accounts: 17; extras go to remaining.

Fields of SwapInstructionAccounts, in account order:

UpdateFees#

Discriminator e11b0d064554acbf · data UpdateFees · accounts UpdateFeesInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of UpdateFeesInstructionAccounts, in account order:

UpdateRewardTokens#

Discriminator f9ec474a683ae11c · data UpdateRewardTokens · accounts UpdateRewardTokensInstructionAccounts.

No data fields.

Required accounts: 12; extras go to remaining.

Fields of UpdateRewardTokensInstructionAccounts, in account order:

WithdrawBuyback#

Discriminator bc4b1ec6632b0c36 · data WithdrawBuyback · accounts WithdrawBuybackInstructionAccounts.

No data fields.

Required accounts: 14; extras go to remaining.

Fields of WithdrawBuybackInstructionAccounts, in account order:

WithdrawLpFee#

Discriminator 95a102d5c3932a41 · data WithdrawLpFee · accounts WithdrawLpFeeInstructionAccounts.

No data fields.

Required accounts: 15; extras go to remaining.

Fields of WithdrawLpFeeInstructionAccounts, in account order:

WithdrawMercantiFee#

Discriminator fde581252f480bf0 · data WithdrawMercantiFee · accounts WithdrawMercantiFeeInstructionAccounts.

No data fields.

Required accounts: 11; extras go to remaining.

Fields of WithdrawMercantiFeeInstructionAccounts, in account order:

WithdrawProjectFee#

Discriminator 82c98e9c9fcfa816 · data WithdrawProjectFee · accounts WithdrawProjectFeeInstructionAccounts.

No data fields.

Required accounts: 14; extras go to remaining.

Fields of WithdrawProjectFeeInstructionAccounts, in account order:

WithdrawRewards#

Discriminator 0ad6db8bcd16fb15 · data WithdrawRewards · accounts WithdrawRewardsInstructionAccounts.

No data fields.

Required accounts: 21; extras go to remaining.

Fields of WithdrawRewardsInstructionAccounts, in account order:

WithdrawShares#

Discriminator b0689a69fa5044f4 · data WithdrawShares · accounts WithdrawSharesInstructionAccounts.

Required accounts: 25; extras go to remaining.

Fields of WithdrawSharesInstructionAccounts, in account order:

Accounts#

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

Farm#

Discriminator a19cd3fdfa4035fa · accounts::farm::Farm.

Pool#

Discriminator f19a6d0411b16dbc · accounts::pool::Pool.

PoolV2#

Discriminator 5b0cd65707b9a737 · accounts::pool_v2::PoolV2.

Provider#

Discriminator a4b447114bd850c3 · accounts::provider::Provider.

State#

Discriminator d8926b5e684bb6b1 · accounts::state::State.

Types#

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

FarmType#

Enum types::FarmType.

FixedPoint#

Struct types::FixedPoint.

Product#

Struct types::Product.

Token#

Struct types::Token.