Heaven decoder

carbon-heaven-decoder decodes the instructions, accounts and events of the Heaven program (HEAVENoP2qxoeuF8Dj2oT1GHEnu49U5mJYkdeC8BAX2o): 54 instructions, 6 account types, 7 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, 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 Heaven transactions from the public RPC and prints every decoded Buy instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-heaven-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_heaven_decoder::{instructions::HeavenInstruction, HeavenDecoder, 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(HeavenDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each Buy instruction prints one line with the transaction signature and the decoded Buy 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 HeavenInstruction::CpiEvent { data: CpiEvent::CreateLiquidityPoolEvent(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 LiquidityPoolState 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_heaven_decoder::{accounts::HeavenAccount, HeavenDecoder, 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(HeavenDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

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

RUST_LOG=info cargo run

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

AddLiquidityProPool#

Discriminator 7d3b6c2a121c2207 · data AddLiquidityProPool · accounts AddLiquidityProPoolInstructionAccounts.

Required accounts: 15; extras go to remaining.

Fields of AddLiquidityProPoolInstructionAccounts, in account order:

AdminBorrowSol#

Discriminator cc485fd7acc089fc · data AdminBorrowSol · accounts AdminBorrowSolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminBorrowSolInstructionAccounts, in account order:

AdminClaimMsol#

Discriminator 7c303cc7cb312429 · data AdminClaimMsol · accounts AdminClaimMsolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminClaimMsolInstructionAccounts, in account order:

AdminClaimProCreatorTradingFees#

Discriminator 4482fa483c5e1f16 · data AdminClaimProCreatorTradingFees · accounts AdminClaimProCreatorTradingFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of AdminClaimProCreatorTradingFeesInstructionAccounts, in account order:

AdminClaimStakingRewards#

Discriminator 18a3dcabe1dea6f8 · data AdminClaimStakingRewards · accounts AdminClaimStakingRewardsInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminClaimStakingRewardsInstructionAccounts, in account order:

AdminClaimStandardCreatorTradingFees#

Discriminator b627a819603f4c11 · data AdminClaimStandardCreatorTradingFees · accounts AdminClaimStandardCreatorTradingFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of AdminClaimStandardCreatorTradingFeesInstructionAccounts, in account order:

AdminDepositMsol#

Discriminator cebdd0a61351ca30 · data AdminDepositMsol · accounts AdminDepositMsolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminDepositMsolInstructionAccounts, in account order:

AdminMintMsol#

Discriminator 8cca39c361d5a813 · data AdminMintMsol · accounts AdminMintMsolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminMintMsolInstructionAccounts, in account order:

AdminRepaySol#

Discriminator 883d30e8a61acf2e · data AdminRepaySol · accounts AdminRepaySolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminRepaySolInstructionAccounts, in account order:

AdminSetTransferFee#

Discriminator e8c1a803505cd7b0 · data AdminSetTransferFee · accounts AdminSetTransferFeeInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of AdminSetTransferFeeInstructionAccounts, in account order:

AdminUnstakeMsol#

Discriminator fdda8dfc2809079a · data AdminUnstakeMsol · accounts AdminUnstakeMsolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminUnstakeMsolInstructionAccounts, in account order:

AdminUpdateProLiquidityPoolState#

Discriminator c845f14091928070 · data AdminUpdateProLiquidityPoolState · accounts AdminUpdateProLiquidityPoolStateInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of AdminUpdateProLiquidityPoolStateInstructionAccounts, in account order:

AdminUpdateStandardLiquidityPoolState#

Discriminator 63e4293fddf4c8c7 · data AdminUpdateStandardLiquidityPoolState · accounts AdminUpdateStandardLiquidityPoolStateInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of AdminUpdateStandardLiquidityPoolStateInstructionAccounts, in account order:

AdminWithdrawMsol#

Discriminator f9db8d48d26ed863 · data AdminWithdrawMsol · accounts AdminWithdrawMsolInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AdminWithdrawMsolInstructionAccounts, in account order:

AdminWithdrawTransferFee#

Discriminator 754fa4cb7e4816f6 · data AdminWithdrawTransferFee · accounts AdminWithdrawTransferFeeInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of AdminWithdrawTransferFeeInstructionAccounts, in account order:

Buy#

Discriminator 66063d1201daebea · data Buy · accounts BuyInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of BuyInstructionAccounts, in account order:

ClaimProCreatorTradingFeeProtocolFees#

Discriminator ea23ed0f8a31ec99 · data ClaimProCreatorTradingFeeProtocolFees · accounts ClaimProCreatorTradingFeeProtocolFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of ClaimProCreatorTradingFeeProtocolFeesInstructionAccounts, in account order:

ClaimProCreatorTradingFees#

Discriminator 517b67716d968a5d · data ClaimProCreatorTradingFees · accounts ClaimProCreatorTradingFeesInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of ClaimProCreatorTradingFeesInstructionAccounts, in account order:

ClaimProLiquidityProviderTradingFees#

Discriminator f274e4342074ac94 · data ClaimProLiquidityProviderTradingFees · accounts ClaimProLiquidityProviderTradingFeesInstructionAccounts.

No data fields.

Required accounts: 13; extras go to remaining.

Fields of ClaimProLiquidityProviderTradingFeesInstructionAccounts, in account order:

ClaimProProtocolTradingFees#

Discriminator ddc065bdff4fc239 · data ClaimProProtocolTradingFees · accounts ClaimProProtocolTradingFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of ClaimProProtocolTradingFeesInstructionAccounts, in account order:

ClaimProReflectionTradingFees#

Discriminator ea9030fc6f06503a · data ClaimProReflectionTradingFees · accounts ClaimProReflectionTradingFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of ClaimProReflectionTradingFeesInstructionAccounts, in account order:

ClaimStandardCreatorTradingFeeProtocolFees#

Discriminator 00c9e2e47f2d456e · data ClaimStandardCreatorTradingFeeProtocolFees · accounts ClaimStandardCreatorTradingFeeProtocolFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of ClaimStandardCreatorTradingFeeProtocolFeesInstructionAccounts, in account order:

ClaimStandardCreatorTradingFees#

Discriminator a559dd34aaf9226f · data ClaimStandardCreatorTradingFees · accounts ClaimStandardCreatorTradingFeesInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of ClaimStandardCreatorTradingFeesInstructionAccounts, in account order:

ClaimStandardProtocolTradingFees#

Discriminator 54ce8cf53fd440ed · data ClaimStandardProtocolTradingFees · accounts ClaimStandardProtocolTradingFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of ClaimStandardProtocolTradingFeesInstructionAccounts, in account order:

ClaimStandardReflectionTradingFees#

Discriminator 4694259366141e17 · data ClaimStandardReflectionTradingFees · accounts ClaimStandardReflectionTradingFeesInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of ClaimStandardReflectionTradingFeesInstructionAccounts, in account order:

CloseProtocolLookupTable#

Discriminator 4f48302777032a74 · data CloseProtocolLookupTable · accounts CloseProtocolLookupTableInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of CloseProtocolLookupTableInstructionAccounts, in account order:

CreateOrUpdateProtocolFeeAdmin#

Discriminator 157eb014556f351f · data CreateOrUpdateProtocolFeeAdmin · accounts CreateOrUpdateProtocolFeeAdminInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of CreateOrUpdateProtocolFeeAdminInstructionAccounts, in account order:

CreateOrUpdateProtocolOwner#

Discriminator aa7c802830698b94 · data CreateOrUpdateProtocolOwner · accounts CreateOrUpdateProtocolOwnerInstructionAccounts.

No data fields.

Required accounts: 5; extras go to remaining.

Fields of CreateOrUpdateProtocolOwnerInstructionAccounts, in account order:

CreateOrUpdateProtocolStakingAdmin#

Discriminator 04acc4d578321e89 · data CreateOrUpdateProtocolStakingAdmin · accounts CreateOrUpdateProtocolStakingAdminInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of CreateOrUpdateProtocolStakingAdminInstructionAccounts, in account order:

CreateProLiquidityPool#

Discriminator d16155bfbb1dc455 · data CreateProLiquidityPool · accounts CreateProLiquidityPoolInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of CreateProLiquidityPoolInstructionAccounts, in account order:

CreateProtocolConfig#

Discriminator 7372186f0e3571fe · data CreateProtocolConfig · accounts CreateProtocolConfigInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of CreateProtocolConfigInstructionAccounts, in account order:

CreateProtocolLookupTable#

Discriminator f9036399a8f1f3e4 · data CreateProtocolLookupTable · accounts CreateProtocolLookupTableInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of CreateProtocolLookupTableInstructionAccounts, in account order:

CreateStandardLiquidityPool#

Discriminator 2a2b7e38e70ad035 · data CreateStandardLiquidityPool · accounts CreateStandardLiquidityPoolInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of CreateStandardLiquidityPoolInstructionAccounts, in account order:

CreatorSetProMarketCapCreatorFee#

Discriminator 75ce38021c25eceb · data CreatorSetProMarketCapCreatorFee · accounts CreatorSetProMarketCapCreatorFeeInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorSetProMarketCapCreatorFeeInstructionAccounts, in account order:

CreatorSetProMarketCapLpFee#

Discriminator 06c12209eb55fff6 · data CreatorSetProMarketCapLpFee · accounts CreatorSetProMarketCapLpFeeInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorSetProMarketCapLpFeeInstructionAccounts, in account order:

CreatorSetProMarketCapReflectionFee#

Discriminator e3ad60792de2a489 · data CreatorSetProMarketCapReflectionFee · accounts CreatorSetProMarketCapReflectionFeeInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorSetProMarketCapReflectionFeeInstructionAccounts, in account order:

CreatorSetProSlotCreatorFee#

Discriminator 15464de404e10353 · data CreatorSetProSlotCreatorFee · accounts CreatorSetProSlotCreatorFeeInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorSetProSlotCreatorFeeInstructionAccounts, in account order:

CreatorToggleProDeposit#

Discriminator a08980cc2ab366ca · data CreatorToggleProDeposit · accounts CreatorToggleProDepositInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorToggleProDepositInstructionAccounts, in account order:

CreatorToggleProSwap#

Discriminator 8fbe0581e63b1c59 · data CreatorToggleProSwap · accounts CreatorToggleProSwapInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorToggleProSwapInstructionAccounts, in account order:

CreatorToggleProWithdraw#

Discriminator 202fea054d92f4b2 · data CreatorToggleProWithdraw · accounts CreatorToggleProWithdrawInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of CreatorToggleProWithdrawInstructionAccounts, in account order:

DeactivateProtocolLookupTable#

Discriminator da0c583a962c9848 · data DeactivateProtocolLookupTable · accounts DeactivateProtocolLookupTableInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of DeactivateProtocolLookupTableInstructionAccounts, in account order:

ExtendProtocolLookupTable#

Discriminator 07e3c6016b711f58 · data ExtendProtocolLookupTable · accounts ExtendProtocolLookupTableInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of ExtendProtocolLookupTableInstructionAccounts, in account order:

InitializeProtocolLending#

Discriminator 00cdedf01b4f1b3b · data InitializeProtocolLending · accounts InitializeProtocolLendingInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of InitializeProtocolLendingInstructionAccounts, in account order:

ProBuy#

Discriminator 67abc4ee9f2dbbf6 · data ProBuy · accounts ProBuyInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of ProBuyInstructionAccounts, in account order:

ProSell#

Discriminator 8c4f7a601689ee7c · data ProSell · accounts ProSellInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of ProSellInstructionAccounts, in account order:

RemainingAccountsStub#

Discriminator 208f535e17223bef · data RemainingAccountsStub · accounts RemainingAccountsStubInstructionAccounts.

No data fields.

Required accounts: 113; extras go to remaining.

Fields of RemainingAccountsStubInstructionAccounts, in account order:

RemoveLiquidityProPool#

Discriminator bf372a2ce262ac4f · data RemoveLiquidityProPool · accounts RemoveLiquidityProPoolInstructionAccounts.

Required accounts: 15; extras go to remaining.

Fields of RemoveLiquidityProPoolInstructionAccounts, in account order:

Sell#

Discriminator 33e685a4017f83ad · data Sell · accounts SellInstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of SellInstructionAccounts, in account order:

SetProtocolSlotFees#

Discriminator b552130f7ecd98f2 · data SetProtocolSlotFees · accounts SetProtocolSlotFeesInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetProtocolSlotFeesInstructionAccounts, in account order:

TransferLpTokens#

Discriminator ee790e52676d46b4 · data TransferLpTokens · accounts TransferLpTokensInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of TransferLpTokensInstructionAccounts, in account order:

UpdateAllowCreatePool#

Discriminator dffce73e60dbf1d6 · data UpdateAllowCreatePool · accounts UpdateAllowCreatePoolInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of UpdateAllowCreatePoolInstructionAccounts, in account order:

UpdateCreatorTradingFeeReceiver#

Discriminator f6e5c84f1f157819 · data UpdateCreatorTradingFeeReceiver · accounts UpdateCreatorTradingFeeReceiverInstructionAccounts.

No data fields.

Required accounts: 15; extras go to remaining.

Fields of UpdateCreatorTradingFeeReceiverInstructionAccounts, in account order:

UpdateProCreatorTradingFeeReceiver#

Discriminator 9cf01bf32aa51f00 · data UpdateProCreatorTradingFeeReceiver · accounts UpdateProCreatorTradingFeeReceiverInstructionAccounts.

No data fields.

Required accounts: 15; extras go to remaining.

Fields of UpdateProCreatorTradingFeeReceiverInstructionAccounts, in account order:

UpdateProtocolConfig#

Discriminator c5617b36dda80b87 · data UpdateProtocolConfig · accounts UpdateProtocolConfigInstructionAccounts.

Required accounts: 3; extras go to remaining.

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

LiquidityPoolState#

Discriminator be9edc820fa284fc · accounts::liquidity_pool_state::LiquidityPoolState.