@railgun-community/shared-models 4.1.1 → 4.1.2

package/dist/utils/available-rpc.d.ts

@@ -0,0 +1,8 @@
+import { ProviderJson } from './fallback-provider';
+declare type LogError = (err: string) => void;
+/**
+ * Health checks ProviderJson inputs, and returns an array of available RPC providers.
+ * Available means that they respond to getBlockNumber(), and they are +/- 100 blocks from the median.
+ */
+export declare const getAvailableProviderJSONs: (providerJsons: ProviderJson[], logError: LogError) => Promise<ProviderJson[]>;
+export {};

package/dist/utils/available-rpc.js

@@ -0,0 +1,106 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.getAvailableProviderJSONs = void 0;
+var providers_1 = require("@ethersproject/providers");
+var median_1 = require("./median");
+var promises_1 = require("./promises");
+var BLOCK_NUMBER_TIMEOUT_MS = 1500;
+/**
+ * Health checks ProviderJson inputs, and returns an array of available RPC providers.
+ * Available means that they respond to getBlockNumber(), and they are +/- 100 blocks from the median.
+ */
+var getAvailableProviderJSONs = function (providerJsons, logError) { return __awaiter(void 0, void 0, void 0, function () {
+    var blockNumbers, nonZeroBlockNumbers, medianBlockNumber, lowerBoundRange, upperBoundRange;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, Promise.all(providerJsons.map(function (providerJson) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, getBlockNumber(providerJson.provider, logError)];
+                        case 1: return [2 /*return*/, _a.sent()];
+                    }
+                }); }); }))];
+            case 1:
+                blockNumbers = _a.sent();
+                nonZeroBlockNumbers = blockNumbers.filter(function (blockNumber) { return blockNumber > 0; });
+                medianBlockNumber = (0, median_1.getUpperBoundMedian)(nonZeroBlockNumbers);
+                lowerBoundRange = medianBlockNumber - 100;
+                upperBoundRange = medianBlockNumber + 100;
+                return [2 /*return*/, providerJsons.filter(function (providerJson, index) {
+                        var blockNumber = blockNumbers[index];
+                        if (blockNumber === 0) {
+                            logError("RPC Health Check failed for ".concat(providerJson.provider, ": No Block Number"));
+                            return false;
+                        }
+                        if (blockNumber < lowerBoundRange) {
+                            logError("RPC Health Check failed for ".concat(providerJson.provider, ": Block Number -").concat(medianBlockNumber - blockNumber, " from median"));
+                            return false;
+                        }
+                        if (blockNumber > upperBoundRange) {
+                            logError("RPC Health Check failed for ".concat(providerJson.provider, ": Block Number +").concat(blockNumber - medianBlockNumber, " from median"));
+                            return false;
+                        }
+                        return true;
+                    })];
+        }
+    });
+}); };
+exports.getAvailableProviderJSONs = getAvailableProviderJSONs;
+var getBlockNumber = function (provider, logError) { return __awaiter(void 0, void 0, void 0, function () {
+    var rpcProvider, blockNumber, err_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 2, , 3]);
+                rpcProvider = new providers_1.JsonRpcProvider(provider);
+                return [4 /*yield*/, (0, promises_1.promiseTimeout)(rpcProvider.getBlockNumber(), BLOCK_NUMBER_TIMEOUT_MS)];
+            case 1:
+                blockNumber = _a.sent();
+                return [2 /*return*/, blockNumber];
+            case 2:
+                err_1 = _a.sent();
+                if (!(err_1 instanceof Error)) {
+                    throw err_1;
+                }
+                logError(err_1.message);
+                return [2 /*return*/, 0];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+//# sourceMappingURL=available-rpc.js.map

package/dist/utils/available-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"available-rpc.js","sourceRoot":"","sources":["../../src/utils/available-rpc.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAA2D;AAE3D,mCAA+C;AAC/C,uCAA4C;AAI5C,IAAM,uBAAuB,GAAG,IAAI,CAAC;AAErC;;;GAGG;AACI,IAAM,yBAAyB,GAAG,UACvC,aAA6B,EAC7B,QAAkB;;;;oBAEa,qBAAM,OAAO,CAAC,GAAG,CAC9C,aAAa,CAAC,GAAG,CACf,UAAM,YAAY;;gCAChB,qBAAM,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAA;gCAArD,sBAAA,SAAqD,EAAA;;yBAAA,CACxD,CACF,EAAA;;gBALK,YAAY,GAAa,SAK9B;gBAEK,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAC7C,UAAA,WAAW,IAAI,OAAA,WAAW,GAAG,CAAC,EAAf,CAAe,CAC/B,CAAC;gBACI,iBAAiB,GAAG,IAAA,4BAAmB,EAAC,mBAAmB,CAAC,CAAC;gBAC7D,eAAe,GAAG,iBAAiB,GAAG,GAAG,CAAC;gBAC1C,eAAe,GAAG,iBAAiB,GAAG,GAAG,CAAC;gBAEhD,sBAAO,aAAa,CAAC,MAAM,CAAC,UAAC,YAAY,EAAE,KAAK;wBAC9C,IAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;wBACxC,IAAI,WAAW,KAAK,CAAC,EAAE;4BACrB,QAAQ,CACN,sCAA+B,YAAY,CAAC,QAAQ,sBAAmB,CACxE,CAAC;4BACF,OAAO,KAAK,CAAC;yBACd;wBACD,IAAI,WAAW,GAAG,eAAe,EAAE;4BACjC,QAAQ,CACN,sCAA+B,YAAY,CAAC,QAAQ,6BAClD,iBAAiB,GAAG,WAAW,iBACnB,CACf,CAAC;4BACF,OAAO,KAAK,CAAC;yBACd;wBACD,IAAI,WAAW,GAAG,eAAe,EAAE;4BACjC,QAAQ,CACN,sCAA+B,YAAY,CAAC,QAAQ,6BAClD,WAAW,GAAG,iBAAiB,iBACnB,CACf,CAAC;4BACF,OAAO,KAAK,CAAC;yBACd;wBACD,OAAO,IAAI,CAAC;oBACd,CAAC,CAAC,EAAC;;;KACJ,CAAC;AA5CW,QAAA,yBAAyB,6BA4CpC;AAEF,IAAM,cAAc,GAAG,UACrB,QAAgB,EAChB,QAAkB;;;;;;gBAGV,WAAW,GAAG,IAAI,2BAAe,CAAC,QAAQ,CAAC,CAAC;gBAC9B,qBAAM,IAAA,yBAAc,EACtC,WAAW,CAAC,cAAc,EAAE,EAC5B,uBAAuB,CACxB,EAAA;;gBAHK,WAAW,GAAG,SAGnB;gBACD,sBAAO,WAAW,EAAC;;;gBAEnB,IAAI,CAAC,CAAC,KAAG,YAAY,KAAK,CAAC,EAAE;oBAC3B,MAAM,KAAG,CAAC;iBACX;gBACD,QAAQ,CAAC,KAAG,CAAC,OAAO,CAAC,CAAC;gBACtB,sBAAO,CAAC,EAAC;;;;KAEZ,CAAC","sourcesContent":["import { JsonRpcProvider } from '@ethersproject/providers';\nimport { ProviderJson } from './fallback-provider';\nimport { getUpperBoundMedian } from './median';\nimport { promiseTimeout } from './promises';\n\ntype LogError = (err: string) => void;\n\nconst BLOCK_NUMBER_TIMEOUT_MS = 1500;\n\n/**\n * Health checks ProviderJson inputs, and returns an array of available RPC providers.\n * Available means that they respond to getBlockNumber(), and they are +/- 100 blocks from the median.\n */\nexport const getAvailableProviderJSONs = async (\n  providerJsons: ProviderJson[],\n  logError: LogError,\n): Promise<ProviderJson[]> => {\n  const blockNumbers: number[] = await Promise.all(\n    providerJsons.map(\n      async providerJson =>\n        await getBlockNumber(providerJson.provider, logError),\n    ),\n  );\n\n  const nonZeroBlockNumbers = blockNumbers.filter(\n    blockNumber => blockNumber > 0,\n  );\n  const medianBlockNumber = getUpperBoundMedian(nonZeroBlockNumbers);\n  const lowerBoundRange = medianBlockNumber - 100;\n  const upperBoundRange = medianBlockNumber + 100;\n\n  return providerJsons.filter((providerJson, index) => {\n    const blockNumber = blockNumbers[index];\n    if (blockNumber === 0) {\n      logError(\n        `RPC Health Check failed for ${providerJson.provider}: No Block Number`,\n      );\n      return false;\n    }\n    if (blockNumber < lowerBoundRange) {\n      logError(\n        `RPC Health Check failed for ${providerJson.provider}: Block Number -${\n          medianBlockNumber - blockNumber\n        } from median`,\n      );\n      return false;\n    }\n    if (blockNumber > upperBoundRange) {\n      logError(\n        `RPC Health Check failed for ${providerJson.provider}: Block Number +${\n          blockNumber - medianBlockNumber\n        } from median`,\n      );\n      return false;\n    }\n    return true;\n  });\n};\n\nconst getBlockNumber = async (\n  provider: string,\n  logError: LogError,\n): Promise<number> => {\n  try {\n    const rpcProvider = new JsonRpcProvider(provider);\n    const blockNumber = await promiseTimeout(\n      rpcProvider.getBlockNumber(),\n      BLOCK_NUMBER_TIMEOUT_MS,\n    );\n    return blockNumber;\n  } catch (err) {\n    if (!(err instanceof Error)) {\n      throw err;\n    }\n    logError(err.message);\n    return 0;\n  }\n};\n"]}

package/dist/utils/median.d.ts

@@ -0,0 +1 @@
+export declare const getUpperBoundMedian: (numbers: number[]) => number;

package/dist/utils/median.js

@@ -0,0 +1,13 @@
+"use strict";
+exports.__esModule = true;
+exports.getUpperBoundMedian = void 0;
+var getUpperBoundMedian = function (numbers) {
+    if (!numbers.length) {
+        return 0;
+    }
+    var index = Math.floor(numbers.length / 2);
+    var sorted = numbers.sort();
+    return sorted[index];
+};
+exports.getUpperBoundMedian = getUpperBoundMedian;
+//# sourceMappingURL=median.js.map

package/dist/utils/median.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"median.js","sourceRoot":"","sources":["../../src/utils/median.ts"],"names":[],"mappings":";;;AAAO,IAAM,mBAAmB,GAAG,UAAC,OAAiB;IACnD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,CAAC,CAAC;KACV;IACD,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7C,IAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC,CAAC;AAPW,QAAA,mBAAmB,uBAO9B","sourcesContent":["export const getUpperBoundMedian = (numbers: number[]) => {\n  if (!numbers.length) {\n    return 0;\n  }\n  const index = Math.floor(numbers.length / 2);\n  const sorted = numbers.sort();\n  return sorted[index];\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@railgun-community/shared-models",
-  "version": "4.1.1",
+  "version": "4.1.2",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [