Skip to main content
Defined in: client/solana/solana.ts:53 The namespace containing all Solana methods.

Implements

Constructors

Constructor

Returns

SolanaClient

Methods

createAccount()

Defined in: client/solana/solana.ts:84 Creates a new Solana account.

Parameters

options?
CreateAccountOptions = {} Parameters for creating the Solana account.

Returns

Promise<{ requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<SignatureResult>; sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<SendTransactionResult>; signMessage: (options: Omit<SignMessageOptions, "address">) => Promise<SignatureResult>; signTransaction: (options: Omit<SignTransactionOptions, "address">) => Promise<SignTransactionResult>; signX402Payment: (paymentRequired: PaymentRequired, acceptedIndex: number) => Promise<PaymentPayload>; transfer: (options: Omit<TransferOptions, "from">) => Promise<SignatureResult>; }> A promise that resolves to the newly created account.

Examples

Implementation of


exportAccount()

Defined in: client/solana/solana.ts:122 Exports a CDP Solana account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters

options
ExportAccountOptions Parameters for exporting the Solana account.

Returns

Promise<string> A promise that resolves to the exported account’s full 64-byte private key as a base58 encoded string.

Examples

Implementation of


getAccount()

Defined in: client/solana/solana.ts:283 Gets a Solana account by its address.

Parameters

options
GetAccountOptions Parameters for getting the Solana account. Either address or name must be provided. If both are provided, lookup will be done by address and name will be ignored.

Returns

Promise<{ requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<SignatureResult>; sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<SendTransactionResult>; signMessage: (options: Omit<SignMessageOptions, "address">) => Promise<SignatureResult>; signTransaction: (options: Omit<SignTransactionOptions, "address">) => Promise<SignTransactionResult>; signX402Payment: (paymentRequired: PaymentRequired, acceptedIndex: number) => Promise<PaymentPayload>; transfer: (options: Omit<TransferOptions, "from">) => Promise<SignatureResult>; }> A promise that resolves to the account.

Examples

Implementation of


getOrCreateAccount()

Defined in: client/solana/solana.ts:312 Gets a Solana account by its address.

Parameters

options
GetOrCreateAccountOptions Parameters for getting or creating the Solana account.

Returns

Promise<{ requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<SignatureResult>; sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<SendTransactionResult>; signMessage: (options: Omit<SignMessageOptions, "address">) => Promise<SignatureResult>; signTransaction: (options: Omit<SignTransactionOptions, "address">) => Promise<SignTransactionResult>; signX402Payment: (paymentRequired: PaymentRequired, acceptedIndex: number) => Promise<PaymentPayload>; transfer: (options: Omit<TransferOptions, "from">) => Promise<SignatureResult>; }> A promise that resolves to the account.

Example

Implementation of


importAccount()

Defined in: client/solana/solana.ts:203 Imports a Solana account using a private key. The private key will be encrypted before being stored securely.

Parameters

options
ImportAccountOptions Parameters for importing the Solana account.

Returns

Promise<{ requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<SignatureResult>; sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<SendTransactionResult>; signMessage: (options: Omit<SignMessageOptions, "address">) => Promise<SignatureResult>; signTransaction: (options: Omit<SignTransactionOptions, "address">) => Promise<SignTransactionResult>; signX402Payment: (paymentRequired: PaymentRequired, acceptedIndex: number) => Promise<PaymentPayload>; transfer: (options: Omit<TransferOptions, "from">) => Promise<SignatureResult>; }> A promise that resolves to the imported account.

Examples

Implementation of


listAccounts()

Defined in: client/solana/solana.ts:376 Lists all Solana accounts.

Parameters

options?
ListAccountsOptions = {} Parameters for listing the Solana accounts.

Returns

Promise<ListAccountsResult> A promise that resolves to an array of Solana account instances.

Examples

}

listTokenBalances()

Defined in: client/solana/solana.ts:664 Lists the token balances for a Solana account.

Parameters

options
ListTokenBalancesOptions Parameters for listing the Solana token balances.

Returns

Promise<ListTokenBalancesResult> A promise that resolves to an array of Solana token balance instances.

Example

Implementation of


requestFaucet()

Defined in: client/solana/solana.ts:422 Requests funds from a Solana faucet.

Parameters

options
RequestFaucetOptions Parameters for requesting funds from the Solana faucet.

Returns

Promise<SignatureResult> A promise that resolves to the transaction signature.

Example

Implementation of


sendTransaction()

Defined in: client/solana/solana.ts:630 Sends a Solana transaction using the Coinbase API.

Parameters

options
SendTransactionOptions Parameters for sending the Solana transaction.

Returns

Promise<SendTransactionResult> A promise that resolves to the transaction result.

Example

Implementation of


signMessage()

Defined in: client/solana/solana.ts:458 Signs a message.

Parameters

options
SignMessageOptions Parameters for signing the message.

Returns

Promise<SignatureResult> A promise that resolves to the signature.

Example

Implementation of


signTransaction()

Defined in: client/solana/solana.ts:531 Signs a transaction.

Parameters

options
SignTransactionOptions Parameters for signing the transaction.

Returns

Promise<SignTransactionResult> A promise that resolves to the signature.

Example

Implementation of


updateAccount()

Defined in: client/solana/solana.ts:586 Updates a CDP Solana account.

Parameters

options?
UpdateSolanaAccountOptions Optional parameters for creating the account.

Returns

Promise<{ requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<SignatureResult>; sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<SendTransactionResult>; signMessage: (options: Omit<SignMessageOptions, "address">) => Promise<SignatureResult>; signTransaction: (options: Omit<SignTransactionOptions, "address">) => Promise<SignTransactionResult>; signX402Payment: (paymentRequired: PaymentRequired, acceptedIndex: number) => Promise<PaymentPayload>; transfer: (options: Omit<TransferOptions, "from">) => Promise<SignatureResult>; }> A promise that resolves to the updated account.

Examples

Implementation of