essential-eth 0.6.2 → 0.8.0

package/dist/cjs/providers/test/json-rpc-provider/get-block.test.js

@@ -0,0 +1,501 @@
+function _arrayLikeToArray(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _arrayWithHoles(arr) {
+    if (Array.isArray(arr)) return arr;
+}
+function _arrayWithoutHoles(arr) {
+    if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+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);
+        });
+    };
+}
+function _iterableToArray(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+function _iterableToArrayLimit(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+    var _s, _e;
+    try {
+        for(_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true){
+            _arr.push(_s.value);
+            if (i && _arr.length === i) break;
+        }
+    } catch (err) {
+        _d = true;
+        _e = err;
+    } finally{
+        try {
+            if (!_n && _i["return"] != null) _i["return"]();
+        } finally{
+            if (_d) throw _e;
+        }
+    }
+    return _arr;
+}
+function _nonIterableRest() {
+    throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _nonIterableSpread() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _slicedToArray(arr, i) {
+    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+function _toConsumableArray(arr) {
+    return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+function _unsupportedIterableToArray(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+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 { ethers } from "ethers";
+import omit from "just-omit";
+import Web3 from "web3";
+import { JsonRpcProvider } from "../../..";
+import { fakeUrls } from "./../rpc-urls";
+// RSK has 30 second block times so tests pass more often
+var rpcUrl = "https://public-node.rsk.co";
+function testBlockEquality(eeBlock, otherBlock) {
+    var typeCheckKeys = [
+        "difficulty",
+        "gasLimit",
+        "gasUsed",
+        "number",
+        "timestamp"
+    ];
+    var omittableEE = [];
+    var omittableOther = [];
+    if (typeof otherBlock.gasLimit === "number") {
+        // web3.js returns gasLimit as number, ethers returns as BigNum
+        if (eeBlock.transactions && typeof eeBlock.transactions[0] !== "string") {
+            eeBlock.transactions.forEach(function(transaction) {
+                if (transaction.gas) transaction.gas = transaction.gas.toString();
+                if (transaction.value) transaction.value = transaction.value.toString();
+                if (transaction.gasPrice) transaction.gasPrice = transaction.gasPrice.toString();
+                if (transaction.nonce) transaction.nonce = transaction.nonce.toString();
+                if (transaction.v) transaction.v = "0x".concat(transaction.v.toString(16));
+            });
+            otherBlock.transactions.forEach(function(transaction) {
+                if (transaction.gas) transaction.gas = transaction.gas.toString();
+                else if (transaction.gas == 0) transaction.gas = "0"; // won't go to string when zero??
+                if (transaction.nonce) transaction.nonce = transaction.nonce.toString();
+            });
+        }
+        typeCheckKeys.push("totalDifficulty", "size");
+        omittableEE = typeCheckKeys;
+        omittableOther = typeCheckKeys;
+        typeCheckKeys.forEach(function(key) {
+            expect(eeBlock[key].toString()).toBe(otherBlock[key].toString());
+        });
+    } else {
+        // rename _difficulty to difficulty
+        delete otherBlock.difficulty;
+        otherBlock.difficulty = otherBlock._difficulty;
+        delete otherBlock._difficulty;
+        omittableEE = // ethers.js doesn't return all these values that essential-eth does, some specific to RSK node
+        _toConsumableArray(typeCheckKeys).concat([
+            "bitcoinMergedMiningCoinbaseTransaction",
+            "bitcoinMergedMiningCoinbaseTransaction",
+            "bitcoinMergedMiningHeader",
+            "bitcoinMergedMiningHeader",
+            "bitcoinMergedMiningMerkleProof",
+            "cumulativeDifficulty",
+            "hashForMergedMining",
+            "logsBloom",
+            "minimumGasPrice",
+            "paidFees",
+            "receiptsRoot",
+            "sha3Uncles",
+            "size",
+            "stateRoot",
+            "totalDifficulty",
+            "transactionsRoot",
+            "uncles"
+        ]);
+        omittableOther = _toConsumableArray(typeCheckKeys);
+    }
+    typeCheckKeys.forEach(function(key) {
+        expect(eeBlock[key].toString()).toBe(otherBlock[key].toString());
+    });
+    var omittedEEBlock = omit(eeBlock, omittableEE);
+    var omittedOtherBlock = omit(otherBlock, omittableOther);
+    expect(omittedEEBlock).toMatchObject(omittedOtherBlock);
+}
+describe("provider.getBlock", function() {
+    var essentialEthProvider = new JsonRpcProvider(rpcUrl);
+    var web3Provider = new Web3(rpcUrl);
+    var ethersProvider = new ethers.providers.StaticJsonRpcProvider(rpcUrl);
+    it("should match ethers.js -- latest", /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeLatestBlock, ethersLatestBlock;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock("latest"),
+                            ethersProvider.getBlock("latest")
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeLatestBlock = _ref[0], ethersLatestBlock = _ref[1];
+                    testBlockEquality(eeLatestBlock, ethersLatestBlock);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should match web3.js -- latest", /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeLatestBlock, web3LatestBlock;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock("latest"),
+                            web3Provider.eth.getBlock("latest")
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeLatestBlock = _ref[0], web3LatestBlock = _ref[1];
+                    testBlockEquality(eeLatestBlock, web3LatestBlock);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should match ethers.js -- earliest", /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeEarliestBlock, ethersEarliestBlock;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock("earliest"),
+                            ethersProvider.getBlock("earliest")
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeEarliestBlock = _ref[0], ethersEarliestBlock = _ref[1];
+                    testBlockEquality(eeEarliestBlock, ethersEarliestBlock);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should match web3.js -- earliest", /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeEarliestBlock, web3EarliestBlock;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock("earliest"),
+                            web3Provider.eth.getBlock("earliest")
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeEarliestBlock = _ref[0], web3EarliestBlock = _ref[1];
+                    testBlockEquality(eeEarliestBlock, web3EarliestBlock);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    var blockNumber = Math.floor(Math.random() * 4202460 /* latest block */ );
+    it("should match ethers.js -- random block as decimal integer. (block #".concat(blockNumber, ")"), /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeRandomBlock, ethersRandomBlock;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock(blockNumber),
+                            ethersProvider.getBlock(blockNumber)
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeRandomBlock = _ref[0], ethersRandomBlock = _ref[1];
+                    testBlockEquality(eeRandomBlock, ethersRandomBlock);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should match web3.js -- random block as decimal integer & transactions. (block #".concat(blockNumber, ")"), /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeRandomBlock, web3RandomBlock;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock(blockNumber, true),
+                            web3Provider.eth.getBlock(blockNumber, true)
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeRandomBlock = _ref[0], web3RandomBlock = _ref[1];
+                    testBlockEquality(eeRandomBlock, web3RandomBlock);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    var blockHash = "0x4cbaa942e48a91108f38e2a250f6dbaff7fffe3027f5ebf76701929eed2b2970"; // Hash corresponds to block on RSK Mainnet
+    it("should match ethers.js -- block by hash. (hash = ".concat(blockHash, ")"), /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeBlockByHash, ethersBlockByHash;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock(blockHash),
+                            ethersProvider.getBlock(blockHash)
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeBlockByHash = _ref[0], ethersBlockByHash = _ref[1];
+                    testBlockEquality(eeBlockByHash, ethersBlockByHash);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+    it("should match web3.js -- block by hash. (hash = ".concat(blockHash, ")"), /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, eeBlockByHash, web3BlockByHash;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            essentialEthProvider.getBlock(blockHash),
+                            web3Provider.eth.getBlock(blockHash)
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), eeBlockByHash = _ref[0], web3BlockByHash = _ref[1];
+                    testBlockEquality(eeBlockByHash, web3BlockByHash);
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+});
+describe("provider.getBlock error handling", function() {
+    it("should handle empty 200 http response", /*#__PURE__*/ _asyncToGenerator(function() {
+        var essentialEth;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    expect.assertions(1);
+                    essentialEth = new JsonRpcProvider(fakeUrls.notRPCButRealHttp);
+                    return [
+                        4,
+                        essentialEth.getBlock("earliest").catch(function() {
+                            var _ref = _asyncToGenerator(function(essentialEthError) {
+                                return __generator(this, function(_state) {
+                                    // error message is Invalid JSON RPC response: "200 OK"
+                                    expect('Invalid JSON RPC response: "200 OK"').toBe(essentialEthError.message);
+                                    return [
+                                        2
+                                    ];
+                                });
+                            });
+                            return function(essentialEthError) {
+                                return _ref.apply(this, arguments);
+                            };
+                        }())
+                    ];
+                case 1:
+                    _state.sent();
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+// TODO: Make a mock http endpoint which returns an empty json object
+// it.only('should handle json emptry object 200 http response', async () => {
+//   expect.assertions(1);
+//   const essentialEth = new JsonRpcProvider('http://localhost:51196/b.json');
+//   const web3 = new Web3('http://localhost:51196/b.json');
+//   await essentialEth.getBlock('earliest').catch(async (essentialEthError) => {
+//     await web3.eth.getBlock('earliest').catch((web3Error) => {
+//       console.log({ w3: web3Error.message, ee: essentialEthError.message });
+//       // error message is Invalid JSON RPC response: "200 OK"
+//       expect(web3Error.message).toBe(essentialEthError.message);
+//     });
+//   });
+// });
+});