Crate solana_sdk

The Solana host and client SDK.

This is the base library for all off-chain programs that interact with Solana or otherwise operate on Solana data structures. On-chain programs instead use the solana-program crate, the modules of which are re-exported by this crate, like the relationship between the Rust core and std crates. As much of the functionality of this crate is provided by solana-program, see that crate’s documentation for an overview.

Many of the modules in this crate are primarily of use to the Solana runtime itself. Additional crates provide capabilities built on solana-sdk, and many programs will need to link to those crates as well, particularly for clients communicating with Solana nodes over RPC.

Such crates include:

• solana-client - For interacting with a Solana node via the JSON-RPC API.
• solana-cli-config - Loading and saving the Solana CLI configuration file.
• solana-clap-utils - Routines for setting up the CLI using clap, as used by the Solana CLI. Includes functions for loading all types of signers supported by the CLI.

Re-exports

pub extern crate bs58;

pub use signer::signers;

Modules

account

The Solana Account type.

account_info

Account information.

account_utils

Useful extras for Account state.

address_lookup_table_account

The definition of address lookup table accounts.

alt_bn128

big_mod_exp

blake3

Hashing with the blake3 hash function.

borsh

Utilities for the borsh serialization format.

bpf_loader

The latest BPF loader native program.

bpf_loader_deprecated

The original and now deprecated Solana BPF loader.

bpf_loader_upgradeable

An upgradeable BPF loader native program.

builtins

Solana helper macros for declaring built-in programs.

client

Defines traits for blocking (synchronous) and non-blocking (asynchronous) communication with a Solana server as well a a trait that encompasses both.

clock

Information about the network’s clock, ticks, slots, etc.

commitment_config

Definitions of commitment levels.

compute_budget

The compute budget native program.

config

The config native program.

debug_account_data

Debug-formatting of account data.

decode_error

Converting custom error codes to enums.

derivation_path

BIP-44 derivation paths.

deserialize_utils

Serde helpers.

ed25519_instruction

Instructions for the ed25519 native program.

ed25519_program

The ed25519 native program.

entrypoint

The Rust-based BPF program entrypoint supported by the latest BPF loader.

entrypoint_deprecated

The Rust-based BPF program entrypoint supported by the original BPF loader.

epoch_info

Information about the current epoch.

epoch_schedule

Configuration for epochs and slots.

exit

Used by validators to run events on exit.

feature

Methods for working with Feature accounts.

feature_set

Collection of all runtime features.

fee

Fee structures.

fee_calculator

Calculation of transaction fees.

genesis_config

The chain’s genesis config.

hard_forks

The list of slot boundaries at which a hard fork should occur.

hash

Hashing with the SHA-256 hash function, and a general Hash type.

incinerator

A designated address for burning lamports.

inflation

configuration for network inflation

instruction

Types for directing the execution of Solana programs.

keccak

Hashing with the keccak (SHA-3) hash function.

lamports

Defines the LamportsError type.

loader_instruction

Instructions for the non-upgradable BPF loader.

loader_upgradeable_instruction

Instructions for the upgradable BPF loader.

message

Sequences of Instructions executed within a single transaction.

native_loader

The native loader native program.

native_token

Definitions for the native SOL token and its fractional lamports.

nonce

Durable transaction nonces.

nonce_account

Functions related to nonce accounts.

offchain_message

Off-chain message container for storing non-transaction messages.

packet

The definition of a Solana network packet.

poh_config

Definitions of Solana’s proof of history.

precompiles

Solana precompiled programs.

program

Cross-program invocation.

program_error

The ProgramError type and related definitions.

program_memory

Basic low-level memory operations.

program_option

A C representation of Rust’s Option, used across the FFI boundary for Solana program interfaces.

program_pack

The Pack serialization trait.

program_stubs

Implementations of syscalls used when solana-program is built for non-SBF targets.

program_utils

Contains a single utility function for deserializing from bincode.

pubkey

Solana account addresses.

quic

Definitions related to Solana over QUIC.

recent_blockhashes_account

Helpers for the recent blockhashes sysvar.

rent

Configuration for network rent.

reward_type

Enumeration of reward types.

rpc_port

RPC default port numbers.

sanitize

A trait for sanitizing values and members of over the wire messages.

sdk_ids

A vector of Solana SDK IDs.

secp256k1_instruction

Instructions for the secp256k1 native program.

secp256k1_program

The secp256k1 native program.

secp256k1_recover

Public key recovery from secp256k1 ECDSA signatures.

serde_varint

Integers that serialize to variable size.

serialize_utils

Helpers for reading and writing bytes.

short_vec

Compact serde-encoding of vectors with small length.

shred_version

Calculation of shred versions.

signature

Functionality for public and private keys.

signer

Abstractions and implementations for transaction signers.

slot_hashes

A type to hold data for the SlotHashes sysvar.

slot_history

A type to hold data for the SlotHistory sysvar.

stake

The stake native program.

stake_history

A type to hold data for the StakeHistory sysvar.

syscalls

Declarations of Solana program syscalls.

system_instruction

Instructions and constructors for the system program.

system_program

The system native program.

system_transaction

The system_transaction module provides functionality for creating system transactions.

sysvar

Access to special accounts with dynamically-updated data.

timing

The timing module provides std::time utility functions.

transaction

Atomically-committed sequences of instructions.

transaction_context

Data shared between program runtime and built-in programs as well as SBF programs.

transport

Defines the TransportError type.

vote

The vote native program.

Macros

custom_heap_default

Define the default global allocator.

custom_panic_default

Define the default global panic handler.

declare_builtin

Convenience macro to declare a built-in program.

declare_builtin_name

declare_deprecated_id

Same as declare_id except report that this id has been deprecated.

declare_deprecated_sysvar_id

Same as [declare_sysvar_id] except that it reports that this ID has been deprecated.

declare_id

Convenience macro to declare a static public key and functions to interact with it.

declare_sysvar_id

Declares an ID that implements SysvarId.

entrypointDeprecated

entrypoint_deprecatedDeprecated

impl_sysvar_get

Implements the Sysvar::get method for both SBF and host targets.

msg

Print a message to the log.

program_stubsDeprecated

pubkey

Convenience macro to define a static public key.

pubkeys

Convenience macro to define multiple static public keys.

respan

A proc-macro which respans the tokens in its first argument (a Path) to be resolved at the tokens of its second argument. For internal use only.

saturating_add_assign

Convenience macro for AddAssign with saturating arithmetic. Replace by std::num::Saturating once stable

unchecked_div_by_const

Convenience macro for doing integer division where the operation’s safety can be checked at compile-time.

Attribute Macros

wasm_bindgen