Jupiter Swap decoder

carbon-jupiter-swap-decoder decodes the instructions, accounts and events of the Jupiter Swap program (JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4): 17 instructions, 1 account type, 6 events. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

Other aggregator and routing decoders: DFlow Aggregator v4, OKX DEX, OnChain Labs DEX v2. To decode several in one pipeline, see aggregator and routing 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 Jupiter Swap transactions from the public RPC and prints every decoded Route instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-jupiter-swap-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_jupiter_swap_decoder::{
        instructions::JupiterSwapInstruction, JupiterSwapDecoder, 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(JupiterSwapDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each Route instruction prints one line with the transaction signature and the decoded Route 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 JupiterSwapInstruction::CpiEvent { data: CpiEvent::FeeEvent(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 TokenLedger 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_jupiter_swap_decoder::{accounts::JupiterSwapAccount, JupiterSwapDecoder, 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(JupiterSwapDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

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

RUST_LOG=info cargo run

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

Claim#

Discriminator 3ec6d6c1d59f6cd2 · data Claim · accounts ClaimInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of ClaimInstructionAccounts, in account order:

ClaimToken#

Discriminator 74ce1bbfa6130049 · data ClaimToken · accounts ClaimTokenInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of ClaimTokenInstructionAccounts, in account order:

CloseToken#

Discriminator 1a4aec976840b7f9 · data CloseToken · accounts CloseTokenInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of CloseTokenInstructionAccounts, in account order:

CloseWsolTokenAccount#

Discriminator cb816785c57d6b56 · data CloseWsolTokenAccount · accounts CloseWsolTokenAccountInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of CloseWsolTokenAccountInstructionAccounts, in account order:

CreateTokenAccount#

Discriminator 93f17b64f484ae76 · data CreateTokenAccount · accounts CreateTokenAccountInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of CreateTokenAccountInstructionAccounts, in account order:

CreateTokenLedger#

Discriminator e8f2c5fdf08f8134 · data CreateTokenLedger · accounts CreateTokenLedgerInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of CreateTokenLedgerInstructionAccounts, in account order:

ExactOutRoute#

Discriminator d033ef977b2bed5c · data ExactOutRoute · accounts ExactOutRouteInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of ExactOutRouteInstructionAccounts, in account order:

ExactOutRouteV2#

Discriminator 9d8ab85215f4f324 · data ExactOutRouteV2 · accounts ExactOutRouteV2InstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of ExactOutRouteV2InstructionAccounts, in account order:

Route#

Discriminator e517cb977ae3ad2a · data Route · accounts RouteInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of RouteInstructionAccounts, in account order:

RouteV2#

Discriminator bb64facc31c4af14 · data RouteV2 · accounts RouteV2InstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of RouteV2InstructionAccounts, in account order:

RouteWithTokenLedger#

Discriminator 96564774a75d0e68 · data RouteWithTokenLedger · accounts RouteWithTokenLedgerInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of RouteWithTokenLedgerInstructionAccounts, in account order:

SetTokenLedger#

Discriminator e455b9704e4f4d02 · data SetTokenLedger · accounts SetTokenLedgerInstructionAccounts.

No data fields.

Required accounts: 2; extras go to remaining.

Fields of SetTokenLedgerInstructionAccounts, in account order:

SharedAccountsExactOutRoute#

Discriminator b0d169a89a7d453e · data SharedAccountsExactOutRoute · accounts SharedAccountsExactOutRouteInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of SharedAccountsExactOutRouteInstructionAccounts, in account order:

SharedAccountsExactOutRouteV2#

Discriminator 3560e5cad8bbfa18 · data SharedAccountsExactOutRouteV2 · accounts SharedAccountsExactOutRouteV2InstructionAccounts.

Required accounts: 12; extras go to remaining.

Fields of SharedAccountsExactOutRouteV2InstructionAccounts, in account order:

SharedAccountsRoute#

Discriminator c1209b3341d69c81 · data SharedAccountsRoute · accounts SharedAccountsRouteInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of SharedAccountsRouteInstructionAccounts, in account order:

SharedAccountsRouteV2#

Discriminator d19853937cfed8e9 · data SharedAccountsRouteV2 · accounts SharedAccountsRouteV2InstructionAccounts.

Required accounts: 12; extras go to remaining.

Fields of SharedAccountsRouteV2InstructionAccounts, in account order:

SharedAccountsRouteWithTokenLedger#

Discriminator e6798f50779f6aaa · data SharedAccountsRouteWithTokenLedger · accounts SharedAccountsRouteWithTokenLedgerInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of SharedAccountsRouteWithTokenLedgerInstructionAccounts, 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 JupiterSwapAccount. Each wraps a boxed struct from carbon_jupiter_swap_decoder::accounts::<module>. decode_account only considers accounts owned by PROGRAM_ID and returns the first variant that matches.

TokenLedger#

Discriminator 9cf709bc366c554d · accounts::token_ledger::TokenLedger.

Events#

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

FeeEvent#

Discriminator 494f4e7fb8d50ddc · events::fee_event::FeeEventEvent.

SwapEvent#

Discriminator 40c6cde8260871e2 · events::swap_event::SwapEventEvent.

SwapsEvent#

Discriminator 982f4eebc0606e6a · events::swaps_event::SwapsEventEvent.

CandidateSwapResults#

Discriminator 2d09f41ee534a87b · events::candidate_swap_results::CandidateSwapResultsEvent.

CandidateSwapQuoteError#

Discriminator f886253791b1724f · events::candidate_swap_quote_error::CandidateSwapQuoteErrorEvent.

BestSwapOutAmountViolation#

Discriminator 7c42c433daad2e5d · events::best_swap_out_amount_violation::BestSwapOutAmountViolationEvent.

Types#

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

AccountsType#

Enum types::AccountsType.

BestSwapOutAmountViolation#

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

CandidateSwap#

Enum types::CandidateSwap.

CandidateSwapQuoteError#

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

CandidateSwapResult#

Enum types::CandidateSwapResult.

CandidateSwapResults#

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

CandidateSwapWithBps#

Struct types::CandidateSwapWithBps.

DefiTunaAccountsType#

Enum types::DefiTunaAccountsType.

FeeEvent#

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

HyloSwapType#

Enum types::HyloSwapType.

RemainingAccountsInfo#

Struct types::RemainingAccountsInfo.

RemainingAccountsSlice#

Struct types::RemainingAccountsSlice.

RoutePlanStep#

Struct types::RoutePlanStep.

RoutePlanStepV2#

Struct types::RoutePlanStepV2.

Side#

Enum types::Side.

Swap#

Enum types::Swap.

SwapEvent#

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

SwapEventV2#

Struct types::SwapEventV2.

SwapsEvent#

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