Class Connection

A connection to a fullnode JSON RPC endpoint

Constructors

constructor

Accessors

commitment rpcEndpoint

Methods

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

Constructors

constructor

  • new Connection(endpoint, commitmentOrConfig?): Connection

  • Establish a JSON RPC connection

    Parameters

    • endpoint: string

      URL to the fullnode JSON RPC endpoint

    • Optional commitmentOrConfig: Commitment | ConnectionConfig

      optional default commitment level or optional ConnectionConfig configuration object

    Returns Connection

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

_buildArgs

  • _buildArgs(args, override?, encoding?, extra?): any[]

  • Parameters

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

    Returns any[]

confirmTransaction

getAccountInfo

  • getAccountInfo(publicKey, commitmentOrConfig?): Promise<null | AccountInfo<Buffer>>

  • Fetch all the account info for the specified public key

    Parameters

    Returns Promise<null | AccountInfo<Buffer>>

getAccountInfoAndContext

getAddressLookupTable

getBalance

  • getBalance(publicKey, commitmentOrConfig?): Promise<number>

  • Fetch the balance for the specified public key

    Parameters

    Returns Promise<number>

getBalanceAndContext

getBlock

getBlockHeight

  • getBlockHeight(commitmentOrConfig?): Promise<number>

  • Parameters

    Returns Promise<number>

getBlockProduction

  • getBlockProduction(configOrCommitment?): Promise<RpcResponseAndContext<Readonly<{
        byIdentity: Readonly<Record<string, readonly number[]>>;
        range: Readonly<{
            firstSlot: number;
            lastSlot: number;
        }>;
    }>>>

  • Parameters

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

getBlockSignatures

  • getBlockSignatures(slot, commitment?): Promise<BlockSignatures>

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

    Parameters

    • slot: number
    • Optional commitment: Finality

    Returns Promise<BlockSignatures>

getBlockTime

  • getBlockTime(slot): Promise<null | number>

  • Fetch the estimated production time of a block

    Parameters

    • slot: number

    Returns Promise<null | number>

getBlocks

  • getBlocks(startSlot, endSlot?, commitment?): Promise<number[]>

  • Fetch confirmed blocks between two slots

    Parameters

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

    Returns Promise<number[]>

getClusterNodes

  • getClusterNodes(): Promise<ContactInfo[]>

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

    Returns Promise<ContactInfo[]>

getConfirmedBlock

  • getConfirmedBlock(slot, commitment?): Promise<ConfirmedBlock>

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

    Parameters

    • slot: number
    • Optional commitment: Finality

    Returns Promise<ConfirmedBlock>

    Deprecated

    Deprecated since v1.13.0. Please use getBlock instead.

getConfirmedBlockSignatures

  • getConfirmedBlockSignatures(slot, commitment?): Promise<BlockSignatures>

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

    Parameters

    • slot: number
    • Optional commitment: Finality

    Returns Promise<BlockSignatures>

    Deprecated

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

getConfirmedSignaturesForAddress

  • getConfirmedSignaturesForAddress(address, startSlot, endSlot): Promise<string[]>

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

    Parameters

    • address: PublicKey

      queried address

    • startSlot: number

      start slot, inclusive

    • endSlot: number

      end slot, inclusive

    Returns Promise<string[]>

    Deprecated

    Deprecated since v1.3. Please use getConfirmedSignaturesForAddress2 instead.

getConfirmedSignaturesForAddress2

getConfirmedTransaction

  • getConfirmedTransaction(signature, commitment?): Promise<null | ConfirmedTransaction>

  • Fetch a transaction details for a confirmed transaction

    Parameters

    • signature: string
    • Optional commitment: Finality

    Returns Promise<null | ConfirmedTransaction>

    Deprecated

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

getEpochInfo

  • getEpochInfo(commitmentOrConfig?): Promise<EpochInfo>

  • Fetch the Epoch Info parameters

    Parameters

    Returns Promise<EpochInfo>

getEpochSchedule

  • getEpochSchedule(): Promise<EpochSchedule>

  • Fetch the Epoch Schedule parameters

    Returns Promise<EpochSchedule>

getFeeCalculatorForBlockhash

getFeeForMessage

getFirstAvailableBlock

  • getFirstAvailableBlock(): Promise<number>

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

    Returns Promise<number>

getGenesisHash

  • getGenesisHash(): Promise<string>

  • Fetch the genesis hash

    Returns Promise<string>

getInflationGovernor

  • getInflationGovernor(commitment?): Promise<InflationGovernor>

  • Fetch the cluster InflationGovernor parameters

    Parameters

    Returns Promise<InflationGovernor>

getInflationReward

  • getInflationReward(addresses, epoch?, commitmentOrConfig?): Promise<(null | InflationReward)[]>

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

    Parameters

    Returns Promise<(null | InflationReward)[]>

getLargestAccounts

getLatestBlockhash

  • getLatestBlockhash(commitmentOrConfig?): Promise<Readonly<{
        blockhash: string;
        lastValidBlockHeight: number;
    }>>

  • Fetch the latest blockhash from the cluster

    Parameters

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

getLatestBlockhashAndContext

  • getLatestBlockhashAndContext(commitmentOrConfig?): Promise<RpcResponseAndContext<Readonly<{
        blockhash: string;
        lastValidBlockHeight: number;
    }>>>

  • Fetch the latest blockhash from the cluster

    Parameters

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

getLeaderSchedule

  • getLeaderSchedule(): Promise<LeaderSchedule>

  • Fetch the leader schedule for the current epoch

    Returns Promise<LeaderSchedule>

getMinimumBalanceForRentExemption

  • getMinimumBalanceForRentExemption(dataLength, commitment?): Promise<number>

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

    Parameters

    Returns Promise<number>

getMinimumLedgerSlot

  • getMinimumLedgerSlot(): Promise<number>

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

getMultipleAccountsInfo

  • getMultipleAccountsInfo(publicKeys, commitmentOrConfig?): Promise<(null | AccountInfo<Buffer>)[]>

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

    Parameters

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

getMultipleAccountsInfoAndContext

getMultipleParsedAccounts

getNonce

  • getNonce(nonceAccount, commitmentOrConfig?): Promise<null | NonceAccount>

  • Fetch the contents of a Nonce account from the cluster

    Parameters

    Returns Promise<null | NonceAccount>

getNonceAndContext

getParsedAccountInfo

getParsedBlock

getParsedConfirmedTransaction

  • getParsedConfirmedTransaction(signature, commitment?): Promise<null | ParsedTransactionWithMeta>

  • Fetch parsed transaction details for a confirmed transaction

    Parameters

    • signature: string
    • Optional commitment: Finality

    Returns Promise<null | ParsedTransactionWithMeta>

    Deprecated

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

getParsedConfirmedTransactions

  • getParsedConfirmedTransactions(signatures, commitment?): Promise<(null | ParsedTransactionWithMeta)[]>

  • Fetch parsed transaction details for a batch of confirmed transactions

    Parameters

    • signatures: string[]
    • Optional commitment: Finality

    Returns Promise<(null | ParsedTransactionWithMeta)[]>

    Deprecated

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

getParsedProgramAccounts

getParsedTokenAccountsByOwner

getParsedTransaction

getParsedTransactions

getProgramAccounts

  • getProgramAccounts(programId, configOrCommitment?): Promise<{
        account: AccountInfo<Buffer>;
        pubkey: PublicKey;
    }[]>

  • Fetch all the accounts owned by the specified program id

    Parameters

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

getRecentBlockhash

  • getRecentBlockhash(commitment?): Promise<{
        blockhash: string;
        feeCalculator: FeeCalculator;
    }>

  • Fetch a recent blockhash from the cluster

    Parameters

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

    Deprecated

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

getRecentBlockhashAndContext

  • getRecentBlockhashAndContext(commitment?): Promise<RpcResponseAndContext<{
        blockhash: string;
        feeCalculator: FeeCalculator;
    }>>

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

    Parameters

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

    Deprecated

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

getRecentPerformanceSamples

  • getRecentPerformanceSamples(limit?): Promise<PerfSample[]>

  • Fetch recent performance samples

    Parameters

    • Optional limit: number

    Returns Promise<PerfSample[]>

getSignatureStatus

getSignatureStatuses

getSignaturesForAddress

  • getSignaturesForAddress(address, options?, commitment?): Promise<ConfirmedSignatureInfo[]>

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

    Parameters

    Returns Promise<ConfirmedSignatureInfo[]>

getSlot

  • getSlot(commitmentOrConfig?): Promise<number>

  • Fetch the current slot that the node is processing

    Parameters

    Returns Promise<number>

getSlotLeader

  • getSlotLeader(commitmentOrConfig?): Promise<string>

  • Fetch the current slot leader of the cluster

    Parameters

    Returns Promise<string>

getSlotLeaders

  • getSlotLeaders(startSlot, limit): Promise<PublicKey[]>

  • 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[]>

getStakeActivation

getStakeMinimumDelegation

getSupply

getTokenAccountBalance

getTokenAccountsByOwner

getTokenLargestAccounts

getTokenSupply

getTotalSupply

  • getTotalSupply(commitment?): Promise<number>

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

    Parameters

    Returns Promise<number>

    Deprecated

    Deprecated since v1.2.8. Please use getSupply instead.

getTransaction

  • getTransaction(signature, rawConfig?): Promise<null | TransactionResponse>

  • Fetch a confirmed or finalized transaction from the cluster.

    Parameters

    Returns Promise<null | TransactionResponse>

    Deprecated

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

  • getTransaction(signature, rawConfig): Promise<null | VersionedTransactionResponse>

  • Fetch a confirmed or finalized transaction from the cluster.

    Parameters

    Returns Promise<null | VersionedTransactionResponse>

getTransactionCount

  • getTransactionCount(commitmentOrConfig?): Promise<number>

  • Fetch the current transaction count of the cluster

    Parameters

    Returns Promise<number>

getTransactions

getVersion

  • getVersion(): Promise<Version>

  • Fetch the node version

    Returns Promise<Version>

getVoteAccounts

  • getVoteAccounts(commitment?): Promise<VoteAccountStatus>

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

    Parameters

    Returns Promise<VoteAccountStatus>

onAccountChange

  • onAccountChange(publicKey, callback, commitment?): number

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

    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

    subscription id

onLogs

  • onLogs(filter, callback, commitment?): number

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

    Parameters

    Returns number

onProgramAccountChange

  • onProgramAccountChange(programId, callback, commitment?, filters?): number

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

    Parameters

    Returns number

    subscription id

onRootChange

  • onRootChange(callback): number

  • Register a callback to be invoked upon root changes

    Parameters

    Returns number

    subscription id

onSignature

  • onSignature(signature, callback, commitment?): number

  • Register a callback to be invoked upon signature updates

    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

    subscription id

onSignatureWithOptions

  • onSignatureWithOptions(signature, callback, options?): number

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

    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

    subscription id

onSlotChange

  • onSlotChange(callback): number

  • Register a callback to be invoked upon slot changes

    Parameters

    Returns number

    subscription id

onSlotUpdate

  • onSlotUpdate(callback): number

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

    Parameters

    Returns number

    subscription id

removeAccountChangeListener

  • removeAccountChangeListener(clientSubscriptionId): Promise<void>

  • Deregister an account notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

removeOnLogsListener

  • removeOnLogsListener(clientSubscriptionId): Promise<void>

  • Deregister a logs callback.

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

removeProgramAccountChangeListener

  • removeProgramAccountChangeListener(clientSubscriptionId): Promise<void>

  • Deregister an account notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

removeRootChangeListener

  • removeRootChangeListener(clientSubscriptionId): Promise<void>

  • Deregister a root notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

removeSignatureListener

  • removeSignatureListener(clientSubscriptionId): Promise<void>

  • Deregister a signature notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

removeSlotChangeListener

  • removeSlotChangeListener(clientSubscriptionId): Promise<void>

  • Deregister a slot notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

removeSlotUpdateListener

  • removeSlotUpdateListener(clientSubscriptionId): Promise<void>

  • Deregister a slot update notification callback

    Parameters

    • clientSubscriptionId: number

    Returns Promise<void>

requestAirdrop

  • requestAirdrop(to, lamports): Promise<string>

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

sendEncodedTransaction

  • sendEncodedTransaction(encodedTransaction, options?): Promise<string>

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

sendRawTransaction

  • sendRawTransaction(rawTransaction, options?): Promise<string>

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

    Parameters

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

    Returns Promise<string>

sendTransaction

  • sendTransaction(transaction, signers, options?): Promise<string>

  • Sign and send a transaction

    Parameters

    Returns Promise<string>

    Deprecated

    Instead, call sendTransaction with a VersionedTransaction

  • sendTransaction(transaction, options?): Promise<string>

  • Send a signed transaction

    Parameters

    Returns Promise<string>

simulateTransaction

Settings

Member Visibility

Theme

On This Page

constructorcommitmentrpcEndpoint_buildArgsconfirmTransactiongetAccountInfogetAccountInfoAndContextgetAddressLookupTablegetBalancegetBalanceAndContextgetBlockgetBlockHeightgetBlockProductiongetBlockSignaturesgetBlockTimegetBlocksgetClusterNodesgetConfirmedBlockgetConfirmedBlockSignaturesgetConfirmedSignaturesForAddressgetConfirmedSignaturesForAddress2getConfirmedTransactiongetEpochInfogetEpochSchedulegetFeeCalculatorForBlockhashgetFeeForMessagegetFirstAvailableBlockgetGenesisHashgetInflationGovernorgetInflationRewardgetLargestAccountsgetLatestBlockhashgetLatestBlockhashAndContextgetLeaderSchedulegetMinimumBalanceForRentExemptiongetMinimumLedgerSlotgetMultipleAccountsInfogetMultipleAccountsInfoAndContextgetMultipleParsedAccountsgetNoncegetNonceAndContextgetParsedAccountInfogetParsedBlockgetParsedConfirmedTransactiongetParsedConfirmedTransactionsgetParsedProgramAccountsgetParsedTokenAccountsByOwnergetParsedTransactiongetParsedTransactionsgetProgramAccountsgetRecentBlockhashgetRecentBlockhashAndContextgetRecentPerformanceSamplesgetSignatureStatusgetSignatureStatusesgetSignaturesForAddressgetSlotgetSlotLeadergetSlotLeadersgetStakeActivationgetStakeMinimumDelegationgetSupplygetTokenAccountBalancegetTokenAccountsByOwnergetTokenLargestAccountsgetTokenSupplygetTotalSupplygetTransactiongetTransactionCountgetTransactionsgetVersiongetVoteAccountsonAccountChangeonLogsonProgramAccountChangeonRootChangeonSignatureonSignatureWithOptionsonSlotChangeonSlotUpdateremoveAccountChangeListenerremoveOnLogsListenerremoveProgramAccountChangeListenerremoveRootChangeListenerremoveSignatureListenerremoveSlotChangeListenerremoveSlotUpdateListenerrequestAirdropsendEncodedTransactionsendRawTransactionsendTransactionsimulateTransaction