​
Interfaces

​
CreateAccountOptions

Defined in: client/solana/solana.types.ts:59 Options for creating a Solana account.

​
Properties

PropertyTypeDescriptionDefined in
accountPolicy?stringThe policy ID to apply to the account.client/solana/solana.types.ts:63
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:65
name?stringThe name of the account.client/solana/solana.types.ts:61

​
ExportAccountOptions

Defined in: client/solana/solana.types.ts:71 Options for exporting a Solana account.

​
Properties

PropertyTypeDescriptionDefined in
address?stringThe address of the account.client/solana/solana.types.ts:73
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:77
name?stringThe name of the account.client/solana/solana.types.ts:75

​
GetAccountOptions

Defined in: client/solana/solana.types.ts:83 Options for getting a Solana account.

​
Properties

PropertyTypeDescriptionDefined in
address?stringThe address of the account.client/solana/solana.types.ts:85
name?stringThe name of the account.client/solana/solana.types.ts:87

​
GetOrCreateAccountOptions

Defined in: client/solana/solana.types.ts:93 Options for getting a Solana account.

​
Properties

PropertyTypeDescriptionDefined in
namestringThe name of the account.client/solana/solana.types.ts:95

​
ImportAccountOptions

Defined in: client/solana/solana.types.ts:171 Options for importing a Solana account.

​
Properties

PropertyTypeDescriptionDefined in
encryptionPublicKey?stringThe public RSA key used to encrypt the private key when importing a Solana account.client/solana/solana.types.ts:173
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:177
name?stringThe name of the account.client/solana/solana.types.ts:175
privateKeystring | Uint8Array<ArrayBufferLike>The private key of the account - can be a base58 encoded string or raw bytes.client/solana/solana.types.ts:179

​
ListAccountsOptions

Defined in: client/solana/solana.types.ts:113 Options for listing Solana accounts.

​
Properties

PropertyTypeDescriptionDefined in
pageSize?numberThe page size.client/solana/solana.types.ts:115
pageToken?stringThe page token.client/solana/solana.types.ts:117

​
ListAccountsResult

Defined in: client/solana/solana.types.ts:123 The result of listing Solana accounts.

​
Properties

PropertyTypeDescriptionDefined in
accounts{ 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>; }[]The accounts.client/solana/solana.types.ts:125
nextPageToken?stringThe token for the next page of accounts, if any.client/solana/solana.types.ts:129

​
ListTokenBalancesOptions

Defined in: client/solana/solana.types.ts:185 Options for listing Solana token balances.

​
Properties

PropertyTypeDescriptionDefined in
addressstringThe address of the account.client/solana/solana.types.ts:187
network?ListSolanaTokenBalancesNetworkThe network to list token balances for.client/solana/solana.types.ts:189
pageSize?numberThe page size.client/solana/solana.types.ts:191
pageToken?stringThe page token.client/solana/solana.types.ts:193

​
ListTokenBalancesResult

Defined in: client/solana/solana.types.ts:245 The result of listing Solana token balances.

​
Properties

PropertyTypeDescriptionDefined in
balancesSolanaTokenBalance[]The token balances.client/solana/solana.types.ts:247
nextPageToken?stringThe next page token to paginate through the token balances. If undefined, there are no more token balances to paginate through.client/solana/solana.types.ts:252

​
RequestFaucetOptions

Defined in: client/solana/solana.types.ts:135 Options for requesting funds from a Solana faucet.

​
Properties

PropertyTypeDescriptionDefined in
addressstringThe address of the account.client/solana/solana.types.ts:137
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:141
token"usdc" | "sol"The token to request funds for.client/solana/solana.types.ts:139

​
SendTransactionOptions

Defined in: client/solana/solana.types.ts:199 Options for sending a Solana transaction.

​
Properties

PropertyTypeDescriptionDefined in
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:205
networkSendSolanaTransactionBodyNetworkThe network to send the transaction to.client/solana/solana.types.ts:201
transactionstringThe base64 encoded transaction to send.client/solana/solana.types.ts:203

​
SignatureResult

Defined in: client/solana/solana.types.ts:51 A Solana signature result.

​
Properties

PropertyTypeDescriptionDefined in
signaturestringThe signature.client/solana/solana.types.ts:53

​
SignMessageOptions

Defined in: client/solana/solana.types.ts:147 Options for signing a Solana message.

​
Properties

PropertyTypeDescriptionDefined in
addressstringThe address of the account.client/solana/solana.types.ts:149
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:153
messagestringThe message to sign.client/solana/solana.types.ts:151

​
SignTransactionOptions

Defined in: client/solana/solana.types.ts:159 Options for signing a Solana transaction.

​
Properties

PropertyTypeDescriptionDefined in
addressstringThe address of the account.client/solana/solana.types.ts:161
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:165
transactionstringThe base64 encoded transaction to sign.client/solana/solana.types.ts:163

​
SolanaToken

Defined in: client/solana/solana.types.ts:223

​
Properties

PropertyTypeDescriptionDefined in
mintAddressstringThe token address.client/solana/solana.types.ts:225
name?stringThe token name.client/solana/solana.types.ts:227
symbol?stringThe token symbol.client/solana/solana.types.ts:229

​
SolanaTokenAmount

Defined in: client/solana/solana.types.ts:216

​
Properties

PropertyTypeDescriptionDefined in
amountbigintThe amount of the token.client/solana/solana.types.ts:218
decimalsnumberThe number of decimals in the token.client/solana/solana.types.ts:220

​
SolanaTokenBalance

Defined in: client/solana/solana.types.ts:235 A Solana token balance.

​
Properties

PropertyTypeDescriptionDefined in
amountSolanaTokenAmountThe amount of the token.client/solana/solana.types.ts:237
tokenSolanaTokenThe token.client/solana/solana.types.ts:239

​
TransactionResult

Defined in: client/solana/solana.types.ts:211 The result of sending a Solana transaction.

​
Properties

PropertyTypeDescriptionDefined in
signaturestringThe signature of the transaction base58 encoded.client/solana/solana.types.ts:213

​
UpdateSolanaAccountOptions

Defined in: client/solana/solana.types.ts:101 Options for creating a SOL server account.

​
Properties

PropertyTypeDescriptionDefined in
addressstringThe address of the account.client/solana/solana.types.ts:103
idempotencyKey?stringThe idempotency key.client/solana/solana.types.ts:107
updateUpdateSolanaAccountBodyThe updates to apply to the accountclient/solana/solana.types.ts:105

​
Type Aliases

​
SolanaClientInterface

type SolanaClientInterface = Omit<typeof OpenApiSolanaMethods, 
  | "createSolanaAccount"
  | "getSolanaAccount"
  | "getSolanaAccountByName"
  | "updateSolanaAccount"
  | "listSolanaAccounts"
  | "requestSolanaFaucet"
  | "signSolanaMessage"
  | "signSolanaTransaction"
  | "updateSolanaAccount"
  | "exportSolanaAccount"
  | "exportSolanaAccountByName"
  | "importSolanaAccount"
  | "listSolanaTokenBalances"
  | "sendSolanaTransaction"> & {
  createAccount: (options: CreateAccountOptions) => Promise<Account>;
  exportAccount: (options: ExportAccountOptions) => Promise<string>;
  getAccount: (options: GetAccountOptions) => Promise<Account>;
  getOrCreateAccount: (options: GetOrCreateAccountOptions) => Promise<Account>;
  importAccount: (options: ImportAccountOptions) => Promise<SolanaAccount>;
  listAccounts: (options: ListAccountsOptions) => Promise<ListAccountsResult>;
  listTokenBalances: (options: ListTokenBalancesOptions) => Promise<ListTokenBalancesResult>;
  requestFaucet: (options: RequestFaucetOptions) => Promise<SignatureResult>;
  sendTransaction: (options: SendSolanaTransactionBody) => Promise<SignatureResult>;
  signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
  signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
  updateAccount: (options: UpdateSolanaAccountOptions) => Promise<Account>;
};
Defined in: client/solana/solana.types.ts:17 The SolanaClient type, where all OpenApiSolanaMethods methods are wrapped.

​
Type declaration

createAccount()
createAccount: (options: CreateAccountOptions) => Promise<Account>;
Parameters
options
CreateAccountOptions
Returns
Promise<Account>
exportAccount()
exportAccount: (options: ExportAccountOptions) => Promise<string>;
Parameters
options
ExportAccountOptions
Returns
Promise<string>
getAccount()
getAccount: (options: GetAccountOptions) => Promise<Account>;
Parameters
options
GetAccountOptions
Returns
Promise<Account>
getOrCreateAccount()
getOrCreateAccount: (options: GetOrCreateAccountOptions) => Promise<Account>;
Parameters
options
GetOrCreateAccountOptions
Returns
Promise<Account>
importAccount()
importAccount: (options: ImportAccountOptions) => Promise<SolanaAccount>;
Parameters
options
ImportAccountOptions
Returns
Promise<SolanaAccount>
listAccounts()
listAccounts: (options: ListAccountsOptions) => Promise<ListAccountsResult>;
Parameters
options
ListAccountsOptions
Returns
Promise<ListAccountsResult>
listTokenBalances()
listTokenBalances: (options: ListTokenBalancesOptions) => Promise<ListTokenBalancesResult>;
Parameters
options
ListTokenBalancesOptions
Returns
Promise<ListTokenBalancesResult>
requestFaucet()
requestFaucet: (options: RequestFaucetOptions) => Promise<SignatureResult>;
Parameters
options
RequestFaucetOptions
Returns
Promise<SignatureResult>
sendTransaction()
sendTransaction: (options: SendSolanaTransactionBody) => Promise<SignatureResult>;
Parameters
options
SendSolanaTransactionBody
Returns
Promise<SignatureResult>
signMessage()
signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
Parameters
options
SignMessageOptions
Returns
Promise<SignatureResult>
signTransaction()
signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
Parameters
options
SignTransactionOptions
Returns
Promise<SignatureResult>
updateAccount()
updateAccount: (options: UpdateSolanaAccountOptions) => Promise<Account>;
Parameters
options
UpdateSolanaAccountOptions
Returns
Promise<Account>