solana_kit_rpc_api #

RPC method type definitions and API composition for the Solana Kit Dart SDK.

This is the Dart port of @solana/rpc-api from the Solana TypeScript SDK.

Installation #

Install with:

dart pub add solana_kit_rpc_api

If you are working within the solana_kit monorepo, the package resolves through the Dart workspace. Otherwise, specify a version or path as needed.

Documentation #

• Package page: https://pub.dev/packages/solana_kit_rpc_api
• API reference: https://pub.dev/documentation/solana_kit_rpc_api/latest/

Usage #

Creating a Solana RPC API #

The createSolanaRpcApi function creates a JsonRpcApi that converts method calls into RpcPlan instances with the standard Solana transformers applied (BigInt downcast, integer overflow checking, default commitment).

import 'package:solana_kit_rpc_api/solana_kit_rpc_api.dart';
import 'package:solana_kit_rpc_spec/solana_kit_rpc_spec.dart';
import 'package:solana_kit_rpc_types/solana_kit_rpc_types.dart';

// Create with defaults.
final api = createSolanaRpcApi();

// Create with custom configuration.
final customApi = createSolanaRpcApi(SolanaRpcApiConfig(
  defaultCommitment: Commitment.finalized,
  onIntegerOverflow: (request, keyPath, value) {
    print('Integer overflow in ${request.methodName}: $value');
  },
));

Using with createRpc #

To build a full RPC client, wrap the API in an adapter and combine it with a transport:

import 'package:solana_kit_rpc_api/solana_kit_rpc_api.dart';
import 'package:solana_kit_rpc_spec/solana_kit_rpc_spec.dart';

final rpc = createRpc(
  RpcConfig(
    api: createSolanaRpcApiAdapter(SolanaRpcApiConfig(
      defaultCommitment: Commitment.confirmed,
    )),
    transport: myTransport,
  ),
);

// Now call any Solana RPC method.
final balance = await rpc.request('getBalance', [
  '83astBRguLMdt2h5U1Tbd4hU5SkfAWRkzG2HPM88BREAK',
]).send();

Method parameter builders #

Each RPC method has a corresponding config class and a params builder function. These construct the JSON-RPC parameter lists.

import 'package:solana_kit_addresses/solana_kit_addresses.dart';
import 'package:solana_kit_rpc_api/solana_kit_rpc_api.dart';
import 'package:solana_kit_rpc_types/solana_kit_rpc_types.dart';

// getBalance parameters.
final addr = address('83astBRguLMdt2h5U1Tbd4hU5SkfAWRkzG2HPM88BREAK');
final balanceParams = getBalanceParams(addr, GetBalanceConfig(
  commitment: Commitment.finalized,
));
// ['83astBRguLMdt2h5U1Tbd4hU5SkfAWRkzG2HPM88BREAK', {'commitment': 'finalized'}]

// getAccountInfo parameters.
final accountParams = getAccountInfoParams(addr, GetAccountInfoConfig(
  encoding: 'base64',
  commitment: Commitment.confirmed,
));

Checking method availability by cluster #

Not all RPC methods are available on all clusters. For example, requestAirdrop is only available on test clusters (devnet, testnet).

import 'package:solana_kit_rpc_api/solana_kit_rpc_api.dart';

// Check if a method is available on all clusters (including mainnet).
print(isSolanaRpcMethodForAllClusters('getBalance')); // true
print(isSolanaRpcMethodForAllClusters('requestAirdrop')); // false

// Check if a method is available on test clusters.
print(isSolanaRpcMethodForTestClusters('requestAirdrop')); // true

// Mainnet check (excludes requestAirdrop).
print(isSolanaRpcMethodForMainnet('getBalance')); // true
print(isSolanaRpcMethodForMainnet('requestAirdrop')); // false

Allowed numeric key paths #

The getAllowedNumericKeypaths function returns a mapping that tells the response transformer which values in RPC responses should remain as int rather than being upcast to BigInt. This is used internally by the default response transformer.

import 'package:solana_kit_rpc_api/solana_kit_rpc_api.dart';

final keypaths = getAllowedNumericKeypaths();
// Contains mappings like:
// 'getAccountInfo' -> [[..., 'decimals'], [..., 'uiAmount'], ...]
// 'getBlock' -> [[..., 'programIdIndex'], [..., 'stackHeight'], ...]

API Reference #

Classes #

• SolanaRpcApiConfig -- Configuration for creating a Solana RPC API. Fields:
  • defaultCommitment (Commitment?) -- Default commitment level.
  • onIntegerOverflow (IntegerOverflowHandler?) -- Callback for BigInt overflow detection.
• GetAccountInfoConfig -- Parameters for getAccountInfo (commitment, encoding, dataSlice, minContextSlot).
• GetBalanceConfig -- Parameters for getBalance (commitment, minContextSlot).
• GetBlockConfig -- Parameters for getBlock.
• GetBlockHeightConfig -- Parameters for getBlockHeight.
• GetLatestBlockhashConfig -- Parameters for getLatestBlockhash.
• GetProgramAccountsConfig -- Parameters for getProgramAccounts.
• GetSignatureStatusesConfig -- Parameters for getSignatureStatuses.
• GetSlotConfig -- Parameters for getSlot.
• GetTokenAccountsByOwnerConfig -- Parameters for getTokenAccountsByOwner.
• GetTransactionConfig -- Parameters for getTransaction.
• SendTransactionConfig -- Parameters for sendTransaction.
• SimulateTransactionConfig -- Parameters for simulateTransaction.

Functions #

• createSolanaRpcApi([SolanaRpcApiConfig? config]) -- Creates a JsonRpcApi with the standard Solana RPC transformers applied.
• createSolanaRpcApiAdapter([SolanaRpcApiConfig? config]) -- Creates an RpcApi adapter wrapping a Solana RPC API, for use with createRpc.
• isSolanaRpcMethodForAllClusters(String methodName) -- Returns true if the method is available on all clusters.
• isSolanaRpcMethodForTestClusters(String methodName) -- Returns true if the method is available on test clusters (includes requestAirdrop).
• isSolanaRpcMethodForMainnet(String methodName) -- Returns true if the method is available on mainnet.
• getAllowedNumericKeypaths() -- Returns the AllowedNumericKeypaths mapping for Solana RPC responses.
• getBalanceParams(Address, [GetBalanceConfig?]) -- Builds JSON-RPC params for getBalance.
• getAccountInfoParams(Address, [GetAccountInfoConfig?]) -- Builds JSON-RPC params for getAccountInfo.

Constants #

• solanaRpcMethodsForAllClusters -- List<String> of 51 RPC method names available on all clusters.
• solanaRpcMethodsForTestClusters -- List<String> of 52 RPC method names available on test clusters (includes requestAirdrop).

Supported RPC Methods #

The package defines parameter types and builders for all 52 Solana JSON-RPC methods: