Stake Program decoder

carbon-stake-program-decoder decodes the instructions of the Stake Program program (Stake11111111111111111111111111111111111111): 18 instructions. It decodes no accounts: StakeProgramAccount has no variants. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

Other core and SPL decoders: Address Lookup Table, Associated Token Account, SPL Memo, SPL Name Service, SPL Token, System Program, Token-2022. To decode several in one pipeline, see core and SPL program 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 Stake Program transactions from the public RPC and prints every decoded DelegateStake instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-stake-program-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_stake_program_decoder::{
        instructions::StakeProgramInstruction, StakeProgramDecoder, 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(StakeProgramDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

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

RUST_LOG=info cargo run

Each DelegateStake instruction prints one line with the transaction signature and the decoded DelegateStake 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 StakeProgramInstruction. Each is StakeProgramInstruction::<Variant> { program_id, data, accounts }, where data and accounts are the types listed under the variant, exported from carbon_stake_program_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 Stake11111111111111111111111111111111111111.
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.

Authorize#

Discriminator 01 · data Authorize · accounts AuthorizeInstructionAccounts.

Required accounts: 3 (4 listed); extras go to remaining.

Fields of AuthorizeInstructionAccounts, in account order:

AuthorizeChecked#

Discriminator 0a · data AuthorizeChecked · accounts AuthorizeCheckedInstructionAccounts.

Required accounts: 4 (5 listed); extras go to remaining.

Fields of AuthorizeCheckedInstructionAccounts, in account order:

AuthorizeCheckedWithSeed#

Discriminator 0b · data AuthorizeCheckedWithSeed · accounts AuthorizeCheckedWithSeedInstructionAccounts.

Required accounts: 4 (5 listed); extras go to remaining.

Fields of AuthorizeCheckedWithSeedInstructionAccounts, in account order:

AuthorizeWithSeed#

Discriminator 08 · data AuthorizeWithSeed · accounts AuthorizeWithSeedInstructionAccounts.

Required accounts: 3 (4 listed); extras go to remaining.

Fields of AuthorizeWithSeedInstructionAccounts, in account order:

Deactivate#

Discriminator 05 · data Deactivate · accounts DeactivateInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of DeactivateInstructionAccounts, in account order:

DeactivateDelinquent#

Discriminator 0e · data DeactivateDelinquent · accounts DeactivateDelinquentInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of DeactivateDelinquentInstructionAccounts, in account order:

DelegateStake#

Discriminator 02 · data DelegateStake · accounts DelegateStakeInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of DelegateStakeInstructionAccounts, in account order:

GetMinimumDelegation#

Discriminator 0d · data GetMinimumDelegation · accounts GetMinimumDelegationInstructionAccounts.

No data fields.

No named accounts.

Initialize#

Discriminator 00 · data Initialize · accounts InitializeInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of InitializeInstructionAccounts, in account order:

InitializeChecked#

Discriminator 09 · data InitializeChecked · accounts InitializeCheckedInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of InitializeCheckedInstructionAccounts, in account order:

Merge#

Discriminator 07 · data Merge · accounts MergeInstructionAccounts.

No data fields.

Required accounts: 5; extras go to remaining.

Fields of MergeInstructionAccounts, in account order:

MoveLamports#

Discriminator 11 · data MoveLamports · accounts MoveLamportsInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of MoveLamportsInstructionAccounts, in account order:

MoveStake#

Discriminator 10 · data MoveStake · accounts MoveStakeInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of MoveStakeInstructionAccounts, in account order:

Redelegate#

Discriminator 0f · data Redelegate · accounts RedelegateInstructionAccounts.

No data fields.

No named accounts.

SetLockup#

Discriminator 06 · data SetLockup · accounts SetLockupInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of SetLockupInstructionAccounts, in account order:

SetLockupChecked#

Discriminator 0c · data SetLockupChecked · accounts SetLockupCheckedInstructionAccounts.

Required accounts: 2 (3 listed); extras go to remaining.

Fields of SetLockupCheckedInstructionAccounts, in account order:

Split#

Discriminator 03 · data Split · accounts SplitInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SplitInstructionAccounts, in account order:

Withdraw#

Discriminator 04 · data Withdraw · accounts WithdrawInstructionAccounts.

Required accounts: 5 (6 listed); extras go to remaining.

Fields of WithdrawInstructionAccounts, in account order:

Types#

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

AuthorizeCheckedWithSeedParams#

Struct types::AuthorizeCheckedWithSeedParams.

Authorized#

Struct types::Authorized.

AuthorizeWithSeedParams#

Struct types::AuthorizeWithSeedParams.

Delegation#

Struct types::Delegation.

Epoch#

Alias types::Epoch = u64.

Lockup#

Struct types::Lockup.

LockupCheckedParams#

Struct types::LockupCheckedParams.

LockupParams#

Struct types::LockupParams.

Meta#

Struct types::Meta.

Stake#

Struct types::Stake.

StakeAuthorize#

Enum types::StakeAuthorize.

StakeFlags#

Struct types::StakeFlags.

StakeState#

Enum types::StakeState.

StakeStateV2#

Enum types::StakeStateV2.

UnixTimestamp#

Alias types::UnixTimestamp = i64.