LifiRoutesRequestOptions

data class LifiRoutesRequestOptions(val insurance: Boolean? = null, val integrator: String? = null, val slippage: Double? = null, val bridges: LifiToolsConfiguration? = null, val exchanges: LifiToolsConfiguration? = null, val order: LifiRoutesOrder? = null, val allowSwitchChain: Boolean? = null, val allowDestinationCall: Boolean? = null, val referrer: String? = null, val fee: Double? = null, val maxPriceImpact: Double? = null, val timing: LifiTimingOptions? = null)

Optional configuration for the routes

Constructors

Link copied to clipboard
constructor(insurance: Boolean? = null, integrator: String? = null, slippage: Double? = null, bridges: LifiToolsConfiguration? = null, exchanges: LifiToolsConfiguration? = null, order: LifiRoutesOrder? = null, allowSwitchChain: Boolean? = null, allowDestinationCall: Boolean? = null, referrer: String? = null, fee: Double? = null, maxPriceImpact: Double? = null, timing: LifiTimingOptions? = null)

Properties

Link copied to clipboard

Defines if we should return routes with a cross-chain bridge protocol (Connext, etc.) destination calls or not (default: true)

Link copied to clipboard

Whether chain switches should be allowed in the routes (default: false)

Link copied to clipboard

Object configuring the bridges that should or should not be taken into consideration for the possibilities

Link copied to clipboard

Object configuring the exchanges that should or should not be taken into consideration for the possibilities

Link copied to clipboard
val fee: Double? = null

The percent of the integrator's fee that is taken from every transaction. The maximum fee amount should be less than 100%. Required range: 0 <= x < 1

Link copied to clipboard
val insurance: Boolean? = null

Facilitates transfer insurance via insurace.io, ensuring secure and insured transfer of assets (deprecated)

Link copied to clipboard
val integrator: String? = null

Custom string the developer who integrates LiFi can set

Link copied to clipboard
val maxPriceImpact: Double? = null

The price impact threshold above which routes are hidden. As an example, one should specify 0.15 (15%) to hide routes with more than 15% price impact. The default is 10%.

Link copied to clipboard
val order: LifiRoutesOrder? = null

The way the resulting routes should be ordered

Link copied to clipboard
val referrer: String? = null

Integrators can set a wallet address as referrer to track them

Link copied to clipboard
val slippage: Double? = null

The maximum allowed slippage

Link copied to clipboard

Timing settings for route and swap steps