Callback function for account change notifications
Information describing an account
Optional data assigned to the account
true if this account's data contains a loaded program
Number of lamports assigned to the account
Identifier of the program that owns the account
Optional rent epoch info for account
Account metadata used to define instructions
True if an instruction requires a transaction signature matching pubkey
True if the pubkey can be loaded as a read-write account.
An account's public key
A processed block fetched from the RPC API where the transactionDetails mode is accounts
Advance nonce account system instruction params
Allocate account system transaction params
Account to allocate
Amount of space in bytes to allocate
Allocate account with seed system transaction params
Account to allocate
Base public key to use to derive the address of the allocated account
Public key of the program to assign as the owner of the allocated account
Seed to use to derive the address of the allocated account
Amount of space in bytes to allocate
Assign system transaction params
Assign account with seed system transaction params
Public key of the account which will be assigned a new owner
Base public key to use to derive the address of the assigned account
Public key of the program to assign as the owner
Seed to use to derive the address of the assigned account
Authorize nonce account system transaction params
Authorize stake instruction params
Authorize instruction params
Current vote or withdraw authority, depending on voteAuthorizationType
AuthorizeWithSeed instruction params
Authorize stake instruction params using a derived key
Properties shared by all transaction confirmation strategies
recent block production information
A processed block fetched from the RPC API
The unix timestamp of when the block was processed
Blockhash of this block
Slot index of this block's parent
Blockhash of this block's parent
Vector of block rewards
Vector of transactions with status meta and original message
A Block on the ledger with signatures only
Blockhash as Base58 string.
A strategy for confirming transactions that uses the last valid block height for a given blockhash to check for transaction expiration.
The level of commitment desired when querying state
'processed': Query the most recent block which has reached 1 confirmation by the connected node 'confirmed': Query the most recent block which has reached 1 confirmation by the cluster 'finalized': Query the most recent block which has been finalized by the cluster
An instruction to execute by a program
Ordered indices into the transaction keys array indicating which accounts to pass to the program
The program input data encoded as base 58
Index into the transaction keys array indicating the program account that executes this instruction
An enumeration of valid ComputeBudgetInstructionType's
Options for confirming transactions
desired commitment level
Maximum number of times for the RPC node to retry sending the transaction to the leader.
The minimum slot that the request can be evaluated at
preflight commitment level
disable transaction verification step
A confirmed block on the ledger
The unix timestamp of when the block was processed
Blockhash of this block
Slot index of this block's parent
Blockhash of this block's parent
Vector of block rewards
Vector of transactions and status metas
A confirmed signature with its status
The unix timestamp of when the transaction was processed
Cluster confirmation status, if available. Possible values: processed, confirmed, finalized
error, if any
memo associated with the transaction, if any
the transaction signature
when the transaction was processed
Options for getConfirmedSignaturesForAddress2
Start searching backwards from this transaction signature.
Maximum transaction signatures to return (between 1 and 1,000, default: 1,000).
Search until this transaction signature is reached, if found before limit.
A confirmed transaction on the ledger
The unix timestamp of when the transaction was processed
Metadata produced from the transaction
The slot during which the transaction was processed
The details of the transaction
Metadata for a confirmed transaction on the ledger
The compute units consumed after processing the transaction
The error result of transaction processing
The fee charged for processing the transaction
An array of cross program invoked instructions
The collection of addresses loaded using address lookup tables
An array of program log messages emitted during a transaction
The balances of the transaction accounts after processing
The token balances of the transaction accounts after processing
The balances of the transaction accounts before processing
The token balances of the transaction accounts before processing
Configuration for instantiating a Connection
Optional commitment level
time to allow for the server to initially process a transaction (in milliseconds)
Optional Disable retrying calls when server responds with HTTP 429 (Too Many Requests)
Optional custom fetch function
Optional fetch middleware callback
An http.Agent that will be used to manage socket connections (eg. to implement connection
persistence). Set this to false to create a connection that uses no agent. This applies to
Node environments only.
Optional HTTP headers object
Optional endpoint URL to the fullnode JSON RPC PubSub WebSocket Endpoint
Information describing a cluster node
Gossip network address for the node
Identity public key of the node
JSON RPC network address for the node (null if not available)
TPU network address for the node (null if not available)
Software version of the node (null if not available)
Extra contextual information for RPC responses
Create account system transaction params
The account that will transfer lamports to the created account
Amount of lamports to transfer to the created account
Public key of the created account
Public key of the program to assign as the owner of the created account
Amount of space in bytes to allocate to the created account
Create account with seed system transaction params
Base public key to use to derive the address of the created account. Must be the same as the base key used to create newAccountPubkey
The account that will transfer lamports to the created account
Amount of lamports to transfer to the created account
Public key of the created account. Must be pre-calculated with PublicKey.createWithSeed()
Public key of the program to assign as the owner of the created account
Seed to use to derive the address of the created account. Must be the same as the seed used to create newAccountPubkey
Amount of space in bytes to allocate to the created account
Params for creating an ed25519 instruction using a private key
Params for creating an ed25519 instruction using a public key
Create nonce account system transaction params
Public key to set as authority of the created nonce account
The account that will transfer lamports to the created nonce account
Amount of lamports to transfer to the created nonce account
Public key of the created nonce account
Create nonce account with seed system transaction params
Public key to set as authority of the created nonce account
Base public key to use to derive the address of the nonce account
The account that will transfer lamports to the created nonce account
Amount of lamports to transfer to the created nonce account
Public key of the created nonce account
Seed to use to derive the address of the nonce account
Params for creating an secp256k1 instruction using an Ethereum address
Params for creating an secp256k1 instruction using a private key
Params for creating an secp256k1 instruction using a public key
Create stake account transaction params
Authorities of the new stake account
Address of the account which will fund creation
Funding amount
Lockup of the new stake account
Address of the new stake account
Create stake account with seed transaction params
Create vote account transaction params
Data size comparison filter for getProgramAccounts
Size of data for program account data length comparison
Data slice argument for getProgramAccounts
length of data slice
offset of data slice
Deactivate stake instruction params
Decoded transfer system transaction instruction
Decoded transferWithSeed system transaction instruction
Base public key to use to derive the funding account address
Account that will transfer lamports
Amount of lamports to transfer
Program id to use to derive the funding account address
Seed to use to derive the funding account address
Account that will receive transferred lamports
Delegate stake instruction params
A durable nonce is a 32 byte value encoded as a base58 string.
A strategy for confirming durable nonce transactions.
A 64 byte secret key, the first 32 bytes of which is the private scalar and the last 32 bytes is the public key. Read more: https://blog.mozilla.org/warner/2011/11/29/ed25519-keys/
History of how many credits earned by the end of each epoch
Information about the current epoch
List of Public Keys to be added to the lookup table.
Account which is the current authority.
Address lookup table account to extend.
Account that will fund the table reallocation. Not required if the reallocation has already been funded.
The type of the JavaScript fetch() API
A subset of Commitment levels, which are at least optimistically confirmed
'confirmed': Query the most recent block which has reached 1 confirmation by the cluster 'finalized': Query the most recent block which has been finalized by the cluster
Configuration object for changing getAccountInfo query behavior
The level of commitment desired
Optional data slice to limit the returned account data
The minimum slot that the request can be evaluated at
Configuration object for changing getBalance query behavior
The level of commitment desired
The minimum slot that the request can be evaluated at
Configuration object for changing getBlock query behavior
The level of finality desired
Whether to populate the rewards array. If parameter not provided, the default includes rewards.
Level of transaction detail to return, either "full", "accounts", "signatures", or "none". If parameter not provided, the default detail level is "full". If "accounts" are requested, transaction details only include signatures and an annotated list of accounts in each transaction. Transaction metadata is limited to only: fee, err, pre_balances, post_balances, pre_token_balances, and post_token_balances.
Configuration object for changing getBlockHeight query behavior
The level of commitment desired
The minimum slot that the request can be evaluated at
Optional commitment level
Only return results for this validator identity (base-58 encoded)
Slot range to return block production for. If parameter not provided, defaults to current epoch.
first slot to return block production information for (inclusive)
last slot to return block production information for (inclusive). If parameter not provided, defaults to the highest slot
Configuration object for changing getEpochInfo query behavior
The level of commitment desired
The minimum slot that the request can be evaluated at
Configuration object for changing getInflationReward query behavior
The level of commitment desired
An epoch for which the reward occurs. If omitted, the previous epoch will be used
The minimum slot that the request can be evaluated at
Configuration object for changing getLargestAccounts query behavior
The level of commitment desired
Filter largest accounts by whether they are part of the circulating supply
Configuration object for changing getLatestBlockhash query behavior
The level of commitment desired
The minimum slot that the request can be evaluated at
Configuration object for getMultipleAccounts
Optional commitment level
Optional data slice to limit the returned account data
The minimum slot that the request can be evaluated at
Configuration object for getNonceAndContext
Optional commitment level
The minimum slot that the request can be evaluated at
Configuration object for getNonce
Optional commitment level
The minimum slot that the request can be evaluated at
Configuration object for getParsedProgramAccounts
Optional commitment level
Optional array of filters to apply to accounts
The minimum slot that the request can be evaluated at
Configuration object for getProgramAccounts requests
Optional commitment level
Optional data slice to limit the returned account data
Optional encoding for account data (default base64)
To use "jsonParsed" encoding, please refer to getParsedProgramAccounts in connection.ts
Optional array of filters to apply to accounts
The minimum slot that the request can be evaluated at
A filter object for getProgramAccounts
Configuration object for changing getSlot query behavior
The level of commitment desired
The minimum slot that the request can be evaluated at
Configuration object for changing getSlotLeader query behavior
The level of commitment desired
The minimum slot that the request can be evaluated at
Configuration object for getStakeActivation
Optional commitment level
Epoch for which to calculate activation details. If parameter not provided, defaults to current epoch
The minimum slot that the request can be evaluated at
Configuration object for changing getStakeMinimumDelegation query behavior
The level of commitment desired
Configuration object for changing getSupply request behavior
The level of commitment desired
Exclude non circulating accounts list from response
Configuration object for getStakeActivation
Optional commitment level
The minimum slot that the request can be evaluated at
Configuration object for changing getTransaction query behavior
The level of finality desired
Configuration object for getStakeActivation
Optional commitment level
The minimum slot that the request can be evaluated at
Configuration object for changing getBlock query behavior
The level of finality desired
The max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned
Whether to populate the rewards array. If parameter not provided, the default includes rewards.
Level of transaction detail to return, either "full", "accounts", "signatures", or "none". If parameter not provided, the default detail level is "full". If "accounts" are requested, transaction details only include signatures and an annotated list of accounts in each transaction. Transaction metadata is limited to only: fee, err, pre_balances, post_balances, pre_token_balances, and post_token_balances.
Configuration object for changing getTransaction query behavior
The level of finality desired
The max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned
An object defining headers to be passed to the RPC server
Network Inflation (see https://docs.solana.com/implemented-proposals/ed_overview)
epoch for which these values are valid
inflation allocated to the foundation
total inflation
inflation allocated to validators
The inflation reward for an epoch
reward amount in lamports
vote account commission when the reward was credited
the slot in which the rewards are effective
epoch for which the reward occurs
post balance of the account in lamports
Info used to identity validators.
optional, extra information the validator chose to share
optional, used to identify validators on keybase.io
validator name
optional, validator website
InitializeAccount instruction params
Initialize nonce account system instruction params
Initialize stake instruction params
Account information identified by pubkey
Filter for largest accounts query
'circulating': Return the largest accounts that are part of the circulating supply 'nonCirculating': Return the largest accounts that are not part of the circulating supply
Leader schedule (see https://docs.solana.com/terminology#leader-schedule)
Collection of addresses loaded by a transaction using address table lookups
Logs result.
Filter for log subscriptions.
An enumeration of valid LookupTableInstructionType's
Memory comparison filter for getProgramAccounts
data to match, as base-58 encoded string and limited to less than 129 bytes
offset into program account data to start comparison
Merge stake instruction params
An address table lookup used to load additional accounts
Message constructor arguments
All the account keys used by this transaction
The message header, identifying signed and read-only accountKeys
Instructions that will be executed in sequence and committed in one atomic transaction if all succeed.
The hash of a recent ledger block
An instruction to execute by a program
Ordered indices into the transaction keys array indicating which accounts to pass to the program
The program input data
Index into the transaction keys array indicating the program account that executes this instruction
The message header, identifying signed and read-only account
The last numReadonlySignedAccounts of the signed keys are read-only accounts
The last numReadonlySignedAccounts of the unsigned keys are read-only accounts
The number of signatures required for this message to be considered valid. The
signatures must match the first numRequiredSignatures of accountKeys.
Message constructor arguments
Instructions that will be executed in sequence and committed in one atomic transaction if all succeed.
Instructions that will be executed in sequence and committed in one atomic transaction if all succeed.
The message header, identifying signed and read-only accountKeys
The hash of a recent ledger block
The static account keys used by this transaction
Nonce information to be used to build an offline Transaction.
The current blockhash stored in the nonce
AdvanceNonceAccount Instruction
A processed block fetched from the RPC API where the transactionDetails mode is none
Parsed account data
Parsed account data
Name of the program that owns this account
Space used by account data
A block with parsed transactions where the transactionDetails mode is accounts
A parsed address table lookup
Address lookup table account key
Parsed instruction info
Parsed instruction info
A block with parsed transactions
The number of blocks beneath this block
The unix timestamp of when the block was processed
Blockhash of this block
Slot index of this block's parent
Blockhash of this block's parent
Vector of block rewards
Vector of transactions with status meta and original message
A parsed and confirmed transaction on the ledger
Metadata for a parsed confirmed transaction on the ledger
A parsed transaction instruction
Parsed instruction info
Name of the program for this instruction
ID of the program for this instruction
A parsed transaction message
Accounts used in the instructions
Address table lookups used to load additional accounts
The atomically executed instructions for the transaction
Recent blockhash
A parsed transaction message account
Public key of the account
Indicates if the account signed the transaction
Indicates if the account key came from the transaction or a lookup table
Indicates if the account is writable for this transaction
A block with parsed transactions where the transactionDetails mode is none
A parsed transaction
Message of the transaction
Signatures for the transaction
Metadata for a parsed transaction on the ledger
The compute units consumed after processing the transaction
The error result of transaction processing
The fee charged for processing the transaction
An array of cross program invoked parsed instructions
The collection of addresses loaded using address lookup tables
An array of program log messages emitted during a transaction
The balances of the transaction accounts after processing
The token balances of the transaction accounts after processing
The balances of the transaction accounts before processing
The token balances of the transaction accounts before processing
A parsed transaction on the ledger with meta
The unix timestamp of when the transaction was processed
Metadata produced from the transaction
The slot during which the transaction was processed
The details of the transaction
The version of the transaction message
A partially decoded transaction instruction
A performance sample
Number of slots in a sample window
Number of transactions in a sample window
Sample window in seconds
Slot number of sample
Callback function for program account change notifications
JSON object representation of PublicKey class
Value to be converted into public key
Request heap frame instruction params
Requested transaction-wide program heap size in bytes. Must be multiple of 1024. Applies to each program, including CPIs.
Callback function for root change notifications
RPC Response with extra contextual information
response context
response value
Options for sending transactions
Maximum number of times for the RPC node to retry sending the transaction to the leader.
The minimum slot that the request can be evaluated at
preflight commitment level
disable transaction verification step
Configuration object for Transaction.serialize()
Require all transaction signatures be present (default: true)
Verify provided signatures (default: true)
Pair of signature and corresponding public key
Signature received notification
Signature result
Callback function for signature status notifications
Signature status
cluster confirmation status, if data available. Possible responses: processed, confirmed, finalized
the number of blocks that have been confirmed and voted on in the fork containing slot
transaction error, if any
when the transaction was processed
Configuration object for changing query behavior
enable searching status history, not needed for recent transactions
Signature status notification with transaction result
Callback function for signature notifications
Signature subscription options
Options for getSignaturesForAddress
Start searching backwards from this transaction signature.
Maximum transaction signatures to return (between 1 and 1,000, default: 1,000).
The minimum slot that the request can be evaluated at
Search until this transaction signature is reached, if found before limit.
Optional parameter used to specify a list of account addresses to return post simulation state for
Optional parameter used to set the commitment level when selecting the latest block
Optional parameter used to specify the minimum block slot that can be used for simulation
Optional parameter used to replace the simulated transaction's recent blockhash with the latest blockhash
Optional parameter used to enable signature verification before simulation
Optional data assigned to the account
true if this account's data contains a loaded program
Number of lamports assigned to the account
Identifier of the program that owns the account
Optional rent epoch info for account
Callback function for slot change notifications
Information about the latest slot being processed by a node
Parent of the current slot
The root block of the current slot's fork
Currently processing slot
Slot updates which can be used for tracking the live progress of a cluster.
"firstShredReceived": connected node received the first shred of a block.
Indicates that a new block that is being produced."completed": connected node has received all shreds of a block. Indicates
a block was recently produced."optimisticConfirmation": block was optimistically confirmed by the
cluster. It is not guaranteed that an optimistic confirmation notification
will be sent for every finalized blocks."root": the connected node rooted this block."createdBank": the connected node has started validating this block."frozen": the connected node has validated this block."dead": the connected node failed to validate this block.Callback function for slot update notifications
Split stake instruction params
Split with seed transaction params
Stake Activation data
stake active during the epoch
stake inactive during the epoch
the stake account's activation state
Stake authorization type
The Stake Authorization index (from solana-stake-program)
An enumeration of valid StakeInstructionType's
Supply
Circulating supply in lamports
Non-circulating supply in lamports
List of non-circulating account addresses
Total supply in lamports
An enumeration of valid SystemInstructionType's
Token address and balance.
Address of the token account
Raw amount of tokens as string ignoring decimals
Number of decimals configured for token's mint
Token amount as float, accounts for decimals
Token amount as string, accounts for decimals
Token amount object which returns a token amount in different formats for various client use cases.
Raw amount of tokens as string ignoring decimals
Number of decimals configured for token's mint
Token amount as float, accounts for decimals
Token amount as string, accounts for decimals
Blockhash-based transactions have a lifetime that are defined by the blockhash they include. Any transaction whose blockhash is too old will be rejected.
A recent blockhash
The transaction fee payer
the last block chain can advance to before tx is exportd expired
One or more signatures
Transaction confirmation status
'processed': Transaction landed in a block which has reached 1 confirmation by the connected node 'confirmed': Transaction landed in a block which has reached 1 confirmation by the cluster 'finalized': Transaction landed in a block which has been finalized by the cluster
This type represents all transaction confirmation strategies
List of Transaction object fields that may be initialized at construction
The transaction fee payer
Optional nonce information used for offline nonce'd transactions
A recent blockhash
One or more signatures
Transaction error
List of TransactionInstruction object fields that may be initialized at construction
Use these options to construct a durable nonce transaction.
The transaction fee payer
One or more signatures
A processed transaction from the RPC API
The unix timestamp of when the transaction was processed
Metadata produced from the transaction
The slot during which the transaction was processed
The transaction
The transaction message
The transaction signatures
Transaction signature as base-58 encoded string
Transfer system transaction params
Transfer with seed system transaction params
Base public key to use to derive the funding account address
Account that will transfer lamports
Amount of lamports to transfer
Program id to use to derive the funding account address
Seed to use to derive the funding account address
Account that will receive transferred lamports
Version info for a node
Version of solana-core
A processed block fetched from the RPC API where the transactionDetails mode is accounts
A processed block fetched from the RPC API
The unix timestamp of when the block was processed
Blockhash of this block
Slot index of this block's parent
Blockhash of this block's parent
Vector of block rewards
Vector of transactions with status meta and original message
A processed block fetched from the RPC API where the transactionDetails mode is none
A processed transaction from the RPC API
The unix timestamp of when the transaction was processed
Metadata produced from the transaction
The slot during which the transaction was processed
The transaction
The transaction message
The transaction signatures
The transaction version
Information describing a vote account
The stake, in lamports, delegated to this vote account and activated
A percentage (0-100) of rewards payout owed to the voter
Recent epoch voting credit history for this voter
Whether the vote account is staked for this epoch
Most recent slot voted on by this vote account
Identity public key of the node voting with this account
Public key of the vote account
A collection of cluster vote accounts
Active vote accounts
Inactive vote accounts
VoteAuthorize type
The VoteAuthorize index (from solana-vote-program)
An enumeration of valid VoteInstructionType's
Withdraw from vote account transaction params
Withdraw nonce account system transaction params
Withdraw stake instruction params
There are 1-billion lamports in one SOL
Maximum length of derived pubkey seed
Maximum over-the-wire size of a Transaction
1280 is IPv6 minimum MTU 40 bytes is the size of the IPv6 header 8 bytes is the size of the fragment header
Size of public key in bytes
Address of the stake config account which configures the rate of stake warmup and cooldown as well as the slashing penalty.
An enumeration of valid StakeAuthorizationLayout's
An enumeration of valid VoteAuthorization layouts.
Retrieves the RPC API URL for the specified cluster
Send and confirm a raw transaction
If commitment option is not specified, defaults to 'max' commitment.
Sign, send and confirm a transaction.
If commitment option is not specified, defaults to 'max' commitment.
Generated using TypeDoc
Pair of an account address and its balance