@across-protocol/sdk 3.0.0

package/dist/esm/priceClient/priceClient.js

@@ -0,0 +1,206 @@
+import { __awaiter, __generator } from "tslib";
+import assert from "assert";
+export function msToS(ms) {
+    return Math.floor(ms / 1000);
+}
+// PriceClient aggregates various user-configured price feeds/sources and retains them for a
+// configurable time period. External price lookups are performed according to an ordered list that
+// is supplied during instantiation. The PriceClient will iterate over the list until a complete set
+// of prices has been retrieved from a single source. External price lookups will opportunistically
+// request new prices for _all_ previously requested tokens. Price lookups into PriceClient will be
+// served out of its local cache if the token price is less than maxPriceAge seconds. This helps to
+// suppress external price lookups and can help to mitigate rate-limiting by external providers.
+// See README.md for further information and usage guidelines.
+var PriceClient = /** @class */ (function () {
+    function PriceClient(logger, priceFeeds) {
+        this.logger = logger;
+        this.priceFeeds = priceFeeds;
+        this.name = "PriceClient";
+        this._maxPriceAge = 300; // seconds
+        this.prices = {};
+        assert(logger, "No logging instance supplied.");
+        assert(priceFeeds.length > 0, "No price feeds supplied.");
+    }
+    Object.defineProperty(PriceClient.prototype, "maxPriceAge", {
+        get: function () {
+            return this._maxPriceAge;
+        },
+        set: function (age) {
+            assert(age >= 0);
+            this.logger.debug({
+                at: "PriceClient#maxPriceAge",
+                message: "Setting maxPriceAge (S) ".concat(this._maxPriceAge, " => ").concat(age, "."),
+            });
+            this._maxPriceAge = age;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    PriceClient.prototype.listPriceFeeds = function () {
+        return this.priceFeeds.map(function (priceFeed) { return priceFeed.name; });
+    };
+    PriceClient.prototype.getPriceByAddress = function (address, currency) {
+        if (currency === void 0) { currency = "usd"; }
+        return __awaiter(this, void 0, void 0, function () {
+            var tokenPrices;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getPricesByAddress([address], currency)];
+                    case 1:
+                        tokenPrices = _a.sent();
+                        return [2 /*return*/, tokenPrices[0]];
+                }
+            });
+        });
+    };
+    // note: Input addresses are *always* converted to lower case for storage as
+    // keys in the PriceClient cache. Adapters will therefore always receive
+    // addresses in lower case form.
+    PriceClient.prototype.getPricesByAddress = function (addresses, currency) {
+        if (currency === void 0) { currency = "usd"; }
+        return __awaiter(this, void 0, void 0, function () {
+            var priceCache, now, missed;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        assert(this.priceFeeds.length > 0, "No price feeds are registered.");
+                        priceCache = this.getPriceCache(currency);
+                        now = msToS(Date.now());
+                        missed = {};
+                        addresses.forEach(function (address) {
+                            var _a;
+                            var addr = address.toLowerCase();
+                            var tokenPrice = (_a = priceCache[addr]) !== null && _a !== void 0 ? _a : { price: 0, timestamp: 0 };
+                            priceCache[addr] = tokenPrice; // Update priceCache if necessary;
+                            var age = now - tokenPrice.timestamp;
+                            if (age > _this.maxPriceAge) {
+                                missed[address] = age;
+                            }
+                        });
+                        if (!(Object.keys(missed).length > 0)) return [3 /*break*/, 2];
+                        this.logger.debug({
+                            at: "PriceClient#getPricesByAddress",
+                            message: "".concat(currency.toUpperCase(), " cache miss (age > ").concat(this.maxPriceAge, " S)."),
+                            tokens: missed,
+                        });
+                        return [4 /*yield*/, this.updatePrices(currency)];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, addresses.map(function (address) {
+                            var _a = priceCache[address.toLowerCase()], price = _a.price, timestamp = _a.timestamp;
+                            return { address: address, price: price, timestamp: timestamp };
+                        })];
+                }
+            });
+        });
+    };
+    PriceClient.prototype.expireCache = function (currency) {
+        var priceCache = this.getPriceCache(currency);
+        Object.values(priceCache).forEach(function (token) { return (token.timestamp = 0); });
+        this.logger.debug({ at: "PriceClient#expireCache", message: "Expired ".concat(currency, " cache.") });
+    };
+    PriceClient.prototype.getPriceCache = function (currency) {
+        if (this.prices[currency] === undefined)
+            this.prices[currency] = {};
+        return this.prices[currency];
+    };
+    PriceClient.prototype.updatePrices = function (currency) {
+        return __awaiter(this, void 0, void 0, function () {
+            var priceCache, addresses, _i, _a, priceFeed, prices, err_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        priceCache = this.getPriceCache(currency);
+                        addresses = Object.keys(priceCache);
+                        _i = 0, _a = this.priceFeeds;
+                        _b.label = 1;
+                    case 1:
+                        if (!(_i < _a.length)) return [3 /*break*/, 7];
+                        priceFeed = _a[_i];
+                        this.logger.debug({
+                            at: "PriceClient#updatePrices",
+                            message: "Looking up prices via ".concat(priceFeed.name, "."),
+                            tokens: addresses,
+                        });
+                        _b.label = 2;
+                    case 2:
+                        _b.trys.push([2, 5, , 6]);
+                        return [4 /*yield*/, priceFeed.getPricesByAddress(addresses, currency)];
+                    case 3:
+                        prices = _b.sent();
+                        return [4 /*yield*/, this.updateCache(priceCache, prices, addresses)];
+                    case 4:
+                        addresses = _b.sent();
+                        if (addresses.length === 0)
+                            return [3 /*break*/, 7]; // All done
+                        return [3 /*break*/, 6];
+                    case 5:
+                        err_1 = _b.sent();
+                        this.logger.debug({
+                            at: "PriceClient#updatePrices",
+                            message: "Price lookup against ".concat(priceFeed.name, " failed (").concat(err_1, ")."),
+                            tokens: addresses,
+                        });
+                        return [3 /*break*/, 6];
+                    case 6:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 7:
+                        if (addresses.length !== 0) {
+                            this.logger.debug({
+                                at: "PriceClient#updatePrices",
+                                message: "Unable to resolve some token prices.",
+                                priceFeeds: this.listPriceFeeds(),
+                                tokens: addresses,
+                            });
+                            throw new Error("Price lookup failed against all price feeds (".concat(this.listPriceFeeds().join(", "), ")"));
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    PriceClient.prototype.updateCache = function (priceCache, prices, expected) {
+        var _this = this;
+        var _a, _b;
+        var updated = [];
+        var skipped = {}; // Includes reason for skipping
+        var now = msToS(Date.now());
+        expected.forEach(function (address) {
+            var addr = address.toLowerCase(); // for internal priceCache lookup.
+            var tokenPrice = prices.find(function (price) { var _a; return ((_a = price === null || price === void 0 ? void 0 : price.address) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === addr; });
+            if (tokenPrice === undefined) {
+                skipped[address] = "Not included in price feed response.";
+            }
+            else if (tokenPrice.timestamp > now) {
+                skipped[address] = "Token price timestamp is too new (timestamp ".concat(tokenPrice.timestamp, ").");
+            }
+            else if (tokenPrice.timestamp >= priceCache[addr].timestamp) {
+                var price = tokenPrice.price, timestamp = tokenPrice.timestamp;
+                // Drop the address; we sub it in when returning to the caller.
+                // @todo: Do we care if the token price is older than maxPriceAge?
+                priceCache[addr] = { price: price, timestamp: timestamp };
+                updated.push(tokenPrice);
+            }
+            else if (tokenPrice.timestamp === priceCache[addr].timestamp) {
+                _this.logger.debug({
+                    at: "PriceClient#updateCache",
+                    message: "No new price available for token ".concat(address, "."),
+                    token: tokenPrice,
+                });
+            }
+        });
+        this.logger.debug({
+            at: "PriceClient#updateCache",
+            message: "Updated ".concat((_a = updated.length) !== null && _a !== void 0 ? _a : 0, " price(s), skipped ").concat((_b = Object.keys(skipped).length) !== null && _b !== void 0 ? _b : 0, "."),
+            updated: updated,
+            skipped: skipped,
+        });
+        return Object.keys(skipped);
+    };
+    return PriceClient;
+}());
+export { PriceClient };
+//# sourceMappingURL=priceClient.js.map

package/dist/esm/priceClient/priceClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"priceClient.js","sourceRoot":"","sources":["../../../src/priceClient/priceClient.ts"],"names":[],"mappings":";AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAuB5B,MAAM,UAAU,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,4FAA4F;AAC5F,mGAAmG;AACnG,oGAAoG;AACpG,mGAAmG;AACnG,mGAAmG;AACnG,mGAAmG;AACnG,gGAAgG;AAChG,8DAA8D;AAC9D;IAOE,qBACY,MAAc,EACf,UAA8B;QAD7B,WAAM,GAAN,MAAM,CAAQ;QACf,eAAU,GAAV,UAAU,CAAoB;QARzB,SAAI,GAAW,aAAa,CAAC;QACrC,iBAAY,GAAG,GAAG,CAAC,CAAC,UAAU;QAC5B,WAAM,GAEZ,EAAE,CAAC;QAML,MAAM,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;QAChD,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,0BAA0B,CAAC,CAAC;IAC5D,CAAC;IAED,sBAAI,oCAAW;aAAf;YACE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;aAED,UAAgB,GAAW;YACzB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,EAAE,EAAE,yBAAyB;gBAC7B,OAAO,EAAE,kCAA2B,IAAI,CAAC,YAAY,iBAAO,GAAG,MAAG;aACnE,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QAC1B,CAAC;;;OATA;IAWD,oCAAc,GAAd;QACE,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,SAA2B,IAAK,OAAA,SAAS,CAAC,IAAI,EAAd,CAAc,CAAC,CAAC;IAC9E,CAAC;IAEK,uCAAiB,GAAvB,UAAwB,OAAe,EAAE,QAAgB;QAAhB,yBAAA,EAAA,gBAAgB;;;;;4BACnC,qBAAM,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAA;;wBAAhE,WAAW,GAAG,SAAkD;wBACtE,sBAAO,WAAW,CAAC,CAAC,CAAC,EAAC;;;;KACvB;IAED,4EAA4E;IAC5E,wEAAwE;IACxE,gCAAgC;IAC1B,wCAAkB,GAAxB,UAAyB,SAAmB,EAAE,QAAgB;QAAhB,yBAAA,EAAA,gBAAgB;;;;;;;wBAC5D,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,gCAAgC,CAAC,CAAC;wBAC/D,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;wBAG1C,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;wBACxB,MAAM,GAAkC,EAAE,CAAC;wBACjD,SAAS,CAAC,OAAO,CAAC,UAAC,OAAe;;4BAChC,IAAM,IAAI,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;4BACnC,IAAM,UAAU,GAAG,MAAA,UAAU,CAAC,IAAI,CAAC,mCAAK,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAiB,CAAC;4BAClF,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,kCAAkC;4BAEjE,IAAM,GAAG,GAAG,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC;4BACvC,IAAI,GAAG,GAAG,KAAI,CAAC,WAAW,EAAE;gCAC1B,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC;6BACvB;wBACH,CAAC,CAAC,CAAC;6BAEC,CAAA,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA,EAA9B,wBAA8B;wBAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;4BAChB,EAAE,EAAE,gCAAgC;4BACpC,OAAO,EAAE,UAAG,QAAQ,CAAC,WAAW,EAAE,gCAAsB,IAAI,CAAC,WAAW,SAAM;4BAC9E,MAAM,EAAE,MAAM;yBACf,CAAC,CAAC;wBACH,qBAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAA;;wBAAjC,SAAiC,CAAC;;4BAGpC,sBAAO,SAAS,CAAC,GAAG,CAAC,UAAC,OAAe;4BAC7B,IAAA,KAAuB,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAtD,KAAK,WAAA,EAAE,SAAS,eAAsC,CAAC;4BAC/D,OAAO,EAAE,OAAO,SAAA,EAAE,KAAK,OAAA,EAAE,SAAS,WAAA,EAAE,CAAC;wBACvC,CAAC,CAAC,EAAC;;;;KACJ;IAED,iCAAW,GAAX,UAAY,QAAgB;QAC1B,IAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,UAAC,KAAiB,IAAK,OAAA,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,yBAAyB,EAAE,OAAO,EAAE,kBAAW,QAAQ,YAAS,EAAE,CAAC,CAAC;IAC9F,CAAC;IAES,mCAAa,GAAvB,UAAwB,QAAgB;QACtC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAEa,kCAAY,GAA1B,UAA2B,QAAgB;;;;;;wBACnC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;wBAC5C,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;8BAED,EAAf,KAAA,IAAI,CAAC,UAAU;;;6BAAf,CAAA,cAAe,CAAA;wBAA5B,SAAS;wBAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;4BAChB,EAAE,EAAE,0BAA0B;4BAC9B,OAAO,EAAE,gCAAyB,SAAS,CAAC,IAAI,MAAG;4BACnD,MAAM,EAAE,SAAS;yBAClB,CAAC,CAAC;;;;wBAEc,qBAAM,SAAS,CAAC,kBAAkB,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAA;;wBAAhE,MAAM,GAAG,SAAuD;wBAC1D,qBAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAA;;wBAAjE,SAAS,GAAG,SAAqD,CAAC;wBAClE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;4BAAE,wBAAM,CAAC,WAAW;;;;wBAE9C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;4BAChB,EAAE,EAAE,0BAA0B;4BAC9B,OAAO,EAAE,+BAAwB,SAAS,CAAC,IAAI,sBAAY,KAAG,OAAI;4BAClE,MAAM,EAAE,SAAS;yBAClB,CAAC,CAAC;;;wBAfiB,IAAe,CAAA;;;wBAoBvC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;4BAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gCAChB,EAAE,EAAE,0BAA0B;gCAC9B,OAAO,EAAE,sCAAsC;gCAC/C,UAAU,EAAE,IAAI,CAAC,cAAc,EAAE;gCACjC,MAAM,EAAE,SAAS;6BAClB,CAAC,CAAC;4BACH,MAAM,IAAI,KAAK,CAAC,uDAAgD,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAG,CAAC,CAAC;yBACtG;;;;;KACF;IAEO,iCAAW,GAAnB,UAAoB,UAAsB,EAAE,MAAoB,EAAE,QAAkB;QAApF,iBAoCC;;QAnCC,IAAM,OAAO,GAAiB,EAAE,CAAC;QACjC,IAAM,OAAO,GAAgC,EAAE,CAAC,CAAC,+BAA+B;QAChF,IAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAE9B,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAe;YAC/B,IAAM,IAAI,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,kCAAkC;YACtE,IAAM,UAAU,GAA2B,MAAM,CAAC,IAAI,CAAC,UAAC,KAAK,YAAK,OAAA,CAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,0CAAE,WAAW,EAAE,MAAK,IAAI,CAAA,EAAA,CAAC,CAAC;YAE1G,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,OAAO,CAAC,OAAO,CAAC,GAAG,sCAAsC,CAAC;aAC3D;iBAAM,IAAI,UAAU,CAAC,SAAS,GAAG,GAAG,EAAE;gBACrC,OAAO,CAAC,OAAO,CAAC,GAAG,sDAA+C,UAAU,CAAC,SAAS,OAAI,CAAC;aAC5F;iBAAM,IAAI,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE;gBACrD,IAAA,KAAK,GAAgB,UAAU,MAA1B,EAAE,SAAS,GAAK,UAAU,UAAf,CAAgB;gBACxC,+DAA+D;gBAC/D,kEAAkE;gBAClE,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,OAAA,EAAE,SAAS,WAAA,EAAgB,CAAC;gBACtD,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC1B;iBAAM,IAAI,UAAU,CAAC,SAAS,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE;gBAC9D,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC;oBAChB,EAAE,EAAE,yBAAyB;oBAC7B,OAAO,EAAE,2CAAoC,OAAO,MAAG;oBACvD,KAAK,EAAE,UAAU;iBAClB,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAChB,EAAE,EAAE,yBAAyB;YAC7B,OAAO,EAAE,kBAAW,MAAA,OAAO,CAAC,MAAM,mCAAI,CAAC,gCAAsB,MAAA,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,mCAAI,CAAC,MAAG;YAChG,OAAO,SAAA;YACP,OAAO,SAAA;SACR,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IACH,kBAAC;AAAD,CAAC,AA5JD,IA4JC"}

package/dist/esm/relayFeeCalculator/chain-queries/baseQuery.d.ts

@@ -0,0 +1,61 @@
+import { L2Provider } from "@eth-optimism/sdk/dist/interfaces/l2-provider";
+import { providers } from "ethers";
+import { Deposit } from "../../interfaces";
+import { SpokePool } from "../../typechain";
+import { TransactionCostEstimate } from "../../utils";
+import { Logger, QueryInterface } from "../relayFeeCalculator";
+type Provider = providers.Provider;
+type OptimismProvider = L2Provider<Provider>;
+type SymbolMappingType = Record<string, {
+    addresses: Record<number, string>;
+    decimals: number;
+}>;
+/**
+ * A unified QueryBase for querying gas costs, token prices, and decimals of various tokens
+ * on a blockchain.
+ */
+export declare class QueryBase implements QueryInterface {
+    readonly provider: Provider | OptimismProvider;
+    readonly symbolMapping: SymbolMappingType;
+    readonly spokePoolAddress: string;
+    readonly simulatedRelayerAddress: string;
+    readonly gasMarkup: number;
+    readonly logger: Logger;
+    readonly coingeckoProApiKey?: string | undefined;
+    readonly fixedGasPrice?: import("ethers").BigNumberish | undefined;
+    readonly coingeckoBaseCurrency: string;
+    readonly spokePool: SpokePool;
+    /**
+     * Instantiates a QueryBase instance
+     * @param provider A valid Ethers.js provider
+     * @param symbolMapping A mapping to valid ERC20 tokens and their respective characteristics
+     * @param spokePoolAddress The valid address of the Spoke Pool deployment
+     * @param simulatedRelayerAddress The address that these queries will reference as the sender. Note: This address must be approved for USDC
+     * @param gasMarkup A multiplier that is applied to the total gas estimate
+     * @param logger A logging utility to report logs
+     * @param coingeckoProApiKey An optional CoinGecko API key that links to a PRO account
+     * @param fixedGasPrice Overrides the gas price with a fixed value. Note: primarily used for the Boba blockchain
+     * @param coingeckoBaseCurrency The basis currency that CoinGecko will use to resolve pricing
+     */
+    constructor(provider: Provider | OptimismProvider, symbolMapping: SymbolMappingType, spokePoolAddress: string, simulatedRelayerAddress: string, gasMarkup: number, logger: Logger, coingeckoProApiKey?: string | undefined, fixedGasPrice?: import("ethers").BigNumberish | undefined, coingeckoBaseCurrency?: string);
+    /**
+     * Retrieves the current gas costs of performing a fillRelay contract at the referenced SpokePool.
+     * @param deposit V3 deposit instance.
+     * @param relayerAddress Relayer address to simulate with.
+     * @returns The gas estimate for this function call (multplied with the optional buffer).
+     */
+    getGasCosts(deposit: Deposit, relayer?: string): Promise<TransactionCostEstimate>;
+    /**
+     * Retrieves the current price of a token
+     * @param tokenSymbol A valid [CoinGecko-ID](https://api.coingecko.com/api/v3/coins/list)
+     * @returns The resolved token price within the specified coingeckoBaseCurrency
+     */
+    getTokenPrice(tokenSymbol: string): Promise<number>;
+    /**
+     * Resolves the number of decimal places a token can have
+     * @param tokenSymbol A valid Across-Enabled Token ID
+     * @returns The number of decimals of precision for the corresponding tokenSymbol
+     */
+    getTokenDecimals(tokenSymbol: string): number;
+}
+export {};

package/dist/esm/relayFeeCalculator/chain-queries/baseQuery.js

@@ -0,0 +1,91 @@
+import { __awaiter, __generator } from "tslib";
+import { Coingecko } from "../../coingecko";
+import { CHAIN_IDs, DEFAULT_SIMULATED_RELAYER_ADDRESS } from "../../constants";
+import { SpokePool__factory } from "../../typechain";
+import { estimateTotalGasRequiredByUnsignedTransaction, populateV3Relay, } from "../../utils";
+/**
+ * A unified QueryBase for querying gas costs, token prices, and decimals of various tokens
+ * on a blockchain.
+ */
+var QueryBase = /** @class */ (function () {
+    /**
+     * Instantiates a QueryBase instance
+     * @param provider A valid Ethers.js provider
+     * @param symbolMapping A mapping to valid ERC20 tokens and their respective characteristics
+     * @param spokePoolAddress The valid address of the Spoke Pool deployment
+     * @param simulatedRelayerAddress The address that these queries will reference as the sender. Note: This address must be approved for USDC
+     * @param gasMarkup A multiplier that is applied to the total gas estimate
+     * @param logger A logging utility to report logs
+     * @param coingeckoProApiKey An optional CoinGecko API key that links to a PRO account
+     * @param fixedGasPrice Overrides the gas price with a fixed value. Note: primarily used for the Boba blockchain
+     * @param coingeckoBaseCurrency The basis currency that CoinGecko will use to resolve pricing
+     */
+    function QueryBase(provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, gasMarkup, logger, coingeckoProApiKey, fixedGasPrice, coingeckoBaseCurrency) {
+        if (coingeckoBaseCurrency === void 0) { coingeckoBaseCurrency = "eth"; }
+        this.provider = provider;
+        this.symbolMapping = symbolMapping;
+        this.spokePoolAddress = spokePoolAddress;
+        this.simulatedRelayerAddress = simulatedRelayerAddress;
+        this.gasMarkup = gasMarkup;
+        this.logger = logger;
+        this.coingeckoProApiKey = coingeckoProApiKey;
+        this.fixedGasPrice = fixedGasPrice;
+        this.coingeckoBaseCurrency = coingeckoBaseCurrency;
+        this.spokePool = SpokePool__factory.connect(spokePoolAddress, provider);
+    }
+    /**
+     * Retrieves the current gas costs of performing a fillRelay contract at the referenced SpokePool.
+     * @param deposit V3 deposit instance.
+     * @param relayerAddress Relayer address to simulate with.
+     * @returns The gas estimate for this function call (multplied with the optional buffer).
+     */
+    QueryBase.prototype.getGasCosts = function (deposit, relayer) {
+        if (relayer === void 0) { relayer = DEFAULT_SIMULATED_RELAYER_ADDRESS; }
+        return __awaiter(this, void 0, void 0, function () {
+            var tx;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, populateV3Relay(this.spokePool, deposit, relayer)];
+                    case 1:
+                        tx = _a.sent();
+                        return [2 /*return*/, estimateTotalGasRequiredByUnsignedTransaction(tx, relayer, this.provider, this.gasMarkup, this.fixedGasPrice)];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves the current price of a token
+     * @param tokenSymbol A valid [CoinGecko-ID](https://api.coingecko.com/api/v3/coins/list)
+     * @returns The resolved token price within the specified coingeckoBaseCurrency
+     */
+    QueryBase.prototype.getTokenPrice = function (tokenSymbol) {
+        return __awaiter(this, void 0, void 0, function () {
+            var coingeckoInstance, _a, price;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!this.symbolMapping[tokenSymbol])
+                            throw new Error("".concat(tokenSymbol, " does not exist in mapping"));
+                        coingeckoInstance = Coingecko.get(this.logger, this.coingeckoProApiKey);
+                        return [4 /*yield*/, coingeckoInstance.getCurrentPriceByContract(this.symbolMapping[tokenSymbol].addresses[CHAIN_IDs.MAINNET], this.coingeckoBaseCurrency)];
+                    case 1:
+                        _a = _b.sent(), price = _a[1];
+                        return [2 /*return*/, price];
+                }
+            });
+        });
+    };
+    /**
+     * Resolves the number of decimal places a token can have
+     * @param tokenSymbol A valid Across-Enabled Token ID
+     * @returns The number of decimals of precision for the corresponding tokenSymbol
+     */
+    QueryBase.prototype.getTokenDecimals = function (tokenSymbol) {
+        if (!this.symbolMapping[tokenSymbol])
+            throw new Error("".concat(tokenSymbol, " does not exist in mapping"));
+        return this.symbolMapping[tokenSymbol].decimals;
+    };
+    return QueryBase;
+}());
+export { QueryBase };
+//# sourceMappingURL=baseQuery.js.map

package/dist/esm/relayFeeCalculator/chain-queries/baseQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseQuery.js","sourceRoot":"","sources":["../../../../src/relayFeeCalculator/chain-queries/baseQuery.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,iCAAiC,EAAE,MAAM,iBAAiB,CAAC;AAE/E,OAAO,EAAa,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAGL,6CAA6C,EAC7C,eAAe,GAChB,MAAM,aAAa,CAAC;AAarB;;;GAGG;AACH;IAEE;;;;;;;;;;;OAWG;IACH,mBACW,QAAqC,EACrC,aAAgC,EAChC,gBAAwB,EACxB,uBAA+B,EAC/B,SAAiB,EACjB,MAAc,EACd,kBAA2B,EAC3B,aAA4B,EAC5B,qBAAqC;QAArC,sCAAA,EAAA,6BAAqC;QARrC,aAAQ,GAAR,QAAQ,CAA6B;QACrC,kBAAa,GAAb,aAAa,CAAmB;QAChC,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,4BAAuB,GAAvB,uBAAuB,CAAQ;QAC/B,cAAS,GAAT,SAAS,CAAQ;QACjB,WAAM,GAAN,MAAM,CAAQ;QACd,uBAAkB,GAAlB,kBAAkB,CAAS;QAC3B,kBAAa,GAAb,aAAa,CAAe;QAC5B,0BAAqB,GAArB,qBAAqB,CAAgB;QAE9C,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACG,+BAAW,GAAjB,UAAkB,OAAgB,EAAE,OAA2C;QAA3C,wBAAA,EAAA,2CAA2C;;;;;4BAClE,qBAAM,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAA;;wBAA5D,EAAE,GAAG,SAAuD;wBAClE,sBAAO,6CAA6C,CAClD,EAAE,EACF,OAAO,EACP,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,CACnB,EAAC;;;;KACH;IAED;;;;OAIG;IACG,iCAAa,GAAnB,UAAoB,WAAmB;;;;;;wBACrC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;4BAAE,MAAM,IAAI,KAAK,CAAC,UAAG,WAAW,+BAA4B,CAAC,CAAC;wBAC5F,iBAAiB,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;wBAC5D,qBAAM,iBAAiB,CAAC,yBAAyB,CACjE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,EAC5D,IAAI,CAAC,qBAAqB,CAC3B,EAAA;;wBAHK,KAAY,SAGjB,EAHQ,KAAK,QAAA;wBAId,sBAAO,KAAK,EAAC;;;;KACd;IAED;;;;OAIG;IACH,oCAAgB,GAAhB,UAAiB,WAAmB;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,UAAG,WAAW,+BAA4B,CAAC,CAAC;QAClG,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC;IAClD,CAAC;IACH,gBAAC;AAAD,CAAC,AArED,IAqEC"}

package/dist/esm/relayFeeCalculator/chain-queries/factory.d.ts

@@ -0,0 +1,151 @@
+import { providers } from "ethers";
+import { QueryBase } from "./baseQuery";
+import { Logger } from "../relayFeeCalculator";
+export declare class QueryBase__factory {
+    static create(chainId: number, provider: providers.Provider, symbolMapping?: {
+        ACX: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BAL: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BADGER: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BOBA: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        DAI: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        ETH: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        MATIC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        POOL: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        SNX: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        UMA: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        "USDC.e": {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDbC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDT: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WBTC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WETH: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WMATIC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        OP: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+    }, spokePoolAddress?: string, simulatedRelayerAddress?: string, coingeckoProApiKey?: string, logger?: Logger, gasMarkup?: number, coingeckoBaseCurrency?: string): QueryBase;
+}

package/dist/esm/relayFeeCalculator/chain-queries/factory.js

@@ -0,0 +1,38 @@
+var _a;
+import { CHAIN_IDs, TOKEN_SYMBOLS_MAP } from "@across-protocol/constants";
+import { getDeployedAddress } from "@across-protocol/contracts";
+import { asL2Provider } from "@eth-optimism/sdk";
+import { DEFAULT_SIMULATED_RELAYER_ADDRESS } from "../../constants";
+import { chainIsMatic, chainIsOPStack } from "../../utils";
+import { QueryBase } from "./baseQuery";
+import { PolygonQueries } from "./polygon";
+import { DEFAULT_LOGGER } from "../relayFeeCalculator";
+/**
+ * Some chains have a fixed gas price that is applied to the gas estimates. We should override
+ * the gas markup for these chains.
+ */
+var fixedGasPrice = (_a = {},
+    _a[CHAIN_IDs.BOBA] = 1e9,
+    _a);
+var QueryBase__factory = /** @class */ (function () {
+    function QueryBase__factory() {
+    }
+    QueryBase__factory.create = function (chainId, provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, coingeckoProApiKey, logger, gasMarkup, coingeckoBaseCurrency) {
+        if (symbolMapping === void 0) { symbolMapping = TOKEN_SYMBOLS_MAP; }
+        if (spokePoolAddress === void 0) { spokePoolAddress = getDeployedAddress("SpokePool", chainId); }
+        if (simulatedRelayerAddress === void 0) { simulatedRelayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS; }
+        if (logger === void 0) { logger = DEFAULT_LOGGER; }
+        if (gasMarkup === void 0) { gasMarkup = 0; }
+        if (coingeckoBaseCurrency === void 0) { coingeckoBaseCurrency = "eth"; }
+        // Currently the only chain that has a custom query class is Polygon
+        if (chainIsMatic(chainId)) {
+            return new PolygonQueries(provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, coingeckoProApiKey, logger, gasMarkup);
+        }
+        // For OPStack chains, we need to wrap the provider in an L2Provider
+        provider = chainIsOPStack(chainId) ? asL2Provider(provider) : provider;
+        return new QueryBase(provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, gasMarkup, logger, coingeckoProApiKey, fixedGasPrice[chainId], coingeckoBaseCurrency);
+    };
+    return QueryBase__factory;
+}());
+export { QueryBase__factory };
+//# sourceMappingURL=factory.js.map

package/dist/esm/relayFeeCalculator/chain-queries/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../src/relayFeeCalculator/chain-queries/factory.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,iCAAiC,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAU,MAAM,uBAAuB,CAAC;AAE/D;;;GAGG;AACH,IAAM,aAAa;IACjB,GAAC,SAAS,CAAC,IAAI,IAAG,GAAG;OACtB,CAAC;AAEF;IAAA;IAuCA,CAAC;IAtCQ,yBAAM,GAAb,UACE,OAAe,EACf,QAA4B,EAC5B,aAAiC,EACjC,gBAA2D,EAC3D,uBAA2D,EAC3D,kBAA2B,EAC3B,MAA+B,EAC/B,SAAa,EACb,qBAA6B;QAN7B,8BAAA,EAAA,iCAAiC;QACjC,iCAAA,EAAA,mBAAmB,kBAAkB,CAAC,WAAW,EAAE,OAAO,CAAC;QAC3D,wCAAA,EAAA,2DAA2D;QAE3D,uBAAA,EAAA,uBAA+B;QAC/B,0BAAA,EAAA,aAAa;QACb,sCAAA,EAAA,6BAA6B;QAE7B,oEAAoE;QACpE,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE;YACzB,OAAO,IAAI,cAAc,CACvB,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,MAAM,EACN,SAAS,CACV,CAAC;SACH;QACD,oEAAoE;QACpE,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEvE,OAAO,IAAI,SAAS,CAClB,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,aAAa,CAAC,OAAO,CAAC,EACtB,qBAAqB,CACtB,CAAC;IACJ,CAAC;IACH,yBAAC;AAAD,CAAC,AAvCD,IAuCC"}

package/dist/esm/relayFeeCalculator/chain-queries/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./baseQuery";
+export * from "./polygon";
+export * from "./factory";

package/dist/esm/relayFeeCalculator/chain-queries/index.js

@@ -0,0 +1,4 @@
+export * from "./baseQuery";
+export * from "./polygon";
+export * from "./factory";
+//# sourceMappingURL=index.js.map

package/dist/esm/relayFeeCalculator/chain-queries/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/relayFeeCalculator/chain-queries/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}