Extends
CrossmintApiClient
Constructors
new WalletsApiClient()
new WalletsApiClient(crossmint
):WalletsApiClient
Parameters
Parameter | Type |
---|---|
crossmint | Crossmint |
Returns
WalletsApiClient
Overrides
CrossmintApiClient.constructor
Defined in
packages/wallets/src/api/client.ts:37Properties
Property | Type | Inherited from | Defined in |
---|---|---|---|
crossmint | Crossmint | CrossmintApiClient.crossmint | packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:18 |
Accessors
baseUrl
get
baseUrl():string
Returns
string
Inherited from
CrossmintApiClient.baseUrl
Defined in
packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:24commonHeaders
get
commonHeaders():object
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
Defined in
packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:25environment
get
environment():APIKeyEnvironmentPrefix
Returns
APIKeyEnvironmentPrefix
Overrides
CrossmintApiClient.environment
Defined in
packages/wallets/src/api/client.ts:196isServerSide
get
isServerSide():boolean
Returns
boolean
Defined in
packages/wallets/src/api/client.ts:192Methods
approveSignature()
approveSignature(walletLocator
,signatureId
,params
):Promise
<ApproveSignatureResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
signatureId | string |
params | SubmitApprovalDto |
Returns
Promise
<ApproveSignatureResponse
>
Defined in
packages/wallets/src/api/client.ts:102approveTransaction()
approveTransaction(walletLocator
,transactionId
,params
):Promise
<ApproveTransactionResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
transactionId | string |
params | SubmitApprovalDto |
Returns
Promise
<ApproveTransactionResponse
>
Defined in
packages/wallets/src/api/client.ts:72buildUrl()
buildUrl(path
):string
Parameters
Parameter | Type |
---|---|
path | string |
Returns
string
Inherited from
CrossmintApiClient.buildUrl
Defined in
packages/common/base/dist/apiClient/ApiClient.d.ts:5createSignature()
createSignature(walletLocator
,params
):Promise
<CreateSignatureResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
params | CreateSignatureRequestDto |
Returns
Promise
<CreateSignatureResponse
>
Defined in
packages/wallets/src/api/client.ts:91createTransaction()
createTransaction(walletLocator
,params
):Promise
<CreateTransactionResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
params | CreateTransactionDto |
Returns
Promise
<CreateTransactionResponse
>
Defined in
packages/wallets/src/api/client.ts:61createWallet()
createWallet(params
):Promise
<CreateWalletResponse
>
Parameters
Parameter | Type |
---|---|
params | CreateWalletDto |
Returns
Promise
<CreateWalletResponse
>
Defined in
packages/wallets/src/api/client.ts:45delete()
delete(path
,params
):Promise
<Response
>
Parameters
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Returns
Promise
<Response
>
Inherited from
CrossmintApiClient.delete
Defined in
packages/common/base/dist/apiClient/ApiClient.d.ts:9experimental_activity()
experimental_activity(walletLocator
,params
):Promise
<GetActivityResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
params | object |
params.chain | Chain |
Returns
Promise
<GetActivityResponse
>
Defined in
packages/wallets/src/api/client.ts:144experimental_getNfts()
experimental_getNfts(params
):Promise
<GetNftsResponse
>
Parameters
Parameter | Type |
---|---|
params | object |
params.address | string |
params.chain | string |
params.page | number |
params.perPage | number |
Returns
Promise
<GetNftsResponse
>
Defined in
packages/wallets/src/api/client.ts:128get()
get(path
,params
):Promise
<Response
>
Parameters
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Returns
Promise
<Response
>
Inherited from
CrossmintApiClient.get
Defined in
packages/common/base/dist/apiClient/ApiClient.d.ts:6getBalance()
getBalance(walletLocator
,params
):Promise
<GetBalanceResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
params | object |
params.chains | Chain [] |
params.tokens | string [] |
Returns
Promise
<GetBalanceResponse
>
Defined in
packages/wallets/src/api/client.ts:153getSignature()
getSignature(walletLocator
,signatureId
):Promise
<GetSignatureResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | EvmWalletLocator |
signatureId | string |
Returns
Promise
<GetSignatureResponse
>
Defined in
packages/wallets/src/api/client.ts:114getSigner()
getSigner(walletLocator
,signer
):Promise
<GetSignerResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
signer | string |
Returns
Promise
<GetSignerResponse
>
Defined in
packages/wallets/src/api/client.ts:177getTransaction()
getTransaction(walletLocator
,transactionId
):Promise
<GetTransactionResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
transactionId | string |
Returns
Promise
<GetTransactionResponse
>
Defined in
packages/wallets/src/api/client.ts:84getTransactions()
getTransactions(walletLocator
):Promise
<GetTransactionsResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
Returns
Promise
<GetTransactionsResponse
>
Defined in
packages/wallets/src/api/client.ts:121getWallet()
getWallet(locator
):Promise
<GetWalletResponse
>
Parameters
Parameter | Type |
---|---|
locator | string |
Returns
Promise
<GetWalletResponse
>
Defined in
packages/wallets/src/api/client.ts:54patch()
patch(path
,params
):Promise
<Response
>
Parameters
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Returns
Promise
<Response
>
Inherited from
CrossmintApiClient.patch
Defined in
packages/common/base/dist/apiClient/ApiClient.d.ts:10post()
post(path
,params
):Promise
<Response
>
Parameters
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Returns
Promise
<Response
>
Inherited from
CrossmintApiClient.post
Defined in
packages/common/base/dist/apiClient/ApiClient.d.ts:7put()
put(path
,params
):Promise
<Response
>
Parameters
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Returns
Promise
<Response
>
Inherited from
CrossmintApiClient.put
Defined in
packages/common/base/dist/apiClient/ApiClient.d.ts:8registerSigner()
registerSigner(walletLocator
,params
):Promise
<RegisterSignerResponse
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
params | CreateSignerInputDto |
Returns
Promise
<RegisterSignerResponse
>
Defined in
packages/wallets/src/api/client.ts:169send()
send(walletLocator
,tokenLocator
,params
):Promise
<WalletsV1Alpha2TransactionResponseWithSendParamsDto
>
Parameters
Parameter | Type |
---|---|
walletLocator | string |
tokenLocator | string |
params | SendTokenDto |
Returns
Promise
<WalletsV1Alpha2TransactionResponseWithSendParamsDto
>
Defined in
packages/wallets/src/api/client.ts:184normalizePath()
static
normalizePath(path
):string
Parameters
Parameter | Type |
---|---|
path | string |
Returns
string
Inherited from
CrossmintApiClient.normalizePath