Request a Route

To request possible routes, please follow the instructions.
Step 1: Build a RoutesRequest object
The RoutesRequest object describes a desired any-to-any transfer and contains all information necessary to calculate the most efficient routes. It is defined by the following interface.
1
interface RoutesRequest {
2
    fromChainId: number;
3
    fromAmount: string;
4
    fromTokenAddress: string;
5
    fromAddress?: string;
6
    toChainId: number;
7
    toTokenAddress: string;
8
    toAddress?: string;
9
    options?: RouteOptions; 
10
} 
Copied!
It is important to note that the fromTokenAddress must be the correct address for the specified fromChainId as the token address changes for a given chain. The same has to be taken into consideration for the toTokenAddress and the toChainId. The optional properties fromAddress and toAddress specify where the token is coming from and where the SDK will send it to once the transaction is completed. 
Further specifications using RouteOptions
Please take a look at Set Route Options to get access to preference patterns, whitelisting, and blacklisting of cross-chain bridges and exchanges.
Step 2: Call getRoutes
After creating the routesRequest object, you can pass it to the getRoutes functions to start calculating the routes.
1
const result = await LiFi.getRoutes(routesRequest)
2
const routes = result.routes
Copied!
getRoutes returns a RoutesReponsewhich contains a list of routes for the described transfer. If an order was specified as part of the RouteOptions object, the resulting list would be sorted accordingly.
Step 3: Done, you can now execute the route
Learn Execute a Route (Transfer)​
Example code snippet
The following code snippet requests Routes for the following statement:
Bridge and swap 1 USDT on xDai to the maximum amount of USDC on BSC.
1
const routeOptions = {
2
    slippage: 3 / 100, // 3%
3
    order: 'RECOMMENDED'
4
}
5
​
6
const routesRequest = {
7
    fromChainId: 100,
8
    fromAmount: '1000000', // 1USDT
9
    fromTokenAddress: '0x4ecaba5870353805a9f068101a40e0f32ed605c6',
10
    toChainId: 56,
11
    toTokenAddress: '0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d',
12
    options: routeOptions,
13
}
14
​
15
const result = await LiFi.getRoutes(routesRequest)
16
const routes = result.routes
Copied!
​

Integrate LI.FI's JS SDK - Previous

Set up the SDK

Set Route Options

Last modified 7d ago

Copy link

Contents

Step 1: Build a RoutesRequest object

Step 2: Call getRoutes

Step 3: Done, you can now execute the route

Example code snippet