CrossmintApiClient
new WalletsApiClient(crossmint
):WalletsApiClient
Parameter | Type |
---|---|
crossmint | Crossmint |
WalletsApiClient
CrossmintApiClient.constructor
Property | Type | Inherited from | Defined in |
---|---|---|---|
crossmint | Crossmint | CrossmintApiClient.crossmint | packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:18 |
get
baseUrl():string
string
CrossmintApiClient.baseUrl
get
commonHeaders():object
object
optional
Authorization:string
x-api-key: string
optional
x-app-identifier:string
x-client-name: string
x-client-version: string
optional
x-extension-id:string
CrossmintApiClient.commonHeaders
get
environment():APIKeyEnvironmentPrefix
APIKeyEnvironmentPrefix
CrossmintApiClient.environment
get
isServerSide():boolean
boolean
approveSignature(walletLocator
,signatureId
,params
):Promise
<ApproveSignatureResponse
>
Parameter | Type |
---|---|
walletLocator | string |
signatureId | string |
params | SubmitApprovalDto |
Promise
<ApproveSignatureResponse
>
approveTransaction(walletLocator
,transactionId
,params
):Promise
<ApproveTransactionResponse
>
Parameter | Type |
---|---|
walletLocator | string |
transactionId | string |
params | SubmitApprovalDto |
Promise
<ApproveTransactionResponse
>
buildUrl(path
):string
Parameter | Type |
---|---|
path | string |
string
CrossmintApiClient.buildUrl
createSignature(walletLocator
,params
):Promise
<CreateSignatureResponse
>
Parameter | Type |
---|---|
walletLocator | string |
params | CreateSignatureRequestDto |
Promise
<CreateSignatureResponse
>
createTransaction(walletLocator
,params
):Promise
<CreateTransactionResponse
>
Parameter | Type |
---|---|
walletLocator | string |
params | CreateTransactionDto |
Promise
<CreateTransactionResponse
>
createWallet(params
):Promise
<CreateWalletResponse
>
Parameter | Type |
---|---|
params | CreateWalletDto |
Promise
<CreateWalletResponse
>
delete(path
,params
):Promise
<Response
>
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Promise
<Response
>
CrossmintApiClient.delete
experimental_activity(walletLocator
,params
):Promise
<GetActivityResponse
>
Parameter | Type |
---|---|
walletLocator | string |
params | object |
params.chain | Chain |
Promise
<GetActivityResponse
>
experimental_getNfts(params
):Promise
<GetNftsResponse
>
Parameter | Type |
---|---|
params | object |
params.address | string |
params.chain | string |
params.page | number |
params.perPage | number |
Promise
<GetNftsResponse
>
get(path
,params
):Promise
<Response
>
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Promise
<Response
>
CrossmintApiClient.get
getBalance(walletLocator
,params
):Promise
<GetBalanceResponse
>
Parameter | Type |
---|---|
walletLocator | string |
params | object |
params.chains | Chain [] |
params.tokens | string [] |
Promise
<GetBalanceResponse
>
getSignature(walletLocator
,signatureId
):Promise
<GetSignatureResponse
>
Parameter | Type |
---|---|
walletLocator | EvmWalletLocator |
signatureId | string |
Promise
<GetSignatureResponse
>
getSigner(walletLocator
,signer
):Promise
<GetSignerResponse
>
Parameter | Type |
---|---|
walletLocator | string |
signer | string |
Promise
<GetSignerResponse
>
getTransaction(walletLocator
,transactionId
):Promise
<GetTransactionResponse
>
Parameter | Type |
---|---|
walletLocator | string |
transactionId | string |
Promise
<GetTransactionResponse
>
getTransactions(walletLocator
):Promise
<GetTransactionsResponse
>
Parameter | Type |
---|---|
walletLocator | string |
Promise
<GetTransactionsResponse
>
getWallet(locator
):Promise
<GetWalletResponse
>
Parameter | Type |
---|---|
locator | string |
Promise
<GetWalletResponse
>
patch(path
,params
):Promise
<Response
>
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Promise
<Response
>
CrossmintApiClient.patch
post(path
,params
):Promise
<Response
>
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Promise
<Response
>
CrossmintApiClient.post
put(path
,params
):Promise
<Response
>
Parameter | Type |
---|---|
path | string |
params | Omit <RequestInit , "method" > |
Promise
<Response
>
CrossmintApiClient.put
registerSigner(walletLocator
,params
):Promise
<RegisterSignerResponse
>
Parameter | Type |
---|---|
walletLocator | string |
params | CreateSignerInputDto |
Promise
<RegisterSignerResponse
>
send(walletLocator
,tokenLocator
,params
):Promise
<WalletsV1Alpha2TransactionResponseWithSendParamsDto
>
Parameter | Type |
---|---|
walletLocator | string |
tokenLocator | string |
params | SendTokenDto |
Promise
<WalletsV1Alpha2TransactionResponseWithSendParamsDto
>
static
normalizePath(path
):string
Parameter | Type |
---|---|
path | string |
string
CrossmintApiClient.normalizePath