solana_kit_compute_budget

Coverage website Compute Budget program client for the Solana Kit Dart SDK.

Provides instruction builders, codecs, and parsers for the Compute Budget program, which controls compute unit limits, priority fees, heap size, and loaded accounts data size.

Installation

Installation

Install the package directly:

dependencies:
  "solana_kit_compute_budget": ^0.8.2

If your app uses several Solana Kit packages together, you can also depend on the umbrella package instead:

dart pub add solana_kit

Inside this monorepo, Dart workspace resolution uses the local package automatically.

Usage

import 'package:solana_kit_compute_budget/solana_kit_compute_budget.dart';

void main() {
  // Set compute unit limit for a transaction.
  final limitIx = getSetComputeUnitLimitInstruction(
    programAddress: computeBudgetProgramAddress,
    units: 200000,
  );

  // Set priority fee (micro-lamports per compute unit).
  final priceIx = getSetComputeUnitPriceInstruction(
    programAddress: computeBudgetProgramAddress,
    microLamports: BigInt.from(50000),
  );

  // Request a larger heap frame (must be a multiple of 1024).
  final heapIx = getRequestHeapFrameInstruction(
    programAddress: computeBudgetProgramAddress,
    bytes: 256 * 1024,
  );

  // Limit loaded accounts data size.
  final dataLimitIx = getSetLoadedAccountsDataSizeLimitInstruction(
    programAddress: computeBudgetProgramAddress,
    accountDataSizeLimit: 64 * 1024,
  );

  print(limitIx.programAddress);
  print(priceIx.programAddress);
  print(heapIx.programAddress);
  print(dataLimitIx.programAddress);
}

Instructions

Instruction Discriminator Description
RequestUnits 0 Deprecated. Use SetComputeUnitLimit + SetComputeUnitPrice instead.
RequestHeapFrame 1 Request a specific heap frame size in bytes.
SetComputeUnitLimit 2 Set the transaction-wide compute unit limit.
SetComputeUnitPrice 3 Set the compute unit price for priority fees.
SetLoadedAccountsDataSizeLimit 4 Set a limit on loaded accounts data size.

Inspecting priority fees

findSetComputeUnitPriceInstructionIndexAndMicroLamports returns the full unsigned 64-bit price as a BigInt, including prices above 2^63 - 1. Compare this value with your application's fee cap before signing externally supplied transactions. The update helper passes the same unsigned value to its updater callback.

Upstream reference

Generated layer mirrors solana-program/compute-budget at js@v0.18.0.

Libraries

solana_kit_compute_budget
Compute Budget program client for the Solana Kit Dart SDK.