@ring-protocol/smart-order-router 0.5.0

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

@@ -0,0 +1,164 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RingswapMulticallProvider = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const stats_lite_1 = __importDefault(require("stats-lite"));
+const UniswapInterfaceMulticall__factory_1 = require("../types/v3/factories/UniswapInterfaceMulticall__factory");
+const addresses_1 = require("../util/addresses");
+const log_1 = require("../util/log");
+const multicall_provider_1 = require("./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
+ */
+class RingswapMulticallProvider extends multicall_provider_1.IMulticallProvider {
+    constructor(chainId, provider, gasLimitPerCall = 1000000) {
+        super();
+        this.chainId = chainId;
+        this.provider = provider;
+        this.gasLimitPerCall = gasLimitPerCall;
+        const multicallAddress = addresses_1.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_1.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 = lodash_1.default.map(addresses, (address) => {
+            return {
+                target: address,
+                callData,
+                gasLimit: this.gasLimitPerCall,
+            };
+        });
+        log_1.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_1.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_1.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 = lodash_1.default.map(functionParams, (functionParam) => {
+            const callData = contractInterface.encodeFunctionData(fragment, functionParam);
+            return {
+                target: address,
+                callData,
+                gasLimit: gasLimitPerCall,
+            };
+        });
+        log_1.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_1.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_1.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_lite_1.default.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 = lodash_1.default.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_1.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_1.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_1.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_lite_1.default.percentile(gasUsedForSuccess, 99),
+        };
+    }
+}
+exports.RingswapMulticallProvider = RingswapMulticallProvider;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"multicall-ringswap-provider.js","sourceRoot":"","sources":["../../../src/providers/multicall-ringswap-provider.ts"],"names":[],"mappings":";;;;;;AAGA,oDAAuB;AACvB,4DAA+B;AAE/B,iHAA8G;AAE9G,iDAAqE;AACrE,qCAAkC;AAElC,6DAM8B;AAG9B;;;;;;;;GAQG;AACH,MAAa,yBAA0B,SAAQ,uCAA0C;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,4CAAgC,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,uEAAkC,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,gBAAC,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,SAAG,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,SAAG,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,SAAG,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,gBAAC,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,SAAG,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,SAAG,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,SAAG,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,oBAAK,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,gBAAC,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,SAAG,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,SAAG,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,SAAG,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,oBAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC;SACrE,CAAC;IACJ,CAAC;CACF;AA5RD,8DA4RC"}

package/build/main/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;
+    }>;
+}

package/build/main/providers/multicall-uniswap-provider.js

@@ -0,0 +1,164 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UniswapMulticallProvider = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const stats_lite_1 = __importDefault(require("stats-lite"));
+const UniswapInterfaceMulticall__factory_1 = require("../types/v3/factories/UniswapInterfaceMulticall__factory");
+const addresses_1 = require("../util/addresses");
+const log_1 = require("../util/log");
+const multicall_provider_1 = require("./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 UniswapMulticallProvider
+ */
+class UniswapMulticallProvider extends multicall_provider_1.IMulticallProvider {
+    constructor(chainId, provider, gasLimitPerCall = 1000000) {
+        super();
+        this.chainId = chainId;
+        this.provider = provider;
+        this.gasLimitPerCall = gasLimitPerCall;
+        const multicallAddress = addresses_1.UNISWAP_MULTICALL_ADDRESSES[this.chainId];
+        if (!multicallAddress) {
+            throw new Error(`No address for Uniswap Multicall Contract on chain id: ${chainId}`);
+        }
+        this.multicallContract = UniswapInterfaceMulticall__factory_1.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 = lodash_1.default.map(addresses, (address) => {
+            return {
+                target: address,
+                callData,
+                gasLimit: this.gasLimitPerCall,
+            };
+        });
+        log_1.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_1.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_1.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 = lodash_1.default.map(functionParams, (functionParam) => {
+            const callData = contractInterface.encodeFunctionData(fragment, functionParam);
+            return {
+                target: address,
+                callData,
+                gasLimit: gasLimitPerCall,
+            };
+        });
+        log_1.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_1.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_1.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_lite_1.default.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 = lodash_1.default.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_1.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_1.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_1.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_lite_1.default.percentile(gasUsedForSuccess, 99),
+        };
+    }
+}
+exports.UniswapMulticallProvider = UniswapMulticallProvider;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"multicall-uniswap-provider.js","sourceRoot":"","sources":["../../../src/providers/multicall-uniswap-provider.ts"],"names":[],"mappings":";;;;;;AAGA,oDAAuB;AACvB,4DAA+B;AAE/B,iHAA8G;AAE9G,iDAAgE;AAChE,qCAAkC;AAElC,6DAM8B;AAM9B;;;;;;;;GAQG;AACH,MAAa,wBAAyB,SAAQ,uCAA0C;IAGtF,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,uCAA2B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEnE,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,KAAK,CACb,0DAA0D,OAAO,EAAE,CACpE,CAAC;SACH;QAED,IAAI,CAAC,iBAAiB,GAAG,uEAAkC,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,gBAAC,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,SAAG,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,SAAG,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,SAAG,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,gBAAC,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,SAAG,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,SAAG,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,SAAG,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,oBAAK,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,gBAAC,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,SAAG,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,SAAG,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,SAAG,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,oBAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC;SACrE,CAAC;IACJ,CAAC;CACF;AA5RD,4DA4RC"}

package/build/main/providers/on-chain-gas-price-provider.d.ts

@@ -0,0 +1,19 @@
+import { ChainId } from '@ring-protocol/sdk-core';
+import { EIP1559GasPriceProvider } from './eip-1559-gas-price-provider';
+import { GasPrice, IGasPriceProvider } from './gas-price-provider';
+import { LegacyGasPriceProvider } from './legacy-gas-price-provider';
+/**
+ * Gets gas prices on chain. If the chain supports EIP-1559 and has the feeHistory API,
+ * uses the EIP1559 provider. Otherwise it will use a legacy provider that uses eth_gasPrice
+ *
+ * @export
+ * @class OnChainGasPriceProvider
+ */
+export declare class OnChainGasPriceProvider extends IGasPriceProvider {
+    protected chainId: ChainId;
+    protected eip1559GasPriceProvider: EIP1559GasPriceProvider;
+    protected legacyGasPriceProvider: LegacyGasPriceProvider;
+    protected eipChains: ChainId[];
+    constructor(chainId: ChainId, eip1559GasPriceProvider: EIP1559GasPriceProvider, legacyGasPriceProvider: LegacyGasPriceProvider, eipChains?: ChainId[]);
+    getGasPrice(latestBlockNumber: number, requestBlockNumber?: number): Promise<GasPrice>;
+}

package/build/main/providers/on-chain-gas-price-provider.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnChainGasPriceProvider = void 0;
+const sdk_core_1 = require("@ring-protocol/sdk-core");
+const l2FeeChains_1 = require("../util/l2FeeChains");
+const gas_price_provider_1 = require("./gas-price-provider");
+const DEFAULT_EIP_1559_SUPPORTED_CHAINS = [
+    sdk_core_1.ChainId.MAINNET,
+    sdk_core_1.ChainId.GOERLI,
+    sdk_core_1.ChainId.POLYGON_MUMBAI,
+    sdk_core_1.ChainId.ARBITRUM_ONE,
+    ...l2FeeChains_1.opStackChains,
+];
+/**
+ * Gets gas prices on chain. If the chain supports EIP-1559 and has the feeHistory API,
+ * uses the EIP1559 provider. Otherwise it will use a legacy provider that uses eth_gasPrice
+ *
+ * @export
+ * @class OnChainGasPriceProvider
+ */
+class OnChainGasPriceProvider extends gas_price_provider_1.IGasPriceProvider {
+    constructor(chainId, eip1559GasPriceProvider, legacyGasPriceProvider, eipChains = DEFAULT_EIP_1559_SUPPORTED_CHAINS) {
+        super();
+        this.chainId = chainId;
+        this.eip1559GasPriceProvider = eip1559GasPriceProvider;
+        this.legacyGasPriceProvider = legacyGasPriceProvider;
+        this.eipChains = eipChains;
+    }
+    async getGasPrice(latestBlockNumber, requestBlockNumber) {
+        if (this.eipChains.includes(this.chainId)) {
+            return this.eip1559GasPriceProvider.getGasPrice(latestBlockNumber, requestBlockNumber);
+        }
+        return this.legacyGasPriceProvider.getGasPrice(latestBlockNumber, requestBlockNumber);
+    }
+}
+exports.OnChainGasPriceProvider = OnChainGasPriceProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib24tY2hhaW4tZ2FzLXByaWNlLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9vbi1jaGFpbi1nYXMtcHJpY2UtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsc0RBQWtEO0FBRWxELHFEQUFvRDtBQUVwRCw2REFBbUU7QUFHbkUsTUFBTSxpQ0FBaUMsR0FBRztJQUN4QyxrQkFBTyxDQUFDLE9BQU87SUFDZixrQkFBTyxDQUFDLE1BQU07SUFDZCxrQkFBTyxDQUFDLGNBQWM7SUFDdEIsa0JBQU8sQ0FBQyxZQUFZO0lBQ3BCLEdBQUcsMkJBQWE7Q0FDakIsQ0FBQztBQUVGOzs7Ozs7R0FNRztBQUNILE1BQWEsdUJBQXdCLFNBQVEsc0NBQWlCO0lBQzVELFlBQ1ksT0FBZ0IsRUFDaEIsdUJBQWdELEVBQ2hELHNCQUE4QyxFQUM5QyxZQUF1QixpQ0FBaUM7UUFFbEUsS0FBSyxFQUFFLENBQUM7UUFMRSxZQUFPLEdBQVAsT0FBTyxDQUFTO1FBQ2hCLDRCQUF1QixHQUF2Qix1QkFBdUIsQ0FBeUI7UUFDaEQsMkJBQXNCLEdBQXRCLHNCQUFzQixDQUF3QjtRQUM5QyxjQUFTLEdBQVQsU0FBUyxDQUErQztJQUdwRSxDQUFDO0lBRWUsS0FBSyxDQUFDLFdBQVcsQ0FDL0IsaUJBQXlCLEVBQ3pCLGtCQUEyQjtRQUUzQixJQUFJLElBQUksQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRTtZQUN6QyxPQUFPLElBQUksQ0FBQyx1QkFBdUIsQ0FBQyxXQUFXLENBQzdDLGlCQUFpQixFQUNqQixrQkFBa0IsQ0FDbkIsQ0FBQztTQUNIO1FBRUQsT0FBTyxJQUFJLENBQUMsc0JBQXNCLENBQUMsV0FBVyxDQUM1QyxpQkFBaUIsRUFDakIsa0JBQWtCLENBQ25CLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUExQkQsMERBMEJDIn0=