@across-protocol/sdk 3.1.18 → 3.1.20

package/dist/cjs/providers/utils.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheType = exports.compareRpcResults = exports.createSendErrorWithMessage = exports.formatProviderError = exports.compareArrayResultsWithIgnoredKeys = exports.compareResultsAndFilterIgnoredKeys = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("../utils");
+var lodash_1 = require("lodash");
+function deleteIgnoredKeys(ignoredKeys, obj) {
+    if (!(0, utils_1.isDefined)(obj)) {
+        return;
+    }
+    var newObj = tslib_1.__assign({}, obj);
+    for (var _i = 0, ignoredKeys_1 = ignoredKeys; _i < ignoredKeys_1.length; _i++) {
+        var key = ignoredKeys_1[_i];
+        delete newObj[key];
+    }
+    return newObj;
+}
+function compareResultsAndFilterIgnoredKeys(ignoredKeys, _objA, _objB) {
+    var filteredA = deleteIgnoredKeys(ignoredKeys, _objA);
+    var filteredB = deleteIgnoredKeys(ignoredKeys, _objB);
+    return (0, lodash_1.isEqual)(filteredA, filteredB);
+}
+exports.compareResultsAndFilterIgnoredKeys = compareResultsAndFilterIgnoredKeys;
+function compareArrayResultsWithIgnoredKeys(ignoredKeys, objA, objB) {
+    var filteredA = objA === null || objA === void 0 ? void 0 : objA.map(function (obj) { return deleteIgnoredKeys(ignoredKeys, obj); });
+    var filteredB = objB === null || objB === void 0 ? void 0 : objB.map(function (obj) { return deleteIgnoredKeys(ignoredKeys, obj); });
+    return (0, utils_1.isDefined)(filteredA) && (0, utils_1.isDefined)(filteredB) && (0, lodash_1.isEqual)(filteredA, filteredB);
+}
+exports.compareArrayResultsWithIgnoredKeys = compareArrayResultsWithIgnoredKeys;
+function formatProviderError(provider, rawErrorText) {
+    return "Provider ".concat(provider.connection.url, " failed with error: ").concat(rawErrorText);
+}
+exports.formatProviderError = formatProviderError;
+function createSendErrorWithMessage(message, sendError) {
+    var error = new Error(message);
+    return tslib_1.__assign(tslib_1.__assign({}, sendError), error);
+}
+exports.createSendErrorWithMessage = createSendErrorWithMessage;
+function compareRpcResults(method, rpcResultA, rpcResultB) {
+    if (method === "eth_getBlockByNumber") {
+        return compareResultsAndFilterIgnoredKeys([
+            "miner",
+            "l1BatchNumber",
+            "l1BatchTimestamp",
+            "size",
+            "totalDifficulty",
+        ], rpcResultA, rpcResultB);
+    }
+    else if (method === "eth_getLogs") {
+        return compareArrayResultsWithIgnoredKeys(["blockTimestamp", "transactionLogIndex", "l1BatchNumber", "logType"], rpcResultA, rpcResultB);
+    }
+    else {
+        return (0, lodash_1.isEqual)(rpcResultA, rpcResultB);
+    }
+}
+exports.compareRpcResults = compareRpcResults;
+var CacheType;
+(function (CacheType) {
+    CacheType[CacheType["NONE"] = 0] = "NONE";
+    CacheType[CacheType["WITH_TTL"] = 1] = "WITH_TTL";
+    CacheType[CacheType["NO_TTL"] = 2] = "NO_TTL";
+})(CacheType || (exports.CacheType = CacheType = {}));
+//# sourceMappingURL=utils.js.map

package/dist/cjs/providers/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/providers/utils.ts"],"names":[],"mappings":";;;;AAGA,kCAAqC;AACrC,iCAAiC;AAQjC,SAAS,iBAAiB,CAAC,WAAqB,EAAE,GAA4B;IAC5E,IAAI,CAAC,IAAA,iBAAS,EAAC,GAAG,CAAC,EAAE;QACnB,OAAO;KACR;IACD,IAAM,MAAM,wBAAQ,GAAG,CAAE,CAAC;IAC1B,KAAkB,UAAW,EAAX,2BAAW,EAAX,yBAAW,EAAX,IAAW,EAAE;QAA1B,IAAM,GAAG,oBAAA;QACZ,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;KACpB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,kCAAkC,CAChD,WAAqB,EACrB,KAA8B,EAC9B,KAA8B;IAG9B,IAAM,SAAS,GAAG,iBAAiB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACxD,IAAM,SAAS,GAAG,iBAAiB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAGxD,OAAO,IAAA,gBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AACvC,CAAC;AAXD,gFAWC;AAED,SAAgB,kCAAkC,CAAC,WAAqB,EAAE,IAAe,EAAE,IAAe;IAExG,IAAM,SAAS,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,iBAAiB,CAAC,WAAW,EAAE,GAA8B,CAAC,EAA9D,CAA8D,CAAC,CAAC;IACrG,IAAM,SAAS,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,iBAAiB,CAAC,WAAW,EAAE,GAA8B,CAAC,EAA9D,CAA8D,CAAC,CAAC;IAGrG,OAAO,IAAA,iBAAS,EAAC,SAAS,CAAC,IAAI,IAAA,iBAAS,EAAC,SAAS,CAAC,IAAI,IAAA,gBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AACvF,CAAC;AAPD,gFAOC;AAqBD,SAAgB,mBAAmB,CAAC,QAAyC,EAAE,YAAoB;IACjG,OAAO,mBAAY,QAAQ,CAAC,UAAU,CAAC,GAAG,iCAAuB,YAAY,CAAE,CAAC;AAClF,CAAC;AAFD,kDAEC;AAED,SAAgB,0BAA0B,CAAC,OAAe,EAAE,SAAkC;IAC5F,IAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IACjC,6CAAY,SAAS,GAAK,KAAK,EAAG;AACpC,CAAC;AAHD,gEAGC;AAWD,SAAgB,iBAAiB,CAAC,MAAc,EAAE,UAAmB,EAAE,UAAmB;IACxF,IAAI,MAAM,KAAK,sBAAsB,EAAE;QAGrC,OAAO,kCAAkC,CACvC;YACE,OAAO;YACP,eAAe;YACf,kBAAkB;YAClB,MAAM;YACN,iBAAiB;SAClB,EACD,UAAqC,EACrC,UAAqC,CACtC,CAAC;KACH;SAAM,IAAI,MAAM,KAAK,aAAa,EAAE;QAOnC,OAAO,kCAAkC,CACvC,CAAC,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,SAAS,CAAC,EACrE,UAAuB,EACvB,UAAuB,CACxB,CAAC;KACH;SAAM;QACL,OAAO,IAAA,gBAAO,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;KACxC;AACH,CAAC;AA9BD,8CA8BC;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,yCAAI,CAAA;IACJ,iDAAQ,CAAA;IACR,6CAAM,CAAA;AACR,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB"}

package/dist/cjs/utils/NetworkUtils.d.ts

@@ -9,3 +9,4 @@ export declare function chainIsLinea(chainId: number): boolean;
 export declare function chainIsL1(chainId: number): boolean;
 export declare function chainIsCCTPEnabled(chainId: number): boolean;
 export declare function chainRequiresL1ToL2Finalization(chainId: number): boolean;
+export declare function getOriginFromURL(url: string): string;

package/dist/cjs/utils/NetworkUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chainRequiresL1ToL2Finalization = exports.chainIsCCTPEnabled = exports.chainIsL1 = exports.chainIsLinea = exports.chainIsArbitrum = exports.chainIsOPStack = exports.chainIsMatic = exports.chainIsTestnet = exports.chainIsProd = exports.getNativeTokenSymbol = exports.getNetworkName = void 0;
+exports.getOriginFromURL = exports.chainRequiresL1ToL2Finalization = exports.chainIsCCTPEnabled = exports.chainIsL1 = exports.chainIsLinea = exports.chainIsArbitrum = exports.chainIsOPStack = exports.chainIsMatic = exports.chainIsTestnet = exports.chainIsProd = exports.getNativeTokenSymbol = exports.getNetworkName = void 0;
 var constants_1 = require("../constants");
 var hreNetworks = {
     666: "Hardhat1",
@@ -63,4 +63,13 @@ function chainRequiresL1ToL2Finalization(chainId) {
     return chainIsCCTPEnabled(chainId) || chainIsLinea(chainId);
 }
 exports.chainRequiresL1ToL2Finalization = chainRequiresL1ToL2Finalization;
+function getOriginFromURL(url) {
+    try {
+        return new URL(url).origin;
+    }
+    catch (e) {
+        return "UNKNOWN";
+    }
+}
+exports.getOriginFromURL = getOriginFromURL;
 //# sourceMappingURL=NetworkUtils.js.map

package/dist/cjs/utils/NetworkUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"NetworkUtils.js","sourceRoot":"","sources":["../../../src/utils/NetworkUtils.ts"],"names":[],"mappings":";;;AAAA,0CAA6G;AAE7G,IAAM,WAAW,GAA2B;IAC1C,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,UAAU;CACjB,CAAC;AAOF,SAAgB,cAAc,CAAC,SAA0B;;IACvD,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC9B,OAAO,MAAA,MAAA,MAAA,2BAAe,CAAC,SAAS,CAAC,0CAAE,IAAI,mCAAI,WAAW,CAAC,SAAS,CAAC,mCAAI,SAAS,CAAC;AACjF,CAAC;AAHD,wCAGC;AAOD,SAAgB,oBAAoB,CAAC,OAAwB;;IAC3D,OAAO,MAAA,MAAA,2BAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,0CAAE,WAAW,mCAAI,KAAK,CAAC;AAChE,CAAC;AAFD,oDAEC;AAOD,SAAgB,WAAW,CAAC,OAAe;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC,6BAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAFD,kCAEC;AAOD,SAAgB,cAAc,CAAC,OAAe;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,6BAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAOD,SAAgB,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,qBAAS,CAAC,OAAO,EAAE,qBAAS,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACvE,CAAC;AAFD,oCAEC;AAOD,SAAgB,cAAc,CAAC,OAAe;;IAC5C,OAAO,MAAA,CAAA,MAAA,2BAAe,CAAC,OAAO,CAAC,0CAAE,MAAM,MAAK,uBAAW,CAAC,QAAQ,mCAAI,KAAK,CAAC;AAC5E,CAAC;AAFD,wCAEC;AAOD,SAAgB,eAAe,CAAC,OAAe;IAC7C,OAAO,CAAC,qBAAS,CAAC,QAAQ,EAAE,qBAAS,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5E,CAAC;AAFD,0CAEC;AAOD,SAAgB,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,qBAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAFD,oCAEC;AAOD,SAAgB,SAAS,CAAC,OAAe;IACvC,OAAO,CAAC,qBAAS,CAAC,OAAO,EAAE,qBAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClE,CAAC;AAFD,8BAEC;AAOD,SAAgB,kBAAkB,CAAC,OAAe;IAChD,OAAO;QAEL,qBAAS,CAAC,IAAI;QACd,qBAAS,CAAC,QAAQ;QAClB,qBAAS,CAAC,QAAQ;QAClB,qBAAS,CAAC,OAAO;QAEjB,qBAAS,CAAC,YAAY;QACtB,qBAAS,CAAC,gBAAgB;QAC1B,qBAAS,CAAC,gBAAgB;QAC1B,qBAAS,CAAC,YAAY;KACvB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC;AAbD,gDAaC;AAOD,SAAgB,+BAA+B,CAAC,OAAe;IAC7D,OAAO,kBAAkB,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAC9D,CAAC;AAFD,0EAEC"}
+{"version":3,"file":"NetworkUtils.js","sourceRoot":"","sources":["../../../src/utils/NetworkUtils.ts"],"names":[],"mappings":";;;AAAA,0CAA6G;AAE7G,IAAM,WAAW,GAA2B;IAC1C,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,UAAU;CACjB,CAAC;AAOF,SAAgB,cAAc,CAAC,SAA0B;;IACvD,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC9B,OAAO,MAAA,MAAA,MAAA,2BAAe,CAAC,SAAS,CAAC,0CAAE,IAAI,mCAAI,WAAW,CAAC,SAAS,CAAC,mCAAI,SAAS,CAAC;AACjF,CAAC;AAHD,wCAGC;AAOD,SAAgB,oBAAoB,CAAC,OAAwB;;IAC3D,OAAO,MAAA,MAAA,2BAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,0CAAE,WAAW,mCAAI,KAAK,CAAC;AAChE,CAAC;AAFD,oDAEC;AAOD,SAAgB,WAAW,CAAC,OAAe;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC,6BAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAFD,kCAEC;AAOD,SAAgB,cAAc,CAAC,OAAe;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,6BAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAOD,SAAgB,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,qBAAS,CAAC,OAAO,EAAE,qBAAS,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACvE,CAAC;AAFD,oCAEC;AAOD,SAAgB,cAAc,CAAC,OAAe;;IAC5C,OAAO,MAAA,CAAA,MAAA,2BAAe,CAAC,OAAO,CAAC,0CAAE,MAAM,MAAK,uBAAW,CAAC,QAAQ,mCAAI,KAAK,CAAC;AAC5E,CAAC;AAFD,wCAEC;AAOD,SAAgB,eAAe,CAAC,OAAe;IAC7C,OAAO,CAAC,qBAAS,CAAC,QAAQ,EAAE,qBAAS,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5E,CAAC;AAFD,0CAEC;AAOD,SAAgB,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,qBAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAFD,oCAEC;AAOD,SAAgB,SAAS,CAAC,OAAe;IACvC,OAAO,CAAC,qBAAS,CAAC,OAAO,EAAE,qBAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClE,CAAC;AAFD,8BAEC;AAOD,SAAgB,kBAAkB,CAAC,OAAe;IAChD,OAAO;QAEL,qBAAS,CAAC,IAAI;QACd,qBAAS,CAAC,QAAQ;QAClB,qBAAS,CAAC,QAAQ;QAClB,qBAAS,CAAC,OAAO;QAEjB,qBAAS,CAAC,YAAY;QACtB,qBAAS,CAAC,gBAAgB;QAC1B,qBAAS,CAAC,gBAAgB;QAC1B,qBAAS,CAAC,YAAY;KACvB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC;AAbD,gDAaC;AAOD,SAAgB,+BAA+B,CAAC,OAAe;IAC7D,OAAO,kBAAkB,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAC9D,CAAC;AAFD,0EAEC;AAOD,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,IAAI;QACF,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;KAC5B;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,4CAMC"}

package/dist/cjs/utils/ObjectUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectUtils.js","sourceRoot":"","sources":["../../../src/utils/ObjectUtils.ts"],"names":[],"mappings":";;;;AAKA,SAAgB,MAAM,CAAC,GAAQ,EAAE,OAAc,EAAE,KAAU;IACzD,IAAM,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,EAAE,CAAC,EAAE;QACrC,IAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;SACf;QACD,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KAChB;IAED,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,QAAQ,EAAE;QAChF,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC;KACpC;SAEI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC7B,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,mDAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,SAAK,KAAK,OAAC,CAAC;KACxE;SAEI,IAAI,KAAK,KAAK,KAAK,EAAE;QACxB,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC;KACpC;SAEI;QACH,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,yCAAQ,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAK,KAAK,CAAE,CAAC;KAC1E;AACH,CAAC;AAzBD,wBAyBC;AAGD,SAAgB,6BAA6B,CAC3C,OAAc,EACd,WAAmB,EACnB,aAAqB,EACrB,YAAoB;IAEpB,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1D,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,mCAAI,EAAE,CAAC;QAClG,IAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QACtF,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC7D,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAdD,sEAcC;AACD,SAAgB,2BAA2B,CACzC,OAAc,EACd,WAAmB,EACnB,gBAAsC;IAEtC,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1D,IAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QACtG,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAXD,kEAWC;AAED,SAAgB,uBAAuB,CAAC,OAAc,EAAE,OAA6B;IACnF,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;QAChC,IAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAND,0DAMC;AAOD,SAAgB,eAAe,CAAC,GAAqC;IACnE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;YAAF,CAAC,QAAA;QAAM,OAAA,CAAC;IAAD,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC;AAFD,0CAEC"}
+{"version":3,"file":"ObjectUtils.js","sourceRoot":"","sources":["../../../src/utils/ObjectUtils.ts"],"names":[],"mappings":";;;;AAMA,SAAgB,MAAM,CAAC,GAAQ,EAAE,OAAc,EAAE,KAAU;IACzD,IAAM,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,EAAE,CAAC,EAAE;QACrC,IAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;SACf;QACD,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KAChB;IAED,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,QAAQ,EAAE;QAChF,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC;KACpC;SAEI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC7B,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,mDAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,SAAK,KAAK,OAAC,CAAC;KACxE;SAEI,IAAI,KAAK,KAAK,KAAK,EAAE;QACxB,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC;KACpC;SAEI;QACH,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,yCAAQ,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAK,KAAK,CAAE,CAAC;KAC1E;AACH,CAAC;AAzBD,wBAyBC;AAGD,SAAgB,6BAA6B,CAC3C,OAAc,EACd,WAAmB,EACnB,aAAqB,EACrB,YAAoB;IAEpB,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1D,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,mCAAI,EAAE,CAAC;QAClG,IAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QACtF,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC7D,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAdD,sEAcC;AACD,SAAgB,2BAA2B,CACzC,OAAc,EACd,WAAmB,EACnB,gBAAsC;IAEtC,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1D,IAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QACtG,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAXD,kEAWC;AAED,SAAgB,uBAAuB,CAAC,OAAc,EAAE,OAA6B;IACnF,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;QAChC,IAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAND,0DAMC;AAOD,SAAgB,eAAe,CAAC,GAAqC;IACnE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;YAAF,CAAC,QAAA;QAAM,OAAA,CAAC;IAAD,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC;AAFD,0CAEC"}

package/dist/esm/index.d.ts

@@ -13,3 +13,4 @@ export * as typeguards from "./typeguards";
 export * as clients from "./clients";
 export * as typechain from "./typechain";
 export * as caching from "./caching";
+export * as providers from "./providers";

package/dist/esm/index.js

@@ -28,4 +28,6 @@ import * as typechain_1 from "./typechain";
 export { typechain_1 as typechain };
 import * as caching_1 from "./caching";
 export { caching_1 as caching };
+import * as providers_1 from "./providers";
+export { providers_1 as providers };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +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"}
+{"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;6BACQ,aAAa;wBAA5B,SAAS"}

package/dist/esm/providers/cachedProvider.d.ts

@@ -0,0 +1,17 @@
+import { CachingMechanismInterface } from "../interfaces";
+import { RateLimitedProvider } from "./rateLimitedProvider";
+export declare class CacheProvider extends RateLimitedProvider {
+    readonly redisClient?: CachingMechanismInterface | undefined;
+    readonly standardTtlBlockDistance: number;
+    readonly noTtlBlockDistance: number;
+    readonly providerCacheTtl: number;
+    readonly getBlockByNumberPrefix: string;
+    readonly getLogsCachePrefix: string;
+    readonly callCachePrefix: string;
+    readonly baseTTL: number;
+    constructor(providerCacheNamespace: string, redisClient?: CachingMechanismInterface | undefined, standardTtlBlockDistance: number, noTtlBlockDistance: number, providerCacheTtl: number, ...jsonRpcConstructorParams: ConstructorParameters<typeof RateLimitedProvider>);
+    send(method: string, params: Array<unknown>): Promise<unknown>;
+    private buildRedisKey;
+    private cacheType;
+    private cacheTypeForBlock;
+}

package/dist/esm/providers/cachedProvider.js

@@ -0,0 +1,167 @@
+import { __awaiter, __extends, __generator } from "tslib";
+import { random } from "lodash";
+import { BLOCK_NUMBER_TTL, PROVIDER_CACHE_TTL, PROVIDER_CACHE_TTL_MODIFIER as ttl_modifier } from "./constants";
+import { RateLimitedProvider } from "./rateLimitedProvider";
+import { CacheType } from "./utils";
+var CacheProvider = /** @class */ (function (_super) {
+    __extends(CacheProvider, _super);
+    function CacheProvider(providerCacheNamespace, redisClient, 
+    // Note: if not provided, this is set to POSITIVE_INFINITY, meaning no cache entries are set with the standard TTL.
+    standardTtlBlockDistance, 
+    // Note: if not provided, this is set to POSITIVE_INFINITY, meaning no cache entries are set with no TTL.
+    noTtlBlockDistance, providerCacheTtl) {
+        if (standardTtlBlockDistance === void 0) { standardTtlBlockDistance = Number.POSITIVE_INFINITY; }
+        if (noTtlBlockDistance === void 0) { noTtlBlockDistance = Number.POSITIVE_INFINITY; }
+        if (providerCacheTtl === void 0) { providerCacheTtl = PROVIDER_CACHE_TTL; }
+        var jsonRpcConstructorParams = [];
+        for (var _i = 5; _i < arguments.length; _i++) {
+            jsonRpcConstructorParams[_i - 5] = arguments[_i];
+        }
+        var _this = _super.apply(this, jsonRpcConstructorParams) || this;
+        _this.redisClient = redisClient;
+        _this.standardTtlBlockDistance = standardTtlBlockDistance;
+        _this.noTtlBlockDistance = noTtlBlockDistance;
+        _this.providerCacheTtl = providerCacheTtl;
+        var chainId = _this.network.chainId;
+        // Pre-compute as much of the redis key as possible.
+        var cachePrefix = "".concat(providerCacheNamespace, ",").concat(new URL(_this.connection.url).hostname, ",").concat(chainId);
+        _this.getBlockByNumberPrefix = "".concat(cachePrefix, ":getBlockByNumber,");
+        _this.getLogsCachePrefix = "".concat(cachePrefix, ":eth_getLogs,");
+        _this.callCachePrefix = "".concat(cachePrefix, ":eth_call,");
+        var _ttlVar = providerCacheTtl;
+        var _ttl = Number(_ttlVar);
+        if (isNaN(_ttl) || _ttl <= 0) {
+            throw new Error("PROVIDER_CACHE_TTL (".concat(_ttlVar, ") must be numeric and > 0"));
+        }
+        _this.baseTTL = _ttl;
+        return _this;
+    }
+    CacheProvider.prototype.send = function (method, params) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function () {
+            var cacheType, _d, redisKey, redisResult, result, _e, ttl;
+            return __generator(this, function (_f) {
+                switch (_f.label) {
+                    case 0:
+                        if (!this.redisClient) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.cacheType(method, params)];
+                    case 1:
+                        _d = _f.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        _d = CacheType.NONE;
+                        _f.label = 3;
+                    case 3:
+                        cacheType = _d;
+                        if (!(cacheType !== CacheType.NONE)) return [3 /*break*/, 12];
+                        redisKey = this.buildRedisKey(method, params);
+                        return [4 /*yield*/, ((_a = this.redisClient) === null || _a === void 0 ? void 0 : _a.get(redisKey))];
+                    case 4:
+                        redisResult = _f.sent();
+                        // If cache has the result, parse the json and return it.
+                        if (redisResult) {
+                            return [2 /*return*/, JSON.parse(redisResult)];
+                        }
+                        return [4 /*yield*/, _super.prototype.send.call(this, method, params)];
+                    case 5:
+                        result = _f.sent();
+                        _e = cacheType;
+                        switch (_e) {
+                            case CacheType.WITH_TTL: return [3 /*break*/, 6];
+                            case CacheType.NO_TTL: return [3 /*break*/, 8];
+                        }
+                        return [3 /*break*/, 10];
+                    case 6:
+                        ttl = this.baseTTL + Math.ceil(random(-ttl_modifier, ttl_modifier, true) * this.baseTTL);
+                        return [4 /*yield*/, ((_b = this.redisClient) === null || _b === void 0 ? void 0 : _b.set(redisKey, JSON.stringify(result), ttl))];
+                    case 7:
+                        _f.sent();
+                        return [3 /*break*/, 11];
+                    case 8: return [4 /*yield*/, ((_c = this.redisClient) === null || _c === void 0 ? void 0 : _c.set(redisKey, JSON.stringify(result), Number.POSITIVE_INFINITY))];
+                    case 9:
+                        _f.sent();
+                        return [3 /*break*/, 11];
+                    case 10: throw new Error("Unexpected Cache type: ".concat(cacheType));
+                    case 11: 
+                    // Return the cached result.
+                    return [2 /*return*/, result];
+                    case 12: return [4 /*yield*/, _super.prototype.send.call(this, method, params)];
+                    case 13: return [2 /*return*/, _f.sent()];
+                }
+            });
+        });
+    };
+    CacheProvider.prototype.buildRedisKey = function (method, params) {
+        // Only handles eth_getLogs and eth_call right now.
+        switch (method) {
+            case "eth_getBlockByNumber":
+                return this.getBlockByNumberPrefix + JSON.stringify(params);
+            case "eth_getLogs":
+                return this.getLogsCachePrefix + JSON.stringify(params);
+            case "eth_call":
+                return this.callCachePrefix + JSON.stringify(params);
+            default:
+                throw new Error("CacheProvider::buildRedisKey: invalid JSON-RPC method ".concat(method));
+        }
+    };
+    CacheProvider.prototype.cacheType = function (method, params) {
+        // Today, we only cache eth_getLogs and eth_call.
+        if (method === "eth_getLogs") {
+            var _a = params[0], fromBlock = _a.fromBlock, toBlock = _a.toBlock;
+            // Handle odd cases where the ordering is flipped, etc.
+            // toBlock/fromBlock is in hex, so it must be parsed before being compared to the first unsafe block.
+            var fromBlockNumber = parseInt(String(fromBlock), 16);
+            var toBlockNumber = parseInt(String(toBlock), 16);
+            // Handle cases where the input block numbers are not hex values ("latest", "pending", etc).
+            // This would result in the result of the above being NaN.
+            if (Number.isNaN(fromBlockNumber) || Number.isNaN(toBlockNumber)) {
+                return Promise.resolve(CacheType.NONE);
+            }
+            if (toBlockNumber < fromBlockNumber) {
+                throw new Error("CacheProvider::shouldCache toBlock cannot be smaller than fromBlock.");
+            }
+            return this.cacheTypeForBlock(toBlock);
+        }
+        else if ("eth_call" === method || "eth_getBlockByNumber" === method) {
+            // Pull out the block tag from params. Its position in params is dependent on the method.
+            // We are only interested in numeric block tags, which would be hex-encoded strings.
+            var idx = method === "eth_getBlockByNumber" ? 0 : 1;
+            var blockNumber = parseInt(String(params[idx]), 16);
+            // If the block number isn't present or is a text string, this will be NaN and we return false.
+            if (Number.isNaN(blockNumber)) {
+                return Promise.resolve(CacheType.NONE);
+            }
+            // If the block is old enough to cache, cache the call.
+            return this.cacheTypeForBlock(blockNumber);
+        }
+        else {
+            return Promise.resolve(CacheType.NONE);
+        }
+    };
+    CacheProvider.prototype.cacheTypeForBlock = function (blockNumber) {
+        return __awaiter(this, void 0, void 0, function () {
+            var currentBlockNumber, headDistance;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, _super.prototype._getInternalBlockNumber.call(this, BLOCK_NUMBER_TTL * 1000)];
+                    case 1:
+                        currentBlockNumber = _a.sent();
+                        headDistance = currentBlockNumber - blockNumber;
+                        // If the distance from head is large enough, set with no TTL.
+                        if (headDistance > this.noTtlBlockDistance) {
+                            return [2 /*return*/, CacheType.NO_TTL];
+                        }
+                        // If the distance is <= noTtlBlockDistance, but > standardTtlBlockDistance, use standard TTL.
+                        if (headDistance > this.standardTtlBlockDistance) {
+                            return [2 /*return*/, CacheType.WITH_TTL];
+                        }
+                        // Too close to HEAD, no cache.
+                        return [2 /*return*/, CacheType.NONE];
+                }
+            });
+        });
+    };
+    return CacheProvider;
+}(RateLimitedProvider));
+export { CacheProvider };
+//# sourceMappingURL=cachedProvider.js.map

package/dist/esm/providers/cachedProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cachedProvider.js","sourceRoot":"","sources":["../../../src/providers/cachedProvider.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,2BAA2B,IAAI,YAAY,EAAE,MAAM,aAAa,CAAC;AAChH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;IAAmC,iCAAmB;IAMpD,uBACE,sBAA8B,EACrB,WAAuC;IAChD,mHAAmH;IAC1G,wBAAmD;IAC5D,yGAAyG;IAChG,kBAA6C,EAC7C,gBAAqC;QAHrC,yCAAA,EAAA,2BAA2B,MAAM,CAAC,iBAAiB;QAEnD,mCAAA,EAAA,qBAAqB,MAAM,CAAC,iBAAiB;QAC7C,iCAAA,EAAA,qCAAqC;QAC9C,kCAA8E;aAA9E,UAA8E,EAA9E,qBAA8E,EAA9E,IAA8E;YAA9E,iDAA8E;;QARhF,+BAUW,wBAAwB,UAgBlC;QAxBU,iBAAW,GAAX,WAAW,CAA4B;QAEvC,8BAAwB,GAAxB,wBAAwB,CAA2B;QAEnD,wBAAkB,GAAlB,kBAAkB,CAA2B;QAC7C,sBAAgB,GAAhB,gBAAgB,CAAqB;QAKtC,IAAA,OAAO,GAAK,KAAI,CAAC,OAAO,QAAjB,CAAkB;QAEjC,oDAAoD;QACpD,IAAM,WAAW,GAAG,UAAG,sBAAsB,cAAI,IAAI,GAAG,CAAC,KAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,cAAI,OAAO,CAAE,CAAC;QACpG,KAAI,CAAC,sBAAsB,GAAG,UAAG,WAAW,uBAAoB,CAAC;QACjE,KAAI,CAAC,kBAAkB,GAAG,UAAG,WAAW,kBAAe,CAAC;QACxD,KAAI,CAAC,eAAe,GAAG,UAAG,WAAW,eAAY,CAAC;QAElD,IAAM,OAAO,GAAG,gBAAgB,CAAC;QACjC,IAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,8BAAuB,OAAO,8BAA2B,CAAC,CAAC;SAC5E;QACD,KAAI,CAAC,OAAO,GAAG,IAAI,CAAC;;IACtB,CAAC;IACc,4BAAI,GAAnB,UAAoB,MAAc,EAAE,MAAsB;;;;;;;6BACtC,IAAI,CAAC,WAAW,EAAhB,wBAAgB;wBAAG,qBAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAAA;;wBAApC,KAAA,SAAoC,CAAA;;;wBAAG,KAAA,SAAS,CAAC,IAAI,CAAA;;;wBAApF,SAAS,KAA2E;6BAEtF,CAAA,SAAS,KAAK,SAAS,CAAC,IAAI,CAAA,EAA5B,yBAA4B;wBACxB,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;wBAGhC,qBAAM,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,GAAG,CAAS,QAAQ,CAAC,CAAA,EAAA;;wBAA3D,WAAW,GAAG,SAA6C;wBAEjE,yDAAyD;wBACzD,IAAI,WAAW,EAAE;4BACf,sBAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAC;yBAChC;wBAGc,qBAAM,iBAAM,IAAI,YAAC,MAAM,EAAE,MAAM,CAAC,EAAA;;wBAAzC,MAAM,GAAG,SAAgC;wBAGvC,KAAA,SAAS,CAAA;;iCACV,SAAS,CAAC,QAAQ,CAAC,CAAnB,wBAAkB;iCAOlB,SAAS,CAAC,MAAM,CAAC,CAAjB,wBAAgB;;;;wBAJX,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;wBAC/F,qBAAM,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAA,EAAA;;wBAAlE,SAAkE,CAAC;wBAErE,yBAAM;4BAEN,qBAAM,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAA,EAAA;;wBAAvF,SAAuF,CAAC;wBACxF,yBAAM;6BAEN,MAAM,IAAI,KAAK,CAAC,iCAA0B,SAAS,CAAE,CAAC,CAAC;;oBAG3D,4BAA4B;oBAC5B,sBAAO,MAAM,EAAC;6BAGT,qBAAM,iBAAM,IAAI,YAAC,MAAM,EAAE,MAAM,CAAC,EAAA;6BAAvC,sBAAO,SAAgC,EAAC;;;;KACzC;IAEO,qCAAa,GAArB,UAAsB,MAAc,EAAE,MAAsB;QAC1D,mDAAmD;QACnD,QAAQ,MAAM,EAAE;YACd,KAAK,sBAAsB;gBACzB,OAAO,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC9D,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC1D,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACvD;gBACE,MAAM,IAAI,KAAK,CAAC,gEAAyD,MAAM,CAAE,CAAC,CAAC;SACtF;IACH,CAAC;IAEO,iCAAS,GAAjB,UAAkB,MAAc,EAAE,MAAsB;QACtD,iDAAiD;QACjD,IAAI,MAAM,KAAK,aAAa,EAAE;YACrB,IAAA,KAA0B,MAAkD,GAAtD,EAApB,SAAS,eAAA,EAAE,OAAO,aAAE,CAAuD;YAEpF,uDAAuD;YACvD,qGAAqG;YACrG,IAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;YACxD,IAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAEpD,4FAA4F;YAC5F,0DAA0D;YAC1D,IAAI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;gBAChE,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACxC;YAED,IAAI,aAAa,GAAG,eAAe,EAAE;gBACnC,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;aACzF;YAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SACxC;aAAM,IAAI,UAAU,KAAK,MAAM,IAAI,sBAAsB,KAAK,MAAM,EAAE;YACrE,yFAAyF;YACzF,oFAAoF;YACpF,IAAM,GAAG,GAAG,MAAM,KAAK,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,IAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAEtD,+FAA+F;YAC/F,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACxC;YAED,uDAAuD;YACvD,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;SAC5C;aAAM;YACL,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SACxC;IACH,CAAC;IAEa,yCAAiB,GAA/B,UAAgC,WAAmB;;;;;4BAItB,qBAAM,iBAAM,uBAAuB,YAAC,gBAAgB,GAAG,IAAI,CAAC,EAAA;;wBAAjF,kBAAkB,GAAG,SAA4D;wBAGjF,YAAY,GAAG,kBAAkB,GAAG,WAAW,CAAC;wBAEtD,8DAA8D;wBAC9D,IAAI,YAAY,GAAG,IAAI,CAAC,kBAAkB,EAAE;4BAC1C,sBAAO,SAAS,CAAC,MAAM,EAAC;yBACzB;wBAED,8FAA8F;wBAC9F,IAAI,YAAY,GAAG,IAAI,CAAC,wBAAwB,EAAE;4BAChD,sBAAO,SAAS,CAAC,QAAQ,EAAC;yBAC3B;wBAED,+BAA+B;wBAC/B,sBAAO,SAAS,CAAC,IAAI,EAAC;;;;KACvB;IACH,oBAAC;AAAD,CAAC,AApJD,CAAmC,mBAAmB,GAoJrD"}

package/dist/esm/providers/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const BLOCK_NUMBER_TTL = 60;
+export declare const PROVIDER_CACHE_TTL = 3600;
+export declare const PROVIDER_CACHE_TTL_MODIFIER = 0.15;
+/**
+ * A default timeout for requests of 60 seconds.
+ */
+export declare const defaultTimeout: number;

package/dist/esm/providers/constants.js

@@ -0,0 +1,10 @@
+// This is how many seconds stale the block number can be for us to use it for evaluating the reorg distance in the cache provider.
+export var BLOCK_NUMBER_TTL = 60;
+// This is the TTL for the provider cache.
+export var PROVIDER_CACHE_TTL = 3600;
+export var PROVIDER_CACHE_TTL_MODIFIER = 0.15;
+/**
+ * A default timeout for requests of 60 seconds.
+ */
+export var defaultTimeout = 60 * 1000;
+//# sourceMappingURL=constants.js.map

package/dist/esm/providers/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/providers/constants.ts"],"names":[],"mappings":"AAAA,mIAAmI;AACnI,MAAM,CAAC,IAAM,gBAAgB,GAAG,EAAE,CAAC;AAEnC,0CAA0C;AAC1C,MAAM,CAAC,IAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,CAAC,IAAM,2BAA2B,GAAG,IAAI,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAC,IAAM,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC"}

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

@@ -0,0 +1,5 @@
+export * from "./rateLimitedProvider";
+export * from "./cachedProvider";
+export * from "./retryProvider";
+export * from "./constants";
+export * from "./utils";

package/dist/esm/providers/index.js

@@ -0,0 +1,6 @@
+export * from "./rateLimitedProvider";
+export * from "./cachedProvider";
+export * from "./retryProvider";
+export * from "./constants";
+export * from "./utils";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC"}

package/dist/esm/providers/rateLimitedProvider.d.ts

@@ -0,0 +1,10 @@
+import { ethers } from "ethers";
+import { Logger } from "winston";
+export declare class RateLimitedProvider extends ethers.providers.StaticJsonRpcProvider {
+    readonly pctRpcCallsLogged: number;
+    readonly logger: Logger;
+    private queue;
+    constructor(maxConcurrency: number, pctRpcCallsLogged: number, logger?: Logger, ...cacheConstructorParams: ConstructorParameters<typeof ethers.providers.StaticJsonRpcProvider>);
+    wrapSendWithLog(method: string, params: Array<unknown>): Promise<any>;
+    send(method: string, params: Array<unknown>): Promise<unknown>;
+}

package/dist/esm/providers/rateLimitedProvider.js

@@ -0,0 +1,101 @@
+// StaticJsonRpcProvider is used in place of JsonRpcProvider to avoid redundant eth_chainId queries prior to each
+// request. This is safe to use when the back-end provider is guaranteed not to change.
+// See https://docs.ethers.io/v5/api/providers/jsonrpc-provider/#StaticJsonRpcProvider
+import { __assign, __awaiter, __extends, __generator } from "tslib";
+import { queue } from "async";
+import { ethers } from "ethers";
+import { getOriginFromURL } from "../utils/NetworkUtils";
+import { Logger as umaLogger } from "@uma/logger";
+// This provider is a very small addition to the StaticJsonRpcProvider that ensures that no more than `maxConcurrency`
+// requests are ever in flight. It uses the async/queue library to manage this.
+var RateLimitedProvider = /** @class */ (function (_super) {
+    __extends(RateLimitedProvider, _super);
+    // Takes the same arguments as the JsonRpcProvider, but it has an additional maxConcurrency value at the beginning
+    // of the list.
+    function RateLimitedProvider(maxConcurrency, pctRpcCallsLogged, logger) {
+        if (logger === void 0) { logger = umaLogger; }
+        var cacheConstructorParams = [];
+        for (var _i = 3; _i < arguments.length; _i++) {
+            cacheConstructorParams[_i - 3] = arguments[_i];
+        }
+        var _this = _super.apply(this, cacheConstructorParams) || this;
+        _this.pctRpcCallsLogged = pctRpcCallsLogged;
+        _this.logger = logger;
+        // This sets up the queue. Each task is executed by calling the superclass's send method, which fires off the
+        // request. This queue sends out requests concurrently, but stops once the concurrency limit is reached. The
+        // maxConcurrency is configured here.
+        _this.queue = queue(function (_a, callback) {
+            var sendArgs = _a.sendArgs, resolve = _a.resolve, reject = _a.reject;
+            return __awaiter(_this, void 0, void 0, function () {
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0: return [4 /*yield*/, this.wrapSendWithLog.apply(this, sendArgs).then(resolve)
+                                .catch(reject)];
+                        case 1:
+                            _b.sent();
+                            // we need this for the queue to know that the task is done
+                            // @see: https://caolan.github.io/async/v3/global.html
+                            callback();
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        }, maxConcurrency);
+        return _this;
+    }
+    RateLimitedProvider.prototype.wrapSendWithLog = function (method, params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var loggerArgs, startTime, result, elapsedTimeS, error_1, elapsedTimeS;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!(this.pctRpcCallsLogged <= 0 || Math.random() > this.pctRpcCallsLogged / 100)) return [3 /*break*/, 1];
+                        // Non sample path: no logging or timing, just issue the request.
+                        return [2 /*return*/, _super.prototype.send.call(this, method, params)];
+                    case 1:
+                        loggerArgs = {
+                            at: "ProviderUtils",
+                            message: "Provider response sample",
+                            provider: getOriginFromURL(this.connection.url),
+                            method: method,
+                            params: params,
+                            chainId: this.network.chainId,
+                        };
+                        startTime = performance.now();
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 4, , 5]);
+                        return [4 /*yield*/, _super.prototype.send.call(this, method, params)];
+                    case 3:
+                        result = _a.sent();
+                        elapsedTimeS = (performance.now() - startTime) / 1000;
+                        this.logger.debug(__assign(__assign({}, loggerArgs), { success: true, timeElapsed: elapsedTimeS }));
+                        return [2 /*return*/, result];
+                    case 4:
+                        error_1 = _a.sent();
+                        elapsedTimeS = (performance.now() - startTime) / 1000;
+                        this.logger.debug(__assign(__assign({}, loggerArgs), { success: false, timeElapsed: elapsedTimeS }));
+                        throw error_1;
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    RateLimitedProvider.prototype.send = function (method, params) {
+        var _this = this;
+        // This simply creates a promise and adds the arguments and resolve and reject handlers to the task.
+        return new Promise(function (resolve, reject) {
+            var task = {
+                sendArgs: [method, params],
+                resolve: resolve,
+                reject: reject,
+            };
+            // We didn't previously wait for this push so we can emulate
+            // the same behavior with the `void` keyword.
+            void _this.queue.push(task);
+        });
+    };
+    return RateLimitedProvider;
+}(ethers.providers.StaticJsonRpcProvider));
+export { RateLimitedProvider };
+//# sourceMappingURL=rateLimitedProvider.js.map

package/dist/esm/providers/rateLimitedProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateLimitedProvider.js","sourceRoot":"","sources":["../../../src/providers/rateLimitedProvider.ts"],"names":[],"mappings":"AAAA,iHAAiH;AACjH,uFAAuF;AACvF,sFAAsF;;AAEtF,OAAO,EAAe,KAAK,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAElD,sHAAsH;AACtH,+EAA+E;AAC/E;IAAyC,uCAAsC;IAI7E,kHAAkH;IAClH,eAAe;IACf,6BACE,cAAsB,EACb,iBAAyB,EACzB,MAA0B;QAA1B,uBAAA,EAAA,kBAA0B;QACnC,gCAA+F;aAA/F,UAA+F,EAA/F,qBAA+F,EAA/F,IAA+F;YAA/F,+CAA+F;;QAJjG,+BAMW,sBAAsB,UAahC;QAjBU,uBAAiB,GAAjB,iBAAiB,CAAQ;QACzB,YAAM,GAAN,MAAM,CAAoB;QAKnC,6GAA6G;QAC7G,4GAA4G;QAC5G,qCAAqC;QACrC,KAAI,CAAC,KAAK,GAAG,KAAK,CAAC,UAAO,EAA4C,EAAE,QAAoB;gBAAhE,QAAQ,cAAA,EAAE,OAAO,aAAA,EAAE,MAAM,YAAA;;;;gCACnD,qBAAM,IAAI,CAAC,eAAe,OAApB,IAAI,EAAoB,QAAQ,EACnC,IAAI,CAAC,OAAO,CAAC;iCACb,KAAK,CAAC,MAAM,CAAC,EAAA;;4BAFhB,SAEgB,CAAC;4BACjB,2DAA2D;4BAC3D,sDAAsD;4BACtD,QAAQ,EAAE,CAAC;;;;;SACZ,EAAE,cAAc,CAAC,CAAC;;IACrB,CAAC;IAEK,6CAAe,GAArB,UAAsB,MAAc,EAAE,MAAsB;;;;;;6BACtD,CAAA,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAA,EAA3E,wBAA2E;wBAC7E,iEAAiE;wBACjE,sBAAO,iBAAM,IAAI,YAAC,MAAM,EAAE,MAAM,CAAC,EAAC;;wBAE5B,UAAU,GAAG;4BACjB,EAAE,EAAE,eAAe;4BACnB,OAAO,EAAE,0BAA0B;4BACnC,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;4BAC/C,MAAM,QAAA;4BACN,MAAM,QAAA;4BACN,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;yBAC9B,CAAC;wBAII,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;;;;wBAEnB,qBAAM,iBAAM,IAAI,YAAC,MAAM,EAAE,MAAM,CAAC,EAAA;;wBAAzC,MAAM,GAAG,SAAgC;wBACzC,YAAY,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;wBAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,uBACZ,UAAU,KACb,OAAO,EAAE,IAAI,EACb,WAAW,EAAE,YAAY,IACzB,CAAC;wBACH,sBAAO,MAAM,EAAC;;;wBAIR,YAAY,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;wBAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,uBACZ,UAAU,KACb,OAAO,EAAE,KAAK,EACd,WAAW,EAAE,YAAY,IACzB,CAAC;wBACH,MAAM,OAAK,CAAC;;;;;KAGjB;IAEQ,kCAAI,GAAb,UAAc,MAAc,EAAE,MAAsB;QAApD,iBAYC;QAXC,oGAAoG;QACpG,OAAO,IAAI,OAAO,CAAU,UAAC,OAAO,EAAE,MAAM;YAC1C,IAAM,IAAI,GAAkB;gBAC1B,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;gBAC1B,OAAO,SAAA;gBACP,MAAM,QAAA;aACP,CAAC;YACF,4DAA4D;YAC5D,6CAA6C;YAC7C,KAAK,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IACH,0BAAC;AAAD,CAAC,AAhFD,CAAyC,MAAM,CAAC,SAAS,CAAC,qBAAqB,GAgF9E"}

package/dist/esm/providers/retryProvider.d.ts

@@ -0,0 +1,16 @@
+import { ethers } from "ethers";
+import { CachingMechanismInterface } from "../interfaces";
+import { AugmentedLogger } from "@uma/logger";
+export declare class RetryProvider extends ethers.providers.StaticJsonRpcProvider {
+    readonly nodeQuorumThreshold: number;
+    readonly retries: number;
+    readonly delay: number;
+    readonly maxConcurrency: number;
+    readonly providers: ethers.providers.StaticJsonRpcProvider[];
+    constructor(params: ConstructorParameters<typeof ethers.providers.StaticJsonRpcProvider>[], chainId: number, nodeQuorumThreshold: number, retries: number, delay: number, maxConcurrency: number, providerCacheNamespace: string, pctRpcCallsLogged: number, redisClient?: CachingMechanismInterface, standardTtlBlockDistance?: number, noTtlBlockDistance?: number, providerCacheTtl?: number, logger?: AugmentedLogger);
+    send(method: string, params: Array<unknown>): Promise<unknown>;
+    _validateResponse(method: string, _: Array<unknown>, response: unknown): boolean;
+    _sendAndValidate(provider: ethers.providers.StaticJsonRpcProvider, method: string, params: Array<unknown>): Promise<unknown>;
+    _trySend(provider: ethers.providers.StaticJsonRpcProvider, method: string, params: Array<unknown>): Promise<unknown>;
+    _getQuorum(method: string, params: Array<unknown>): number;
+}