Circle CCTP Token Messenger v2 decoder

carbon-circle-token-messenger-v2-decoder decodes the instructions, accounts and events of the Circle CCTP Token Messenger v2 program (CCTPV2vPZJS2u2BBsUoscuikbYjnpFmbFsvVuJdgUMQe): 25 instructions, 7 account types, 22 events. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

Other bridge and messaging decoders: Circle CCTP Message Transmitter v2. To decode several in one pipeline, see bridge and messaging 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 Circle CCTP Token Messenger v2 transactions from the public RPC and prints every decoded DepositForBurn instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-circle-token-messenger-v2-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_circle_token_messenger_v2_decoder::{
        instructions::CircleTokenMessengerV2Instruction, CircleTokenMessengerV2Decoder, 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(CircleTokenMessengerV2Decoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each DepositForBurn instruction prints one line with the transaction signature and the decoded DepositForBurn 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 CircleTokenMessengerV2Instruction::CpiEvent { data: CpiEvent::Denylisted(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 DenylistedAccount 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_circle_token_messenger_v2_decoder::{
        accounts::CircleTokenMessengerV2Account, CircleTokenMessengerV2Decoder, 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(CircleTokenMessengerV2Decoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

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

RUST_LOG=info cargo run

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

AcceptOwnership#

Discriminator ac172b0deed55596 · data AcceptOwnership · accounts AcceptOwnershipInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of AcceptOwnershipInstructionAccounts, in account order:

AddLocalToken#

Discriminator d5c7cd12627c49c6 · data AddLocalToken · accounts AddLocalTokenInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of AddLocalTokenInstructionAccounts, in account order:

AddRemoteTokenMessenger#

Discriminator 0c95aca56fca1821 · data AddRemoteTokenMessenger · accounts AddRemoteTokenMessengerInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of AddRemoteTokenMessengerInstructionAccounts, in account order:

BurnTokenCustody#

Discriminator e988b4af70293e47 · data BurnTokenCustody · accounts BurnTokenCustodyInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of BurnTokenCustodyInstructionAccounts, in account order:

DenylistAccount#

Discriminator 6574c57051f94bc2 · data DenylistAccount · accounts DenylistAccountInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of DenylistAccountInstructionAccounts, in account order:

DepositForBurn#

Discriminator d73c3d2e723780b0 · data DepositForBurn · accounts DepositForBurnInstructionAccounts.

Required accounts: 18; extras go to remaining.

Fields of DepositForBurnInstructionAccounts, in account order:

DepositForBurnWithHook#

Discriminator 6ff53e83cc6cdf9b · data DepositForBurnWithHook · accounts DepositForBurnWithHookInstructionAccounts.

Required accounts: 18; extras go to remaining.

Fields of DepositForBurnWithHookInstructionAccounts, in account order:

HandleReceiveFinalizedMessage#

Discriminator bafcef4656b46e5f · data HandleReceiveFinalizedMessage · accounts HandleReceiveFinalizedMessageInstructionAccounts.

Required accounts: 12; extras go to remaining.

Fields of HandleReceiveFinalizedMessageInstructionAccounts, in account order:

HandleReceiveUnfinalizedMessage#

Discriminator c8a9af14c83ab63d · data HandleReceiveUnfinalizedMessage · accounts HandleReceiveUnfinalizedMessageInstructionAccounts.

Required accounts: 12; extras go to remaining.

Fields of HandleReceiveUnfinalizedMessageInstructionAccounts, in account order:

Initialize#

Discriminator afaf6d1f0d989bed · data Initialize · accounts InitializeInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of InitializeInstructionAccounts, in account order:

LinkTokenPair#

Discriminator 44a218687d2e820c · data LinkTokenPair · accounts LinkTokenPairInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of LinkTokenPairInstructionAccounts, in account order:

Pause#

Discriminator d316ddfb4a79c12f · data Pause · accounts PauseInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of PauseInstructionAccounts, in account order:

RemoveLocalToken#

Discriminator 1b2b42aabc2c6d61 · data RemoveLocalToken · accounts RemoveLocalTokenInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of RemoveLocalTokenInstructionAccounts, in account order:

RemoveRemoteTokenMessenger#

Discriminator 41724255a962b192 · data RemoveRemoteTokenMessenger · accounts RemoveRemoteTokenMessengerInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of RemoveRemoteTokenMessengerInstructionAccounts, in account order:

SetFeeRecipient#

Discriminator e312d72aedf69742 · data SetFeeRecipient · accounts SetFeeRecipientInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of SetFeeRecipientInstructionAccounts, in account order:

SetMaxBurnAmountPerMessage#

Discriminator 1e8091f046ed6dcf · data SetMaxBurnAmountPerMessage · accounts SetMaxBurnAmountPerMessageInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of SetMaxBurnAmountPerMessageInstructionAccounts, in account order:

SetMinFee#

Discriminator 72c6230329c4c2f6 · data SetMinFee · accounts SetMinFeeInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of SetMinFeeInstructionAccounts, in account order:

SetMinFeeController#

Discriminator c38e4a54ea5eb471 · data SetMinFeeController · accounts SetMinFeeControllerInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of SetMinFeeControllerInstructionAccounts, in account order:

SetTokenController#

Discriminator 5806620a4f3b0f18 · data SetTokenController · accounts SetTokenControllerInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of SetTokenControllerInstructionAccounts, in account order:

TransferOwnership#

Discriminator 41b1d749352d632f · data TransferOwnership · accounts TransferOwnershipInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of TransferOwnershipInstructionAccounts, in account order:

UndenylistAccount#

Discriminator 39242ba83eac2127 · data UndenylistAccount · accounts UndenylistAccountInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of UndenylistAccountInstructionAccounts, in account order:

UnlinkTokenPair#

Discriminator 34c6647268ae553a · data UnlinkTokenPair · accounts UnlinkTokenPairInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of UnlinkTokenPairInstructionAccounts, in account order:

Unpause#

Discriminator a99004260a8dbcff · data Unpause · accounts UnpauseInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of UnpauseInstructionAccounts, in account order:

UpdateDenylister#

Discriminator c142c6c954390ede · data UpdateDenylister · accounts UpdateDenylisterInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of UpdateDenylisterInstructionAccounts, in account order:

UpdatePauser#

Discriminator 8cabd38439c910fe · data UpdatePauser · accounts UpdatePauserInstructionAccounts.

Required accounts: 5; extras go to remaining.

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

DenylistedAccount#

Discriminator ba3ad4ef66839d92 · accounts::denylisted_account::DenylistedAccount.

LocalToken#

Discriminator 9f833aaac15480b6 · accounts::local_token::LocalToken.

MessageTransmitter#

Discriminator 4728b48e13cb23fc · accounts::message_transmitter::MessageTransmitter.

RemoteTokenMessenger#

Discriminator 6973ae225fe98afc · accounts::remote_token_messenger::RemoteTokenMessenger.

TokenMessenger#

Discriminator a204f23493f3dd60 · accounts::token_messenger::TokenMessenger.

TokenMinter#

Discriminator 7a85543f399fabce · accounts::token_minter::TokenMinter.

TokenPair#

Discriminator 11d62db0e595c547 · accounts::token_pair::TokenPair.

Events#

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

Denylisted#

Discriminator 1491adc8b611ea9a · events::denylisted::DenylistedEvent.

DenylisterChanged#

Discriminator f9aa51b4b9af8a48 · events::denylister_changed::DenylisterChangedEvent.

DepositForBurn#

Discriminator 90fc9192064aa7eb · events::deposit_for_burn::DepositForBurnEvent.

FeeRecipientSet#

Discriminator 638c5023f5b0b36e · events::fee_recipient_set::FeeRecipientSetEvent.

LocalTokenAdded#

Discriminator 9208e0967aad1727 · events::local_token_added::LocalTokenAddedEvent.

LocalTokenRemoved#

Discriminator b5cc015f023242d2 · events::local_token_removed::LocalTokenRemovedEvent.

MinFeeControllerSet#

Discriminator ef0c7a69e7720dc4 · events::min_fee_controller_set::MinFeeControllerSetEvent.

MinFeeSet#

Discriminator 3c7f65e6d881bc62 · events::min_fee_set::MinFeeSetEvent.

MintAndWithdraw#

Discriminator 4b43e546a27e0047 · events::mint_and_withdraw::MintAndWithdrawEvent.

OwnershipTransferStarted#

Discriminator b7fdeff68cb38569 · events::ownership_transfer_started::OwnershipTransferStartedEvent.

OwnershipTransferred#

Discriminator ac3dcdb7fa322662 · events::ownership_transferred::OwnershipTransferredEvent.

Pause#

Discriminator c2fbe8c4765f6fdb · events::pause::PauseEvent.

No fields.

PauserChanged#

Discriminator 8e9d9e577f087737 · events::pauser_changed::PauserChangedEvent.

RemoteTokenMessengerAdded#

Discriminator fb1d3ff43072d2af · events::remote_token_messenger_added::RemoteTokenMessengerAddedEvent.

RemoteTokenMessengerRemoved#

Discriminator ff798927e67d0b1e · events::remote_token_messenger_removed::RemoteTokenMessengerRemovedEvent.

SetBurnLimitPerMessage#

Discriminator 629858bff51e1bd1 · events::set_burn_limit_per_message::SetBurnLimitPerMessageEvent.

SetTokenController#

Discriminator c12cf353e64878d8 · events::set_token_controller::SetTokenControllerEvent.

TokenCustodyBurned#

Discriminator db8f6be2434bb22e · events::token_custody_burned::TokenCustodyBurnedEvent.

TokenPairLinked#

Discriminator 020eb1409b5dc48d · events::token_pair_linked::TokenPairLinkedEvent.

TokenPairUnlinked#

Discriminator 4ee8e6d0b4d4f648 · events::token_pair_unlinked::TokenPairUnlinkedEvent.

UnDenylisted#

Discriminator 9627e314a2b405f2 · events::un_denylisted::UnDenylistedEvent.

Unpause#

Discriminator f195685ac788db92 · events::unpause::UnpauseEvent.

No fields.

Types#

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

AcceptOwnershipParams#

Struct types::AcceptOwnershipParams.

No fields.

AddLocalTokenParams#

Struct types::AddLocalTokenParams.

No fields.

AddRemoteTokenMessengerParams#

Struct types::AddRemoteTokenMessengerParams.

BurnTokenCustodyParams#

Struct types::BurnTokenCustodyParams.

Denylisted#

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

DenylisterChanged#

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

DenylistParams#

Struct types::DenylistParams.

DepositForBurn#

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

DepositForBurnParams#

Struct types::DepositForBurnParams.

DepositForBurnWithHookParams#

Struct types::DepositForBurnWithHookParams.

FeeRecipientSet#

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

HandleReceiveMessageParams#

Struct types::HandleReceiveMessageParams.

InitializeParams#

Struct types::InitializeParams.

LinkTokenPairParams#

Struct types::LinkTokenPairParams.

LocalTokenAdded#

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

LocalTokenRemoved#

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

MinFeeControllerSet#

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

MinFeeSet#

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

MintAndWithdraw#

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

OwnershipTransferred#

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

OwnershipTransferStarted#

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

Pause#

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

PauseParams#

Struct types::PauseParams.

No fields.

PauserChanged#

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

RemoteTokenMessengerAdded#

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

RemoteTokenMessengerRemoved#

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

RemoveLocalTokenParams#

Struct types::RemoveLocalTokenParams.

No fields.

RemoveRemoteTokenMessengerParams#

Struct types::RemoveRemoteTokenMessengerParams.

No fields.

SetBurnLimitPerMessage#

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

SetFeeRecipientParams#

Struct types::SetFeeRecipientParams.

SetMaxBurnAmountPerMessageParams#

Struct types::SetMaxBurnAmountPerMessageParams.

SetMinFeeControllerParams#

Struct types::SetMinFeeControllerParams.

SetMinFeeParams#

Struct types::SetMinFeeParams.

SetTokenController#

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

SetTokenControllerParams#

Struct types::SetTokenControllerParams.

TokenCustodyBurned#

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

TokenPairLinked#

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

TokenPairUnlinked#

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

TransferOwnershipParams#

Struct types::TransferOwnershipParams.

UnDenylisted#

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

UndenylistParams#

Struct types::UndenylistParams.

UninkTokenPairParams#

Struct types::UninkTokenPairParams.

No fields.

Unpause#

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

UnpauseParams#

Struct types::UnpauseParams.

No fields.

UpdateDenylisterParams#

Struct types::UpdateDenylisterParams.

UpdatePauserParams#

Struct types::UpdatePauserParams.