WalletsApiClient

Defined in: packages/wallets/src/api/client.ts:47

Extends

• CrossmintApiClient

Constructors

new WalletsApiClient()

new WalletsApiClient(crossmint): ApiClient

Defined in: packages/wallets/src/api/client.ts:51

Parameters

Parameter	Type
crossmint	Crossmint

Returns

ApiClient

Overrides

CrossmintApiClient.constructor

Properties

Property	Type	Inherited from	Defined in
crossmint	Crossmint	CrossmintApiClient.crossmint	packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:15

Accessors

baseUrl

Get Signature

get baseUrl(): string

Defined in: packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:21

Returns

string

Inherited from

CrossmintApiClient.baseUrl

---

commonHeaders

Get Signature

get commonHeaders(): object

Defined in: packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:22

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:348

Returns

APIKeyEnvironmentPrefix

Overrides

CrossmintApiClient.environment

---

isServerSide

Get Signature

get isServerSide(): boolean

Defined in: packages/wallets/src/api/client.ts:344

Returns

boolean

---

projectId

Get Signature

get projectId(): string

Defined in: packages/wallets/src/api/client.ts:355

Returns

string

Methods

approveSignature()

approveSignature(walletLocator, signatureId, params): Promise<ApproveSignatureResponse>

Defined in: packages/wallets/src/api/client.ts:146

Parameters

Parameter	Type
walletLocator	string
signatureId	string
params	SubmitApprovalV2025Dto

Returns

Promise<ApproveSignatureResponse>

---

approveTransaction()

approveTransaction(walletLocator, transactionId, params): Promise<ApproveTransactionResponse>

Defined in: packages/wallets/src/api/client.ts:116

Parameters

Parameter	Type
walletLocator	string
transactionId	string
params	SubmitApprovalV2025Dto

Returns

Promise<ApproveTransactionResponse>

---

buildUrl()

buildUrl(path): string

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:11

Parameters

Parameter	Type
path	string

Returns

string

Inherited from

CrossmintApiClient.buildUrl

---

createSignature()

createSignature(walletLocator, params): Promise<CreateSignatureResponse>

Defined in: packages/wallets/src/api/client.ts:135

Parameters

Parameter	Type
walletLocator	string
params	CreateSignatureV2025Dto

Returns

Promise<CreateSignatureResponse>

---

createTransaction()

createTransaction(walletLocator, params): Promise<CreateTransactionResponse>

Defined in: packages/wallets/src/api/client.ts:105

Parameters

Parameter	Type
walletLocator	string
params	CreateTransactionV2025DtoClass

Returns

Promise<CreateTransactionResponse>

---

createWallet()

createWallet(params): Promise<CreateWalletResponse>

Defined in: packages/wallets/src/api/client.ts:59

Parameters

Parameter	Type
params	CreateWalletV2025DtoClass

Returns

Promise<CreateWalletResponse>

---

delete()

delete(path, params): Promise<Response>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:15

Parameters

Parameter	Type
path	string
params	Omit<RequestInit, "method">

Returns

Promise<Response>

Inherited from

CrossmintApiClient.delete

---

fundWallet()

fundWallet(walletLocator, params): Promise<FundWalletResponse>

Defined in: packages/wallets/src/api/client.ts:228

Parameters

Parameter	Type
walletLocator	string
params	FundWalletAmountDto

Returns

Promise<FundWalletResponse>

---

get()

get(path, params): Promise<Response>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:12

Parameters

Parameter	Type
path	string
params	Omit<RequestInit, "method">

Returns

Promise<Response>

Inherited from

CrossmintApiClient.get

---

getBalance()

getBalance(walletLocator, params): Promise<GetBalanceResponse>

Defined in: packages/wallets/src/api/client.ts:212

Parameters

Parameter	Type
walletLocator	string
params	{ chains: Chain[]; tokens: string[]; }
params.chains	Chain[]
params.tokens	string[]

Returns

Promise<GetBalanceResponse>

---

getNfts()

getNfts(params): Promise<unknown>

Defined in: packages/wallets/src/api/client.ts:177

Parameters

Parameter	Type
params	{ address: string; chain: string; page: number; perPage: number; }
params.address	string
params.chain	string
params.page	number
params.perPage	number

Returns

Promise<unknown>

---

getSignature()

getSignature(walletLocator, signatureId): Promise<GetSignatureResponse>

Defined in: packages/wallets/src/api/client.ts:163

Parameters

Parameter	Type
walletLocator	string
signatureId	string

Returns

Promise<GetSignatureResponse>

---

getSigner()

getSigner(walletLocator, signer): Promise<GetSignerResponse>

Defined in: packages/wallets/src/api/client.ts:298

Parameters

Parameter	Type
walletLocator	string
signer	string

Returns

Promise<GetSignerResponse>

---

getTransaction()

getTransaction(walletLocator, transactionId): Promise<GetTransactionResponse>

Defined in: packages/wallets/src/api/client.ts:128

Parameters

Parameter	Type
walletLocator	string
transactionId	string

Returns

Promise<GetTransactionResponse>

---

getTransactions()

getTransactions(walletLocator): Promise<GetTransactionsResponse>

Defined in: packages/wallets/src/api/client.ts:170

Parameters

Parameter	Type
walletLocator	string

Returns

Promise<GetTransactionsResponse>

---

getTransfers()

getTransfers(walletLocator, params): Promise<GetTransfersResponse>

Defined in: packages/wallets/src/api/client.ts:193

Parameters

Parameter	Type
walletLocator	string
params	{ chain: Chain; status: "successful" | "failed"; tokens: string; }
params.chain	Chain
params.status	"successful" | "failed"
params.tokens?	string

Returns

Promise<GetTransfersResponse>

---

getWallet()

getWallet(locator): Promise<GetWalletResponse>

Defined in: packages/wallets/src/api/client.ts:85

Parameters

Parameter	Type
locator	string

Returns

Promise<GetWalletResponse>

---

patch()

patch(path, params): Promise<Response>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:16

Parameters

Parameter	Type
path	string
params	Omit<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:13

Parameters

Parameter	Type
path	string
params	Omit<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:14

Parameters

Parameter	Type
path	string
params	Omit<RequestInit, "method">

Returns

Promise<Response>

Inherited from

CrossmintApiClient.put

---

registerRecoveryMethod()

registerRecoveryMethod(walletLocator, params): Promise<RegisterRecoveryMethodResponse>

Defined in: packages/wallets/src/api/client.ts:267

Parameters

Parameter	Type
walletLocator	string
params	RegisterRecoveryMethodParams

Returns

Promise<RegisterRecoveryMethodResponse>

---

registerSigner()

registerSigner(walletLocator, params): Promise<RegisterSignerResponse>

Defined in: packages/wallets/src/api/client.ts:239

Parameters

Parameter	Type
walletLocator	string
params	RegisterSignerParams

Returns

Promise<RegisterSignerResponse>

---

removeRecoveryMethod()

removeRecoveryMethod(walletLocator, signer, params): Promise<RemoveRecoveryMethodResponse>

Defined in: packages/wallets/src/api/client.ts:278

Parameters

Parameter	Type
walletLocator	string
signer	string
params	RemoveRecoveryMethodParams

Returns

Promise<RemoveRecoveryMethodResponse>

---

removeSigner()

removeSigner(walletLocator, signer, params): Promise<RemoveSignerResponse>

Defined in: packages/wallets/src/api/client.ts:247

Parameters

Parameter	Type
walletLocator	string
signer	string
params	RemoveSignerParams

Returns

Promise<RemoveSignerResponse>

---

send()

send(walletLocator, tokenLocator, params): Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDtoClass>

Defined in: packages/wallets/src/api/client.ts:318

Parameters

Parameter	Type
walletLocator	string
tokenLocator	string
params	SendTokenDto

Returns

Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDtoClass>

---

normalizePath()

static normalizePath(path): string

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:17

Parameters

Parameter	Type
path	string

Returns

string

Inherited from

CrossmintApiClient.normalizePath