Interface RpcInterface

Defines the interface for an RPC client. It allows us to interact with the Solana blockchain.

Hierarchy

  • RpcInterface

Methods

accountExists airdrop call confirmTransaction getAccount getAccounts getBalance getBlockTime getCluster getEndpoint getLatestBlockhash getProgramAccounts getRent getSignatureStatuses getSlot getTransaction sendTransaction

Methods

accountExists

  • Whether or not an account at a given address exists.

    Returns

    true if the account exists, false otherwise.

    Parameters

    • publicKey: PublicKey<string>

      The public key of the account.

    • Optional options: RpcBaseOptions

      The options to use when checking if an account exists.

    Returns Promise<boolean>

airdrop

  • Send and confirm an airdrop transaction to the given address.

    Parameters

    Returns Promise<void>

call

  • Send a custom RPC request to the node.

    Returns

    The generic result of the RPC call.

    Type Parameters

    • R

    • P extends any[] = any[]

    Parameters

    • method: string

      The method to call.

    • Optional params: [...P[]]

      The parameters to pass to the method.

    • Optional options: RpcCallOptions

      The options to use when sending a custom RPC request.

    Returns Promise<R>

confirmTransaction

getAccount

  • Fetch a raw account at the given address.

    Returns

    A raw account that may or may not exist.

    Parameters

    • publicKey: PublicKey<string>

      The public key of the account to fetch.

    • Optional options: RpcGetAccountOptions

      The options to use when fetching the account.

    Returns Promise<MaybeRpcAccount>

getAccounts

  • Fetch multiple raw accounts at the given addresses.

    Returns

    An array of raw accounts that may or may not exist.

    Parameters

    Returns Promise<MaybeRpcAccount[]>

getBalance

  • Fetch the balance of an account.

    Returns

    An amount of SOL.

    Parameters

    • publicKey: PublicKey<string>

      The public key of the account.

    • Optional options: RpcBaseOptions

      The options to use when fetching an account's balance.

    Returns Promise<SolAmount>

getBlockTime

  • Fetch the estimated production time of a block.

    Returns

    The estimated production time of the block in Unix time.

    Parameters

    • slot: number

      The slot to get the estimated production time for.

    • Optional options: RpcBaseOptions

      The options to use when getting the block time of a slot.

    Returns Promise<null | bigint>

getCluster

  • The Solana cluster of the RPC being used.

    Returns Cluster

getEndpoint

  • The RPC endpoint used by the client.

    Returns string

getLatestBlockhash

  • Fetch the latest blockhash.

    Returns

    The latest blockhash and its block height.

    Parameters

    • Optional options: RpcBaseOptions

      The options to use when fetching the latest blockhash.

    Returns Promise<BlockhashWithExpiryBlockHeight>

getProgramAccounts

  • Fetch multiple raw accounts from a program.

    Returns

    An array of raw accounts.

    Parameters

    Returns Promise<RpcAccount[]>

getRent

  • Get the amount of rent-exempt SOL required to create an account of the given size.

    Returns

    An amount of SOL.

    Parameters

    • bytes: number

      The size of the account in bytes.

    • Optional options: RpcGetRentOptions

      The options to use when fetching the rent exempt amount.

    Returns Promise<SolAmount>

getSignatureStatuses

  • Fetch transaction commitments from an array of signatures.

    Returns

    An array of transaction statuses in the same order as the signatures. If a transaction was not found, null will be returned instead.

    Parameters

    • signatures: Uint8Array[]

      The signatures of all transactions we want to fetch commitments for.

    • Optional options: RpcGetSignatureStatusesOptions

      The options to use when fetching transaction commitments.

    Returns Promise<(null | TransactionStatus)[]>

getSlot

  • Fetch the recent slot.

    Returns

    The recent slot.

    Parameters

    • Optional options: RpcBaseOptions

      The options to use when fetching the recent slot.

    Returns Promise<number>

getTransaction

  • Fetch a transaction by its signature.

    Returns

    A transaction with its metadata or null if the transaction was not found.

    Parameters

    • signature: Uint8Array

      The signature of the transaction to fetch.

    • Optional options: RpcBaseOptions

      The options to use when fetching transactions.

    Returns Promise<null | TransactionWithMeta>

sendTransaction

  • Send a transaction to the blockchain.

    Returns

    The signature of the sent transaction.

    Parameters

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc