Classes
SolanaClient
Defined in: client/solana/solana.ts:53 The namespace containing all Solana methods.Implements
Constructors
Constructor
Returns
SolanaClient
Methods
createAccount()
Parameters
options
CreateAccountOptions
= {}
Parameters for creating the Solana account.
Returns
Promise
<{
fund
: (options
: Omit
<SolanaFundOptions
, "address"
>) => Promise
<FundOperationResult
>;
quoteFund
: (options
: Omit
<SolanaQuoteFundOptions
, "address"
>) => Promise
<SolanaQuote
>;
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
>;
transfer
: (options
: Omit
<TransferOptions
, "from"
>) => Promise
<SignatureResult
>;
waitForFundOperationReceipt
: Promise
<WaitForFundOperationResult
>;
}>
A promise that resolves to the newly created account.
Examples
Implementation of
exportAccount()
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()
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
<{
fund
: (options
: Omit
<SolanaFundOptions
, "address"
>) => Promise
<FundOperationResult
>;
quoteFund
: (options
: Omit
<SolanaQuoteFundOptions
, "address"
>) => Promise
<SolanaQuote
>;
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
>;
transfer
: (options
: Omit
<TransferOptions
, "from"
>) => Promise
<SignatureResult
>;
waitForFundOperationReceipt
: Promise
<WaitForFundOperationResult
>;
}>
A promise that resolves to the account.
Examples
Implementation of
getOrCreateAccount()
Parameters
options
GetOrCreateAccountOptions
Parameters for getting or creating the Solana account.
Returns
Promise
<{
fund
: (options
: Omit
<SolanaFundOptions
, "address"
>) => Promise
<FundOperationResult
>;
quoteFund
: (options
: Omit
<SolanaQuoteFundOptions
, "address"
>) => Promise
<SolanaQuote
>;
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
>;
transfer
: (options
: Omit
<TransferOptions
, "from"
>) => Promise
<SignatureResult
>;
waitForFundOperationReceipt
: Promise
<WaitForFundOperationResult
>;
}>
A promise that resolves to the account.
Example
Implementation of
importAccount()
Parameters
options
ImportAccountOptions
Parameters for importing the Solana account.
Returns
Promise
<{
fund
: (options
: Omit
<SolanaFundOptions
, "address"
>) => Promise
<FundOperationResult
>;
quoteFund
: (options
: Omit
<SolanaQuoteFundOptions
, "address"
>) => Promise
<SolanaQuote
>;
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
>;
transfer
: (options
: Omit
<TransferOptions
, "from"
>) => Promise
<SignatureResult
>;
waitForFundOperationReceipt
: Promise
<WaitForFundOperationResult
>;
}>
A promise that resolves to the imported account.
Examples
Implementation of
listAccounts()
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()
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()
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()
Parameters
options
SendTransactionOptions
Parameters for sending the Solana transaction.
Returns
Promise
<SendTransactionResult
>
A promise that resolves to the transaction result.
Example
Implementation of
signMessage()
Parameters
options
SignMessageOptions
Parameters for signing the message.
Returns
Promise
<SignatureResult
>
A promise that resolves to the signature.
Example
Implementation of
signTransaction()
Parameters
options
SignTransactionOptions
Parameters for signing the transaction.
Returns
Promise
<SignTransactionResult
>
A promise that resolves to the signature.
Example
Implementation of
updateAccount()
Parameters
options?
UpdateSolanaAccountOptions
Optional parameters for creating the account.
Returns
Promise
<{
fund
: (options
: Omit
<SolanaFundOptions
, "address"
>) => Promise
<FundOperationResult
>;
quoteFund
: (options
: Omit
<SolanaQuoteFundOptions
, "address"
>) => Promise
<SolanaQuote
>;
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
>;
transfer
: (options
: Omit
<TransferOptions
, "from"
>) => Promise
<SignatureResult
>;
waitForFundOperationReceipt
: Promise
<WaitForFundOperationResult
>;
}>
A promise that resolves to the updated account.