@across-protocol/sdk 3.0.0

package/dist/esm/contracts/utils.js

@@ -0,0 +1,38 @@
+import assert from "assert";
+import { BigNumber } from "ethers";
+import { isDefined } from "../utils";
+/**
+ * Utility for maintaining records of a token balance.
+ */
+export function Balances(balances) {
+    if (balances === void 0) { balances = {}; }
+    function create(id, amount) {
+        if (amount === void 0) { amount = "0"; }
+        assert(!has(id), "balance already exists");
+        return set(id, amount);
+    }
+    function has(id) {
+        return isDefined(balances[id]);
+    }
+    function set(id, amount) {
+        balances[id] = amount;
+        return amount;
+    }
+    function add(id, amount) {
+        return set(id, BigNumber.from(amount).add(getOrCreate(id)).toString());
+    }
+    function sub(id, amount) {
+        return set(id, BigNumber.from(getOrCreate(id)).sub(amount).toString());
+    }
+    function get(id) {
+        assert(has(id), "balance does not exist");
+        return balances[id];
+    }
+    function getOrCreate(id) {
+        if (has(id))
+            return get(id);
+        return create(id);
+    }
+    return { create: create, add: add, sub: sub, get: get, balances: balances, set: set, has: has, getOrCreate: getOrCreate };
+}
+//# sourceMappingURL=utils.js.map

package/dist/esm/contracts/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/contracts/utils.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAuB,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAgBrC;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,QAAuB;IAAvB,yBAAA,EAAA,aAAuB;IAC9C,SAAS,MAAM,CAAC,EAAU,EAAE,MAAY;QAAZ,uBAAA,EAAA,YAAY;QACtC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC,CAAC;QAC3C,OAAO,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAED,SAAS,GAAG,CAAC,EAAU;QACrB,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,SAAS,GAAG,CAAC,EAAU,EAAE,MAAc;QACrC,QAAQ,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;QACtB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,SAAS,GAAG,CAAC,EAAU,EAAE,MAAoB;QAC3C,OAAO,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,SAAS,GAAG,CAAC,EAAU,EAAE,MAAoB;QAC3C,OAAO,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,SAAS,GAAG,CAAC,EAAU;QACrB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED,SAAS,WAAW,CAAC,EAAU;QAC7B,IAAI,GAAG,CAAC,EAAE,CAAC;YAAE,OAAO,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,EAAE,MAAM,QAAA,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,QAAQ,UAAA,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,WAAW,aAAA,EAAE,CAAC;AACpE,CAAC"}

package/dist/esm/gasPriceOracle/adapters/arbitrum.d.ts

@@ -0,0 +1,3 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "../types";
+export declare function eip1559_arbitrum(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;

package/dist/esm/gasPriceOracle/adapters/arbitrum.js

@@ -0,0 +1,25 @@
+import { __awaiter, __generator } from "tslib";
+import { ethers, utils as ethersUtils } from "ethers";
+import { eip1559 } from "./ethereum";
+// Arbitrum Nitro implements EIP-1559 pricing, but the priority fee is always refunded to the caller. Further,
+// ethers typically hardcodes the priority fee to 1.5 Gwei. So, confirm that the priority fee supplied was 1.5
+// Gwei, and then drop it to 1 Wei. Reference: https://developer.arbitrum.io/faqs/gas-faqs#q-priority
+export function eip1559_arbitrum(provider, chainId) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _a, _maxFeePerGas, maxPriorityFeePerGas, maxFeePerGas;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, eip1559(provider, chainId)];
+                case 1:
+                    _a = _b.sent(), _maxFeePerGas = _a.maxFeePerGas, maxPriorityFeePerGas = _a.maxPriorityFeePerGas;
+                    // If this throws, ethers default behaviour has changed, or Arbitrum RPCs are returning something more sensible.
+                    if (!maxPriorityFeePerGas.eq(ethersUtils.parseUnits("1.5", 9))) {
+                        throw new Error("Expected hardcoded 1.5 Gwei priority fee on Arbitrum, got ".concat(maxPriorityFeePerGas));
+                    }
+                    maxFeePerGas = _maxFeePerGas.sub(maxPriorityFeePerGas).add(1);
+                    return [2 /*return*/, { maxPriorityFeePerGas: ethers.constants.One, maxFeePerGas: maxFeePerGas }];
+            }
+        });
+    });
+}
+//# sourceMappingURL=arbitrum.js.map

package/dist/esm/gasPriceOracle/adapters/arbitrum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arbitrum.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/arbitrum.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAa,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEjE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,8GAA8G;AAC9G,8GAA8G;AAC9G,qGAAqG;AACrG,MAAM,UAAgB,gBAAgB,CAAC,QAA4B,EAAE,OAAe;;;;;wBACpB,qBAAM,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAA;;oBAAxF,KAAwD,SAAgC,EAAxE,aAAa,kBAAA,EAAE,oBAAoB,0BAAA;oBAEzD,gHAAgH;oBAChH,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;wBAC9D,MAAM,IAAI,KAAK,CAAC,oEAA6D,oBAAoB,CAAE,CAAC,CAAC;qBACtG;oBAIK,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;oBAEpE,sBAAO,EAAE,oBAAoB,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,cAAA,EAAE,EAAC;;;;CACrE"}

package/dist/esm/gasPriceOracle/adapters/ethereum.d.ts

@@ -0,0 +1,4 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "../types";
+export declare function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+export declare function legacy(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;

package/dist/esm/gasPriceOracle/adapters/ethereum.js

@@ -0,0 +1,41 @@
+import { __awaiter, __generator } from "tslib";
+import { BigNumber, ethers } from "ethers";
+import { gasPriceError } from "../util";
+export function eip1559(provider, chainId) {
+    return __awaiter(this, void 0, void 0, function () {
+        var feeData, maxPriorityFeePerGas, maxFeePerGas;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, provider.getFeeData()];
+                case 1:
+                    feeData = _a.sent();
+                    [feeData.lastBaseFeePerGas, feeData.maxPriorityFeePerGas].forEach(function (field) {
+                        if (!BigNumber.isBigNumber(field) || field.lt(0))
+                            gasPriceError("getFeeData()", chainId, feeData);
+                    });
+                    maxPriorityFeePerGas = feeData.maxPriorityFeePerGas;
+                    maxFeePerGas = maxPriorityFeePerGas.add(feeData.lastBaseFeePerGas);
+                    return [2 /*return*/, { maxPriorityFeePerGas: maxPriorityFeePerGas, maxFeePerGas: maxFeePerGas }];
+            }
+        });
+    });
+}
+export function legacy(provider, chainId) {
+    return __awaiter(this, void 0, void 0, function () {
+        var gasPrice;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, provider.getGasPrice()];
+                case 1:
+                    gasPrice = _a.sent();
+                    if (!BigNumber.isBigNumber(gasPrice) || gasPrice.lt(0))
+                        gasPriceError("getGasPrice()", chainId, gasPrice);
+                    return [2 /*return*/, {
+                            maxFeePerGas: gasPrice,
+                            maxPriorityFeePerGas: ethers.constants.Zero,
+                        }];
+            }
+        });
+    });
+}
+//# sourceMappingURL=ethereum.js.map

package/dist/esm/gasPriceOracle/adapters/ethereum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethereum.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/ethereum.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAa,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,UAAgB,OAAO,CAAC,QAA4B,EAAE,OAAe;;;;;wBACzD,qBAAM,QAAQ,CAAC,UAAU,EAAE,EAAA;;oBAArC,OAAO,GAAG,SAA2B;oBAE3C,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,UAAC,KAAuB;wBACxF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;4BAAE,aAAa,CAAC,cAAc,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;oBACpG,CAAC,CAAC,CAAC;oBAEG,oBAAoB,GAAG,OAAO,CAAC,oBAAiC,CAAC;oBACjE,YAAY,GAAG,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,iBAA8B,CAAC,CAAC;oBAEtF,sBAAO,EAAE,oBAAoB,sBAAA,EAAE,YAAY,cAAA,EAAE,EAAC;;;;CAC/C;AAED,MAAM,UAAgB,MAAM,CAAC,QAA4B,EAAE,OAAe;;;;;wBAC5C,qBAAM,QAAQ,CAAC,WAAW,EAAE,EAAA;;oBAAlD,QAAQ,GAAc,SAA4B;oBAExD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;wBAAE,aAAa,CAAC,eAAe,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAE1G,sBAAO;4BACL,YAAY,EAAE,QAAQ;4BACtB,oBAAoB,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI;yBAC5C,EAAC;;;;CACH"}

package/dist/esm/gasPriceOracle/adapters/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ethereum";
+export * from "./arbitrum";
+export * from "./polygon";

package/dist/esm/gasPriceOracle/adapters/index.js

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

package/dist/esm/gasPriceOracle/adapters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/esm/gasPriceOracle/adapters/polygon.d.ts

@@ -0,0 +1,3 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "../types";
+export declare function polygonGasStation(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;

package/dist/esm/gasPriceOracle/adapters/polygon.js

@@ -0,0 +1,78 @@
+import { __awaiter, __extends, __generator } from "tslib";
+import { utils as ethersUtils } from "ethers";
+import { BaseHTTPAdapter } from "../../priceClient/adapters/baseAdapter";
+import { isDefined } from "../../utils/TypeGuards";
+import { gasPriceError } from "../util";
+import { eip1559 } from "./ethereum";
+// @dev toBNWei() is not imported from ../utils because of a circular dependency loop.
+//      The fix is probably to relocate the function estimateTotalGasRequiredByUnsignedTransaction().
+var PolygonGasStation = /** @class */ (function (_super) {
+    __extends(PolygonGasStation, _super);
+    function PolygonGasStation(_a) {
+        var _this = this;
+        var _b = _a === void 0 ? {} : _a, _c = _b.chainId, chainId = _c === void 0 ? 137 : _c, host = _b.host, _d = _b.timeout, timeout = _d === void 0 ? 1500 : _d, _e = _b.retries, retries = _e === void 0 ? 1 : _e;
+        host = (host !== null && host !== void 0 ? host : chainId === 137) ? "gasstation.polygon.technology" : "gasstation-testnet.polygon.technology";
+        _this = _super.call(this, "Polygon Gas Station", host, { timeout: timeout, retries: retries }) || this;
+        _this.chainId = chainId;
+        return _this;
+    }
+    PolygonGasStation.prototype.getFeeData = function (strategy) {
+        if (strategy === void 0) { strategy = "fast"; }
+        return __awaiter(this, void 0, void 0, function () {
+            var gas, gasPrice, maxPriorityFeePerGas, maxFeePerGas;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.query("v2", {})];
+                    case 1:
+                        gas = _a.sent();
+                        gasPrice = gas === null || gas === void 0 ? void 0 : gas[strategy];
+                        if (!this.isPolygon1559GasPrice(gasPrice)) {
+                            // @todo: generalise gasPriceError() to accept a reason/cause?
+                            gasPriceError("getFeeData()", this.chainId, ethersUtils.parseUnits("0"));
+                        }
+                        [gasPrice.maxFee, gasPrice.maxPriorityFee].forEach(function (gasPrice) {
+                            if (Number(gasPrice) < 0) {
+                                gasPriceError("getFeeData()", _this.chainId, ethersUtils.parseUnits(gasPrice.toString(), 9));
+                            }
+                        });
+                        maxPriorityFeePerGas = ethersUtils.parseUnits(gasPrice.maxPriorityFee.toString(), 9);
+                        maxFeePerGas = ethersUtils.parseUnits(gasPrice.maxFee.toString(), 9);
+                        return [2 /*return*/, { maxPriorityFeePerGas: maxPriorityFeePerGas, maxFeePerGas: maxFeePerGas }];
+                }
+            });
+        });
+    };
+    PolygonGasStation.prototype.isPolygon1559GasPrice = function (gasPrice) {
+        if (!isDefined(gasPrice)) {
+            return false;
+        }
+        var _gasPrice = gasPrice;
+        return [_gasPrice.maxPriorityFee, _gasPrice.maxFee].every(function (field) { return ["number", "string"].includes(typeof field); });
+    };
+    return PolygonGasStation;
+}(BaseHTTPAdapter));
+export function polygonGasStation(provider, chainId) {
+    return __awaiter(this, void 0, void 0, function () {
+        var gasStation, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    gasStation = new PolygonGasStation({ chainId: chainId });
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 5]);
+                    return [4 /*yield*/, gasStation.getFeeData()];
+                case 2: return [2 /*return*/, _a.sent()];
+                case 3:
+                    err_1 = _a.sent();
+                    return [4 /*yield*/, eip1559(provider, chainId)];
+                case 4: 
+                // Fall back to the RPC provider. May be less accurate.
+                return [2 /*return*/, _a.sent()];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+}
+//# sourceMappingURL=polygon.js.map

package/dist/esm/gasPriceOracle/adapters/polygon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polygon.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/polygon.ts"],"names":[],"mappings":";AAAA,OAAO,EAAa,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EAAE,eAAe,EAAuB,MAAM,wCAAwC,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAqBrC,sFAAsF;AACtF,qGAAqG;AACrG;IAAgC,qCAAe;IAG7C,2BAAY,EAAyE;QAArF,iBAKC;YALW,qBAAuE,EAAE,KAAA,EAAvE,eAAa,EAAb,OAAO,mBAAG,GAAG,KAAA,EAAE,IAAI,UAAA,EAAE,eAAc,EAAd,OAAO,mBAAG,IAAI,KAAA,EAAE,eAAW,EAAX,OAAO,mBAAG,CAAC,KAAA;QAC5D,IAAI,GAAG,CAAA,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,OAAO,KAAK,GAAG,EAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,uCAAuC,CAAC;gBAE3G,kBAAM,qBAAqB,EAAE,IAAI,EAAE,EAAE,OAAO,SAAA,EAAE,OAAO,SAAA,EAAE,CAAC;QACxD,KAAI,CAAC,OAAO,GAAG,OAAO,CAAC;;IACzB,CAAC;IAEK,sCAAU,GAAhB,UAAiB,QAAkD;QAAlD,yBAAA,EAAA,iBAAkD;;;;;;4BACrD,qBAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,EAAA;;wBAAhC,GAAG,GAAG,SAA0B;wBAEhC,QAAQ,GAAyB,GAA4B,aAA5B,GAAG,uBAAH,GAAG,CAA4B,QAAQ,CAAC,CAAC;wBAChF,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE;4BACzC,8DAA8D;4BAC9D,aAAa,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;yBAC1E;wBAED,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,UAAC,QAAQ;4BAC1D,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gCACxB,aAAa,CAAC,cAAc,EAAE,KAAI,CAAC,OAAO,EAAE,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;6BAC7F;wBACH,CAAC,CAAC,CAAC;wBAEG,oBAAoB,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;wBACrF,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;wBAE3E,sBAAO,EAAE,oBAAoB,sBAAA,EAAE,YAAY,cAAA,EAAE,EAAC;;;;KAC/C;IAES,iDAAqB,GAA/B,UAAgC,QAAiB;QAC/C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;YACxB,OAAO,KAAK,CAAC;SACd;QACD,IAAM,SAAS,GAAG,QAA+B,CAAC;QAClD,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK,IAAK,OAAA,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAA3C,CAA2C,CAAC,CAAC;IACpH,CAAC;IACH,wBAAC;AAAD,CAAC,AAtCD,CAAgC,eAAe,GAsC9C;AAED,MAAM,UAAgB,iBAAiB,CAAC,QAA4B,EAAE,OAAe;;;;;;oBAC7E,UAAU,GAAG,IAAI,iBAAiB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;;;;oBAEtD,qBAAM,UAAU,CAAC,UAAU,EAAE,EAAA;wBAApC,sBAAO,SAA6B,EAAC;;;oBAG9B,qBAAM,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAA;;gBADvC,uDAAuD;gBACvD,sBAAO,SAAgC,EAAC;;;;;CAE3C"}

package/dist/esm/gasPriceOracle/index.d.ts

@@ -0,0 +1,2 @@
+export { getGasPriceEstimate } from "./oracle";
+export { GasPriceEstimate } from "./types";

package/dist/esm/gasPriceOracle/index.js

@@ -0,0 +1,2 @@
+export { getGasPriceEstimate } from "./oracle";
+//# sourceMappingURL=index.js.map

package/dist/esm/gasPriceOracle/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gasPriceOracle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC"}

package/dist/esm/gasPriceOracle/oracle.d.ts

@@ -0,0 +1,10 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "./types";
+/**
+ * Provide an estimate for the current gas price for a particular chain.
+ * @param chainId The chain ID to query for gas prices.
+ * @param provider A valid ethers provider.
+ * @param legacyFallback In the case of an unrecognised chain, fall back to type 0 gas estimation.
+ * @returns Am object of type GasPriceEstimate.
+ */
+export declare function getGasPriceEstimate(provider: providers.Provider, chainId?: number, legacyFallback?: boolean): Promise<GasPriceEstimate>;

package/dist/esm/gasPriceOracle/oracle.js

@@ -0,0 +1,48 @@
+import { __awaiter, __generator } from "tslib";
+import { eip1559, eip1559_arbitrum, legacy, polygonGasStation } from "./adapters";
+/**
+ * Provide an estimate for the current gas price for a particular chain.
+ * @param chainId The chain ID to query for gas prices.
+ * @param provider A valid ethers provider.
+ * @param legacyFallback In the case of an unrecognised chain, fall back to type 0 gas estimation.
+ * @returns Am object of type GasPriceEstimate.
+ */
+export function getGasPriceEstimate(provider, chainId, legacyFallback) {
+    if (legacyFallback === void 0) { legacyFallback = true; }
+    return __awaiter(this, void 0, void 0, function () {
+        var network, gasPriceFeeds, gasPriceFeed, gasPriceEstimate;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!!chainId) return [3 /*break*/, 2];
+                    return [4 /*yield*/, provider.getNetwork()];
+                case 1:
+                    network = _a.sent();
+                    chainId = network.chainId;
+                    _a.label = 2;
+                case 2:
+                    gasPriceFeeds = {
+                        1: eip1559,
+                        10: eip1559,
+                        137: polygonGasStation,
+                        288: legacy,
+                        324: legacy,
+                        8453: eip1559,
+                        42161: eip1559_arbitrum,
+                    };
+                    gasPriceFeed = gasPriceFeeds[chainId];
+                    if (gasPriceFeed === undefined) {
+                        if (!legacyFallback) {
+                            throw new Error("No suitable gas price oracle for Chain ID ".concat(chainId));
+                        }
+                        gasPriceFeed = legacy;
+                    }
+                    return [4 /*yield*/, gasPriceFeed(provider, chainId)];
+                case 3:
+                    gasPriceEstimate = _a.sent();
+                    return [2 /*return*/, gasPriceEstimate];
+            }
+        });
+    });
+}
+//# sourceMappingURL=oracle.js.map

package/dist/esm/gasPriceOracle/oracle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oracle.js","sourceRoot":"","sources":["../../../src/gasPriceOracle/oracle.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGlF;;;;;;GAMG;AACH,MAAM,UAAgB,mBAAmB,CACvC,QAA4B,EAC5B,OAAgB,EAChB,cAAqB;IAArB,+BAAA,EAAA,qBAAqB;;;;;;yBAEjB,CAAC,OAAO,EAAR,wBAAQ;oBACyB,qBAAM,QAAQ,CAAC,UAAU,EAAE,EAAA;;oBAAxD,OAAO,GAAsB,SAA2B;oBAC9D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;;;oBAGtB,aAAa,GAAwC;wBACzD,CAAC,EAAE,OAAO;wBACV,EAAE,EAAE,OAAO;wBACX,GAAG,EAAE,iBAAiB;wBACtB,GAAG,EAAE,MAAM;wBACX,GAAG,EAAE,MAAM;wBACX,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,gBAAgB;qBACxB,CAAC;oBAEE,YAAY,GAAiB,aAAa,CAAC,OAAO,CAAC,CAAC;oBACxD,IAAI,YAAY,KAAK,SAAS,EAAE;wBAC9B,IAAI,CAAC,cAAc,EAAE;4BACnB,MAAM,IAAI,KAAK,CAAC,oDAA6C,OAAO,CAAE,CAAC,CAAC;yBACzE;wBACD,YAAY,GAAG,MAAM,CAAC;qBACvB;oBAE0C,qBAAM,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAA;;oBAA1E,gBAAgB,GAAqB,SAAqC;oBAChF,sBAAO,gBAAgB,EAAC;;;;CACzB"}

package/dist/esm/gasPriceOracle/types.d.ts

@@ -0,0 +1,8 @@
+import { BigNumber, providers } from "ethers";
+export type GasPriceEstimate = {
+    maxFeePerGas: BigNumber;
+    maxPriorityFeePerGas: BigNumber;
+};
+export interface GasPriceFeed {
+    (provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+}

package/dist/esm/gasPriceOracle/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/gasPriceOracle/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/gasPriceOracle/types.ts"],"names":[],"mappings":""}

package/dist/esm/gasPriceOracle/util.d.ts

@@ -0,0 +1,2 @@
+import { BigNumber, providers } from "ethers";
+export declare function gasPriceError(method: string, chainId: number, data: providers.FeeData | BigNumber): void;

package/dist/esm/gasPriceOracle/util.js

@@ -0,0 +1,4 @@
+export function gasPriceError(method, chainId, data) {
+    throw new Error("Malformed ".concat(method, " response on chain ID ").concat(chainId, " (").concat(JSON.stringify(data), ")"));
+}
+//# sourceMappingURL=util.js.map

package/dist/esm/gasPriceOracle/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/gasPriceOracle/util.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,OAAe,EAAE,IAAmC;IAChG,MAAM,IAAI,KAAK,CAAC,oBAAa,MAAM,mCAAyB,OAAO,eAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAG,CAAC,CAAC;AACnG,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,15 @@
+export * as lpFeeCalculator from "./lpFeeCalculator";
+export * as pool from "./pool";
+export * as relayFeeCalculator from "./relayFeeCalculator";
+export * as utils from "./utils";
+export * as contracts from "./contracts";
+export * as coingecko from "./coingecko";
+export * as gasPriceOracle from "./gasPriceOracle";
+export * as priceClient from "./priceClient";
+export * as merkleDistributor from "./merkleDistributor";
+export * as constants from "./constants";
+export * as interfaces from "./interfaces";
+export * as typeguards from "./typeguards";
+export * as clients from "./clients";
+export * as typechain from "./typechain";
+export * as caching from "./caching";

package/dist/esm/index.js

@@ -0,0 +1,31 @@
+import * as lpFeeCalculator_1 from "./lpFeeCalculator";
+export { lpFeeCalculator_1 as lpFeeCalculator };
+import * as pool_1 from "./pool";
+export { pool_1 as pool };
+import * as relayFeeCalculator_1 from "./relayFeeCalculator";
+export { relayFeeCalculator_1 as relayFeeCalculator };
+import * as utils_1 from "./utils";
+export { utils_1 as utils };
+import * as contracts_1 from "./contracts";
+export { contracts_1 as contracts };
+import * as coingecko_1 from "./coingecko";
+export { coingecko_1 as coingecko };
+import * as gasPriceOracle_1 from "./gasPriceOracle";
+export { gasPriceOracle_1 as gasPriceOracle };
+import * as priceClient_1 from "./priceClient";
+export { priceClient_1 as priceClient };
+import * as merkleDistributor_1 from "./merkleDistributor";
+export { merkleDistributor_1 as merkleDistributor };
+import * as constants_1 from "./constants";
+export { constants_1 as constants };
+import * as interfaces_1 from "./interfaces";
+export { interfaces_1 as interfaces };
+import * as typeguards_1 from "./typeguards";
+export { typeguards_1 as typeguards };
+import * as clients_1 from "./clients";
+export { clients_1 as clients };
+import * as typechain_1 from "./typechain";
+export { typechain_1 as typechain };
+import * as caching_1 from "./caching";
+export { caching_1 as caching };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"mCAAiC,mBAAmB;8BAAxC,eAAe;wBACL,QAAQ;mBAAlB,IAAI;sCACoB,sBAAsB;iCAA9C,kBAAkB;yBACP,SAAS;oBAApB,KAAK;6BACU,aAAa;wBAA5B,SAAS;6BACM,aAAa;wBAA5B,SAAS;kCACW,kBAAkB;6BAAtC,cAAc;+BACG,eAAe;0BAAhC,WAAW;qCACY,qBAAqB;gCAA5C,iBAAiB;6BACF,aAAa;wBAA5B,SAAS;8BACO,cAAc;yBAA9B,UAAU;8BACM,cAAc;yBAA9B,UAAU;2BACG,WAAW;sBAAxB,OAAO;6BACQ,aAAa;wBAA5B,SAAS;2BACI,WAAW;sBAAxB,OAAO"}

package/dist/esm/interfaces/Bridge.d.ts

@@ -0,0 +1,9 @@
+import { BigNumber } from "ethers";
+export interface OutstandingTransfers {
+    [address: string]: {
+        [l1Token: string]: {
+            totalAmount: BigNumber;
+            depositTxHashes: string[];
+        };
+    };
+}

package/dist/esm/interfaces/Bridge.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Bridge.js.map

package/dist/esm/interfaces/Bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bridge.js","sourceRoot":"","sources":["../../../src/interfaces/Bridge.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/CachingMechanism.d.ts

@@ -0,0 +1,26 @@
+import { Struct } from "superstruct";
+/**
+ * The interface for a caching mechanism. This is used to store and retrieve values from a cache.
+ * @interface CachingInterface
+ * @exports
+ */
+export interface CachingMechanismInterface {
+    /**
+     * Attempts to retrieve a value from the cache.
+     * @param key The key to retrieve.
+     * @returns The value if it exists, otherwise null.
+     */
+    get<ObjectType, OverrideType = unknown>(key?: string, structValidator?: Struct<unknown, unknown>, overrides?: OverrideType): Promise<ObjectType | null>;
+    /**
+     * Attempts to set a key in the caching store. Returns the ID of the value stored. This is useful for storing values
+     * in a cache that are not known ahead of time. For example, if you want to store a value in a cache that is the result of a
+     * computation, you can use this method to store the value and retrieve the ID of the value stored.
+     * @param key The canonical key to store.
+     * @param value The value to store.
+     * @param ttl The time to live in seconds.
+     * @param overrides Any overrides to the default caching mechanism configuration for the given caching protocol.
+     * @note Caching mechanisms where the `key` is directly used to store values will return `key` on success.
+     * @returns The ID of the value stored. If the value could not be stored, undefined is returned. If the caching mechanism uses the `key` as the ID, the `key` is returned.
+     */
+    set<ObjectType, OverrideType>(key: string, value: ObjectType, ttl?: number, overrides?: OverrideType): Promise<string | undefined>;
+}

package/dist/esm/interfaces/CachingMechanism.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CachingMechanism.js.map

package/dist/esm/interfaces/CachingMechanism.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachingMechanism.js","sourceRoot":"","sources":["../../../src/interfaces/CachingMechanism.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/Common.d.ts

@@ -0,0 +1,10 @@
+import { BigNumber } from "ethers";
+export interface SortableEvent {
+    blockNumber: number;
+    transactionIndex: number;
+    logIndex: number;
+    transactionHash: string;
+}
+export interface BigNumberForToken {
+    [l1TokenAddress: string]: BigNumber;
+}

package/dist/esm/interfaces/Common.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Common.js.map

package/dist/esm/interfaces/Common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../src/interfaces/Common.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/ConfigStore.d.ts

@@ -0,0 +1,157 @@
+import { BigNumber } from "ethers";
+import { RateModelDictionary } from "../lpFeeCalculator/rateModel";
+import { SortableEvent } from "./Common";
+export interface ParsedTokenConfig {
+    rateModel: RateModelDictionary;
+    routeRateModel?: {
+        [path: string]: RateModelDictionary;
+    };
+    uba?: UBAOnChainConfigType;
+    spokeTargetBalances?: {
+        [chainId: number]: {
+            target: string;
+            threshold: string;
+        };
+    };
+}
+export interface SpokePoolTargetBalance {
+    target: BigNumber;
+    threshold: BigNumber;
+}
+export type SpokePoolTargetBalanceStringified = Omit<SpokePoolTargetBalance, "threshold" | "target"> & {
+    target: string;
+    threshold: string;
+};
+export interface SpokeTargetBalanceUpdate extends SortableEvent {
+    spokeTargetBalances?: {
+        [chainId: number]: SpokePoolTargetBalance;
+    };
+    l1Token: string;
+}
+export interface SpokeTargetBalanceUpdateStringified extends SortableEvent {
+    spokeTargetBalances?: {
+        [chainId: number]: SpokePoolTargetBalanceStringified;
+    };
+    l1Token: string;
+}
+export interface RouteRateModelUpdate extends SortableEvent {
+    routeRateModel: {
+        [path: string]: string;
+    };
+    l1Token: string;
+}
+export interface TokenConfig extends SortableEvent {
+    key: string;
+    value: string;
+}
+export interface GlobalConfigUpdate<ValueStore = number> extends SortableEvent {
+    value: ValueStore;
+}
+export interface ConfigStoreVersionUpdate<ValueStore = number> extends GlobalConfigUpdate<ValueStore> {
+    timestamp: number;
+}
+export interface DisabledChainsUpdate extends SortableEvent {
+    chainIds: number[];
+}
+/**
+ * A generic type of a dictionary that has string keys and values of type T. This
+ * record is enforced to have a default entry within the "default" key.
+ * @type Value The type of the values in the dictionary.
+ */
+type RecordWithDefaultEntry<Value> = Record<string, Value>;
+/**
+ * A generic type for an array of tuples.
+ * @type Value The type of the values in the array.
+ */
+type ArrayOfTuples<Value> = [Value, Value][];
+/**
+ * A type for the UBA config object stored both on and off chain.
+ * @type T The type of the values in the config.
+ * @note This is a dictionary of parameters that defines a fee curve for the token.
+ *       These parameters can be further subindexed by a route (e.g. using the key "1-10" or "42161-1")
+ *       to create a specific fee curve for a token per route. The subkeys are as followed:
+ *         - alpha: The alpha parameter of the fee curve.
+ *         - gamma: The gamma parameter of the fee curve.
+ *         - omega: The omega parameter of the fee curve.
+ *         - rebalance: The rebalance parameters of the fee curve.
+ */
+type UBAAgnosticConfigType<T> = {
+    /**
+     * A DAO controlled variable to track any donations made to the incentivePool liquidity
+     */
+    incentivePoolAdjustment?: Record<string, T>;
+    /**
+     * Used to scale rewards when a fee is larger than the incentive balance
+     */
+    ubaRewardMultiplier?: Record<string, T>;
+    /**
+     * This is a scalar value that is a constant percentage of each transfer that is allocated for LPs.
+     * This value can be determined by token and route-by-route.
+     */
+    alpha: RecordWithDefaultEntry<T>;
+    /**
+     * This is a piecewise linear function (defined by a vector of cut-off points and the values at
+     * those points) that determine additional LP fees as a function of utilization. This piecewise
+     * linear function can be determined by token and chain-by-chain.
+     */
+    gamma: RecordWithDefaultEntry<ArrayOfTuples<T>>;
+    /**
+     * This is a piecewise linear function (defined by a vector of cut-off points and the values at
+     * those points) that determine the balancing fees (rewards) that are imposed on (paid to) a user
+     * who makes a transfer involving a particular chain. There is a single piecewise linear function for
+     * each token/chain combination. A transfer will incur a balancing fee on both the origin and destination
+     * chains.
+     */
+    omega: RecordWithDefaultEntry<ArrayOfTuples<T>>;
+    /**
+     * This is a set of parameters that determine when a rebalance is triggered. A rebalance is triggered
+     * when the utilization of a pool is outside of the range defined by the lower and upper thresholds.
+     */
+    rebalance: RecordWithDefaultEntry<{
+        /**
+         * For tokens/chains that have a supported bridge, these are the lower and upper threshold that trigger
+         * the reallocation of funds. i.e. If the running balance on a chain moves below (above) threshold_lower
+         * (threshold_upper) then the bridge moves funds from Ethereum to the chain (from the chain to Ethereum).
+         */
+        threshold_lower?: T;
+        /**
+         * For tokens/chains that have a supported bridge, these are the lower and upper threshold that trigger
+         * the reallocation of funds. i.e. If the running balance on a chain moves below (above) threshold_lower
+         * (threshold_upper) then the bridge moves funds from Ethereum to the chain (from the chain to Ethereum).
+         */
+        threshold_upper?: T;
+        /**
+         * For tokens/chains that have a supported bridge, these are the values that are targeted whenever funds
+         * are reallocated.
+         */
+        target_lower?: T;
+        /**
+         * For tokens/chains that have a supported bridge, these are the values that are targeted whenever funds
+         * are reallocated.
+         */
+        target_upper?: T;
+    }>;
+};
+/**
+ * A type for the UBA config object stored on chain.
+ */
+export type UBAOnChainConfigType = UBAAgnosticConfigType<string>;
+/**
+ * A type for the UBA config object after it has been parsed.
+ */
+export type UBAParsedConfigType = UBAAgnosticConfigType<BigNumber>;
+/**
+ * A type for UBAConfig Update events.
+ */
+export type UBAConfigUpdates = SortableEvent & {
+    config: UBAParsedConfigType;
+    l1Token: string;
+};
+/**
+ * A type for stringified UBAConfig Update events.
+ */
+export type UBASerializedConfigUpdates = SortableEvent & {
+    config: UBAOnChainConfigType;
+    l1Token: string;
+};
+export {};

package/dist/esm/interfaces/ConfigStore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ConfigStore.js.map

package/dist/esm/interfaces/ConfigStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigStore.js","sourceRoot":"","sources":["../../../src/interfaces/ConfigStore.ts"],"names":[],"mappings":""}