API Reference

Class: VeloraProtocolEvm

Main class for velora token swaps on EVM.

Constructor

new VeloraProtocolEvm(account, config?)

Parameters:

• account: WalletAccountEvm | WalletAccountReadOnlyEvm | WalletAccountEvmErc4337 | WalletAccountReadOnlyEvmErc4337
• config (optional):
  • swapMaxFee (bigint): maximum total gas fee allowed (wei)

Example:

const swap = new VeloraProtocolEvm(account, { swapMaxFee: 200000000000000n })

Methods

swap(options, config?)

Execute a swap via velora.

Options:

• tokenIn (string): Address of the ERC‑20 token to sell
• tokenOut (string): Address of the ERC‑20 token to buy
• tokenInAmount (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 ({ address: string }, optional): Paymaster token override for this swap
• isSponsored (true, optional): Use sponsorship mode for this swap
• sponsorshipPolicyId (string, optional): Sponsorship policy override
• useNativeCoins (true, optional): Pay fees in the chain's native token
• swapMaxFee (bigint, optional): Per‑swap fee cap (wei)

Returns:

• Standard account: { hash, fee, tokenInAmount, tokenOutAmount }
• ERC‑4337 account: { hash, fee, tokenInAmount, tokenOutAmount }

Notes:

• Approve the input token with the wallet account before swapping if the spender does not already have enough allowance.
• Requires a provider; requires a non read‑only account to send transactions.

Example:

const tx = await swap.swap({
  tokenIn: '0xdAC17F...ec7',      // USD₮
  tokenOut: '0xC02a...6Cc2',      // WETH
  tokenInAmount: 1000000n
})

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 ({ address: string }, optional): Paymaster token override for fee estimation
• isSponsored (true, optional): Use sponsorship mode for fee estimation
• sponsorshipPolicyId (string, optional): Sponsorship policy override
• useNativeCoins (true, optional): Estimate fees in the chain's native token

Works with read‑only accounts.

Example:

const quote = await swap.quoteSwap({
  tokenIn: '0xdAC17F...ec7',      // USD₮
  tokenOut: '0xC02a...6Cc2',      // WETH
  tokenOutAmount: 500000000000000000n // 0.5 WETH
})

Errors

Common errors include:

• Insufficient liquidity / no route for pair
• Fee exceeds swapMaxFee
• Read‑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 units
• paymasterToken: { address: string } — ERC‑4337 paymaster token override

Need Help?