Class ReadApiConnection

Hierarchy

  • Connection
    • ReadApiConnection

Accessors

commitment rpcEndpoint

Methods

getBalanceAndContext getBalance getBlockTime getMinimumLedgerSlot getFirstAvailableBlock getSupply getTokenSupply getTokenAccountBalance getTokenAccountsByOwner getParsedTokenAccountsByOwner getLargestAccounts getTokenLargestAccounts getAccountInfoAndContext getParsedAccountInfo getAccountInfo getMultipleParsedAccounts getMultipleAccountsInfoAndContext getMultipleAccountsInfo getStakeActivation getProgramAccounts getParsedProgramAccounts confirmTransaction getClusterNodes getVoteAccounts getSlot getSlotLeader getSlotLeaders getSignatureStatus getSignatureStatuses getTransactionCount getTotalSupply getInflationGovernor getInflationReward getEpochInfo getEpochSchedule getLeaderSchedule getMinimumBalanceForRentExemption getRecentBlockhashAndContext getRecentPerformanceSamples getFeeCalculatorForBlockhash getFeeForMessage getRecentBlockhash getLatestBlockhash getLatestBlockhashAndContext getVersion getGenesisHash getBlock getParsedBlock getBlockHeight getBlockProduction getTransaction getParsedTransaction getParsedTransactions getTransactions getConfirmedBlock getBlocks getBlockSignatures getConfirmedBlockSignatures getConfirmedTransaction getParsedConfirmedTransaction getParsedConfirmedTransactions getConfirmedSignaturesForAddress getConfirmedSignaturesForAddress2 getSignaturesForAddress getAddressLookupTable getNonceAndContext getNonce requestAirdrop getStakeMinimumDelegation simulateTransaction sendTransaction sendRawTransaction sendEncodedTransaction onAccountChange removeAccountChangeListener onProgramAccountChange removeProgramAccountChangeListener onLogs removeOnLogsListener onSlotChange removeSlotChangeListener onSlotUpdate removeSlotUpdateListener _buildArgs onSignature onSignatureWithOptions removeSignatureListener onRootChange removeRootChangeListener callReadApi getAsset getAssetProof getAssetsByGroup getAssetsByOwner

Constructors

constructor

Accessors

commitment

  • get commitment(): undefined | Commitment

  • The default commitment used for requests

    Returns undefined | Commitment

rpcEndpoint

  • get rpcEndpoint(): string

  • The RPC endpoint

    Returns string

Methods

getBalanceAndContext

  • Fetch the balance for the specified public key, return with context

    Parameters

    • publicKey: PublicKey
    • Optional commitmentOrConfig: Commitment | GetBalanceConfig

    Returns Promise<RpcResponseAndContext<number>>

getBalance

  • Fetch the balance for the specified public key

    Parameters

    • publicKey: PublicKey
    • Optional commitmentOrConfig: Commitment | GetBalanceConfig

    Returns Promise<number>

getBlockTime

  • Fetch the estimated production time of a block

    Parameters

    • slot: number

    Returns Promise<null | number>

getMinimumLedgerSlot

  • Fetch 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

    Returns Promise<number>

getFirstAvailableBlock

  • Fetch the slot of the lowest confirmed block that has not been purged from the ledger

    Returns Promise<number>

getSupply

  • Fetch information about the current supply

    Parameters

    • Optional config: Commitment | GetSupplyConfig

    Returns Promise<RpcResponseAndContext<Supply>>

getTokenSupply

  • Fetch the current supply of a token mint

    Parameters

    • tokenMintAddress: PublicKey
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<TokenAmount>>

getTokenAccountBalance

  • Fetch the current balance of a token account

    Parameters

    • tokenAddress: PublicKey
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<TokenAmount>>

getTokenAccountsByOwner

  • Fetch all the token accounts owned by the specified account

    Returns

    Parameters

    • ownerAddress: PublicKey
    • filter: TokenAccountsFilter
    • Optional commitmentOrConfig: Commitment | GetTokenAccountsByOwnerConfig

    Returns Promise<RpcResponseAndContext<{
        pubkey: PublicKey;
        account: AccountInfo<Buffer>;
    }[]>>

getParsedTokenAccountsByOwner

  • Fetch parsed token accounts owned by the specified account

    Returns

    Parameters

    • ownerAddress: PublicKey
    • filter: TokenAccountsFilter
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<{
        pubkey: PublicKey;
        account: AccountInfo<ParsedAccountData>;
    }[]>>

getLargestAccounts

  • Fetch the 20 largest accounts with their current balances

    Parameters

    • Optional config: GetLargestAccountsConfig

    Returns Promise<RpcResponseAndContext<AccountBalancePair[]>>

getTokenLargestAccounts

  • Fetch the 20 largest token accounts with their current balances for a given mint.

    Parameters

    • mintAddress: PublicKey
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<TokenAccountBalancePair[]>>

getAccountInfoAndContext

  • Fetch all the account info for the specified public key, return with context

    Parameters

    • publicKey: PublicKey
    • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

    Returns Promise<RpcResponseAndContext<null | AccountInfo<Buffer>>>

getParsedAccountInfo

  • Fetch parsed account info for the specified public key

    Parameters

    • publicKey: PublicKey
    • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

    Returns Promise<RpcResponseAndContext<null | AccountInfo<Buffer | ParsedAccountData>>>

getAccountInfo

  • Fetch all the account info for the specified public key

    Parameters

    • publicKey: PublicKey
    • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

    Returns Promise<null | AccountInfo<Buffer>>

getMultipleParsedAccounts

  • Fetch all the account info for multiple accounts specified by an array of public keys, return with context

    Parameters

    • publicKeys: PublicKey[]
    • Optional rawConfig: GetMultipleAccountsConfig

    Returns Promise<RpcResponseAndContext<(null | AccountInfo<Buffer | ParsedAccountData>)[]>>

getMultipleAccountsInfoAndContext

  • Fetch all the account info for multiple accounts specified by an array of public keys, return with context

    Parameters

    • publicKeys: PublicKey[]
    • Optional commitmentOrConfig: Commitment | GetMultipleAccountsConfig

    Returns Promise<RpcResponseAndContext<(null | AccountInfo<Buffer>)[]>>

getMultipleAccountsInfo

  • Fetch all the account info for multiple accounts specified by an array of public keys

    Parameters

    • publicKeys: PublicKey[]
    • Optional commitmentOrConfig: Commitment | GetMultipleAccountsConfig

    Returns Promise<(null | AccountInfo<Buffer>)[]>

getStakeActivation

  • Returns epoch activation information for a stake account that has been delegated

    Parameters

    • publicKey: PublicKey
    • Optional commitmentOrConfig: Commitment | GetStakeActivationConfig
    • Optional epoch: number

    Returns Promise<StakeActivationData>

getProgramAccounts

  • Fetch all the accounts owned by the specified program id

    Returns

    Parameters

    • programId: PublicKey
    • Optional configOrCommitment: Commitment | GetProgramAccountsConfig

    Returns Promise<{
        pubkey: PublicKey;
        account: AccountInfo<Buffer>;
    }[]>

getParsedProgramAccounts

  • Fetch and parse all the accounts owned by the specified program id

    Returns

    Parameters

    • programId: PublicKey
    • Optional configOrCommitment: Commitment | GetParsedProgramAccountsConfig

    Returns Promise<{
        pubkey: PublicKey;
        account: AccountInfo<Buffer | ParsedAccountData>;
    }[]>

confirmTransaction

  • Parameters

    • strategy: BlockheightBasedTransactionConfirmationStrategy | DurableNonceTransactionConfirmationStrategy
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<SignatureResult>>

  • Deprecated

    Instead, call confirmTransaction using a TransactionConfirmationConfig

    Parameters

    • strategy: string
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<SignatureResult>>

getClusterNodes

  • Return the list of nodes that are currently participating in the cluster

    Returns Promise<ContactInfo[]>

getVoteAccounts

  • Return the list of nodes that are currently participating in the cluster

    Parameters

    • Optional commitment: Commitment

    Returns Promise<VoteAccountStatus>

getSlot

  • Fetch the current slot that the node is processing

    Parameters

    • Optional commitmentOrConfig: Commitment | GetSlotConfig

    Returns Promise<number>

getSlotLeader

  • Fetch the current slot leader of the cluster

    Parameters

    • Optional commitmentOrConfig: Commitment | GetSlotLeaderConfig

    Returns Promise<string>

getSlotLeaders

  • Fetch limit number of slot leaders starting from startSlot

    Parameters

    • startSlot: number

      fetch slot leaders starting from this slot

    • limit: number

      number of slot leaders to return

    Returns Promise<PublicKey[]>

getSignatureStatus

  • Fetch the current status of a signature

    Parameters

    • signature: string
    • Optional config: SignatureStatusConfig

    Returns Promise<RpcResponseAndContext<null | SignatureStatus>>

getSignatureStatuses

  • Fetch the current statuses of a batch of signatures

    Parameters

    • signatures: string[]
    • Optional config: SignatureStatusConfig

    Returns Promise<RpcResponseAndContext<(null | SignatureStatus)[]>>

getTransactionCount

  • Fetch the current transaction count of the cluster

    Parameters

    • Optional commitmentOrConfig: Commitment | GetTransactionCountConfig

    Returns Promise<number>

getTotalSupply

  • Fetch the current total currency supply of the cluster in lamports

    Deprecated

    Deprecated since v1.2.8. Please use getSupply instead.

    Parameters

    • Optional commitment: Commitment

    Returns Promise<number>

getInflationGovernor

  • Fetch the cluster InflationGovernor parameters

    Parameters

    • Optional commitment: Commitment

    Returns Promise<InflationGovernor>

getInflationReward

  • Fetch the inflation reward for a list of addresses for an epoch

    Parameters

    • addresses: PublicKey[]
    • Optional epoch: number
    • Optional commitmentOrConfig: Commitment | GetInflationRewardConfig

    Returns Promise<(null | InflationReward)[]>

getEpochInfo

  • Fetch the Epoch Info parameters

    Parameters

    • Optional commitmentOrConfig: Commitment | GetEpochInfoConfig

    Returns Promise<EpochInfo>

getEpochSchedule

  • Fetch the Epoch Schedule parameters

    Returns Promise<EpochSchedule>

getLeaderSchedule

  • Fetch the leader schedule for the current epoch

    Returns

    Returns Promise<LeaderSchedule>

getMinimumBalanceForRentExemption

  • Fetch the minimum balance needed to exempt an account of dataLength size from rent

    Parameters

    • dataLength: number
    • Optional commitment: Commitment

    Returns Promise<number>

getRecentBlockhashAndContext

  • Fetch a recent blockhash from the cluster, return with context

    Returns

    Deprecated

    Deprecated since Solana v1.8.0. Please use getLatestBlockhash instead.

    Parameters

    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<{
        blockhash: string;
        feeCalculator: FeeCalculator;
    }>>

getRecentPerformanceSamples

  • Fetch recent performance samples

    Returns

    Parameters

    • Optional limit: number

    Returns Promise<PerfSample[]>

getFeeCalculatorForBlockhash

  • Fetch the fee calculator for a recent blockhash from the cluster, return with context

    Deprecated

    Deprecated since Solana v1.8.0. Please use getFeeForMessage instead.

    Parameters

    • blockhash: string
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<null | FeeCalculator>>

getFeeForMessage

  • Fetch the fee for a message from the cluster, return with context

    Parameters

    • message: VersionedMessage
    • Optional commitment: Commitment

    Returns Promise<RpcResponseAndContext<number>>

getRecentBlockhash

  • Fetch a recent blockhash from the cluster

    Returns

    Deprecated

    Deprecated since Solana v1.8.0. Please use getLatestBlockhash instead.

    Parameters

    • Optional commitment: Commitment

    Returns Promise<{
        blockhash: string;
        feeCalculator: FeeCalculator;
    }>

getLatestBlockhash

  • Fetch the latest blockhash from the cluster

    Returns

    Parameters

    • Optional commitmentOrConfig: Commitment | GetLatestBlockhashConfig

    Returns Promise<Readonly<{
        blockhash: string;
        lastValidBlockHeight: number;
    }>>

getLatestBlockhashAndContext

  • Fetch the latest blockhash from the cluster

    Returns

    Parameters

    • Optional commitmentOrConfig: Commitment | GetLatestBlockhashConfig

    Returns Promise<RpcResponseAndContext<Readonly<{
        blockhash: string;
        lastValidBlockHeight: number;
    }>>>

getVersion

  • Fetch the node version

    Returns Promise<Version>

getGenesisHash

  • Fetch the genesis hash

    Returns Promise<string>

getBlock

  • Fetch a processed block from the cluster.

    Deprecated

    Instead, call getBlock using a GetVersionedBlockConfig by setting the maxSupportedTransactionVersion property.

    Parameters

    • slot: number
    • Optional rawConfig: GetBlockConfig

    Returns Promise<null | BlockResponse>

  • Deprecated

    Instead, call getBlock using a GetVersionedBlockConfig by setting the maxSupportedTransactionVersion property.

    Parameters

    • slot: number
    • rawConfig: GetBlockConfig & {
          transactionDetails: "accounts";
      }

    Returns Promise<null | VersionedAccountsModeBlockResponse>

  • Deprecated

    Instead, call getBlock using a GetVersionedBlockConfig by setting the maxSupportedTransactionVersion property.

    Parameters

    • slot: number
    • rawConfig: GetBlockConfig & {
          transactionDetails: "none";
      }

    Returns Promise<null | VersionedNoneModeBlockResponse>

  • Fetch a processed block from the cluster.

    Parameters

    • slot: number
    • Optional rawConfig: GetVersionedBlockConfig

    Returns Promise<null | VersionedBlockResponse>

  • Parameters

    • slot: number
    • rawConfig: GetVersionedBlockConfig & {
          transactionDetails: "accounts";
      }

    Returns Promise<null | VersionedAccountsModeBlockResponse>

  • Parameters

    • slot: number
    • rawConfig: GetVersionedBlockConfig & {
          transactionDetails: "none";
      }

    Returns Promise<null | VersionedNoneModeBlockResponse>

getParsedBlock

  • Fetch parsed transaction details for a confirmed or finalized block

    Parameters

    • slot: number
    • Optional rawConfig: GetVersionedBlockConfig

    Returns Promise<ParsedAccountsModeBlockResponse>

  • Parameters

    • slot: number
    • rawConfig: GetVersionedBlockConfig & {
          transactionDetails: "accounts";
      }

    Returns Promise<ParsedAccountsModeBlockResponse>

  • Parameters

    • slot: number
    • rawConfig: GetVersionedBlockConfig & {
          transactionDetails: "none";
      }

    Returns Promise<ParsedNoneModeBlockResponse>

getBlockHeight

  • Parameters

    • Optional commitmentOrConfig: Commitment | GetBlockHeightConfig

    Returns Promise<number>

getBlockProduction

  • Parameters

    • Optional configOrCommitment: Commitment | GetBlockProductionConfig

    Returns Promise<RpcResponseAndContext<Readonly<{
        byIdentity: Readonly<Record<string, readonly number[]>>;
        range: Readonly<{
            firstSlot: number;
            lastSlot: number;
        }>;
    }>>>

getTransaction

  • Fetch a confirmed or finalized transaction from the cluster.

    Deprecated

    Instead, call getTransaction using a GetVersionedTransactionConfig by setting the maxSupportedTransactionVersion property.

    Parameters

    • signature: string
    • Optional rawConfig: GetTransactionConfig

    Returns Promise<null | TransactionResponse>

  • Fetch a confirmed or finalized transaction from the cluster.

    Parameters

    • signature: string
    • rawConfig: GetVersionedTransactionConfig

    Returns Promise<null | VersionedTransactionResponse>

getParsedTransaction

  • Fetch parsed transaction details for a confirmed or finalized transaction

    Parameters

    • signature: string
    • Optional commitmentOrConfig: GetVersionedTransactionConfig | Finality

    Returns Promise<null | ParsedTransactionWithMeta>

getParsedTransactions

  • Fetch parsed transaction details for a batch of confirmed transactions

    Parameters

    • signatures: string[]
    • Optional commitmentOrConfig: GetVersionedTransactionConfig | Finality

    Returns Promise<(null | ParsedTransactionWithMeta)[]>

getTransactions

  • Fetch transaction details for a batch of confirmed transactions. Similar to getParsedTransactions but returns a TransactionResponse.

    Deprecated

    Instead, call getTransactions using a GetVersionedTransactionConfig by setting the maxSupportedTransactionVersion property.

    Parameters

    • signatures: string[]
    • Optional commitmentOrConfig: GetTransactionConfig | Finality

    Returns Promise<(null | TransactionResponse)[]>

  • Fetch transaction details for a batch of confirmed transactions. Similar to getParsedTransactions but returns a VersionedTransactionResponse.

    Parameters

    • signatures: string[]
    • commitmentOrConfig: GetVersionedTransactionConfig | Finality

    Returns Promise<(null | VersionedTransactionResponse)[]>

getConfirmedBlock

  • Fetch a list of Transactions and transaction statuses from the cluster for a confirmed block.

    Deprecated

    Deprecated since v1.13.0. Please use getBlock instead.

    Parameters

    • slot: number
    • Optional commitment: Finality

    Returns Promise<ConfirmedBlock>

getBlocks

  • Fetch confirmed blocks between two slots

    Parameters

    • startSlot: number
    • Optional endSlot: number
    • Optional commitment: Finality

    Returns Promise<number[]>

getBlockSignatures

  • Fetch a list of Signatures from the cluster for a block, excluding rewards

    Parameters

    • slot: number
    • Optional commitment: Finality

    Returns Promise<BlockSignatures>

getConfirmedBlockSignatures

  • Fetch a list of Signatures from the cluster for a confirmed block, excluding rewards

    Deprecated

    Deprecated since Solana v1.8.0. Please use getBlockSignatures instead.

    Parameters

    • slot: number
    • Optional commitment: Finality

    Returns Promise<BlockSignatures>

getConfirmedTransaction

  • Fetch a transaction details for a confirmed transaction

    Deprecated

    Deprecated since Solana v1.8.0. Please use getTransaction instead.

    Parameters

    • signature: string
    • Optional commitment: Finality

    Returns Promise<null | ConfirmedTransaction>

getParsedConfirmedTransaction

  • Fetch parsed transaction details for a confirmed transaction

    Deprecated

    Deprecated since Solana v1.8.0. Please use getParsedTransaction instead.

    Parameters

    • signature: string
    • Optional commitment: Finality

    Returns Promise<null | ParsedTransactionWithMeta>

getParsedConfirmedTransactions

  • Fetch parsed transaction details for a batch of confirmed transactions

    Deprecated

    Deprecated since Solana v1.8.0. Please use getParsedTransactions instead.

    Parameters

    • signatures: string[]
    • Optional commitment: Finality

    Returns Promise<(null | ParsedTransactionWithMeta)[]>

getConfirmedSignaturesForAddress

  • Fetch a list of all the confirmed signatures for transactions involving an address within a specified slot range. Max range allowed is 10,000 slots.

    Deprecated

    Deprecated since v1.3. Please use getConfirmedSignaturesForAddress2 instead.

    Parameters

    • address: PublicKey

      queried address

    • startSlot: number

      start slot, inclusive

    • endSlot: number

      end slot, inclusive

    Returns Promise<string[]>

getConfirmedSignaturesForAddress2

  • Returns confirmed signatures for transactions involving an address backwards in time from the provided signature or most recent confirmed block

    Parameters

    • address: PublicKey

      queried address

    • Optional options: ConfirmedSignaturesForAddress2Options
    • Optional commitment: Finality

    Returns Promise<ConfirmedSignatureInfo[]>

getSignaturesForAddress

  • Returns confirmed signatures for transactions involving an address backwards in time from the provided signature or most recent confirmed block

    Parameters

    • address: PublicKey

      queried address

    • Optional options: SignaturesForAddressOptions
    • Optional commitment: Finality

    Returns Promise<ConfirmedSignatureInfo[]>

getAddressLookupTable

  • Parameters

    • accountKey: PublicKey
    • Optional config: GetAccountInfoConfig

    Returns Promise<RpcResponseAndContext<null | AddressLookupTableAccount>>

getNonceAndContext

  • Fetch the contents of a Nonce account from the cluster, return with context

    Parameters

    • nonceAccount: PublicKey
    • Optional commitmentOrConfig: Commitment | GetNonceAndContextConfig

    Returns Promise<RpcResponseAndContext<null | NonceAccount>>

getNonce

  • Fetch the contents of a Nonce account from the cluster

    Parameters

    • nonceAccount: PublicKey
    • Optional commitmentOrConfig: Commitment | GetNonceConfig

    Returns Promise<null | NonceAccount>

requestAirdrop

  • Request an allocation of lamports to the specified address

    import { Connection, PublicKey, LAMPORTS_PER_SOL } from "@solana/web3.js";

    (async () => {
      const connection = new Connection("https://api.testnet.solana.com", "confirmed");
      const myAddress = new PublicKey("2nr1bHFT86W9tGnyvmYW4vcHKsQB3sVQfnddasz4kExM");
      const signature = await connection.requestAirdrop(myAddress, LAMPORTS_PER_SOL);
      await connection.confirmTransaction(signature);
    })();

    Parameters

    Returns Promise<string>

getStakeMinimumDelegation

  • get the stake minimum delegation

    Parameters

    • Optional config: GetStakeMinimumDelegationConfig

    Returns Promise<RpcResponseAndContext<number>>

simulateTransaction

  • Simulate a transaction

    Deprecated

    Instead, call simulateTransaction with VersionedTransaction and SimulateTransactionConfig parameters

    Parameters

    • transactionOrMessage: Transaction | Message
    • Optional signers: Signer[]
    • Optional includeAccounts: boolean | PublicKey[]

    Returns Promise<RpcResponseAndContext<SimulatedTransactionResponse>>

  • Simulate a transaction

    Parameters

    • transaction: VersionedTransaction
    • Optional config: SimulateTransactionConfig

    Returns Promise<RpcResponseAndContext<SimulatedTransactionResponse>>

sendTransaction

  • Sign and send a transaction

    Deprecated

    Instead, call sendTransaction with a VersionedTransaction

    Parameters

    • transaction: Transaction
    • signers: Signer[]
    • Optional options: SendOptions

    Returns Promise<string>

  • Send a signed transaction

    Parameters

    • transaction: VersionedTransaction
    • Optional options: SendOptions

    Returns Promise<string>

sendRawTransaction

  • Send a transaction that has already been signed and serialized into the wire format

    Parameters

    • rawTransaction: Buffer | number[] | Uint8Array
    • Optional options: SendOptions

    Returns Promise<string>

sendEncodedTransaction

  • Send a transaction that has already been signed, serialized into the wire format, and encoded as a base64 string

    Parameters

    • encodedTransaction: string
    • Optional options: SendOptions

    Returns Promise<string>

onAccountChange

  • Register a callback to be invoked whenever the specified account changes

    Returns

    subscription id

    Parameters

    • publicKey: PublicKey

      Public key of the account to monitor

    • callback: AccountChangeCallback

      Function to invoke whenever the account is changed

    • Optional commitment: Commitment

      Specify the commitment level account changes must reach before notification

    Returns number

removeAccountChangeListener

  • Deregister an account notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

onProgramAccountChange

  • Register a callback to be invoked whenever accounts owned by the specified program change

    Returns

    subscription id

    Parameters

    • programId: PublicKey

      Public key of the program to monitor

    • callback: ProgramAccountChangeCallback

      Function to invoke whenever the account is changed

    • Optional commitment: Commitment

      Specify the commitment level account changes must reach before notification

    • Optional filters: GetProgramAccountsFilter[]

      The program account filters to pass into the RPC method

    Returns number

removeProgramAccountChangeListener

  • Deregister an account notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

onLogs

  • Registers a callback to be invoked whenever logs are emitted.

    Parameters

    • filter: LogsFilter
    • callback: LogsCallback
    • Optional commitment: Commitment

    Returns number

removeOnLogsListener

  • Deregister a logs callback.

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

onSlotChange

  • Register a callback to be invoked upon slot changes

    Returns

    subscription id

    Parameters

    • callback: SlotChangeCallback

      Function to invoke whenever the slot changes

    Returns number

removeSlotChangeListener

  • Deregister a slot notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

onSlotUpdate

  • Register a callback to be invoked upon slot updates. SlotUpdate's may be useful to track live progress of a cluster.

    Returns

    subscription id

    Parameters

    • callback: SlotUpdateCallback

      Function to invoke whenever the slot updates

    Returns number

removeSlotUpdateListener

  • Deregister a slot update notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

_buildArgs

  • _buildArgs(args: any[], override?: Commitment, encoding?: "base64" | "jsonParsed", extra?: any): any[]

  • Parameters

    • args: any[]
    • Optional override: Commitment
    • Optional encoding: "base64" | "jsonParsed"
    • Optional extra: any

    Returns any[]

onSignature

  • Register a callback to be invoked upon signature updates

    Returns

    subscription id

    Parameters

    • signature: string

      Transaction signature string in base 58

    • callback: SignatureResultCallback

      Function to invoke on signature notifications

    • Optional commitment: Commitment

      Specify the commitment level signature must reach before notification

    Returns number

onSignatureWithOptions

  • Register a callback to be invoked when a transaction is received and/or processed.

    Returns

    subscription id

    Parameters

    • signature: string

      Transaction signature string in base 58

    • callback: SignatureSubscriptionCallback

      Function to invoke on signature notifications

    • Optional options: SignatureSubscriptionOptions

      Enable received notifications and set the commitment level that signature must reach before notification

    Returns number

removeSignatureListener

  • Deregister a signature notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

onRootChange

  • Register a callback to be invoked upon root changes

    Returns

    subscription id

    Parameters

    • callback: RootChangeCallback

      Function to invoke whenever the root changes

    Returns number

removeRootChangeListener

  • Deregister a root notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

Private callReadApi

  • Type Parameters

    • ReadApiMethodParams

    • ReadApiJsonOutput

    Parameters

    • jsonRpcParams: JsonRpcParams<ReadApiMethodParams>

    Returns Promise<JsonRpcOutput<ReadApiJsonOutput>>

getAsset

getAssetProof

getAssetsByGroup

getAssetsByOwner

Constructors

constructor

Settings

Member Visibility

Theme

Generated using TypeDoc