Phoenix v1 decoder

carbon-phoenix-v1-decoder decodes the instructions of the Phoenix v1 program (PhoeNiXZ8ByJGLkxNfZRnkUfjvmuYqLR89jjFHGqdXY): 28 instructions. It decodes no accounts: PhoenixV1Account has no variants. 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, Kamino Limit Order, Lifinity AMM v2, Meteora DAMM v2, Meteora DLMM, Meteora Pools, OpenBook v2, Orca Whirlpools, PancakeSwap, 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 Phoenix v1 transactions from the public RPC and prints every decoded Swap instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-phoenix-v1-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_phoenix_v1_decoder::{instructions::PhoenixV1Instruction, PhoenixV1Decoder, 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(PhoenixV1Decoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

impl Processor<InstructionProcessorInputType<'_, PhoenixV1Instruction>> for InstructionLogger {
    async fn process(
        &mut self,
        input: &InstructionProcessorInputType<'_, PhoenixV1Instruction>,
    ) -> CarbonResult<()> {
        let signature = input.metadata.transaction_metadata.signature;
        if let PhoenixV1Instruction::Swap { data, accounts, .. } = input.decoded_instruction {
            println!("swap {signature}: {data:?} phoenix_program={}", accounts.phoenix_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.

Instructions#

Variants of PhoenixV1Instruction. Each is PhoenixV1Instruction::<Variant> { program_id, data, accounts }, where data and accounts are the types listed under the variant, exported from carbon_phoenix_v1_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 PhoeNiXZ8ByJGLkxNfZRnkUfjvmuYqLR89jjFHGqdXY.
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.

CancelAllOrders#

Discriminator 06 · data CancelAllOrders · accounts CancelAllOrdersInstructionAccounts.

No data fields.

Required accounts: 9; extras go to remaining.

Fields of CancelAllOrdersInstructionAccounts, in account order:

CancelAllOrdersWithFreeFunds#

Discriminator 07 · data CancelAllOrdersWithFreeFunds · accounts CancelAllOrdersWithFreeFundsInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of CancelAllOrdersWithFreeFundsInstructionAccounts, in account order:

CancelMultipleOrdersById#

Discriminator 0a · data CancelMultipleOrdersById · accounts CancelMultipleOrdersByIdInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of CancelMultipleOrdersByIdInstructionAccounts, in account order:

CancelMultipleOrdersByIdWithFreeFunds#

Discriminator 0b · data CancelMultipleOrdersByIdWithFreeFunds · accounts CancelMultipleOrdersByIdWithFreeFundsInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of CancelMultipleOrdersByIdWithFreeFundsInstructionAccounts, in account order:

CancelUpTo#

Discriminator 08 · data CancelUpTo · accounts CancelUpToInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of CancelUpToInstructionAccounts, in account order:

CancelUpToWithFreeFunds#

Discriminator 09 · data CancelUpToWithFreeFunds · accounts CancelUpToWithFreeFundsInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of CancelUpToWithFreeFundsInstructionAccounts, in account order:

ChangeFeeRecipient#

Discriminator 6d · data ChangeFeeRecipient · accounts ChangeFeeRecipientInstructionAccounts.

No data fields.

Required accounts: 5; extras go to remaining.

Fields of ChangeFeeRecipientInstructionAccounts, in account order:

ChangeMarketStatus#

Discriminator 67 · data ChangeMarketStatus · accounts ChangeMarketStatusInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of ChangeMarketStatusInstructionAccounts, in account order:

ChangeSeatStatus#

Discriminator 68 · data ChangeSeatStatus · accounts ChangeSeatStatusInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of ChangeSeatStatusInstructionAccounts, in account order:

ClaimAuthority#

Discriminator 65 · data ClaimAuthority · accounts ClaimAuthorityInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of ClaimAuthorityInstructionAccounts, in account order:

CollectFees#

Discriminator 6c · data CollectFees · accounts CollectFeesInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of CollectFeesInstructionAccounts, in account order:

DepositFunds#

Discriminator 0d · data DepositFunds · accounts DepositFundsInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of DepositFundsInstructionAccounts, in account order:

EvictSeat#

Discriminator 6a · data EvictSeat · accounts EvictSeatInstructionAccounts.

No data fields.

Required accounts: 11; extras go to remaining.

Fields of EvictSeatInstructionAccounts, in account order:

ForceCancelOrders#

Discriminator 6b · data ForceCancelOrders · accounts ForceCancelOrdersInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of ForceCancelOrdersInstructionAccounts, in account order:

InitializeMarket#

Discriminator 64 · data InitializeMarket · accounts InitializeMarketInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of InitializeMarketInstructionAccounts, in account order:

Log#

Discriminator 0f · data Log · accounts LogInstructionAccounts.

No data fields.

Required accounts: 1; extras go to remaining.

Fields of LogInstructionAccounts, in account order:

NameSuccessor#

Discriminator 66 · data NameSuccessor · accounts NameSuccessorInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of NameSuccessorInstructionAccounts, in account order:

PlaceLimitOrder#

Discriminator 02 · data PlaceLimitOrder · accounts PlaceLimitOrderInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of PlaceLimitOrderInstructionAccounts, in account order:

PlaceLimitOrderWithFreeFunds#

Discriminator 03 · data PlaceLimitOrderWithFreeFunds · accounts PlaceLimitOrderWithFreeFundsInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of PlaceLimitOrderWithFreeFundsInstructionAccounts, in account order:

PlaceMultiplePostOnlyOrders#

Discriminator 10 · data PlaceMultiplePostOnlyOrders · accounts PlaceMultiplePostOnlyOrdersInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of PlaceMultiplePostOnlyOrdersInstructionAccounts, in account order:

PlaceMultiplePostOnlyOrdersWithFreeFunds#

Discriminator 11 · data PlaceMultiplePostOnlyOrdersWithFreeFunds · accounts PlaceMultiplePostOnlyOrdersWithFreeFundsInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of PlaceMultiplePostOnlyOrdersWithFreeFundsInstructionAccounts, in account order:

ReduceOrder#

Discriminator 04 · data ReduceOrder · accounts ReduceOrderInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of ReduceOrderInstructionAccounts, in account order:

ReduceOrderWithFreeFunds#

Discriminator 05 · data ReduceOrderWithFreeFunds · accounts ReduceOrderWithFreeFundsInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of ReduceOrderWithFreeFundsInstructionAccounts, in account order:

RequestSeat#

Discriminator 0e · data RequestSeat · accounts RequestSeatInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of RequestSeatInstructionAccounts, in account order:

RequestSeatAuthorized#

Discriminator 69 · data RequestSeatAuthorized · accounts RequestSeatAuthorizedInstructionAccounts.

No data fields.

Required accounts: 8; extras go to remaining.

Fields of RequestSeatAuthorizedInstructionAccounts, in account order:

Swap#

Discriminator 00 · data Swap · accounts SwapInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of SwapInstructionAccounts, in account order:

SwapWithFreeFunds#

Discriminator 01 · data SwapWithFreeFunds · accounts SwapWithFreeFundsInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of SwapWithFreeFundsInstructionAccounts, in account order:

WithdrawFunds#

Discriminator 0c · data WithdrawFunds · accounts WithdrawFundsInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of WithdrawFundsInstructionAccounts, in account order:

Types#

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

AuditLogHeader#

Struct types::AuditLogHeader.

CancelMultipleOrdersByIdParams#

Struct types::CancelMultipleOrdersByIdParams.

CancelOrderParams#

Struct types::CancelOrderParams.

CancelUpToParams#

Struct types::CancelUpToParams.

CondensedOrder#

Struct types::CondensedOrder.

DepositParams#

Struct types::DepositParams.

EvictEvent#

Struct types::EvictEvent.

ExpiredOrderEvent#

Struct types::ExpiredOrderEvent.

FailedMultipleLimitOrderBehavior#

Enum types::FailedMultipleLimitOrderBehavior.

FeeEvent#

Struct types::FeeEvent.

FillEvent#

Struct types::FillEvent.

FillSummaryEvent#

Struct types::FillSummaryEvent.

InitializeParams#

Struct types::InitializeParams.

MarketHeader#

Struct types::MarketHeader.

MarketSizeParams#

Struct types::MarketSizeParams.

MarketStatus#

Enum types::MarketStatus.

MultipleOrderPacket#

Struct types::MultipleOrderPacket.

OrderPacket#

Enum types::OrderPacket.

PhoenixMarketEvent#

Enum types::PhoenixMarketEvent.

PlaceEvent#

Struct types::PlaceEvent.

ReduceEvent#

Struct types::ReduceEvent.

ReduceOrderParams#

Struct types::ReduceOrderParams.

Seat#

Struct types::Seat.

SeatApprovalStatus#

Enum types::SeatApprovalStatus.

SelfTradeBehavior#

Enum types::SelfTradeBehavior.

Side#

Enum types::Side.

TimeInForceEvent#

Struct types::TimeInForceEvent.

TokenParams#

Struct types::TokenParams.

WithdrawParams#

Struct types::WithdrawParams.