Direct Deposit
Last updated
Last updated
The performDeposit
function in our SDK returns the transaction data only by selecting the best way to deposit the funds. This functionality ensures optimal transaction efficiency and enhances user convenience.
performDeposit
accepts the following parameters:
Parameter | Type | Description |
---|---|---|
performDeposit
function will initiate all required transactions on source chain such as getting an approval and sending tokens for bridging & swapping.
The response from the performDeposit
will be:
If you face any trouble, feel free to reach out to our engineers in the Telegram support group.
senderSigner
ethers.Signer
The signer object from ethers
fromChainId
number
Source chain id
fromTokenAddress
string
address of initial token on source chain
toChainId
number
Chain id of the destination chain
toTokenAddress
string
Address of the final token on the destination chain.
fromAmount
string
Amount of the initial token on the source chain.
userAddress
string
Address of the sender on the source chain.
recipient
string
Address of the receiver on the destination chain.
routeType
[Optional]
string
Default route is Value
. The type of route to be preferred. It can be Value
,Fee
and Time
.
estimateGas
[Optional]
boolean
Default is set to true
. If you don't want to estimate gas on the backend.
senderSigner
WalletClient
walletClient
object from viem
fromChainId
number
Source chain id
fromTokenAddress
string
address of initial token on source chain
toChainId
number
Chain id of the destination chain
toTokenAddress
string
Address of the final token on the destination chain.
fromAmount
string
Amount of the initial token on the source chain.
userAddress
string
Address of the sender on the source chain.
recipient
string
Address of the receiver on the destination chain.
routeType
[Optional]
string
Default route is Value
. The type of route to be preferred. It can be Value
,Fee
and Time
.
estimateGas
[Optional]
boolean
Default is set to true
. If you don't want to estimate gas on the backend.