estimateTransferFee

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Developer Account

Initialization

Transactions

Monitored Tokens

Webhook Subscriptions

Wallets

Wallet Sets

Token Lookup

Faucet

Signing

estimateTransferFeeNode.js,latest

Go to NPM

Estimates gas fees for a transfer transaction.

Parameters

input

object

Required

Represents the input parameters for estimating transfer fees.

option 1:

Show 7 properties

userId

string

Required

Unique system-generated identifier for the user.

tokenId

string

Required

System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.

amount

array of strings

Required

Specifies the transfer amount in decimal format.

destinationAddress

string

Required

The recipient's blockchain address.

nftTokenIds

array of strings

The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.

sourceAddress

string

The source blockchain address of the transaction.

walletId

string

Identifier for the originating wallet.

option 2:

Show 8 properties

userId

string

Required

Unique system-generated identifier for the user.

blockchain

string

Blockchain of the transferred token. Required if tokenId is not provided. The blockchain and tokenId fields are mutually exclusive.

Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA

tokenAddress

string

Required

Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId.

amount

array of strings

Required

Specifies the transfer amount in decimal format.

destinationAddress

string

Required

The recipient's blockchain address.

nftTokenIds

array of strings

The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.

sourceAddress

string

The source blockchain address of the transaction.

walletId

string

Identifier for the originating wallet.

option 3:

Show 7 properties

userToken

string

Required

The JSON Web Token (JWT) representing the user.

tokenId

string

Required

System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.

amount

array of strings

Required

Specifies the transfer amount in decimal format.

destinationAddress

string

Required

The recipient's blockchain address.

nftTokenIds

array of strings

The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.

sourceAddress

string

The source blockchain address of the transaction.

walletId

string

Identifier for the originating wallet.

option 4:

Show 8 properties

userToken

string

Required

The JSON Web Token (JWT) representing the user.

blockchain

string

Blockchain of the transferred token. Required if tokenId is not provided. The blockchain and tokenId fields are mutually exclusive.

Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA

tokenAddress

string

Required

Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId.

amount

array of strings

Required

Specifies the transfer amount in decimal format.

destinationAddress

string

Required

The recipient's blockchain address.

nftTokenIds

array of strings

The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.

sourceAddress

string

The source blockchain address of the transaction.

walletId

string

Identifier for the originating wallet.

Responses

Data - EstimateTransactionFeeResponse

Response Body

object

data

object

Required

Show 6 properties

high

object

Show 6 properties

gasLimit

string

The maximum units of gas to use for the transaction. Required if feeLevel is not provided. Estimates for this limit can be obtained through the POST /transactions/transfer/estimateFee API. GasLimit override (only supported for EOA wallets): Using gasLimit together with feeLevel, the provided gasLimit is required to be greater or equal to feeLevel estimation and will override the estimation's gasLimit.

gasPrice

string

For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see gasLimit). Requires gasLimit. Cannot be used with feeLevel, priorityFee, or maxFee. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

maxFee

string

For blockchains with EIP-1559 support, the maximum price per unit of gas (see gasLimit), in gwei. Requires priorityFee, and gasLimit to be present. Cannot be used with feeLevel or gasPrice. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

priorityFee

string

For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators. Please note that the maxFee and gasLimit parameters are required alongside the priorityFee. The feeLevel and gasPrice parameters cannot be used with the priorityFee. Estimations for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

baseFee

string

For blockchains with EIP-1559 support, the estimated base fee represents the minimum fee required for a transaction to be included in a block on the blockchain. It is measured in gwei and compensates for the computational resources validators consume to process the transaction. The base fee is supplemented by a separate "tip" called the priority fee, which acts as an extra incentive for validators to prioritize the transaction. The priority fee is added to the base fee to calculate the final transaction fee.

networkFee

string

The estimated network fee is the maximum amount of cryptocurrency (such as ETH, ARB, or SOL) that you will pay for your transaction. This fee depends on the parameters you set, including Gas Limit, Priority Fee, and Max Fee. It compensates for the computational resources that validators consume to process the transaction. It is measured in native token such as ETH, SOL. For blockchains with L1 data fees such as OP/BASE, the network fee is a combination of the Execution Gas Fee and the L1 Data Fee. Each blockchain might use different formula for network fee. Refer to each specific blockchain's documentation to understand how networkFee is calculated.

low

object

Show 6 properties

gasLimit

string

gasPrice

string

maxFee

string

priorityFee

string

baseFee

string

networkFee

string

medium

object

Show 6 properties

gasLimit

string

gasPrice

string

maxFee

string

priorityFee

string

baseFee

string

networkFee

string

callGasLimit

string

One of ERC-4337 gas fields. The amount of gas to allocate for the main execution call. Only in smart contract account estimation response.

verificationGasLimit

string

One of ERC-4337 gas fields. The amount of gas to allocate for the verification step. Only in smart contract account estimation response.

preVerificationGas

string

One of ERC-4337 gas fields. The amount of gas to pay to compensate the bundler for pre-verification execution and call data. Only in smart contract account estimation response.

Error

Error - NotAuthorizedResponse

Error - NotFoundResponse

Example

1const response = await client.estimateTransferFee({
2  amount: ["0.01"],
3  destinationAddress: "address",
4  tokenId: "token-id",
5  userToken: "dummy-user-token",
6})
7console.log(response.data)

ResponseChoose an example

1{
2  "data": {
3    "high": {
4      "gasLimit": "21000",
5      "gasPrice": "",
6      "maxFee": "5.935224468",
7      "priorityFee": "1.022783914",
8      "baseFee": "1.022783914",
9      "networkFee": "0.0001246397138"
10    },
11    "low": {
12      "gasLimit": "21000",
13      "gasPrice": "",
14      "maxFee": "5.935224468",
15      "priorityFee": "1.022783914",
16      "baseFee": "1.022783914",
17      "networkFee": "0.0001246397138"
18    },
19    "medium": {
20      "gasLimit": "21000",
21      "gasPrice": "",
22      "maxFee": "5.935224468",
23      "priorityFee": "1.022783914",
24      "baseFee": "1.022783914",
25      "networkFee": "0.0001246397138"
26    },
27    "callGasLimit": "69222",
28    "verificationGasLimit": "56863",
29    "preVerificationGas": "44112"
30  }
31}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy