UNPKG

navi-sdk

Version:

The NAVI SDK Client provides tools for interacting with the Sui blockchain networks, designed for handling transactions, accounts, and smart contracts efficiently. This documentation covers the setup, account management, and transaction handling within th

14 lines (13 loc) • 843 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { Quote, SwapOptions } from '../../types'; /** * Get a swap quote between two coins using the aggregator API. * * @param fromCoinAddress - The address of the coin to swap from. * @param toCoinAddress - The address of the coin to swap to. * @param amountIn - The amount of the fromCoin to swap. Can be a number, string, or bigint. * @param apiKey - Optional API key for authentication. * @param swapOptions - Optional swap options including baseUrl, dexList, byAmountIn, and depth. * @returns A promise that resolves to a Router object containing the swap route details. * @throws Will throw an error if the API request fails or returns no data. */ export declare function getQuote(fromCoinAddress: string, toCoinAddress: string, amountIn: number | string | bigint, apiKey?: string, swapOptions?: SwapOptions): Promise<Quote>;