WalletsApiClient

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

​

Extends

• CrossmintApiClient

​

Constructors

​

new WalletsApiClient()

new WalletsApiClient(crossmint): ApiClient

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

​

Parameters

​

Returns

ApiClient

​

Overrides

CrossmintApiClient.constructor

​

Properties

​

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

Returns

APIKeyEnvironmentPrefix

​

Overrides

CrossmintApiClient.environment

---

​

isServerSide

​

Get Signature

get isServerSide(): boolean

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

Returns

boolean

---

​

projectId

​

Get Signature

get projectId(): string

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

Returns

string

​

Methods

​

approveSignature()

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

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

​

Parameters

​

Returns

Promise<ApproveSignatureResponse>

---

​

approveTransaction()

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

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

​

Parameters

​

Returns

Promise<ApproveTransactionResponse>

---

​

buildUrl()

buildUrl(path): string

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

​

Parameters

​

Returns

string

​

Inherited from

CrossmintApiClient.buildUrl

---

​

createSignature()

createSignature(walletLocator, params): Promise<CreateSignatureResponse>

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

​

Parameters

​

Returns

Promise<CreateSignatureResponse>

---

​

createTransaction()

createTransaction(walletLocator, params): Promise<CreateTransactionResponse>

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

​

Parameters

​

Returns

Promise<CreateTransactionResponse>

---

​

createWallet()

createWallet(params): Promise<CreateWalletResponse>

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

​

Parameters

​

Returns

Promise<CreateWalletResponse>

---

​

delete()

delete(path, params): Promise<Response>

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

​

Parameters

​

Returns

Promise<Response>

​

Inherited from

CrossmintApiClient.delete

---

​

fundWallet()

fundWallet(walletLocator, params): Promise<FundWalletResponse>

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

​

Parameters

​

Returns

Promise<FundWalletResponse>

---

​

get()

get(path, params): Promise<Response>

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

​

Parameters

​

Returns

Promise<Response>

​

Inherited from

CrossmintApiClient.get

---

​

getBalance()

getBalance(walletLocator, params): Promise<GetBalanceResponse>

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

​

Parameters

​

Returns

Promise<GetBalanceResponse>

---

​

getNfts()

getNfts(params): Promise<unknown>

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

​

Parameters

​

Returns

Promise<unknown>

---

​

getSignature()

getSignature(walletLocator, signatureId): Promise<GetSignatureResponse>

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

​

Parameters

​

Returns

Promise<GetSignatureResponse>

---

​

getSigner()

getSigner(walletLocator, signer): Promise<GetSignerResponse>

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

​

Parameters

​

Returns

Promise<GetSignerResponse>

---

​

getTransaction()

getTransaction(walletLocator, transactionId): Promise<GetTransactionResponse>

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

​

Parameters

​

Returns

Promise<GetTransactionResponse>

---

​

getTransactions()

getTransactions(walletLocator): Promise<GetTransactionsResponse>

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

​

Parameters

​

Returns

Promise<GetTransactionsResponse>

---

​

getTransfers()

getTransfers(walletLocator, params): Promise<GetTransfersResponse>

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

​

Parameters

​

Returns

Promise<GetTransfersResponse>

---

​

getWallet()

getWallet(locator): Promise<GetWalletResponse>

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

​

Parameters

​

Returns

Promise<GetWalletResponse>

---

​

patch()

patch(path, params): Promise<Response>

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

​

Parameters

​

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

​

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

​

Returns

Promise<Response>

​

Inherited from

CrossmintApiClient.put

---

​

registerSigner()

registerSigner(walletLocator, params): Promise<RegisterSignerResponse>

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

​

Parameters

​

Returns

Promise<RegisterSignerResponse>

---

​

removeSigner()

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

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

​

Parameters

​

Returns

Promise<RemoveSignerResponse>

---

​

send()

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

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

​

Parameters

​

Returns

Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDtoClass>

---

​

normalizePath()

static normalizePath(path): string

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

​

Parameters

​

Returns

string

​

Inherited from

CrossmintApiClient.normalizePath