@ring-protocol/smart-order-router 0.5.0

package/build/module/providers/index.d.ts

@@ -0,0 +1,56 @@
+export * from './cache';
+export * from './cache-node';
+export * from './caching-gas-provider';
+export * from './caching-token-list-provider';
+export * from './caching-token-provider';
+export * from './caching/route';
+export * from './eip-1559-gas-price-provider';
+export * from './eth-estimate-gas-provider';
+export * from './eth-gas-station-info-gas-price-provider';
+export * from './gas-price-provider';
+export * from './legacy-gas-price-provider';
+export * from './multicall-provider';
+export * from './multicall-uniswap-provider';
+export * from './multicall-ringswap-provider';
+export * from './on-chain-gas-price-provider';
+export * from './on-chain-quote-provider';
+export * from './pool-provider';
+export * from './simulation-provider';
+export * from './static-gas-price-provider';
+export * from './swap-router-provider';
+export * from './tenderly-simulation-provider';
+export * from './token-properties-provider';
+export * from './token-provider';
+export * from './token-validator-provider';
+export * from './uri-subgraph-provider';
+export * from './v2/caching-pool-provider';
+export * from './v2/caching-subgraph-provider';
+export * from './v2/pool-provider';
+export * from './v2/quote-provider';
+export * from './v2/static-subgraph-provider';
+export * from './v2/subgraph-provider';
+export * from './v2/subgraph-provider-with-fallback';
+export * from './v2/uri-subgraph-provider';
+export * from './fewV2/ring-caching-pool-provider';
+export * from './fewV2/ring-caching-subgraph-provider';
+export * from './fewV2/ring-pool-provider';
+export * from './fewV2/ring-quote-provider';
+export * from './fewV2/ring-static-subgraph-provider';
+export * from './fewV2/ring-subgraph-provider';
+export * from './fewV2/ring-subgraph-provider-with-fallback';
+export * from './fewV2/ring-uri-subgraph-provider';
+export * from './v3/caching-pool-provider';
+export * from './v3/caching-subgraph-provider';
+export * from './v3/pool-provider';
+export * from './v3/static-subgraph-provider';
+export * from './v3/subgraph-provider';
+export * from './v3/subgraph-provider-with-fallback';
+export * from './v3/uri-subgraph-provider';
+export * from './v4/caching-pool-provider';
+export * from './v4/caching-subgraph-provider';
+export * from './v4/euler-swap-hooks-subgraph-provider';
+export * from './v4/pool-provider';
+export * from './v4/static-subgraph-provider';
+export * from './v4/subgraph-provider';
+export * from './v4/subgraph-provider-with-fallback';
+export * from './v4/uri-subgraph-provider';

package/build/module/providers/index.js

@@ -0,0 +1,57 @@
+export * from './cache';
+export * from './cache-node';
+export * from './caching-gas-provider';
+export * from './caching-token-list-provider';
+export * from './caching-token-provider';
+export * from './caching/route';
+export * from './eip-1559-gas-price-provider';
+export * from './eth-estimate-gas-provider';
+export * from './eth-gas-station-info-gas-price-provider';
+export * from './gas-price-provider';
+export * from './legacy-gas-price-provider';
+export * from './multicall-provider';
+export * from './multicall-uniswap-provider';
+export * from './multicall-ringswap-provider';
+export * from './on-chain-gas-price-provider';
+export * from './on-chain-quote-provider';
+export * from './pool-provider';
+export * from './simulation-provider';
+export * from './static-gas-price-provider';
+export * from './swap-router-provider';
+export * from './tenderly-simulation-provider';
+export * from './token-properties-provider';
+export * from './token-provider';
+export * from './token-validator-provider';
+export * from './uri-subgraph-provider';
+export * from './v2/caching-pool-provider';
+export * from './v2/caching-subgraph-provider';
+export * from './v2/pool-provider';
+export * from './v2/quote-provider';
+export * from './v2/static-subgraph-provider';
+export * from './v2/subgraph-provider';
+export * from './v2/subgraph-provider-with-fallback';
+export * from './v2/uri-subgraph-provider';
+export * from './fewV2/ring-caching-pool-provider';
+export * from './fewV2/ring-caching-subgraph-provider';
+export * from './fewV2/ring-pool-provider';
+export * from './fewV2/ring-quote-provider';
+export * from './fewV2/ring-static-subgraph-provider';
+export * from './fewV2/ring-subgraph-provider';
+export * from './fewV2/ring-subgraph-provider-with-fallback';
+export * from './fewV2/ring-uri-subgraph-provider';
+export * from './v3/caching-pool-provider';
+export * from './v3/caching-subgraph-provider';
+export * from './v3/pool-provider';
+export * from './v3/static-subgraph-provider';
+export * from './v3/subgraph-provider';
+export * from './v3/subgraph-provider-with-fallback';
+export * from './v3/uri-subgraph-provider';
+export * from './v4/caching-pool-provider';
+export * from './v4/caching-subgraph-provider';
+export * from './v4/euler-swap-hooks-subgraph-provider';
+export * from './v4/pool-provider';
+export * from './v4/static-subgraph-provider';
+export * from './v4/subgraph-provider';
+export * from './v4/subgraph-provider-with-fallback';
+export * from './v4/uri-subgraph-provider';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcHJvdmlkZXJzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsU0FBUyxDQUFDO0FBQ3hCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYywrQkFBK0IsQ0FBQztBQUM5QyxjQUFjLDBCQUEwQixDQUFDO0FBQ3pDLGNBQWMsaUJBQWlCLENBQUM7QUFDaEMsY0FBYywrQkFBK0IsQ0FBQztBQUM5QyxjQUFjLDZCQUE2QixDQUFDO0FBQzVDLGNBQWMsMkNBQTJDLENBQUM7QUFDMUQsY0FBYyxzQkFBc0IsQ0FBQztBQUNyQyxjQUFjLDZCQUE2QixDQUFDO0FBQzVDLGNBQWMsc0JBQXNCLENBQUM7QUFDckMsY0FBYyw4QkFBOEIsQ0FBQztBQUM3QyxjQUFjLCtCQUErQixDQUFDO0FBQzlDLGNBQWMsK0JBQStCLENBQUM7QUFDOUMsY0FBYywyQkFBMkIsQ0FBQztBQUMxQyxjQUFjLGlCQUFpQixDQUFDO0FBQ2hDLGNBQWMsdUJBQXVCLENBQUM7QUFDdEMsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLHdCQUF3QixDQUFDO0FBQ3ZDLGNBQWMsZ0NBQWdDLENBQUM7QUFDL0MsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsNEJBQTRCLENBQUM7QUFDM0MsY0FBYyx5QkFBeUIsQ0FBQztBQUN4QyxjQUFjLDRCQUE0QixDQUFDO0FBQzNDLGNBQWMsZ0NBQWdDLENBQUM7QUFDL0MsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMsK0JBQStCLENBQUM7QUFDOUMsY0FBYyx3QkFBd0IsQ0FBQztBQUN2QyxjQUFjLHNDQUFzQyxDQUFDO0FBQ3JELGNBQWMsNEJBQTRCLENBQUM7QUFDM0MsY0FBYyxvQ0FBb0MsQ0FBQztBQUNuRCxjQUFjLHdDQUF3QyxDQUFDO0FBQ3ZELGNBQWMsNEJBQTRCLENBQUM7QUFDM0MsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLHVDQUF1QyxDQUFDO0FBQ3RELGNBQWMsZ0NBQWdDLENBQUM7QUFDL0MsY0FBYyw4Q0FBOEMsQ0FBQztBQUM3RCxjQUFjLG9DQUFvQyxDQUFDO0FBQ25ELGNBQWMsNEJBQTRCLENBQUM7QUFDM0MsY0FBYyxnQ0FBZ0MsQ0FBQztBQUMvQyxjQUFjLG9CQUFvQixDQUFDO0FBQ25DLGNBQWMsK0JBQStCLENBQUM7QUFDOUMsY0FBYyx3QkFBd0IsQ0FBQztBQUN2QyxjQUFjLHNDQUFzQyxDQUFDO0FBQ3JELGNBQWMsNEJBQTRCLENBQUM7QUFDM0MsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLGdDQUFnQyxDQUFDO0FBQy9DLGNBQWMseUNBQXlDLENBQUM7QUFDeEQsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLCtCQUErQixDQUFDO0FBQzlDLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyxzQ0FBc0MsQ0FBQztBQUNyRCxjQUFjLDRCQUE0QixDQUFDIn0=

package/build/module/providers/legacy-gas-price-provider.d.ts

@@ -0,0 +1,7 @@
+import { JsonRpcProvider } from '@ethersproject/providers';
+import { GasPrice, IGasPriceProvider } from './gas-price-provider';
+export declare class LegacyGasPriceProvider extends IGasPriceProvider {
+    protected provider: JsonRpcProvider;
+    constructor(provider: JsonRpcProvider);
+    getGasPrice(_latestBlockNumber: number, _requestBlockNumber?: number): Promise<GasPrice>;
+}

package/build/module/providers/legacy-gas-price-provider.js

@@ -0,0 +1,14 @@
+import { IGasPriceProvider } from './gas-price-provider';
+export class LegacyGasPriceProvider extends IGasPriceProvider {
+    constructor(provider) {
+        super();
+        this.provider = provider;
+    }
+    async getGasPrice(_latestBlockNumber, _requestBlockNumber) {
+        const gasPriceWei = await this.provider.getGasPrice();
+        return {
+            gasPriceWei,
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGVnYWN5LWdhcy1wcmljZS1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wcm92aWRlcnMvbGVnYWN5LWdhcy1wcmljZS1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQVksaUJBQWlCLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQUVuRSxNQUFNLE9BQU8sc0JBQXVCLFNBQVEsaUJBQWlCO0lBQzNELFlBQXNCLFFBQXlCO1FBQzdDLEtBQUssRUFBRSxDQUFDO1FBRFksYUFBUSxHQUFSLFFBQVEsQ0FBaUI7SUFFL0MsQ0FBQztJQUVlLEtBQUssQ0FBQyxXQUFXLENBQy9CLGtCQUEwQixFQUMxQixtQkFBNEI7UUFFNUIsTUFBTSxXQUFXLEdBQUcsTUFBTSxJQUFJLENBQUMsUUFBUSxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQ3RELE9BQU87WUFDTCxXQUFXO1NBQ1osQ0FBQztJQUNKLENBQUM7Q0FDRiJ9

package/build/module/providers/multicall-provider.d.ts

@@ -0,0 +1,83 @@
+import { Interface } from '@ethersproject/abi';
+import { BigNumber } from '@ethersproject/bignumber';
+import { ProviderConfig } from './provider';
+export declare type CallSameFunctionOnMultipleContractsParams<TFunctionParams, TAdditionalConfig = any> = {
+    addresses: string[];
+    contractInterface: Interface;
+    functionName: string;
+    functionParams?: TFunctionParams;
+    providerConfig?: ProviderConfig;
+    additionalConfig?: TAdditionalConfig;
+};
+export declare type CallSameFunctionOnContractWithMultipleParams<TFunctionParams, TAdditionalConfig = any> = {
+    address: string;
+    contractInterface: Interface;
+    functionName: string;
+    functionParams: TFunctionParams[];
+    providerConfig?: ProviderConfig;
+    additionalConfig?: TAdditionalConfig;
+};
+export declare type CallMultipleFunctionsOnSameContractParams<TFunctionParams, TAdditionalConfig = any> = {
+    address: string;
+    contractInterface: Interface;
+    functionNames: string[];
+    functionParams?: TFunctionParams[];
+    providerConfig?: ProviderConfig;
+    additionalConfig?: TAdditionalConfig;
+};
+export declare type SuccessResult<TReturn> = {
+    success: true;
+    result: TReturn;
+};
+export declare type FailResult = {
+    success: false;
+    returnData: string;
+    gasUsed?: BigNumber;
+};
+export declare type Result<TReturn> = SuccessResult<TReturn> | FailResult;
+/**
+ * Provider for fetching data on chain using multicall contracts.
+ *
+ * @export
+ * @abstract
+ * @class IMulticallProvider
+ * @template TMulticallConfig
+ */
+export declare abstract class IMulticallProvider<TMulticallConfig = any> {
+    /**
+     * Calls the same function on multiple contracts.
+     *
+     * For example, if you wanted to get the ERC-20 balance of 10 different tokens
+     * this can be used to call balance on the 10 contracts in a single multicall.
+     *
+     * @abstract
+     * @template TFunctionParams
+     * @template TReturn
+     * @param params
+     * @returns {*}
+     */
+    abstract callSameFunctionOnMultipleContracts<TFunctionParams extends any[] | undefined, TReturn = any>(params: CallSameFunctionOnMultipleContractsParams<TFunctionParams, TMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+    }>;
+    /**
+     * Calls a function on a single contract with different parameters.
+     *
+     * For example, if you wanted to call the Uniswap V3 Quoter with 10 different
+     * swap amounts this can be used to make the calls in a single multicall.
+     *
+     * @abstract
+     * @template TFunctionParams
+     * @template TReturn
+     * @param params
+     * @returns {*}
+     */
+    abstract callSameFunctionOnContractWithMultipleParams<TFunctionParams extends any[] | undefined, TReturn = any>(params: CallSameFunctionOnContractWithMultipleParams<TFunctionParams, TMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+    }>;
+    abstract callMultipleFunctionsOnSameContract<TFunctionParams extends any[] | undefined, TReturn = any>(params: CallMultipleFunctionsOnSameContractParams<TFunctionParams, TMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+    }>;
+}

package/build/module/providers/multicall-provider.js

@@ -0,0 +1,11 @@
+/**
+ * Provider for fetching data on chain using multicall contracts.
+ *
+ * @export
+ * @abstract
+ * @class IMulticallProvider
+ * @template TMulticallConfig
+ */
+export class IMulticallProvider {
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXVsdGljYWxsLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9tdWx0aWNhbGwtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBc0RBOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLE9BQWdCLGtCQUFrQjtDQStEdkMifQ==

package/build/module/providers/multicall-ringswap-provider.d.ts

@@ -0,0 +1,35 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { ChainId } from '@ring-protocol/sdk-core';
+import { CallMultipleFunctionsOnSameContractParams, CallSameFunctionOnContractWithMultipleParams, CallSameFunctionOnMultipleContractsParams, IMulticallProvider, Result } from './multicall-provider';
+import { UniswapMulticallConfig } from './multicall-uniswap-provider';
+/**
+ * The UniswapMulticall contract has added functionality for limiting the amount of gas
+ * that each call within the multicall can consume. This is useful for operations where
+ * a call could consume such a large amount of gas that it causes the node to error out
+ * with an out of gas error.
+ *
+ * @export
+ * @class RingswapMulticallProvider
+ */
+export declare class RingswapMulticallProvider extends IMulticallProvider<UniswapMulticallConfig> {
+    protected chainId: ChainId;
+    protected provider: BaseProvider;
+    protected gasLimitPerCall: number;
+    private multicallContract;
+    constructor(chainId: ChainId, provider: BaseProvider, gasLimitPerCall?: number);
+    callSameFunctionOnMultipleContracts<TFunctionParams extends any[] | undefined, TReturn = any>(params: CallSameFunctionOnMultipleContractsParams<TFunctionParams>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+    }>;
+    callSameFunctionOnContractWithMultipleParams<TFunctionParams extends any[] | undefined, TReturn>(params: CallSameFunctionOnContractWithMultipleParams<TFunctionParams, UniswapMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+        approxGasUsedPerSuccessCall: number;
+    }>;
+    callMultipleFunctionsOnSameContract<TFunctionParams extends any[] | undefined, TReturn>(params: CallMultipleFunctionsOnSameContractParams<TFunctionParams, UniswapMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+        approxGasUsedPerSuccessCall: number;
+    }>;
+}

package/build/module/providers/multicall-ringswap-provider.js

@@ -0,0 +1,157 @@
+import _ from 'lodash';
+import stats from 'stats-lite';
+import { UniswapInterfaceMulticall__factory } from '../types/v3/factories/UniswapInterfaceMulticall__factory';
+import { RING_UNISWAP_MULTICALL_ADDRESSES } from '../util/addresses';
+import { log } from '../util/log';
+import { IMulticallProvider, } from './multicall-provider';
+/**
+ * The UniswapMulticall contract has added functionality for limiting the amount of gas
+ * that each call within the multicall can consume. This is useful for operations where
+ * a call could consume such a large amount of gas that it causes the node to error out
+ * with an out of gas error.
+ *
+ * @export
+ * @class RingswapMulticallProvider
+ */
+export class RingswapMulticallProvider extends IMulticallProvider {
+    constructor(chainId, provider, gasLimitPerCall = 1000000) {
+        super();
+        this.chainId = chainId;
+        this.provider = provider;
+        this.gasLimitPerCall = gasLimitPerCall;
+        const multicallAddress = RING_UNISWAP_MULTICALL_ADDRESSES[this.chainId];
+        if (!multicallAddress) {
+            throw new Error(`No address for Ring Swap Multicall Contract on chain id: ${chainId}`);
+        }
+        this.multicallContract = UniswapInterfaceMulticall__factory.connect(multicallAddress, this.provider);
+    }
+    async callSameFunctionOnMultipleContracts(params) {
+        var _a;
+        const { addresses, contractInterface, functionName, functionParams, providerConfig, } = params;
+        const blockNumberOverride = (_a = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber) !== null && _a !== void 0 ? _a : undefined;
+        const fragment = contractInterface.getFunction(functionName);
+        const callData = contractInterface.encodeFunctionData(fragment, functionParams);
+        const calls = _.map(addresses, (address) => {
+            return {
+                target: address,
+                callData,
+                gasLimit: this.gasLimitPerCall,
+            };
+        });
+        log.debug({ calls }, `About to multicall for ${functionName} across ${addresses.length} addresses`);
+        const { blockNumber, returnData: aggregateResults } = await this.multicallContract.callStatic.multicall(calls, {
+            blockTag: blockNumberOverride,
+        });
+        const results = [];
+        for (let i = 0; i < aggregateResults.length; i++) {
+            const { success, returnData } = aggregateResults[i];
+            // Return data "0x" is sometimes returned for invalid calls.
+            if (!success || returnData.length <= 2) {
+                log.debug({ result: aggregateResults[i] }, `Invalid result calling ${functionName} on address ${addresses[i]}`);
+                results.push({
+                    success: false,
+                    returnData,
+                });
+                continue;
+            }
+            results.push({
+                success: true,
+                result: contractInterface.decodeFunctionResult(fragment, returnData),
+            });
+        }
+        log.debug({ results }, `Results for multicall on ${functionName} across ${addresses.length} addresses as of block ${blockNumber}`);
+        return { blockNumber, results };
+    }
+    async callSameFunctionOnContractWithMultipleParams(params) {
+        var _a, _b;
+        const { address, contractInterface, functionName, functionParams, additionalConfig, providerConfig, } = params;
+        const fragment = contractInterface.getFunction(functionName);
+        const gasLimitPerCall = (_a = additionalConfig === null || additionalConfig === void 0 ? void 0 : additionalConfig.gasLimitPerCallOverride) !== null && _a !== void 0 ? _a : this.gasLimitPerCall;
+        const blockNumberOverride = (_b = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber) !== null && _b !== void 0 ? _b : undefined;
+        const calls = _.map(functionParams, (functionParam) => {
+            const callData = contractInterface.encodeFunctionData(fragment, functionParam);
+            return {
+                target: address,
+                callData,
+                gasLimit: gasLimitPerCall,
+            };
+        });
+        log.debug({ calls }, `About to multicall for ${functionName} at address ${address} with ${functionParams.length} different sets of params`);
+        const { blockNumber, returnData: aggregateResults } = await this.multicallContract.callStatic.multicall(calls, {
+            blockTag: blockNumberOverride,
+        });
+        const results = [];
+        const gasUsedForSuccess = [];
+        for (let i = 0; i < aggregateResults.length; i++) {
+            const { success, returnData, gasUsed } = aggregateResults[i];
+            // Return data "0x" is sometimes returned for invalid pools.
+            if (!success || returnData.length <= 2) {
+                log.debug({ result: aggregateResults[i] }, `Invalid result calling ${functionName} address ${address} with params ${functionParams[i]}`);
+                results.push({
+                    success: false,
+                    returnData,
+                    gasUsed,
+                });
+                continue;
+            }
+            gasUsedForSuccess.push(gasUsed.toNumber());
+            results.push({
+                success: true,
+                result: contractInterface.decodeFunctionResult(fragment, returnData),
+            });
+        }
+        log.debug({ results, functionName, address }, `Results for multicall for ${functionName} at address ${address} with ${functionParams.length} different sets of params. Results as of block ${blockNumber}`);
+        return {
+            blockNumber,
+            results,
+            approxGasUsedPerSuccessCall: stats.percentile(gasUsedForSuccess, 99),
+        };
+    }
+    async callMultipleFunctionsOnSameContract(params) {
+        var _a, _b;
+        const { address, contractInterface, functionNames, functionParams, additionalConfig, providerConfig, } = params;
+        const gasLimitPerCall = (_a = additionalConfig === null || additionalConfig === void 0 ? void 0 : additionalConfig.gasLimitPerCallOverride) !== null && _a !== void 0 ? _a : this.gasLimitPerCall;
+        const blockNumberOverride = (_b = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber) !== null && _b !== void 0 ? _b : undefined;
+        const calls = _.map(functionNames, (functionName, i) => {
+            const fragment = contractInterface.getFunction(functionName);
+            const param = functionParams ? functionParams[i] : [];
+            const callData = contractInterface.encodeFunctionData(fragment, param);
+            return {
+                target: address,
+                callData,
+                gasLimit: gasLimitPerCall,
+            };
+        });
+        log.debug({ calls }, `About to multicall for ${functionNames.length} functions at address ${address} with ${functionParams === null || functionParams === void 0 ? void 0 : functionParams.length} different sets of params`);
+        const { blockNumber, returnData: aggregateResults } = await this.multicallContract.callStatic.multicall(calls, {
+            blockTag: blockNumberOverride,
+        });
+        const results = [];
+        const gasUsedForSuccess = [];
+        for (let i = 0; i < aggregateResults.length; i++) {
+            const fragment = contractInterface.getFunction(functionNames[i]);
+            const { success, returnData, gasUsed } = aggregateResults[i];
+            // Return data "0x" is sometimes returned for invalid pools.
+            if (!success || returnData.length <= 2) {
+                log.debug({ result: aggregateResults[i] }, `Invalid result calling ${functionNames[i]} with ${functionParams ? functionParams[i] : '0'} params`);
+                results.push({
+                    success: false,
+                    returnData,
+                });
+                continue;
+            }
+            gasUsedForSuccess.push(gasUsed.toNumber());
+            results.push({
+                success: true,
+                result: contractInterface.decodeFunctionResult(fragment, returnData),
+            });
+        }
+        log.debug({ results, functionNames, address }, `Results for multicall for ${functionNames.length} functions at address ${address} with ${functionParams ? functionParams.length : ' 0'} different sets of params. Results as of block ${blockNumber}`);
+        return {
+            blockNumber,
+            results,
+            approxGasUsedPerSuccessCall: stats.percentile(gasUsedForSuccess, 99),
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"multicall-ringswap-provider.js","sourceRoot":"","sources":["../../../src/providers/multicall-ringswap-provider.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EAAE,kCAAkC,EAAE,MAAM,0DAA0D,CAAC;AAE9G,OAAO,EAAE,gCAAgC,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,OAAO,EAIL,kBAAkB,GAEnB,MAAM,sBAAsB,CAAC;AAG9B;;;;;;;;GAQG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAA0C;IAGvF,YACY,OAAgB,EAChB,QAAsB,EACtB,kBAAkB,OAAS;QAErC,KAAK,EAAE,CAAC;QAJE,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAc;QACtB,oBAAe,GAAf,eAAe,CAAY;QAGrC,MAAM,gBAAgB,GAAG,gCAAgC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAExE,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,KAAK,CACb,4DAA4D,OAAO,EAAE,CACtE,CAAC;SACH;QAED,IAAI,CAAC,iBAAiB,GAAG,kCAAkC,CAAC,OAAO,CACjE,gBAAgB,EAChB,IAAI,CAAC,QAAQ,CACd,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,mCAAmC,CAI9C,MAAkE;;QAKlE,MAAM,EACJ,SAAS,EACT,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,cAAc,GACf,GAAG,MAAM,CAAC;QAEX,MAAM,mBAAmB,GAAG,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,mCAAI,SAAS,CAAC;QAErE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC7D,MAAM,QAAQ,GAAG,iBAAiB,CAAC,kBAAkB,CACnD,QAAQ,EACR,cAAc,CACf,CAAC;QAEF,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;YACzC,OAAO;gBACL,MAAM,EAAE,OAAO;gBACf,QAAQ;gBACR,QAAQ,EAAE,IAAI,CAAC,eAAe;aAC/B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,KAAK,CACP,EAAE,KAAK,EAAE,EACT,0BAA0B,YAAY,WAAW,SAAS,CAAC,MAAM,YAAY,CAC9E,CAAC;QAEF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,GACjD,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE;YACvD,QAAQ,EAAE,mBAAmB;SAC9B,CAAC,CAAC;QAEL,MAAM,OAAO,GAAsB,EAAE,CAAC;QAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAChD,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,gBAAgB,CAAC,CAAC,CAAE,CAAC;YAErD,4DAA4D;YAC5D,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE;gBACtC,GAAG,CAAC,KAAK,CACP,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAC/B,0BAA0B,YAAY,eAAe,SAAS,CAAC,CAAC,CAAC,EAAE,CACpE,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC;oBACX,OAAO,EAAE,KAAK;oBACd,UAAU;iBACX,CAAC,CAAC;gBACH,SAAS;aACV;YAED,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,iBAAiB,CAAC,oBAAoB,CAC5C,QAAQ,EACR,UAAU,CACW;aACxB,CAAC,CAAC;SACJ;QAED,GAAG,CAAC,KAAK,CACP,EAAE,OAAO,EAAE,EACX,4BAA4B,YAAY,WAAW,SAAS,CAAC,MAAM,0BAA0B,WAAW,EAAE,CAC3G,CAAC;QAEF,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,4CAA4C,CAIvD,MAGC;;QAMD,MAAM,EACJ,OAAO,EACP,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,cAAc,GACf,GAAG,MAAM,CAAC;QACX,MAAM,QAAQ,GAAG,iBAAiB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAE7D,MAAM,eAAe,GACnB,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,uBAAuB,mCAAI,IAAI,CAAC,eAAe,CAAC;QACpE,MAAM,mBAAmB,GAAG,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,mCAAI,SAAS,CAAC;QAErE,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,aAAa,EAAE,EAAE;YACpD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,kBAAkB,CACnD,QAAQ,EACR,aAAa,CACd,CAAC;YAEF,OAAO;gBACL,MAAM,EAAE,OAAO;gBACf,QAAQ;gBACR,QAAQ,EAAE,eAAe;aAC1B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,KAAK,CACP,EAAE,KAAK,EAAE,EACT,0BAA0B,YAAY,eAAe,OAAO,SAAS,cAAc,CAAC,MAAM,2BAA2B,CACtH,CAAC;QAEF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,GACjD,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE;YACvD,QAAQ,EAAE,mBAAmB;SAC9B,CAAC,CAAC;QAEL,MAAM,OAAO,GAAsB,EAAE,CAAC;QAEtC,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAChD,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC,CAAC,CAAE,CAAC;YAE9D,4DAA4D;YAC5D,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE;gBACtC,GAAG,CAAC,KAAK,CACP,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAC/B,0BAA0B,YAAY,YAAY,OAAO,gBAAgB,cAAc,CAAC,CAAC,CAAC,EAAE,CAC7F,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC;oBACX,OAAO,EAAE,KAAK;oBACd,UAAU;oBACV,OAAO;iBACR,CAAC,CAAC;gBACH,SAAS;aACV;YAED,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE3C,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,iBAAiB,CAAC,oBAAoB,CAC5C,QAAQ,EACR,UAAU,CACW;aACxB,CAAC,CAAC;SACJ;QAED,GAAG,CAAC,KAAK,CACP,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAClC,6BAA6B,YAAY,eAAe,OAAO,SAAS,cAAc,CAAC,MAAM,kDAAkD,WAAW,EAAE,CAC7J,CAAC;QACF,OAAO;YACL,WAAW;YACX,OAAO;YACP,2BAA2B,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC;SACrE,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,mCAAmC,CAI9C,MAGC;;QAMD,MAAM,EACJ,OAAO,EACP,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,cAAc,GACf,GAAG,MAAM,CAAC;QAEX,MAAM,eAAe,GACnB,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,uBAAuB,mCAAI,IAAI,CAAC,eAAe,CAAC;QACpE,MAAM,mBAAmB,GAAG,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,mCAAI,SAAS,CAAC;QAErE,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE;YACrD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAC7D,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YACvE,OAAO;gBACL,MAAM,EAAE,OAAO;gBACf,QAAQ;gBACR,QAAQ,EAAE,eAAe;aAC1B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,KAAK,CACP,EAAE,KAAK,EAAE,EACT,0BAA0B,aAAa,CAAC,MAAM,yBAAyB,OAAO,SAAS,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,2BAA2B,CACzI,CAAC;QAEF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,GACjD,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE;YACvD,QAAQ,EAAE,mBAAmB;SAC9B,CAAC,CAAC;QAEL,MAAM,OAAO,GAAsB,EAAE,CAAC;QAEtC,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAChD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAE,CAAC,CAAC;YAClE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC,CAAC,CAAE,CAAC;YAE9D,4DAA4D;YAC5D,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE;gBACtC,GAAG,CAAC,KAAK,CACP,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAC/B,0BAA0B,aAAa,CAAC,CAAC,CAAC,SAAS,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACxF,SAAS,CACV,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC;oBACX,OAAO,EAAE,KAAK;oBACd,UAAU;iBACX,CAAC,CAAC;gBACH,SAAS;aACV;YAED,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE3C,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,iBAAiB,CAAC,oBAAoB,CAC5C,QAAQ,EACR,UAAU,CACW;aACxB,CAAC,CAAC;SACJ;QAED,GAAG,CAAC,KAAK,CACP,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,EACnC,6BAA6B,aAAa,CAAC,MAC3C,yBAAyB,OAAO,SAAS,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,IAClF,kDAAkD,WAAW,EAAE,CAChE,CAAC;QACF,OAAO;YACL,WAAW;YACX,OAAO;YACP,2BAA2B,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC;SACrE,CAAC;IACJ,CAAC;CACF"}

package/build/module/providers/multicall-uniswap-provider.d.ts

@@ -0,0 +1,37 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { ChainId } from '@ring-protocol/sdk-core';
+import { CallMultipleFunctionsOnSameContractParams, CallSameFunctionOnContractWithMultipleParams, CallSameFunctionOnMultipleContractsParams, IMulticallProvider, Result } from './multicall-provider';
+export declare type UniswapMulticallConfig = {
+    gasLimitPerCallOverride?: number;
+};
+/**
+ * The UniswapMulticall contract has added functionality for limiting the amount of gas
+ * that each call within the multicall can consume. This is useful for operations where
+ * a call could consume such a large amount of gas that it causes the node to error out
+ * with an out of gas error.
+ *
+ * @export
+ * @class UniswapMulticallProvider
+ */
+export declare class UniswapMulticallProvider extends IMulticallProvider<UniswapMulticallConfig> {
+    protected chainId: ChainId;
+    protected provider: BaseProvider;
+    protected gasLimitPerCall: number;
+    private multicallContract;
+    constructor(chainId: ChainId, provider: BaseProvider, gasLimitPerCall?: number);
+    callSameFunctionOnMultipleContracts<TFunctionParams extends any[] | undefined, TReturn = any>(params: CallSameFunctionOnMultipleContractsParams<TFunctionParams>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+    }>;
+    callSameFunctionOnContractWithMultipleParams<TFunctionParams extends any[] | undefined, TReturn>(params: CallSameFunctionOnContractWithMultipleParams<TFunctionParams, UniswapMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+        approxGasUsedPerSuccessCall: number;
+    }>;
+    callMultipleFunctionsOnSameContract<TFunctionParams extends any[] | undefined, TReturn>(params: CallMultipleFunctionsOnSameContractParams<TFunctionParams, UniswapMulticallConfig>): Promise<{
+        blockNumber: BigNumber;
+        results: Result<TReturn>[];
+        approxGasUsedPerSuccessCall: number;
+    }>;
+}