请求路由/报价

LI.FI SDK 提供了请求路由和报价以及执行它们的功能。本指南将引导您完成使用 getRoutes 和 getQuote 函数发出请求的过程。

如何请求路由

首先，这是一个简单的示例，演示如何请求路由，将 Arbitrum 上的 10 USDC 桥接并交换为 Optimism 上的最大数量的 DAI。

import { createClient } from '@lifi/sdk';
import { getRoutes } from '@lifi/sdk';

const client = createClient({
  integrator: 'Your dApp/company name',
});

const routesRequest = {
  fromChainId: 42161, // Arbitrum
  toChainId: 10, // Optimism
  fromTokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831', // USDC on Arbitrum
  toTokenAddress: '0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1', // DAI on Optimism
  fromAmount: '10000000', // 10 USDC
};

const result = await getRoutes(client, routesRequest);
const routes = result.routes;

当您请求路由时，会收到一个路由对象数组，其中包含确定采用哪条路由进行交换或桥接转账的基本信息。在此阶段，不包含交易数据，必须单独请求。阅读更多执行路由/报价。此外，如果您只想收到我们的智能路由 API 可以提供的一个最佳选项，那么使用 getQuote 请求报价可能会更好。

路由请求参数

getRoutes 函数需要一个 RoutesRequest 对象，它指定所需的 任意到任意 转账，并包含计算最有效路由所需的所有信息。

参数

以下是 RoutesRequest 接口的参数及其描述：

参数	类型	必需	描述
`fromChainId`	number	是	源链的 ID（例如，Ethereum 主网为 1）。
`fromTokenAddress`	string	是	源链上代币的合约地址。请确保此地址与指定的 `fromChainId` 相对应。
`fromAmount`	string	是	要从源链转账的金额，以代币的最小单位指定（例如，ETH 的 wei）。
`fromAddress`	string	否	转出代币的地址。
`toChainId`	number	是	目标链的 ID（例如，Optimism 为 10）。
`toTokenAddress`	string	是	目标链上代币的合约地址。请确保此地址与指定的 `toChainId` 相对应。
`toAddress`	string	否	交易完成后代币将在目标链上发送到的地址。
`fromAmountForGas`	string	否	LI.Fuel 的一部分。允许接收部分桥接代币作为目标链上的 gas。以代币的最小单位指定。
`options`	RouteOptions	否	用于自定义路由的其他选项。这由 RouteOptions 接口定义（详见下文，参见路由选项）。

路由选项

RouteOptions 接口允许进一步自定义路由请求。以下是 RouteOptions 接口的参数及其描述：

参数	类型	必需	描述
`integrator`	string	否	集成商的标识符，通常是 dApp 或公司名称。理想情况下，应在配置 SDK 时指定，但也可以在请求期间修改
`fee`	number	否	集成商费用百分比（例如，0.03 表示 3% 的费用）。这需要集成商经过验证。
`maxPriceImpact`	number	否	隐藏价格影响大于或等于此值的路由。（例如，0.3 表示 30%）
`order`	string	否	`CHEAPEST` - 此排序选项优先考虑估计回报金额最高的路由。以牺牲速度和路由复杂性为代价重视资金效率的用户应选择最便宜的路由。`FASTEST` - 此排序选项优先考虑估计执行时间最短的路由。重视速度并希望交易尽快完成的用户应选择最快的路由。
`slippage`	number	否	滑点容差，以小数比例表示（例如，0.005 表示 0.5%）。
`referrer`	string	否	推荐人的钱包地址，用于跟踪目的。
`allowSwitchChain`	boolean	否	指定是否返回需要切换链的路由（2 步路由）。
`allowDestinationCall`	boolean	否	指定是否启用目标调用。
`bridges`	AllowDenyPrefer	否	用于指定桥接偏好的 `AllowDenyPrefer` 对象。
`exchanges`	AllowDenyPrefer	否	用于指定交易所偏好的 `AllowDenyPrefer` 对象。
`protocols`	AllowDenyPrefer	否	用于指定协议（桥接和交易所组合）偏好的 `AllowDenyPrefer` 对象。
`executionType`	ExecutionType	否	是否包含需要交易、消息或两者的路由。可能的值：`'transaction'`、`'message'`、`'all'`。默认值：`'transaction'`。
`timing`	Timing	否	用于指定时序策略偏好的 Timing 对象。
`jitoBundle`	boolean	否	SVM 特定。为隐式源交换启用 Jito bundle 路由。没有它，这些路由将被丢弃。
`svmSponsor`	string	否	SVM 特定。用于赞助交易成本的钱包地址。
`svmPriorityFeeLevel`	SVMPriorityFeeLevel	否	SVM 特定。Solana 交易的优先费用级别。可能的值：`'NORMAL'`、`'FAST'`、`'ULTRA'`。
`preset`	string	否	用于稳定币路由优化的预设配置。提供时，会用优化设置覆盖其他路由选项。

Allow/Deny/Prefer

AllowDenyPrefer 接口用于指定桥接或交易所的偏好。使用 allow 选项，您可以允许工具，并且仅使用这些工具来查找最佳路由。在 deny 中指定的工具将被列入黑名单。您可以在列表：链、桥接、DEX 聚合器、解算器中找到所有可用的键，或从 API 获取可用选项。参见链和工具。以下是 AllowDenyPrefer 接口的参数：

参数	类型	必需	描述
`allow`	string[]	否	允许的桥接或交易所列表（默认：全部）。
`deny`	string[]	否	拒绝的桥接或交易所列表（默认：无）。
`prefer`	string[]	否	优先的桥接或交易所列表（例如，[‘1inch’] 表示在可用时优先使用 1inch）。

Timing

Timing 接口允许您指定路由执行时序的偏好。这有助于根据时序策略优化请求的性能。 Timing 接口的参数：

参数	类型	必需	描述
`swapStepTimingStrategies`	TimingStrategy[]	否	专门针对路由中每个交换步骤的时序策略数组。这允许您为各个交换步骤执行期间的时序控制定义自定义策略。
`routeTimingStrategies`	TimingStrategy[]	否	应用于整个路由的时序策略数组。这使您能够设置路由整体计时方式的偏好，从而潜在地提高执行效率和可靠性。

时序策略

这有助于根据特定条件优化请求的时序。

参数	类型	描述
`strategy`	string	策略类型，必须设置为 ‘minWaitTime’。这表示所应用的时序策略基于最小等待时间。
`minWaitTimeMs`	number	返回任何结果之前的最小等待时间（以毫秒为单位）。此值确保请求等待指定的持续时间，以获得更准确的结果。
`startingExpectedResults`	number	在最小等待时间过后应返回的预期结果的初始数量。这有助于管理用户对请求结果的期望。
`reduceEveryMs`	number	随着等待时间的推移，预期结果减少的间隔（以毫秒为单位）。此参数允许根据经过的时间对预期结果进行动态调整。

您可以实现自定义时序策略，通过控制路由执行的时序来改善用户体验并优化应用程序的性能。

请求报价

当您请求报价时，我们的智能路由 API 会提供最佳可用选项。报价包含发起交换或桥接转账所需的所有必要信息和交易数据。您可以通过指定 fromAmount（要发送的金额）或 toAmount（要接收的期望金额）来请求报价。当用户知道他们想花多少时使用 fromAmount，当他们知道他们想接收多少时使用 toAmount。这是一个简单的示例，演示如何请求报价，将 Arbitrum 上的 10 USDC 桥接并交换为 Optimism 上的最大数量的 DAI。

import { createClient } from '@lifi/sdk';
import { getQuote } from '@lifi/sdk';

const client = createClient({
  integrator: 'Your dApp/company name',
});

// Request by source amount
const quoteRequest = {
  fromChain: 42161, // Arbitrum
  toChain: 10, // Optimism
  fromToken: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831', // USDC on Arbitrum
  toToken: '0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1', // DAI on Optimism
  fromAmount: '10000000', // 10 USDC
  fromAddress: '0x552008c0f6870c2f77e5cC1d2eb9bdff03e30Ea0', 
};

const quote = await getQuote(client, quoteRequest);

// Or request by destination amount
const toAmountQuoteRequest = {
  fromChain: 42161, // Arbitrum
  toChain: 10, // Optimism
  fromToken: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831', // USDC on Arbitrum
  toToken: '0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1', // DAI on Optimism
  toAmount: '10000000000000000000', // 10 DAI
  fromAddress: '0x552008c0f6870c2f77e5cC1d2eb9bdff03e30Ea0', 
};

const toAmountQuote = await getQuote(client, toAmountQuoteRequest);

报价请求参数

getQuote 函数需要一个 QuoteRequest 对象。您必须提供 fromAmount 或 toAmount 其中之一，但不能同时提供两者。以下是 QuoteRequest 接口的参数。

参数	类型	必需	描述
`fromChain`	number	是	源链的 ID（例如，Ethereum 主网为 1）。
`fromToken`	string	是	源链上代币的合约地址。请确保此地址与指定的 `fromChain` 相对应。
`fromAmount`	string	条件性	要从源链发送的金额，以代币的最小单位指定（例如，ETH 的 wei）。如果未提供 `toAmount`，则为必需。
`toAmount`	string	条件性	要在目标链上接收的期望金额，以代币的最小单位指定。如果未提供 `fromAmount`，则为必需。
`fromAddress`	string	是	转出代币的地址。
`toChain`	number	是	目标链的 ID（例如，Optimism 为 10）。
`toToken`	string	是	目标链上代币的合约地址。请确保此地址与指定的 `toChain` 相对应。
`toAddress`	string	否	交易完成后代币将在目标链上发送到的地址。
`fromAmountForGas`	string	否	LI.Fuel 的一部分。允许接收部分桥接代币作为目标链上的 gas。以代币的最小单位指定。仅适用于 `fromAmount` 请求。

其他报价参数

除了上述参数外，路由选项部分中列出的所有参数在使用 getQuote 时也可用，allowSwitchChain 除外，它专门用于控制路由请求中的链切换。此外，用于指定允许、拒绝或优先某些桥接、交易所和协议选项的参数名称略有不同：

allowBridges (string[], 可选)
denyBridges (string[], 可选)
preferBridges (string[], 可选)
allowExchanges (string[], 可选)
denyExchanges (string[], 可选)
preferExchanges (string[], 可选)
allowProtocols (string[], 可选)
denyProtocols (string[], 可选)

此外，您可以使用 swapStepTimingStrategies 参数为交换步骤指定时序策略：

swapStepTimingStrategies (string[], 可选) 指定交换步骤的时序策略。此参数允许您定义请求应等待结果的时长并管理预期结果。格式为：

minWaitTime-${minWaitTimeMs}-${startingExpectedResults}-${reduceEveryMs}

请求合约调用报价

除了请求一般报价外，LI.FI SDK 还提供了请求目标合约调用报价的功能。在 Composer 文档中阅读更多内容。有关特定于 SDK 的 Composer 集成，请参阅 SDK Composer 集成指南。这是一个简单的示例，演示如何请求报价，使用来自 Optimism 的 ETH，在 Base 链上桥接并购买 OpenSea 市场上价值 0.0000085 ETH 的 NFT。此示例的调用数据是使用 OpenSea Seaport SDK 获取的。

import { createClient } from '@lifi/sdk';
import { getContractCallsQuote } from '@lifi/sdk';

const client = createClient({
  integrator: 'Your dApp/company name',
});

const contractCallsQuoteRequest = {
  fromAddress: '0x552008c0f6870c2f77e5cC1d2eb9bdff03e30Ea0',
  fromChain: 10,
  fromToken: '0x0000000000000000000000000000000000000000',
  toAmount: '8500000000000',
  toChain: 8453,
  toToken: '0x0000000000000000000000000000000000000000',
  contractCalls: [
    {
      fromAmount: '8500000000000',
      fromTokenAddress: '0x0000000000000000000000000000000000000000',
      toContractAddress: '0x0000000000000068F116a894984e2DB1123eB395',
      toContractCallData:
        '0xe7acab24000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000006e0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000029dacdf7ccadf4ee67c923b4c22255a4b2494ed700000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000520000000000000000000000000000000000000000000000000000000000000064000000000000000000000000090884b5bd9f774ed96f941be2fb95d56a029c99c00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000160000000000000000000000000000000000000000000000000000000000000022000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000066757dd300000000000000000000000000000000000000000000000000000000669d0a580000000000000000000000000000000000000000000000000000000000000000360c6ebe0000000000000000000000000000000000000000ad0303de3e1093e50000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f000000000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000200000000000000000000000029f25e8a71e52e795e5016edf7c9e02a08c519b40000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006ff0cbadd00000000000000000000000000000000000000000000000000000006ff0cbadd0000000000000000000000000090884b5bd9f774ed96f941be2fb95d56a029c99c0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003179fcad000000000000000000000000000000000000000000000000000000003179fcad000000000000000000000000000000a26b00c1f0df003000390027140000faa7190000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008a88c37e000000000000000000000000000000000000000000000000000000008a88c37e000000000000000000000000009323bb21a4c6122f60713e4a1e38e7b94a40ce2900000000000000000000000000000000000000000000000000000000000000e3b5b41791fe051471fa3c2da1325a8147c833ad9a6609ffc07a37e2603de3111b262911aaf25ed6d131dd531574cf54d4ea61b479f2b5aaa2dff7c210a3d4e203000000f37ec094486e9092b82287d7ae66fbf8cd6148233c70813583e3264383afbd0484b80500070135f54edd2918ddd4260c840f8a6957160766a4e4ef941517f2a0ab3077a2ac6478f0ad7fad9b821766df11ca3fdb16a8e95782faaed6e0395df2f416651ac87a5c1edec0a36ad42555083e57cff59f4ad98617a48a3664b2f19d46f4db85e95271c747d03194b5cfdcfc86bb0b08fb2bc4936d6f75be03ab498d000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
      toContractGasLimit: '210000',
    },
  ],
};

const contractCallQuote = await getContractCallsQuote(client, contractCallsQuoteRequest);

合约调用报价请求参数

getContractCallsQuote 函数需要一个 ContractCallsQuoteRequest 对象，它包含请求目标合约调用报价所需的所有信息。合约调用报价请求可以视为报价请求的扩展，除了下面提到的参数外，其他报价参数部分中列出的所有参数（例如 integrator、fee、slippage 等）在使用 getContractCallsQuote 时也可用。

参数	类型	必需	描述

合约调用对象数组。

参数	类型	必需	描述
`fromAmount`	string	是	要发送到合约的代币金额。此金额独立于任何先前桥接或存入的代币。
`fromTokenAddress`	string	是	要发送到合约的代币地址。例如，ETH 质押交易需要 ETH。
`toContractAddress`	string	是	在目标链上要交互的合约地址。
`toContractCallData`	string	是	在目标链上要发送到合约以进行交互的调用数据。
`toContractGasLimit`	string	是	合约调用所需的估计 gas。不正确的值可能导致交互失败。
`toApprovalAddress`	string	否	如果代币转账的批准地址与合约地址不同，则用于批准的地址。
`contractOutputsToken`	string	否	合约将输出的代币地址（如果适用）（例如，质押 ETH 会产生 stETH）。

`Route` 和 `Quote` 之间的区别

尽管 Route 和 Quote 术语都属于为您提供进行交换或桥接转账的最佳选项这一领域，但您需要注意一些区别。 LI.FI 中的 Route 表示一个详细的转账计划，可能包含 多个步骤。每个步骤对应一笔单独的交易，例如交换代币或在链之间桥接资金。这些步骤必须按特定顺序执行，因为每个步骤都取决于上一个步骤的输出。Route 为涉及多个操作的复杂转账提供了详细的路径。相比之下，Quote 是一个单步交易。它包含一次性执行转账所需的所有必要信息，无需任何额外步骤。Quote 用于较简单的交易，其中单个操作（例如代币交换或跨链转账）就足够了。因此，虽然 Route 可能涉及多个步骤来完成转账，但 Quote 始终只表示一个步骤。

入门

使用 SDK

其他

请求路由/报价

如何请求路由

路由请求参数

参数

路由选项

Allow/Deny/Prefer

Timing

时序策略

请求报价

报价请求参数

其他报价参数

请求合约调用报价

合约调用报价请求参数

`Route` 和 `Quote` 之间的区别

​如何请求路由

​路由请求参数

​参数

​路由选项

​Allow/Deny/Prefer

​Timing

​时序策略

​请求报价

​报价请求参数

​其他报价参数

​请求合约调用报价

​合约调用报价请求参数

​Route 和 Quote 之间的区别

如何请求路由

路由请求参数

参数

路由选项

Allow/Deny/Prefer

Timing

时序策略

请求报价

报价请求参数

其他报价参数

请求合约调用报价

合约调用报价请求参数

`Route` 和 `Quote` 之间的区别