Interface RpcInterface

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

interface RpcInterface {
    accountExists(
        publicKey: PublicKey,
        options?: RpcBaseOptions,
    ): Promise<boolean>;
    airdrop(
        publicKey: PublicKey,
        amount: SolAmount,
        options?: Partial<RpcConfirmTransactionOptions>,
    ): Promise<void>;
    call<R, P extends any[] | Record<string, any> = any[]>(
        method: string,
        params?: P,
        options?: RpcCallOptions,
    ): Promise<R>;
    confirmTransaction(
        signature: TransactionSignature,
        options: RpcConfirmTransactionOptions,
    ): Promise<RpcConfirmTransactionResult>;
    getAccount(
        publicKey: PublicKey,
        options?: RpcGetAccountOptions,
    ): Promise<MaybeRpcAccount>;
    getAccounts(
        publicKeys: PublicKey[],
        options?: RpcGetAccountsOptions,
    ): Promise<MaybeRpcAccount[]>;
    getBalance(
        publicKey: PublicKey,
        options?: RpcBaseOptions,
    ): Promise<SolAmount>;
    getBlockTime(
        slot: number,
        options?: RpcBaseOptions,
    ): Promise<null | bigint>;
    getCluster(): Cluster;
    getEndpoint(): string;
    getGenesisHash(): Promise<string>;
    getLatestBlockhash(
        options?: RpcBaseOptions,
    ): Promise<BlockhashWithExpiryBlockHeight>;
    getProgramAccounts(
        programId: PublicKey,
        options?: RpcGetProgramAccountsOptions,
    ): Promise<RpcAccount[]>;
    getRent(bytes: number, options?: RpcGetRentOptions): Promise<SolAmount>;
    getSignatureStatuses(
        signatures: TransactionSignature[],
        options?: RpcGetSignatureStatusesOptions,
    ): Promise<(null | TransactionStatus)[]>;
    getSlot(options?: RpcBaseOptions): Promise<number>;
    getTransaction(
        signature: TransactionSignature,
        options?: RpcBaseOptions,
    ): Promise<
        | null
        | Transaction & { meta: TransactionMeta } & RpcGetTransactionResponseOther,
    >;
    sendTransaction(
        transaction: Transaction,
        options?: RpcSendTransactionOptions,
    ): Promise<TransactionSignature>;
    simulateTransaction(
        transaction: Transaction,
        options?: RpcSimulateTransactionOptions,
    ): Promise<RpcSimulateTransactionResult>;
}

Index

Methods

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

Methods

accountExists

accountExists(publicKey: PublicKey, options?: RpcBaseOptions): Promise<boolean>
Whether or not an account at a given address exists.
Parameters
- publicKey: PublicKey
  The public key of the account.
- Optionaloptions: RpcBaseOptions
  The options to use when checking if an account exists.
Returns Promise<boolean>
true if the account exists, false otherwise.
- Defined in packages/umi/src/RpcInterface.ts:158

airdrop

airdrop(
    publicKey: PublicKey,
    amount: SolAmount,
    options?: Partial<RpcConfirmTransactionOptions>,
): Promise<void>
Send and confirm an airdrop transaction to the given address.
Parameters
- publicKey: PublicKey
  The public key of the account to airdrop to.
- amount: SolAmount
  The amount of SOL to airdrop.
- Optionaloptions: Partial<RpcConfirmTransactionOptions>
  The options to use when airdropping SOL.
Returns Promise<void>
- Defined in packages/umi/src/RpcInterface.ts:170

call

call<R, P extends any[] | Record<string, any> = any[]>(
    method: string,
    params?: P,
    options?: RpcCallOptions,
): Promise<R>
Send a custom RPC request to the node.
Type Parameters
- R
- P extends any[] | Record<string, any> = any[]
Parameters
- method: string
  The method to call.
- Optionalparams: P
  The parameters to pass to the method. Can be either: - An array for positional parameters - An object for named parameters
- Optionaloptions: RpcCallOptions
  The options to use when sending a custom RPC request.
Returns Promise<R>
The generic result of the RPC call.
- Defined in packages/umi/src/RpcInterface.ts:186

confirmTransaction

confirmTransaction(
signature: TransactionSignature,
options: RpcConfirmTransactionOptions,
): Promise<RpcConfirmTransactionResult>
Confirm a sent transaction.
Parameters
- signature: TransactionSignature
  The signature of the transaction to confirm.
- options: RpcConfirmTransactionOptions
  The options to use when confirming a transaction.
Returns Promise<RpcConfirmTransactionResult>
The RPC response of the transaction confirmation.
- Defined in packages/umi/src/RpcInterface.ts:223

getAccount

getAccount(
publicKey: PublicKey,
options?: RpcGetAccountOptions,
): Promise<MaybeRpcAccount>
Fetch a raw account at the given address.
Parameters
- publicKey: PublicKey
  The public key of the account to fetch.
- Optionaloptions: RpcGetAccountOptions
  The options to use when fetching the account.
Returns Promise<MaybeRpcAccount>
A raw account that may or may not exist.
- Defined in packages/umi/src/RpcInterface.ts:39

getAccounts

getAccounts(
publicKeys: PublicKey[],
options?: RpcGetAccountsOptions,
): Promise<MaybeRpcAccount[]>
Fetch multiple raw accounts at the given addresses.
Parameters
- publicKeys: PublicKey[]
- Optionaloptions: RpcGetAccountsOptions
  The options to use when fetching multiple accounts.
Returns Promise<MaybeRpcAccount[]>
An array of raw accounts that may or may not exist.
- Defined in packages/umi/src/RpcInterface.ts:51

getBalance

getBalance(publicKey: PublicKey, options?: RpcBaseOptions): Promise<SolAmount>
Fetch the balance of an account.
Parameters
- publicKey: PublicKey
  The public key of the account.
- Optionaloptions: RpcBaseOptions
  The options to use when fetching an account's balance.
Returns Promise<SolAmount>
An amount of SOL.
- Defined in packages/umi/src/RpcInterface.ts:87

getBlockTime

getBlockTime(slot: number, options?: RpcBaseOptions): Promise<null | bigint>
Fetch the estimated production time of a block.
Parameters
- slot: number
  The slot to get the estimated production time for.
- Optionaloptions: RpcBaseOptions
  The options to use when getting the block time of a slot.
Returns Promise<null | bigint>
The estimated production time of the block in Unix time.
- Defined in packages/umi/src/RpcInterface.ts:75

getCluster

getCluster(): Cluster
The Solana cluster of the RPC being used.

Returns Cluster
- Defined in packages/umi/src/RpcInterface.ts:30

getEndpoint

getEndpoint(): string
The RPC endpoint used by the client.

Returns string
- Defined in packages/umi/src/RpcInterface.ts:27

getGenesisHash

getGenesisHash(): Promise<string>
Get the genesis hash.

Returns Promise<string>
The genesis hash.
- Defined in packages/umi/src/RpcInterface.ts:97

getLatestBlockhash

getLatestBlockhash(
options?: RpcBaseOptions,
): Promise<BlockhashWithExpiryBlockHeight>
Fetch the latest blockhash.
Parameters
- Optionaloptions: RpcBaseOptions
  The options to use when fetching the latest blockhash.
Returns Promise<BlockhashWithExpiryBlockHeight>
The latest blockhash and its block height.
- Defined in packages/umi/src/RpcInterface.ts:122

getProgramAccounts

getProgramAccounts(
programId: PublicKey,
options?: RpcGetProgramAccountsOptions,
): Promise<RpcAccount[]>
Fetch multiple raw accounts from a program.
Parameters
- programId: PublicKey
  The public key of the program to fetch accounts from.
- Optionaloptions: RpcGetProgramAccountsOptions
  The options to use when fetching program accounts.
Returns Promise<RpcAccount[]>
An array of raw accounts.
- Defined in packages/umi/src/RpcInterface.ts:63

getRent

getRent(bytes: number, options?: RpcGetRentOptions): Promise<SolAmount>
Get the amount of rent-exempt SOL required to create an account of the given size.
Parameters
- bytes: number
  The size of the account in bytes.
- Optionaloptions: RpcGetRentOptions
  The options to use when fetching the rent exempt amount.
Returns Promise<SolAmount>
An amount of SOL.
- Defined in packages/umi/src/RpcInterface.ts:106

getSignatureStatuses

getSignatureStatuses(
signatures: TransactionSignature[],
options?: RpcGetSignatureStatusesOptions,
): Promise<(null | TransactionStatus)[]>
Fetch transaction commitments from an array of signatures.
Parameters
- signatures: TransactionSignature[]
  The signatures of all transactions we want to fetch commitments for.
- Optionaloptions: RpcGetSignatureStatusesOptions
  The options to use when fetching transaction commitments.
Returns Promise<(null | TransactionStatus)[]>
An array of transaction statuses in the same order as the signatures. If a transaction was not found, null will be returned instead.
- Defined in packages/umi/src/RpcInterface.ts:146

getSlot

getSlot(options?: RpcBaseOptions): Promise<number>
Fetch the recent slot.
Parameters
- Optionaloptions: RpcBaseOptions
  The options to use when fetching the recent slot.
Returns Promise<number>
The recent slot.
- Defined in packages/umi/src/RpcInterface.ts:114

getTransaction

getTransaction(
    signature: TransactionSignature,
    options?: RpcBaseOptions,
): Promise<
    | null
    | Transaction & { meta: TransactionMeta } & RpcGetTransactionResponseOther,
>
Fetch a transaction by its signature.
Parameters
- signature: TransactionSignature
  The signature of the transaction to fetch.
- Optionaloptions: RpcBaseOptions
  The options to use when fetching transactions.
Returns Promise<
| null
| Transaction & { meta: TransactionMeta } & RpcGetTransactionResponseOther,
>
A transaction with its metadata or null if the transaction was not found.
- Defined in packages/umi/src/RpcInterface.ts:133

sendTransaction

sendTransaction(
transaction: Transaction,
options?: RpcSendTransactionOptions,
): Promise<TransactionSignature>
Send a transaction to the blockchain.
Parameters
- transaction: Transaction
  The transaction to send.
- Optionaloptions: RpcSendTransactionOptions
  The options to use when sending a transaction.
Returns Promise<TransactionSignature>
The signature of the sent transaction.
- Defined in packages/umi/src/RpcInterface.ts:199

simulateTransaction

simulateTransaction(
transaction: Transaction,
options?: RpcSimulateTransactionOptions,
): Promise<RpcSimulateTransactionResult>
Simulate a transaction.
Parameters
- transaction: Transaction
  The transaction to simulate.
- Optionaloptions: RpcSimulateTransactionOptions
  The options to use when simulating a transaction.
Returns Promise<RpcSimulateTransactionResult>
The signature of the sent transaction.
- Defined in packages/umi/src/RpcInterface.ts:211

Interface RpcInterface

Index

Methods

Methods

accountExists

Parameters

Returns Promise<boolean>

airdrop

Parameters

Returns Promise<void>

call

Type Parameters

Parameters

Returns Promise<R>

confirmTransaction

Parameters

Returns Promise<RpcConfirmTransactionResult>

getAccount

Parameters

Returns Promise<MaybeRpcAccount>

getAccounts

Parameters

Returns Promise<MaybeRpcAccount[]>

getBalance

Parameters

Returns Promise<SolAmount>

getBlockTime

Parameters

Returns Promise<null | bigint>

getCluster

Returns Cluster

getEndpoint

Returns string

getGenesisHash

Returns Promise<string>

getLatestBlockhash

Parameters

Returns Promise<BlockhashWithExpiryBlockHeight>

getProgramAccounts

Parameters

Returns Promise<RpcAccount[]>

getRent

Parameters

Returns Promise<SolAmount>

getSignatureStatuses

Parameters

Returns Promise<(null | TransactionStatus)[]>

getSlot

Parameters

Returns Promise<number>

getTransaction

Parameters

Returns Promise< | null | Transaction & { meta: TransactionMeta } & RpcGetTransactionResponseOther,>

sendTransaction

Parameters

Returns Promise<TransactionSignature>

simulateTransaction

Parameters

Returns Promise<RpcSimulateTransactionResult>

Settings

On This Page

Returns Promise<
| null
| Transaction & { meta: TransactionMeta } & RpcGetTransactionResponseOther,
>