solana/solana_web3/solana_web3 library

Classes

AccountInfo<T>
Account Info
AccountMeta
Account Meta
AccountsFilter
Accounts Filter
AccountSubscribe
Account Subscribe
AccountSubscribeConfig
Account Subscribe Config
Base58To64Codec
Converts a base-58 encoded string to/from a base-64 encoded string.
Base58To64Decoder
Base-58 to Base-64 Decoder
Base58To64Encoder
Base-58 to Base-64 Encoder
Block
Block
BlockCommitment
Block Commitment
BlockhashCache
Blockhash Cache
BlockhashWithExpiryBlockHeight
Blockhash With Expiry Block Height
BlockProduction
Block Production
Client<R>
JSON RPC Client
Cluster
Cluster
ClusterNode
Cluster Node
CommitmentAndMinContextSlotConfig
Commitment and Min Context Slot Config
CommitmentConfig
Commitment Config
ConfirmedSignatureInfo
Confirmed Signature Info
Connection
Connection
DataSize
Data Size
DataSlice
Data Slice
Ed25519Keypair
Ed25519 Keypair
EpochInfo
Epoch Info
EpochSchedule
Epoch Schedule
FeeCalculator
Fee Calculator
Filter
GetAccountInfo<T>
Get Account Info
GetAccountInfoConfig
Get Account Info Config
GetBalance
Get Balance
GetBlock
Get Block
GetBlockCommitment
Get Block Commitment
GetBlockConfig
Get Block Config
GetBlockHeight
Get Block Height
GetBlockProduction
Get Block Production
GetBlockProductionConfig
Get Block Production Config
GetBlocks
Get Blocks
GetBlocksConfig
Get Blocks Config
GetBlocksWithLimit
Get Blocks With Limit
GetBlockTime
Get Block Time
GetClusterNodes
Get Cluster Nodes
GetEpochInfo
Get Epoch Info
GetEpochSchedule
Get Epoch Schedule
GetFeeForMessage
Get Fee For Message
GetFirstAvailableBlock
Get First Available Block
GetGenesisHash
Get Genesis Hash
GetHealth
Get Health
GetHighestSnapshotSlot
Get Highest Snapshot Slot
GetIdentity
Get Identity
GetInflationGovernor
Get Inflation Governor
GetInflationRate
Get Inflation Rate
GetInflationReward
Get Inflation Reward
GetInflationRewardConfig
Get Inflation Reward Config
GetLargestAccounts
Get Largest Accounts
GetLargestAccountsConfig
Get Largest Accounts Config
GetLatestBlockhash
Get Latest Blockhash
GetLeaderSchedule
Get Leader Schedule
GetLeaderScheduleConfig
Get Leader Schedule Config
GetMaxRetransmitSlot
Get Max Retransmit Slot
GetMaxShredInsertSlot
Get Max Shred Insert Slot
GetMinimumBalanceForRentExemption
Get Minimum Balance For Rent Exemption
GetMultipleAccounts
Get Multiple Accounts
GetNonceAccountConfig
Get Nonce Account Config
GetParsedAccountInfoConfig
Get Parsed Account Info Config
GetProgramAccounts
Get Program Accounts
GetProgramAccountsConfig
Get Program Accounts Config
GetRecentPerformanceSamples
Get Recent Performance Samples
GetRecentPrioritizationFees
Get Recent Performance Samples
GetSignaturesForAddress
Get Signatures For Address
GetSignaturesForAddressConfig
Get Signatures For Address Config
GetSignatureStatuses
Get Signature Statuses
GetSignatureStatusesConfig
Get Signature Statuses Config
GetSlot
Get Slot
GetSlotLeader
Get Slot Leader
GetSlotLeaders
Get Slot Leaders
GetStakeActivation
Get Stake Activation
GetStakeActivationConfig
Get Stake Activation Config
GetStakeMinimumDelegation
Get Stake Minimum Delegation
GetSupply
Get Supply
GetSupplyConfig
Get Supply Config
GetTokenAccountBalance
Get Token Account Balance
GetTokenAccountsByDelegate
Get Token Accounts By Delegate
GetTokenAccountsByOwner
Get Token Accounts By Owner
GetTokenLargestAccounts
Get Token Largest Accounts
GetTokenSupply
Get Token Supply
GetTransaction
Get Transaction
GetTransactionConfig
Get Transaction Config
GetTransactionCount
Get Transaction Count
GetVersion
Get Version
GetVoteAccounts
Get Vote Accounts
GetVoteAccountsConfig
Get Vote Accounts Config
HighestSnapshotSlot
Highest Snapshot Slot
Identity
Identity
InflationGovernor
Inflation Governor
InflationRate
Inflation Rate
InflationReward
Inflation Reward
InnerInstruction
Inner Instruction
IsBlockhashValid
Is Blockhash Valid
JsonRpcClientConfig
A JSON RPC client request configurations.
JsonRpcContext
JSON RPC Context
JsonRpcContextMethod<S, T>
JSON RPC Context Method Decoder
JsonRpcErrorResponse<T>
JSON RPC Error Response
JsonRpcExceptionCode
JSON RPC Exception Codes
JsonRpcHttpClient
JSON RPC HTTP Client
JsonRpcMethod<S, T>
JSON RPC Method
JsonRpcMethodBuilder<S, T>
JSON RPC Method Builder
JsonRpcNotification<T>
JSON RPC Notification
JsonRpcNotificationResponse<T>
JSON RPC Notification
JsonRpcRequest
JSON RPC Request
JsonRpcResponse<T>
JSON RPC Response
JsonRpcResponseContext<T>
JSON RPC Response Context
JsonRpcSuccessResponse<T>
JSON RPC Success Response
JsonRpcWebsocketClient<R>
JSON RPC Websocket Client
Keypair
Keypair
LargeAccount
Large Account
LoadedAddress
Loaded Address
LogsFilter<T extends Object>
Logs Filter
LogsNotification
Logs Notification
LogsSubscribe
Logs Subscribe
MemCmp
Memory Comparison
Message
Message
MessageHeader
Message Header
MessageInstruction
Message Instruction
Meta
Meta
MinimumLedgerSlot
Minimum Ledger Slot
MintAccountInfo
Mint Account Info
NonceAccount
Nonce Account
NonceInformation
Nonce Information
NonceWithMinContextSlot
Nonce with Min Context Slot
PerformanceSample
Performance Sample
PrioritizationFee
Prioritization Fee
ProgramAccount
ProgramAccount
ProgramAddress
Program Address
ProgramSubscribe
Program Subscribe
ProgramSubscribeConfig
Program Subscribe Config
Pubkey
Public Key
RequestAirdrop
Request Airdrop
Reward
Reward
SendAndConfirmTransactionConfig
Send And Confirm Transaction Config
SendTransaction
Send Transaction
SendTransactionConfig
Send Transaction Config
Serializable
A JSON serializable object.
SignatureNotification
Signature Notification
SignatureStatus
Signature Status
SignatureSubscribe
Signature Subscribe
Signer
Signer
SimulateTransaction
Simulate Transaction
SimulateTransactionConfig
Simulate Transaction Config
SlotNotification
Slot Notification
SlotRange
Slot Range
SlotSubscribe
Slot Subscribe
StakeAccount
Stake Account
StakeAccountInfo
Stake Account Info
StakeActivation
Stake Activation
Supply
Supply
TokenAccount
Token Account
TokenAccountInfo
Token Account Info
TokenAccountsFilter
Token Accounts Filter
TokenAmount
Token Amount
TokenBalance
Token Balance
Transaction
Transaction
TransactionData<T extends Object>
Transaction Data
TransactionInfo<T extends Object>
Transaction Info
TransactionInstruction
Transaction Instruction
TransactionSerializable
A serializable transaction interface.
TransactionSerializableConfig
Transaction Serializable Config
TransactionStatus
Transaction Status
UITokenAmount
UI Token Amount
Version
Version
VoteAccount
Vote Account
VoteAccountStatus
Vote Account Status
WebsocketSubscription<T>
Websocket Subscription

Enums

AccountEncoding
AccountFilter
AccountState
Commitment
Commitments
HealthStatus
The result of a GET /health endpoint call that provides a health-check mechanism for use by load balancers or other network infrastructure. This request will always return a HTTP 200 OK response with a body of "ok", "behind" or "unknown" based on the following conditions:
RewardType
TransactionDetail
TransactionEncoding

Mixins

SerializableMixin
Serializable Mixin
TransactionSerializableMixin
Transaction Serializable Mixin

Extensions

IterableSerializable on Iterable<SerializableMixin>
Iterable Serializable Extension
NumToBigInt on num

Constants

base58To64 → const Base58To64Codec
Base-58 to Base-64 Codec
lamportsPerSol → const int
Lamports

Functions

base58Decode(String encoded) → Uint8List
Decodes a base-58 encoded string.
base58Encode(Uint8List input) → String
Base-58 Codec
base58To64Decode(String base64) → String
Converts a base-64 encoded string to base-58.
base58To64Encode(String base58) → String
Converts a base-58 encoded string to base-64.
check(bool condition, [Object? message]) → void
Asserts that condition is true.
checkEq(int value, int limit, [Object? label]) → void
Asserts that value is equal to limit.
checkGt(int value, int limit, [Object? label]) → void
Asserts that value is greater than limit.
checkGte(int value, int limit, [Object? label]) → void
Asserts that value is greater than or equal to limit.
checkLt(int value, int limit, [Object? label]) → void
Asserts that value is less than limit.
checkLte(int value, int limit, [Object? label]) → void
Asserts that value is less than or equal to limit.
checkThrow(bool condition, Object callback()) → void
Asserts that condition is true.
decodeLength(BufferReader reader) → int
Shortvec Encoding (Compact-u16 Format)
encodeLength(int length) → List<int>
Encodes length into a byte array.
hexDecode(String encoded) → Uint8List
Decodes a hexadecimal encoded string.
hexEncode(Uint8List input) → String
Hex (Base-16) Codec
lamportsToSol(BigInt lamports) → double
Converts lamports to sol.
solToLamports(num sol) → BigInt
Converts sol to lamports.

Typedefs

Blockhash = String
A unique base-58 encoded hash that identifies a record (block).
bu64 = BigInt
ConfirmTransactionConfig = CommitmentConfig
Confirm Transaction Config
f32 = double
f64 = double
GetBalanceConfig = CommitmentAndMinContextSlotConfig
Get Balance Config
GetBlockHeightConfig = CommitmentAndMinContextSlotConfig
Get Block Height Config
GetBlocksWithLimitConfig = GetBlocksConfig
Get Blocks With Limit Config
GetEpochInfoConfig = CommitmentAndMinContextSlotConfig
Get Epoch Info Config
GetFeeForMessageConfig = CommitmentConfig
Get Fee For Message Config
GetInflationGovernorConfig = CommitmentConfig
Get Inflation Governor Config
GetLatestBlockhashConfig = CommitmentAndMinContextSlotConfig
Get Latest Blockhash Config
GetMinimumBalanceForRentExemptionConfig = CommitmentConfig
Get Minimum Balance For Rent Exemption Config
GetMultipleAccountsConfig = GetAccountInfoConfig
Get Multiple Accounts Config
GetSlotConfig = CommitmentAndMinContextSlotConfig
Get Slot Config
GetSlotLeaderConfig = CommitmentAndMinContextSlotConfig
Get Slot Leader Config
GetStakeMinimumDelegationConfig = CommitmentConfig
Get Stake Minimum Delegation Config
GetTokenAccountBalanceConfig = CommitmentConfig
Get Token Account Balance Config
GetTokenAccountsByDelegateConfig = GetAccountInfoConfig
Get Token Accounts By Delegate Config
GetTokenAccountsByOwnerConfig = GetAccountInfoConfig
Get Token Accounts By Owner Config
GetTokenLargestAccountsConfig = CommitmentConfig
Get Token Largest Accounts Config
GetTokenSupplyConfig = CommitmentConfig
Get Token Supply Config
GetTransactionCountConfig = CommitmentAndMinContextSlotConfig
Get Transaction Count Config
i16 = int
i32 = int
i64 = int
i8 = int
IsBlockhashValidConfig = CommitmentAndMinContextSlotConfig
Is Blockhash Valid Config
isize = int
JsonRpcClientDecoder<T> = Converter<T, FutureOr>
Converts a JSON RPC response of type T to JSON.
JsonRpcClientEncoder = Converter<Object, FutureOr<List<int>>>
Types
JsonRpcContextResponse<T> = JsonRpcSuccessResponse<JsonRpcResponseContext<T>>
Types
JsonRpcResponseDecoder<S, T> = T Function(S input)
Converts a JSON object to type T, where T is a JsonRpcResponse or list of JsonRpcResponses.
JsonRpcSubscribeMethod = JsonRpcMethod<int, int>
Types
JsonRpcSubscribeResponse = JsonRpcSuccessResponse<int>
A JsonRpcSuccessResponse subscribe methods.
JsonRpcUnsubscribeMethod = JsonRpcMethod<bool, bool>
A JsonRpcMethod for unsubscribe methods.
JsonRpcUnsubscribeResponse = JsonRpcSuccessResponse<bool>
A JsonRpcSuccessResponse unsubscribe methods.
JsonRpcWebsocketClientIsPing<R> = bool Function(R data)
The isPing callback handler.
JsonRpcWebsocketClientOnConnect<R> = void Function()
Types
JsonRpcWebsocketClientOnData<R> = void Function(dynamic data)
The onData callback handler.
JsonRpcWebsocketClientOnDisconnect = void Function()
The onDisconnect callback handler.
JsonRpcWebsocketClientOnError = void Function(Object error, [StackTrace? stackTrace])
The onError callback handler.
JsonRpcWebsocketClientOnPing<R> = void Function(R data)
The onPing callback handler.
LeaderSchedule = Map<String, List>
Validator identities, as base-58 encoded strings, and their corresponding leader slot indices as values (indices are relative to the first slot in the requested epoch).
LogsSubscribeConfig = CommitmentConfig
Logs Subscribe Config
RequestAirdropConfig = CommitmentConfig
Request Airdrop Config
SignatureSubscribeConfig = CommitmentConfig
Signature Subscribe Config
SubscriptionId = int
A subscription's unique identifier.
TransactionSignature = String
A base-58 encoded transaction signature.
u16 = int
u32 = int
u64 = int
u8 = int
usize = int

Exceptions / Errors

JsonRpcException
JSON RPC Exception
SolanaException
Solana Exception