Skip to main content
Defined in: packages/wallets/src/api/client.ts:41

​
Extends

  • CrossmintApiClient

​
Constructors

​
new WalletsApiClient()

new WalletsApiClient(crossmint): ApiClient
Defined in: packages/wallets/src/api/client.ts:45

​
Parameters

ParameterType
crossmintCrossmint

​
Returns

ApiClient

​
Overrides

CrossmintApiClient.constructor

​
Properties

PropertyTypeInherited fromDefined in
crossmintCrossmintCrossmintApiClient.crossmintpackages/common/base/dist/apiClient/CrossmintApiClient.d.ts:18

​
Accessors

​
baseUrl

​
Get Signature

get baseUrl(): string
Defined in: packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:24
Returns
string

​
Inherited from

CrossmintApiClient.baseUrl

​
commonHeaders

​
Get Signature

get commonHeaders(): object
Defined in: packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:25
Returns
object
Authorization?
optional Authorization: string
x-api-key
x-api-key: string
x-app-identifier?
optional x-app-identifier: string
x-client-name
x-client-name: string
x-client-version
x-client-version: string
x-extension-id?
optional x-extension-id: string

​
Inherited from

CrossmintApiClient.commonHeaders

​
environment

​
Get Signature

get environment(): APIKeyEnvironmentPrefix
Defined in: packages/wallets/src/api/client.ts:264
Returns
APIKeyEnvironmentPrefix

​
Overrides

CrossmintApiClient.environment

​
isServerSide

​
Get Signature

get isServerSide(): boolean
Defined in: packages/wallets/src/api/client.ts:260
Returns
boolean

​
Methods

​
approveSignature()

approveSignature(walletLocator, signatureId, params): Promise<ApproveSignatureResponse>
Defined in: packages/wallets/src/api/client.ts:137

​
Parameters

ParameterType
walletLocatorstring
signatureIdstring
paramsSubmitApprovalV2025Dto

​
Returns

Promise<ApproveSignatureResponse>

​
approveTransaction()

approveTransaction(walletLocator, transactionId, params): Promise<ApproveTransactionResponse>
Defined in: packages/wallets/src/api/client.ts:107

​
Parameters

ParameterType
walletLocatorstring
transactionIdstring
paramsSubmitApprovalV2025Dto

​
Returns

Promise<ApproveTransactionResponse>

​
buildUrl()

buildUrl(path): string
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:5

​
Parameters

ParameterType
pathstring

​
Returns

string

​
Inherited from

CrossmintApiClient.buildUrl

​
createSignature()

createSignature(walletLocator, params): Promise<CreateSignatureResponse>
Defined in: packages/wallets/src/api/client.ts:126

​
Parameters

ParameterType
walletLocatorstring
paramsCreateSignatureV2025Dto

​
Returns

Promise<CreateSignatureResponse>

​
createTransaction()

createTransaction(walletLocator, params): Promise<CreateTransactionResponse>
Defined in: packages/wallets/src/api/client.ts:96

​
Parameters

ParameterType
walletLocatorstring
paramsCreateTransactionV2025Dto

​
Returns

Promise<CreateTransactionResponse>

​
createWallet()

createWallet(params): Promise<CreateWalletResponse>
Defined in: packages/wallets/src/api/client.ts:53

​
Parameters

ParameterType
paramsCreateWalletV2025Dto

​
Returns

Promise<CreateWalletResponse>

​
delete()

delete(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:9

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.delete

​
experimental_activity()

experimental_activity(walletLocator, params): Promise<GetActivityResponse>
Defined in: packages/wallets/src/api/client.ts:179

​
Parameters

ParameterType
walletLocatorstring
params{ chain: Chain; }
params.chainChain

​
Returns

Promise<GetActivityResponse>

​
experimental_getNfts()

experimental_getNfts(params): Promise<WalletNftsResponseDto>
Defined in: packages/wallets/src/api/client.ts:163

​
Parameters

ParameterType
params{ address: string; chain: string; page: number; perPage: number; }
params.addressstring
params.chainstring
params.pagenumber
params.perPagenumber

​
Returns

Promise<WalletNftsResponseDto>

​
fundWallet()

fundWallet(walletLocator, params): Promise<FundWalletResponse>
Defined in: packages/wallets/src/api/client.ts:208

​
Parameters

ParameterType
walletLocatorstring
paramsFundWalletAmountDto

​
Returns

Promise<FundWalletResponse>

​
get()

get(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:6

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.get

​
getBalance()

getBalance(walletLocator, params): Promise<GetBalanceResponse>
Defined in: packages/wallets/src/api/client.ts:192

​
Parameters

ParameterType
walletLocatorstring
params{ chains: Chain[]; tokens: string[]; }
params.chainsChain[]
params.tokensstring[]

​
Returns

Promise<GetBalanceResponse>

​
getSignature()

getSignature(walletLocator, signatureId): Promise<GetSignatureResponse>
Defined in: packages/wallets/src/api/client.ts:149

​
Parameters

ParameterType
walletLocatorstring
signatureIdstring

​
Returns

Promise<GetSignatureResponse>

​
getSigner()

getSigner(walletLocator, signer): Promise<GetSignerResponse>
Defined in: packages/wallets/src/api/client.ts:227

​
Parameters

ParameterType
walletLocatorstring
signerstring

​
Returns

Promise<GetSignerResponse>

​
getTransaction()

getTransaction(walletLocator, transactionId): Promise<GetTransactionResponse>
Defined in: packages/wallets/src/api/client.ts:119

​
Parameters

ParameterType
walletLocatorstring
transactionIdstring

​
Returns

Promise<GetTransactionResponse>

​
getTransactions()

getTransactions(walletLocator): Promise<GetTransactionsResponse>
Defined in: packages/wallets/src/api/client.ts:156

​
Parameters

ParameterType
walletLocatorstring

​
Returns

Promise<GetTransactionsResponse>

​
getWallet()

getWallet(locator): Promise<GetWalletResponse>
Defined in: packages/wallets/src/api/client.ts:79

​
Parameters

ParameterType
locatorstring

​
Returns

Promise<GetWalletResponse>

​
patch()

patch(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:10

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.patch

​
post()

post(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:7

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.post

​
put()

put(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:8

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.put

​
registerSigner()

registerSigner(walletLocator, params): Promise<RegisterSignerResponse>
Defined in: packages/wallets/src/api/client.ts:219

​
Parameters

ParameterType
walletLocatorstring
paramsRegisterSignerParams

​
Returns

Promise<RegisterSignerResponse>

​
send()

send(walletLocator, tokenLocator, params): Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDto>
Defined in: packages/wallets/src/api/client.ts:234

​
Parameters

ParameterType
walletLocatorstring
tokenLocatorstring
paramsSendTokenDto

​
Returns

Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDto>

​
normalizePath()

static normalizePath(path): string
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:11

​
Parameters

ParameterType
pathstring

​
Returns

string

​
Inherited from

CrossmintApiClient.normalizePath