Interfaces
CreateAccountOptions
Defined in: client/solana/solana.types.ts:59 Options for creating a Solana account.Properties
accountPolicy?
idempotencyKey?
name?
ExportAccountOptions
Defined in: client/solana/solana.types.ts:71 Options for exporting a Solana account.Properties
address?
idempotencyKey?
name?
GetAccountOptions
Defined in: client/solana/solana.types.ts:83 Options for getting a Solana account.Properties
address?
name?
GetOrCreateAccountOptions
Defined in: client/solana/solana.types.ts:93 Options for getting a Solana account.Properties
name
ImportAccountOptions
Defined in: client/solana/solana.types.ts:171 Options for importing a Solana account.Properties
encryptionPublicKey?
idempotencyKey?
name?
privateKey
ListAccountsOptions
Defined in: client/solana/solana.types.ts:113 Options for listing Solana accounts.Properties
pageSize?
pageToken?
ListAccountsResult
Defined in: client/solana/solana.types.ts:123 The result of listing Solana accounts.Properties
accounts
fund()
Parameters
options
Omit
<SolanaFundOptions
, "address"
>
The options for the fund operation.
Returns
Promise
<FundOperationResult
>
A promise that resolves to the fund operation result containing the transfer details.
Example
quoteFund()
Parameters
options
Omit
<SolanaQuoteFundOptions
, "address"
>
The options for the quote fund.
Returns
Promise
<SolanaQuote
>
A promise that resolves to a Quote object containing details about the funding operation.
Example
requestFaucet()
Parameters
options
Omit
<RequestFaucetOptions
, "address"
>
Parameters for requesting funds from the Solana faucet.
Returns
Promise
<SignatureResult
>
A promise that resolves to the transaction hash.
Example
sendTransaction()
Parameters
options
Omit
<SendTransactionOptions
, "address"
>
Parameters for sending the transaction.
Returns
Promise
<SendTransactionResult
>
A promise that resolves to the transaction signature.
Example
signMessage()
Parameters
options
Omit
<SignMessageOptions
, "address"
>
Parameters for signing the message.
Returns
Promise
<SignatureResult
>
A promise that resolves to the signature.
Example
signTransaction()
Parameters
options
Omit
<SignTransactionOptions
, "address"
>
Parameters for signing the transaction.
Returns
Promise
<SignTransactionResult
>
A promise that resolves to the signature.
Example
transfer()
Parameters
options
Omit
<TransferOptions
, "from"
>
Parameters for the transfer.
Returns
Promise
<SignatureResult
>
A promise that resolves to the transaction signature, which can be used to wait for the transaction result.
Example
waitForFundOperationReceipt()
Parameters
options
WaitForFundOperationOptions
The options for the wait for fund operation.
Returns
Promise
<WaitForFundOperationResult
>
A promise that resolves to the completed transfer receipt containing details about the funding operation.
Example
nextPageToken?
ListTokenBalancesOptions
Defined in: client/solana/solana.types.ts:185 Options for listing Solana token balances.Properties
address
network?
pageSize?
pageToken?
ListTokenBalancesResult
Defined in: client/solana/solana.types.ts:245 The result of listing Solana token balances.Properties
balances
nextPageToken?
RequestFaucetOptions
Defined in: client/solana/solana.types.ts:135 Options for requesting funds from a Solana faucet.Properties
address
idempotencyKey?
token
SendTransactionOptions
Defined in: client/solana/solana.types.ts:199 Options for sending a Solana transaction.Properties
idempotencyKey?
network
transaction
SignatureResult
Defined in: client/solana/solana.types.ts:51 A Solana signature result.Properties
signature
SignMessageOptions
Defined in: client/solana/solana.types.ts:147 Options for signing a Solana message.Properties
address
idempotencyKey?
message
SignTransactionOptions
Defined in: client/solana/solana.types.ts:159 Options for signing a Solana transaction.Properties
address
idempotencyKey?
transaction
SolanaToken
Defined in: client/solana/solana.types.ts:223Properties
mintAddress
name?
symbol?
SolanaTokenAmount
Defined in: client/solana/solana.types.ts:216Properties
amount
decimals
SolanaTokenBalance
Defined in: client/solana/solana.types.ts:235 A Solana token balance.Properties
amount
token
TransactionResult
Defined in: client/solana/solana.types.ts:211 The result of sending a Solana transaction.Properties
signature
UpdateSolanaAccountOptions
Defined in: client/solana/solana.types.ts:101 Options for creating a SOL server account.Properties
address
idempotencyKey?
update
Type Aliases
SolanaClientInterface
Type declaration
createAccount()
Parameters
options
CreateAccountOptions
Returns
Promise
<Account
>
exportAccount()
Parameters
options
ExportAccountOptions
Returns
Promise
<string
>
getAccount()
Parameters
options
GetAccountOptions
Returns
Promise
<Account
>
getOrCreateAccount()
Parameters
options
GetOrCreateAccountOptions
Returns
Promise
<Account
>
importAccount()
Parameters
options
ImportAccountOptions
Returns
Promise
<SolanaAccount
>
listAccounts()
Parameters
options
ListAccountsOptions
Returns
Promise
<ListAccountsResult
>
listTokenBalances()
Parameters
options
ListTokenBalancesOptions
Returns
Promise
<ListTokenBalancesResult
>
requestFaucet()
Parameters
options
RequestFaucetOptions
Returns
Promise
<SignatureResult
>
sendTransaction()
Parameters
options
SendSolanaTransactionBody
Returns
Promise
<SignatureResult
>
signMessage()
Parameters
options
SignMessageOptions
Returns
Promise
<SignatureResult
>
signTransaction()
Parameters
options
SignTransactionOptions
Returns
Promise
<SignatureResult
>
updateAccount()
Parameters
options
UpdateSolanaAccountOptions
Returns
Promise
<Account
>