API Reference
API reference for @tetherto/wdk-protocol-swap-velora-evm
Class: veloraProtocolEvm
Main class for velora token swaps on EVM.
Constructor
new veloraProtocolEvm(account, config?)Parameters:
account:WalletAccountEvm | WalletAccountReadOnlyEvm | WalletAccountEvmErc4337 | WalletAccountReadOnlyEvmErc4337config(optional):swapMaxFee(bigint): maximum total gas fee allowed (wei)
Example:
const swap = new veloraProtocolEvm(account, { swapMaxFee: 200000000000000n })Methods
swap(options, config?)
Perform a token swap
Promise<{hash: string, fee: bigint, tokenInAmount: bigint, tokenOutAmount: bigint, approveHash?: string, resetAllowanceHash?: string}>
quoteSwap(options, config?)
Get estimated fee and amounts
Promise<{fee: bigint, tokenInAmount: bigint, tokenOutAmount: bigint}>
swap(options, config?)
swap(options, config?)Execute a swap via velora.
Options:
tokenIn(string): Address of the ERC‑20 token to selltokenOut(string): Address of the ERC‑20 token to buytokenInAmount(bigint, optional): Exact input amount (base units)tokenOutAmount(bigint, optional): Exact output amount (base units)to(string, optional): Recipient address (defaults to account address)
Config (ERC‑4337 only):
paymasterToken(string, optional): Token symbol/address for fee sponsorshipswapMaxFee(bigint, optional): Per‑swap fee cap (wei)
Returns:
Standard account:
{ hash, fee, tokenInAmount, tokenOutAmount, approveHash?, resetAllowanceHash? }ERC‑4337 account:
{ hash, fee, tokenInAmount, tokenOutAmount }(approve may be bundled)
Notes:
On Ethereum mainnet, selling USDT may first set allowance to 0, then approve.
Requires a provider; requires a non read‑only account to send transactions.
Example:
const tx = await swap.swap({
tokenIn: '0xdAC17F...ec7', // USDT
tokenOut: '0xC02a...6Cc2', // WETH
tokenInAmount: 1000000n
})quoteSwap(options, config?)
quoteSwap(options, config?)Get estimated fee and token in/out amounts.
Options are the same as swap.
Returns: { fee, tokenInAmount, tokenOutAmount }
Config (ERC‑4337 only):
paymasterToken(string, optional): Token symbol/address for fee sponsorship
Works with read‑only accounts.
Example:
const quote = await swap.quoteSwap({
tokenIn: '0xdAC17F...ec7', // USDT
tokenOut: '0xC02a...6Cc2', // WETH
tokenOutAmount: 500000000000000000n // 0.5 WETH
})Errors
Common errors include:
Insufficient liquidity / no route for pair
Fee exceeds
swapMaxFeeRead‑only account cannot send swaps
Provider/RPC errors (invalid endpoint, network mismatch)
Types
swapMaxFee: bigint— Upper bound for gas fees (wei)tokenInAmount/tokenOutAmount: bigint— ERC‑20 base unitspaymasterToken: string— token symbol or address (AA only)