Class RpcClient

Represents the RpcClient used for interacting with the Solana RPC.

Hierarchy

Module
- RpcClient

Index

Constructors

constructor

new RpcClient(_connection?): RpcClient
Parameters
- Optional _connection: Connection
Returns RpcClient
Overrides Module.constructor
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:16

Properties

`Protected` _honeycomb

_honeycomb: Honeycomb

Accessors

connection

get connection(): Connection
Gets the connection object used by the RpcClient.

Returns Connection
The connection object.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:125

feePayer

get feePayer(): Signer
Gets the fee payer's Signer.

Returns Signer
The fee payer's signer.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:130

Methods

accountExists

accountExists(publicKey, commitment?): Promise<boolean>
Checks if an account exists for the specified public key.
Parameters
- publicKey: PublicKey
  
  The public key to check.
- Optional commitment: Commitment
  
  The desired commitment level.
Returns Promise<boolean>
True if the account exists, otherwise false.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:83

airdrop

airdrop(to, lamports): Promise<string>
Requests an airdrop of lamports to the specified public key.
Parameters
- to: PublicKey
  
  The recipient's public key.
- lamports: number
  
  The amount of lamports to airdrop.
Returns Promise<string>
The transaction signature.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:69

confirmTransactions

confirmTransactions(ctxs, commitment?, doNotThrowOnError?): Promise<ConfirmedContext[]>
Confirms an array of processed contexts as transactions on the Solana network.
Parameters
- ctxs: ProcessedContext[]
  
  An array of processed contexts.
- Optional commitment: Commitment
  
  The desired commitment level for the confirmation.
- Optional doNotThrowOnError: boolean
  
  If true, it won't throw an error on confirmation failure.
Returns Promise<ConfirmedContext[]>
An array of confirmed contexts.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:37

getAccount

getAccount(publicKey, commitment?): Promise<AccountInfo<Buffer>>
Retrieves the account information for the specified public key.
Parameters
- publicKey: PublicKey
  
  The public key for the account.
- Optional commitment: Commitment
  
  The desired commitment level.
Returns Promise<AccountInfo<Buffer>>
The account information.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:76

getBalance

getBalance(publicKey, commitment?): Promise<number>
Retrieves the account balance for the specified public key.
Parameters
- publicKey: PublicKey
  
  The public key to check the balance for.
- Optional commitment: Commitment
  
  The desired commitment level.
Returns Promise<number>
The account balance.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:107

getLatestBlockhash

getLatestBlockhash(commitmentOrConfig?): Promise<BlockhashWithBlockHeight>
Retrieves the latest blockhash with its block height.
Parameters
- Optional commitmentOrConfig: Commitment | GetLatestBlockhashConfig
  
  Commitment level or configuration.
Returns Promise<BlockhashWithBlockHeight>
The blockhash with its block height.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:120

getMultipleAccounts

getMultipleAccounts(publicKeys, commitment?): Promise<AccountInfo<Buffer>[]>
Retrieves the account information for multiple public keys.
Parameters
- publicKeys: PublicKey[]
  
  An array of public keys to retrieve account information for.
- Optional commitment: Commitment
  
  The desired commitment level.
Returns Promise<AccountInfo<Buffer>[]>
An array of account information for the specified public keys.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:90

getProgramAccounts

getProgramAccounts(programId, configOrCommitment?): Promise<{
account: AccountInfo<Buffer>;
pubkey: PublicKey;
}[]>
Retrieves program accounts for the specified program ID.
Parameters
- programId: PublicKey
  
  The program ID to query for accounts.
- Optional configOrCommitment: Commitment | GetProgramAccountsConfig
  
  Configuration or commitment level.
Returns Promise<{
account: AccountInfo<Buffer>;
pubkey: PublicKey;
}[]>
An array of program accounts.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:97

getRent

getRent(bytes, commitment?): Promise<number>
Retrieves the minimum balance required to rent an account with the specified data size.
Parameters
- bytes: number
  
  The size of the account data in bytes.
- Optional commitment: Commitment
  
  The desired commitment level.
Returns Promise<number>
The minimum balance required for rent exemption.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:114

honeycomb

honeycomb(): Honeycomb
Get the Honeycomb client instance associated with the module.

Returns Honeycomb
The Honeycomb client instance.
Inherited from Module.honeycomb
- Defined in packages/hive-control/Abstracts.d.ts:13

install

install(honeycomb): Honeycomb
Installs the RpcClient into the Honeycomb instance.
Parameters
- honeycomb: Honeycomb
  
  The Honeycomb instance to install the RpcClient into.
Returns Honeycomb
The Honeycomb instance with the RpcClient installed.
Overrides Module.install
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:136

prepareTransactions

prepareTransactions(ctxs): Promise<PreparedContext[]>
Prepares an array of operation contexts for transaction serialization and signing.
Parameters
- ctxs: OperationContext[]
  
  An array of operation contexts.
Returns Promise<PreparedContext[]>
An array of prepared contexts.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:22

sendAndConfirmTransaction

sendAndConfirmTransaction(ctx, confirmOptions?): Promise<ConfirmedContext>
Sends a transaction context and confirms it on the Solana network.
Parameters
- ctx: OperationContext
  
  The operation context to send and confirm.
- Optional confirmOptions: ConfirmOptions
  
  Options for confirming the transaction.
Returns Promise<ConfirmedContext>
The confirmed context.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:44

sendAndConfirmTransactionsInBatches

sendAndConfirmTransactionsInBatches(items, options?): Promise<ConfirmedContext[]>
Sends an array of transaction contexts in batches and confirms them on the Solana network.
Parameters
- items: OperationContext[]
  
  An array of operation contexts.
- Optional options: ConfirmOptions & {
      batchSize?: number;
      doNotStopOnError?: boolean;
      firstBatchSize?: number;
  }
  
  Options for confirming the transactions in batches.
Returns Promise<ConfirmedContext[]>
An array of confirmed contexts.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:51

sendTransactions

sendTransactions(ctxs, sendOptions?): Promise<ProcessedContext[]>
Sends an array of prepared contexts as transactions to the Solana RPC.
Parameters
- ctxs: OperationContext[]
  
  An array of prepared contexts.
- Optional sendOptions: SendOptions
  
  Options for sending the transactions.
Returns Promise<ProcessedContext[]>
An array of processed contexts.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:29

transfer

transfer(destination, lamports): Promise<ConfirmedContext>
Transfers lamports to the specified destination address.
Parameters
- destination: PublicKey
  
  The recipient's public key.
- lamports: number
  
  The amount of lamports to transfer.
Returns Promise<ConfirmedContext>
The confirmed context of the transaction.
- Defined in packages/hive-control/modules/Rpc/RpcClient.d.ts:62

Class RpcClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional _connection: Connection

Returns RpcClient

Properties

Protected _honeycomb

Accessors

connection

Returns Connection

feePayer

Returns Signer

Methods

accountExists

Parameters

publicKey: PublicKey

Optional commitment: Commitment

Returns Promise<boolean>

airdrop

Parameters

to: PublicKey

lamports: number

Returns Promise<string>

confirmTransactions

Parameters

ctxs: ProcessedContext[]

Optional commitment: Commitment

Optional doNotThrowOnError: boolean

Returns Promise<ConfirmedContext[]>

getAccount

Parameters

publicKey: PublicKey

Optional commitment: Commitment

Returns Promise<AccountInfo<Buffer>>

getBalance

Parameters

publicKey: PublicKey

Optional commitment: Commitment

Returns Promise<number>

getLatestBlockhash

Parameters

Optional commitmentOrConfig: Commitment | GetLatestBlockhashConfig

Returns Promise<BlockhashWithBlockHeight>

getMultipleAccounts

Parameters

publicKeys: PublicKey[]

Optional commitment: Commitment

Returns Promise<AccountInfo<Buffer>[]>

getProgramAccounts

Parameters

programId: PublicKey

Optional configOrCommitment: Commitment | GetProgramAccountsConfig

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

getRent

Parameters

bytes: number

Optional commitment: Commitment

Returns Promise<number>

honeycomb

Returns Honeycomb

install

Parameters

honeycomb: Honeycomb

Returns Honeycomb

prepareTransactions

Parameters

ctxs: OperationContext[]

Returns Promise<PreparedContext[]>

sendAndConfirmTransaction

Parameters

ctx: OperationContext

Optional confirmOptions: ConfirmOptions

Returns Promise<ConfirmedContext>

`Optional` _connection: Connection

`Protected` _honeycomb

`Optional` commitment: Commitment

`Optional` commitment: Commitment

`Optional` doNotThrowOnError: boolean

`Optional` commitment: Commitment

`Optional` commitment: Commitment

`Optional` commitmentOrConfig: Commitment | GetLatestBlockhashConfig

`Optional` commitment: Commitment

`Optional` configOrCommitment: Commitment | GetProgramAccountsConfig

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

`Optional` commitment: Commitment

`Optional` confirmOptions: ConfirmOptions

`Optional` options: ConfirmOptions & {
batchSize?: number;
doNotStopOnError?: boolean;
firstBatchSize?: number;
}

`Optional` sendOptions: SendOptions