essential-eth 0.6.1 → 0.7.0

package/dist/cjs/providers/FallthroughProvider.js

@@ -1,50 +1,130 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FallthroughProvider = void 0;
-const logger_1 = require("../logger/logger");
-const BaseProvider_1 = require("./BaseProvider");
+function _assertThisInitialized(self) {
+    if (self === void 0) {
+        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
+    }
+    return self;
+}
+function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+function _getPrototypeOf(o) {
+    _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
+        return o.__proto__ || Object.getPrototypeOf(o);
+    };
+    return _getPrototypeOf(o);
+}
+function _inherits(subClass, superClass) {
+    if (typeof superClass !== "function" && superClass !== null) {
+        throw new TypeError("Super expression must either be null or a function");
+    }
+    subClass.prototype = Object.create(superClass && superClass.prototype, {
+        constructor: {
+            value: subClass,
+            writable: true,
+            configurable: true
+        }
+    });
+    if (superClass) _setPrototypeOf(subClass, superClass);
+}
+function _possibleConstructorReturn(self, call) {
+    if (call && (_typeof(call) === "object" || typeof call === "function")) {
+        return call;
+    }
+    return _assertThisInitialized(self);
+}
+function _setPrototypeOf(o, p) {
+    _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+        o.__proto__ = p;
+        return o;
+    };
+    return _setPrototypeOf(o, p);
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+function _isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _createSuper(Derived) {
+    var hasNativeReflectConstruct = _isNativeReflectConstruct();
+    return function _createSuperInternal() {
+        var Super = _getPrototypeOf(Derived), result;
+        if (hasNativeReflectConstruct) {
+            var NewTarget = _getPrototypeOf(this).constructor;
+            result = Reflect.construct(Super, arguments, NewTarget);
+        } else {
+            result = Super.apply(this, arguments);
+        }
+        return _possibleConstructorReturn(this, result);
+    };
+}
+import { logger } from "../logger/logger";
+import { BaseProvider } from "./BaseProvider";
 // https://advancedweb.hu/how-to-add-timeout-to-a-promise-in-javascript/
-const promiseTimeout = (prom, time) => Promise.race([
-    prom,
-    new Promise((_r, reject) => setTimeout(() => reject('Promise timed out'), time)),
-]);
-const DEFAULT_TIMEOUT_DURATION = 8000;
+var promiseTimeout = function(prom, time) {
+    return Promise.race([
+        prom,
+        new Promise(function(_r, reject) {
+            return setTimeout(function() {
+                return reject("Promise timed out");
+            }, time);
+        })
+    ]);
+};
+var DEFAULT_TIMEOUT_DURATION = 8000;
 /**
  * @beta
  * A JSON RPC Provider which moves to the next URL when one fails.
- */
-class FallthroughProvider extends BaseProvider_1.BaseProvider {
-    constructor(rpcUrls, options = {}) {
+ */ export var FallthroughProvider = /*#__PURE__*/ function(BaseProvider) {
+    "use strict";
+    _inherits(FallthroughProvider, BaseProvider);
+    var _super = _createSuper(FallthroughProvider);
+    function FallthroughProvider(rpcUrls) {
+        var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+        _classCallCheck(this, FallthroughProvider);
+        var _this;
         if (!Array.isArray(rpcUrls)) {
-            logger_1.logger.throwError('Array required', { rpcUrls });
+            logger.throwError("Array required", {
+                rpcUrls: rpcUrls
+            });
         }
         if (rpcUrls.length <= 1) {
-            logger_1.logger.throwError('More than one rpcUrl is required', { rpcUrls });
+            logger.throwError("More than one rpcUrl is required", {
+                rpcUrls: rpcUrls
+            });
         }
-        super(rpcUrls);
+        _this = _super.call(this, rpcUrls);
         // index of current trusted rpc url
         /**
-         * @ignore
-         */
-        this.rpcUrlCounter = 0;
+   * @ignore
+   */ _this.rpcUrlCounter = 0;
         /**
-         * @ignore
-         */
-        this.post = (body) => {
+   * @ignore
+   */ _this.post = function(body) {
             // while failing post, add to rpcUrlCounter and post again
-            const genesisCount = this.rpcUrlCounter;
-            const recursivePostRetry = () => {
+            var genesisCount = _this.rpcUrlCounter;
+            var recursivePostRetry = function() {
                 // Times out request
-                const genesisRpcUrl = this.selectRpcUrl();
-                const res = promiseTimeout(this._post(body), this.timeoutDuration).catch((e) => {
+                var genesisRpcUrl = _this.selectRpcUrl();
+                var res = promiseTimeout(_this._post(body), _this.timeoutDuration).catch(function(e) {
                     // A mutex: Only add if no other instance has discovered this url as failing yet
-                    if (genesisRpcUrl === this.selectRpcUrl()) {
+                    if (genesisRpcUrl === _this.selectRpcUrl()) {
                         // add one and handle array overflow
-                        this.rpcUrlCounter =
-                            (this.rpcUrlCounter + 1) % this._rpcUrls.length;
+                        _this.rpcUrlCounter = (_this.rpcUrlCounter + 1) % _this._rpcUrls.length;
                     }
                     // we've already tried this rpc, throw for good
-                    if (this.rpcUrlCounter === genesisCount) {
+                    if (_this.rpcUrlCounter === genesisCount) {
                         throw e;
                     }
                     return recursivePostRetry();
@@ -53,13 +133,14 @@ class FallthroughProvider extends BaseProvider_1.BaseProvider {
             };
             return recursivePostRetry();
         };
-        this.timeoutDuration = options.timeoutDuration || DEFAULT_TIMEOUT_DURATION;
+        _this.timeoutDuration = options.timeoutDuration || DEFAULT_TIMEOUT_DURATION;
+        return _this;
     }
+    var _proto = FallthroughProvider.prototype;
     /**
-     * @ignore
-     */
-    selectRpcUrl() {
+   * @ignore
+   */ _proto.selectRpcUrl = function selectRpcUrl() {
         return this._rpcUrls[this.rpcUrlCounter];
-    }
-}
-exports.FallthroughProvider = FallthroughProvider;
+    };
+    return FallthroughProvider;
+}(BaseProvider);

package/dist/cjs/providers/JsonRpcProvider.js

@@ -1,32 +1,99 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonRpcProvider = exports.JsonRpcProvider = void 0;
-const BaseProvider_1 = require("./BaseProvider");
-class JsonRpcProvider extends BaseProvider_1.BaseProvider {
-    /**
-     * @ignore
-     */
-    selectRpcUrl() {
-        return this._rpcUrls[0];
+function _assertThisInitialized(self) {
+    if (self === void 0) {
+        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
     }
-    /**
-     * @ignore
-     */
-    post(body) {
-        return this._post(body);
+    return self;
+}
+function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
     }
-    /**
-     * @param rpcUrl The URL to your Eth node. Consider POKT or Infura
-     * @example
-     * `https://free-eth-node.com/api/eth`
-     * @example
-     * `https://mainnet.infura.io/v3/YOUR-PROJECT-ID`
-     */
-    constructor(rpcUrl = 'https://free-eth-node.com/api/eth') {
-        super([rpcUrl]);
+}
+function _getPrototypeOf(o) {
+    _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
+        return o.__proto__ || Object.getPrototypeOf(o);
+    };
+    return _getPrototypeOf(o);
+}
+function _inherits(subClass, superClass) {
+    if (typeof superClass !== "function" && superClass !== null) {
+        throw new TypeError("Super expression must either be null or a function");
+    }
+    subClass.prototype = Object.create(superClass && superClass.prototype, {
+        constructor: {
+            value: subClass,
+            writable: true,
+            configurable: true
+        }
+    });
+    if (superClass) _setPrototypeOf(subClass, superClass);
+}
+function _possibleConstructorReturn(self, call) {
+    if (call && (_typeof(call) === "object" || typeof call === "function")) {
+        return call;
     }
+    return _assertThisInitialized(self);
 }
-exports.JsonRpcProvider = JsonRpcProvider;
+function _setPrototypeOf(o, p) {
+    _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+        o.__proto__ = p;
+        return o;
+    };
+    return _setPrototypeOf(o, p);
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+function _isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _createSuper(Derived) {
+    var hasNativeReflectConstruct = _isNativeReflectConstruct();
+    return function _createSuperInternal() {
+        var Super = _getPrototypeOf(Derived), result;
+        if (hasNativeReflectConstruct) {
+            var NewTarget = _getPrototypeOf(this).constructor;
+            result = Reflect.construct(Super, arguments, NewTarget);
+        } else {
+            result = Super.apply(this, arguments);
+        }
+        return _possibleConstructorReturn(this, result);
+    };
+}
+import { BaseProvider } from "./BaseProvider";
+export var JsonRpcProvider = /*#__PURE__*/ function(BaseProvider) {
+    "use strict";
+    _inherits(JsonRpcProvider, BaseProvider);
+    var _super = _createSuper(JsonRpcProvider);
+    function JsonRpcProvider() {
+        var rpcUrl = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : "https://free-eth-node.com/api/eth";
+        _classCallCheck(this, JsonRpcProvider);
+        return _super.call(this, [
+            rpcUrl
+        ]);
+    }
+    var _proto = JsonRpcProvider.prototype;
+    /**
+   * @ignore
+   */ _proto.selectRpcUrl = function selectRpcUrl() {
+        return this._rpcUrls[0];
+    };
+    /**
+   * @ignore
+   */ _proto.post = function post(body) {
+        return this._post(body);
+    };
+    return JsonRpcProvider;
+}(BaseProvider);
 /**
  * Helper function to avoid "new"
  *
@@ -39,8 +106,6 @@ exports.JsonRpcProvider = JsonRpcProvider;
  * })
  * // 14530496
  * ```
- */
-function jsonRpcProvider(rpcUrl) {
+ */ export function jsonRpcProvider(rpcUrl) {
     return new JsonRpcProvider(rpcUrl);
 }
-exports.jsonRpcProvider = jsonRpcProvider;

package/dist/cjs/providers/test/fallthrough-provider/get-gas-price.test.js

@@ -0,0 +1,228 @@
+// performance polyfill required to support node <= 14
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+var __generator = this && this.__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    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
+        };
+    }
+};
+import { performance } from "perf_hooks";
+import { FallthroughProvider } from "../../../index";
+import { rpcUrls } from "../rpc-urls";
+var rpcUrl = rpcUrls.mainnet;
+function timePromise(fn) {
+    var onPromiseDone = function() {
+        return performance.now() - start;
+    };
+    var start = performance.now();
+    return fn().then(onPromiseDone, onPromiseDone);
+}
+describe("provider.getGasPrice", function() {
+    it("should fallthrough on several types of invalid urls", /*#__PURE__*/ _asyncToGenerator(function() {
+        var essentialEthProvider, block;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    essentialEthProvider = new FallthroughProvider([
+                        "https://bad-123123123123.com",
+                        "https://bad-523123123123.com",
+                        rpcUrl
+                    ]);
+                    return [
+                        4,
+                        essentialEthProvider.getBlock(14631185)
+                    ];
+                case 1:
+                    block = _state.sent();
+                    expect(block.gasUsed.toString()).toBe("2429588");
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should fallthrough after timeout linearly", /*#__PURE__*/ _asyncToGenerator(function() {
+        var essentialEthProvider;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    essentialEthProvider = new FallthroughProvider([
+                        "https://flash-the-slow-api.herokuapp.com/delay/10000",
+                        // url with request delayed by 20 seconds
+                        "https://flash-the-slow-api.herokuapp.com/delay/10000",
+                        "https://bad-523123123123.com",
+                        rpcUrl
+                    ], {
+                        timeoutDuration: 1000
+                    });
+                    return [
+                        4,
+                        timePromise(function() {
+                            return essentialEthProvider.getBlock(14631000);
+                        }).then(function(duration) {
+                            // times out the first two requests in 1200 ms each
+                            // expect(duration).toBeGreaterThan(1200);
+                            // finished the last valid request within two seconds
+                            expect(duration).toBeLessThan(4000);
+                        })
+                    ];
+                case 1:
+                    _state.sent();
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should mutex the current rpc selection properly", /*#__PURE__*/ _asyncToGenerator(function() {
+        var providers, allBlocks;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    providers = [
+                        1,
+                        2,
+                        3
+                    ].map(function() {
+                        return new FallthroughProvider([
+                            "https://flash-sgkl.onrender.com/delay/10000",
+                            rpcUrl
+                        ], {
+                            timeoutDuration: 2500
+                        });
+                    });
+                    return [
+                        4,
+                        Promise.all(providers.map(function(provider) {
+                            return provider.getBlock(123456);
+                        }))
+                    ];
+                case 1:
+                    allBlocks = _state.sent();
+                    allBlocks.forEach(function(blockNumber) {
+                        expect(blockNumber.difficulty.toString()).toBe("4505282870523");
+                    });
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+});