Class OneInchAggregatorHelper

constructor

• new OneInchAggregatorHelper(params): OneInchAggregatorHelper

• Parameters

  • params: OneInchAggregatorHelperParams

  Returns OneInchAggregatorHelper

Optional Readonly apiParamsOverrides

Readonly apiUrl

Readonly axios

Readonly chainId

Readonly customHeader

Readonly extRouter

Readonly liquiditySourcesProvider

Static Readonly OneInchAggregationRouterV5

Static cachedLiquiditySources

getBaseQueryParams

• getBaseQueryParams(__namedParameters): Promise<OneInchSwapAPIQueryParams>

• Parameters

  • __namedParameters: MakeCallParams

  Returns Promise<OneInchSwapAPIQueryParams>

getLiquiditySources

• getLiquiditySources(_params): Promise<string[]>

• Parameters

  • _params: {
        needScale: boolean;
    }

    • needScale: boolean

  Returns Promise<string[]>

getLiquiditySourcesUrl

• getLiquiditySourcesUrl(): string

• Returns string

getOverriddenQueryParams

• getOverriddenQueryParams(params): Promise<OneInchSwapAPIQueryParams>

• Parameters

  • params: MakeCallParams

  Returns Promise<OneInchSwapAPIQueryParams>

getSwapUrl

• getSwapUrl(): string

• Returns string

makeCall

• makeCall(...params): Promise<AggregatorResult>

• Parameters

  • Rest ...params: MakeCallParams

  Returns Promise<AggregatorResult>

Static buildCreateParams

• buildCreateParams(chainId, apiKey, apiRPS, optionalParams?): OneInchAggregatorHelperParams

• Parameters

  • chainId: ChainId

  • apiKey: string

  • apiRPS: number

  • Optional optionalParams: Partial<OneInchAggregatorHelperParams>

  Returns OneInchAggregatorHelperParams

Static create

• create(chainId, apiKey, apiRPS?): OneInchAggregatorHelper

• Parameters

  • chainId: ChainId

  • apiKey: string

  • apiRPS: number = 1

  Returns OneInchAggregatorHelper

Static provideCachedLiquiditySources

• provideCachedLiquiditySources(this, instance): Promise<string[]>

• Parameters

  • this: void

  • instance: OneInchAggregatorHelper

  Returns Promise<string[]>

  Remarks

  This cache (without expiry) is introduced to avoid calling the liquiditySources endpoint lots of time.

  The routing algorithm will call AggregatorHelper#makeCall a lot. As OneInchAggregatorHelper#makeCall depend on OneInchAggregatorHelper#getLiquiditySources, and liquidity sources is is very unlikely to change (and should be the same accross multiple call), the liquidity sources should be cache.

  To invalidate the cache, simply clear this map.

  But for better behaviour customization, it is recommended to pass in a custom OneInchAggregatorHelperParams#liquiditySourcesProvider.