solana/src/rpc/rpc library

Classes

AccountBalancePairResponse
BlockhashWithExpiryBlockHeight
BlockProduction
BlockSubscribeTransactionDetails
evel of transaction detail to return
Commitment
For preflight checks and transaction processing, Solana nodes choose which bank state to query based on a commitment requirement set by the client. The commitment describes how finalized a block is at that point in time. When querying the ledger state, it's recommended to use lower levels of commitment to report progress and higher levels to ensure the state will not be rolled back.
ContactInfo
Information describing a cluster node
Context
EpochInfo
Information about the current epoch
EpochSchedule
Epoch schedule
InflationGovernor
Network Inflation
InflationRate
InflationReward
The inflation reward for an epoch
LeaderSchedule
Leader schedule
MinContextSlot
PerfSample
A performance sample
RecentPrioritizationFees
ResultWithContext<T>
RPCAccountConfig
Accounts configuration object
RPCBlockRangeConfig
RPC Slot range to return block production for. If parameter not provided, defaults to current epoch.
RPCDataSliceConfig
RPC Object class for Request a slice of the account's data.
RPCFilterConfig
RPCMemcmpFilterConfig
RPCSizeFilterConfig
RPCTransactionDetails
SignatureStatus
Signature status
SimulateTranasctionResponse
SimulateTranasctionReturnDataResponse
SolanaAccountInfo
SolanaProvider
Represents an interface to interact with Solana nodes using JSON-RPC requests.
SolanaRequest<RESULT, SERVICERESPONSE>
An abstract class representing Solana JSON-RPC requests with generic response types.
SolanaRequestAccountSubscribeInfo
Subscribe to an account to receive notifications when the lamports or data for a given account public key changes https://solana.com/docs/rpc/websocket/accountsubscribe
SolanaRequestBlockSubscribe
Subscribe to receive notification anytime a new block is confirmed or finalized. https://solana.com/docs/rpc/websocket/blocksubscribe
SolanaRequestDetails
Represents the details of an Solana JSON-RPC request.
SolanaRequestEncoding
SolanaRequestGetAccountInfo
Returns all information associated with the account of provided Pubkey https://solana.com/docs/rpc/http/getaccountinfo
SolanaRequestGetBalance
Returns the lamport balance of the account of provided Pubkey https://solana.com/docs/rpc/http/getbalance
SolanaRequestGetBlock
Returns identity and transaction information about a confirmed block in the ledger https://solana.com/docs/rpc/http/getblock
SolanaRequestGetBlockCommitment
Returns commitment for particular block https://solana.com/docs/rpc/http/getblockcommitment
SolanaRequestGetBlockHeight
Returns the current block height of the node https://solana.com/docs/rpc/http/getblockheight
SolanaRequestGetBlockProduction
Returns recent block production information from the current or previous epoch. https://solana.com/docs/rpc/http/getblockproduction
SolanaRequestGetBlocks
Returns a list of confirmed blocks between two slots https://solana.com/docs/rpc/http/getblocks
SolanaRequestGetBlocksWithLimit
Returns a list of confirmed blocks starting at the given slot https://solana.com/docs/rpc/http/getblockswithlimit
SolanaRequestGetBlockTime
Returns the estimated production time of a block.
SolanaRequestGetClusterNodes
Returns information about all the nodes participating in the clusterot https://solana.com/docs/rpc/http/getclusternodes
SolanaRequestGetEpochInfo
Returns information about the current epoch https://solana.com/docs/rpc/http/getepochinfo
SolanaRequestGetEpochSchedule
Returns the epoch schedule information from this cluster's genesis config https://solana.com/docs/rpc/http/getepochschedule
SolanaRequestGetFeeForMessage
Get the fee the network will charge for a particular Message https://solana.com/docs/rpc/http/getfeeformessage
SolanaRequestGetFirstAvailableBlock
Returns the slot of the lowest confirmed block that has not been purged from the ledger https://solana.com/docs/rpc/http/getfirstavailableblock
SolanaRequestGetGenesisHash
Returns the genesis hash https://solana.com/docs/rpc/http/getgenesishash
SolanaRequestGetHealth
Returns the current health of the node. A healthy node is one that is within HEALTH_CHECK_SLOT_DISTANCE slots of the latest cluster confirmed slot. https://solana.com/docs/rpc/http/gethealth
SolanaRequestGetHighestSnapshotSlot
Returns the highest slot information that the node has snapshots for.
SolanaRequestGetIdentity
Returns the identity pubkey for the current node https://solana.com/docs/rpc/http/getidentity
SolanaRequestGetInflationGovernor
Returns the current inflation governor https://solana.com/docs/rpc/http/getinflationgovernor
SolanaRequestGetInflationRate
Returns the specific inflation values for the current epoch https://solana.com/docs/rpc/http/getinflationrate
SolanaRequestGetInflationReward
Returns the inflation / staking reward for a list of addresses for an epoch https://solana.com/docs/rpc/http/getinflationreward
SolanaRequestGetLargestAccounts
Returns the 20 largest accounts, by lamport balance (results may be cached up to two hours) https://solana.com/docs/rpc/http/getlargestaccounts
SolanaRequestGetLatestBlockhash
Returns the latest blockhash https://solana.com/docs/rpc/http/getlatestblockhash
SolanaRequestGetLeaderSchedule
Returns the leader schedule for an epoch https://solana.com/docs/rpc/http/getleaderschedule
SolanaRequestGetMaxRetransmitSlot
Get the max slot seen from retransmit stage. https://solana.com/docs/rpc/http/getmaxretransmitslot
SolanaRequestGetMaxShredInsertSlot
Get the max slot seen from after shred insert. https://solana.com/docs/rpc/http/getmaxshredinsertslot
SolanaRequestGetMinimumBalanceForRentExemption
Returns minimum balance required to make account rent exempt.
SolanaRequestGetMultipleAccounts
Returns the account information for a list of Pubkeys. https://solana.com/docs/rpc/http/getmultipleaccounts
SolanaRequestGetProgramAccounts
Returns all accounts owned by the provided program Pubkey https://solana.com/docs/rpc/http/getprogramaccounts
SolanaRequestGetRecentPerformanceSamples
Returns a list of recent performance samples, in reverse slot order. Performance samples are taken every 60 seconds and include the number of transactions and slots that occur in a given time window. https://solana.com/docs/rpc/http/getrecentperformancesamples
SolanaRequestGetRecentPrioritizationFees
Returns a list of prioritization fees from recent blocks. Currently, a node's prioritization-fee cache stores data from up to 150 blocks.
SolanaRequestGetSignaturesForAddress
Returns signatures for confirmed transactions that include the given address in their accountKeys list. Returns signatures backwards in time from the provided signature or most recent confirmed block https://solana.com/docs/rpc/http/getsignaturesforaddress
SolanaRequestGetSignatureStatuses
Returns the statuses of a list of signatures. Each signature must be a txid, the first signature of a transaction. Unless the searchTransactionHistory configuration parameter is included, this method only searches the recent status cache of signatures, which retains statuses for all active slots plus MAX_RECENT_BLOCKHASHES rooted slots.
SolanaRequestGetSlot
Returns the slot that has reached the given or default commitment level https://solana.com/docs/rpc/http/getslot
SolanaRequestGetSlotLeader
Returns the current slot leader https://solana.com/docs/rpc/http/getslotleader
SolanaRequestGetSlotLeaders
Returns the slot leaders for a given slot range https://solana.com/docs/rpc/http/getslotleaders
SolanaRequestGetStakeActivation
Pubkey of stake Account to query, as base-58 encoded string https://solana.com/docs/rpc/http/getstakeactivation
SolanaRequestGetStakeMinimumDelegation
Returns the stake minimum delegation, in lamports. https://solana.com/docs/rpc/http/getstakeminimumdelegation
SolanaRequestGetSupply
Returns information about the current supply. https://solana.com/docs/rpc/http/getsupply
SolanaRequestGetTokenAccountBalance
Returns the token balance of an SPL Token account. https://solana.com/docs/rpc/http/gettokenaccountbalance
SolanaRequestGetTokenAccountsByDelegate
Returns all SPL Token accounts by approved Delegate. https://solana.com/docs/rpc/http/gettokenaccountsbydelegate
SolanaRequestGetTokenAccountsByOwner
Returns all SPL Token accounts by token owner. https://solana.com/docs/rpc/http/gettokenaccountsbyowner
SolanaRequestGetTokenLargestAccounts
Returns the 20 largest accounts of a particular SPL Token type. https://solana.com/docs/rpc/http/gettokenlargestaccounts
SolanaRequestGetTokenSupply
Returns the total supply of an SPL Token type. https://solana.com/docs/rpc/http/gettokensupply
SolanaRequestGetTransaction
Returns transaction details for a confirmed transaction https://solana.com/docs/rpc/http/gettransaction
SolanaRequestGetTransactionCount
Returns the current Transaction count from the ledger https://solana.com/docs/rpc/http/gettransactioncount
SolanaRequestGetVersion
Returns the current Solana version running on the node. https://solana.com/docs/rpc/http/getversion
SolanaRequestGetVoteAccounts
Returns the account info and associated stake for all the voting accounts in the current bank. https://solana.com/docs/rpc/http/getvoteaccounts
SolanaRequestIsBlockhashValid
Returns whether a blockhash is still valid or not. https://solana.com/docs/rpc/http/isblockhashvalid
SolanaRequestlogsSubscribe
Subscribe to transaction logging. https://solana.com/docs/rpc/websocket/logssubscribe
SolanaRequestMethods
A class containing constants representing various Solana RPC methods.
SolanaRequestMinimumLedgerSlot
Returns the lowest slot that the node has information about in its ledger. This value may increase over time if the node is configured to purge older ledger data https://solana.com/docs/rpc/http/minimumledgerslot
SolanaRequestProgramSubscribe
Subscribe to receive notification anytime a new root is set by the validator. https://solana.com/docs/rpc/websocket/rootSubscribe
SolanaRequestRequestAirdrop
Requests an airdrop of lamports to a Pubkey https://solana.com/docs/rpc/http/requestairdrop
SolanaRequestSendTransaction
The returned signature is the first signature in the transaction, which is used to identify the transaction (transaction id). This identifier can be easily extracted from the transaction data before submission. https://solana.com/docs/rpc/http/sendtransaction
SolanaRequestSignatureSubscribe
Subscribe to receive a notification when the transaction with the given signature reaches the specified commitment level. https://solana.com/docs/rpc/websocket/signaturesubscribe
SolanaRequestSimulateTransaction
Simulate sending a transaction https://solana.com/docs/rpc/http/simulatetransaction
SolanaRequestSlotSubscribe
Subscribe to receive notification anytime a slot is processed by the validator. https://solana.com/docs/rpc/websocket/slotsubscribe
SolanaRequestSlotsUpdatesSubscribe
Subscribe to receive a notification from the validator on a variety of updates on every slot. https://solana.com/docs/rpc/websocket/slotsupdatessubscribe
SolanaRequestUnSubscribe
Unsubscribe notifications https://solana.com/docs/rpc/websocket/votesubscribe
SolanaRequestUtils
A utility class for Solana RPC-related tasks.
SolanaRequestVoteSubscribe
Subscribe to receive notification anytime a new vote is observed in gossip. These votes are pre-consensus therefore there is no guarantee these votes will enter the ledger. https://solana.com/docs/rpc/websocket/votesubscribe
SolanaSubscribeRpcMethods
A class containing constants representing various Solana Webosocket subscribe methods.
SolanaUnSubscribeRpcMethods
A class containing constants representing various Solana Webosocket subscribe methods.
SubscribeBlockFilter
filter criteria for the logs to receive results by account type; currently supported:
SubscribeTransactionLogsFilter
filter criteria for the logs to receive results by account type.
SupplyResponse
TokenAccountBalancePair
TokenAccountResponse
TokenAmoutResponse
TransactionConfirmationStatus
VersionedBlockResponse
VersionedTransactionResponse

Mixins

SolanaServiceProvider
A mixin for providing JSON-RPC service functionality.

Typedefs

SolanaServiceResponse<T> = BaseServiceResponse<T>