essential-eth 0.9.0 → 0.9.1-next.0

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

@@ -1,14 +1,3 @@
-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);
@@ -23,7 +12,7 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
         Promise.resolve(value).then(_next, _throw);
     }
 }
-function _asyncToGenerator(fn) {
+function _async_to_generator(fn) {
     return function() {
         var self = this, args = arguments;
         return new Promise(function(resolve, reject) {
@@ -38,54 +27,59 @@ function _asyncToGenerator(fn) {
         });
     };
 }
-function _iterableToArray(iter) {
-    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
 }
-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;
+function _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
         }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
     }
-    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.");
+    return target;
 }
-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 ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
 }
-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);
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
 }
-var __generator = this && this.__generator || function(thisArg, body) {
+function _ts_generator(thisArg, body) {
     var f, y, t, g, _ = {
         label: 0,
         sent: function() {
@@ -179,199 +173,136 @@ var __generator = this && this.__generator || function(thisArg, body) {
             done: true
         };
     }
+}
+import * as unfetch from "isomorphic-unfetch";
+import { JsonRpcProvider, tinyBig, toChecksumAddress } from "../../..";
+import { buildFetchInit, buildRPCPostBody } from "../../../classes/utils/fetchers";
+import { hexToDecimal } from "../../../classes/utils/hex-to-decimal";
+import { mockOf } from "../mock-of";
+import { rpcUrls } from "../rpc-urls";
+jest.mock("isomorphic-unfetch");
+var rpcUrl = rpcUrls.mainnet;
+var provider = new JsonRpcProvider(rpcUrl);
+var mockBlockResponse = {
+    number: "0x1b4",
+    hash: "0x5f6fb043528e9892679bce31e9e4a9c5773b3b1ebad1dc4c533ed6fe75ebe13d",
+    parentHash: "0x4e61f7d8fc6253a08d0762dbb2d3d5f4a7e0a2394a2d29c4bbe7056aa13d48e8",
+    nonce: "0xe04d296d2460cfb8472af2c5fd05b5a214109c25688d3704aed5484f9a7792f2",
+    sha3Uncles: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
+    logsBloom: "0x056e68544253...",
+    transactionsRoot: "0x9156485c5d...",
+    stateRoot: "0x2f8bde4d1b...",
+    miner: "0x4e65fda2159562a496f9f3522f89122a3088497a",
+    difficulty: "0x027f07",
+    totalDifficulty: "0x027f07",
+    extraData: "0x000000000000...",
+    size: "0x027f07",
+    gasLimit: "0x9f759",
+    gasUsed: "0x9f759",
+    timestamp: "0x54e34e8e",
+    transactions: [],
+    uncles: []
 };
-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);
+var mockRpcBlockResponse = JSON.stringify({
+    jsonrpc: "2.0",
+    id: 1,
+    result: mockBlockResponse
+});
+var mockBlock = _object_spread_props(_object_spread({}, mockBlockResponse), {
+    number: Number(hexToDecimal(mockBlockResponse.number)),
+    miner: toChecksumAddress(mockBlockResponse.miner),
+    totalDifficulty: tinyBig(mockBlockResponse.totalDifficulty),
+    difficulty: tinyBig(mockBlockResponse.difficulty),
+    gasLimit: tinyBig(mockBlockResponse.gasLimit),
+    gasUsed: tinyBig(mockBlockResponse.gasUsed),
+    size: tinyBig(mockBlockResponse.size),
+    timestamp: tinyBig(mockBlockResponse.timestamp)
+});
+function runTest(method, params, responseIdentifier) {
+    return _runTest.apply(this, arguments);
 }
-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) {
+function _runTest() {
+    _runTest = _async_to_generator(function(method, params, responseIdentifier) {
+        var spy, result;
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
+                    jest.clearAllMocks();
+                    mockOf(unfetch.default).mockResolvedValueOnce({
+                        text: function() {
+                            return Promise.resolve(mockRpcBlockResponse);
+                        }
+                    });
+                    spy = jest.spyOn(unfetch, "default");
                     return [
                         4,
-                        Promise.all([
-                            essentialEthProvider.getBlock("latest"),
-                            web3Provider.eth.getBlock("latest")
-                        ])
+                        provider.getBlock(responseIdentifier)
                     ];
                 case 1:
-                    _ref = _slicedToArray.apply(void 0, [
-                        _state.sent(),
-                        2
-                    ]), eeLatestBlock = _ref[0], web3LatestBlock = _ref[1];
-                    testBlockEquality(eeLatestBlock, web3LatestBlock);
+                    result = _state.sent();
+                    expect(spy).toHaveBeenCalledWith(rpcUrl, buildFetchInit(buildRPCPostBody(method, params)));
+                    expect(JSON.stringify(result)).toBe(JSON.stringify(mockBlock));
                     return [
                         2
                     ];
             }
         });
-    }));
-    it("should match ethers.js -- earliest", /*#__PURE__*/ _asyncToGenerator(function() {
-        var _ref, eeEarliestBlock, ethersEarliestBlock;
-        return __generator(this, function(_state) {
+    });
+    return _runTest.apply(this, arguments);
+}
+describe("provider.getBlock", function() {
+    it("should match mocked -- latest", /*#__PURE__*/ _async_to_generator(function() {
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
                     return [
                         4,
-                        Promise.all([
-                            essentialEthProvider.getBlock("earliest"),
-                            ethersProvider.getBlock("earliest")
-                        ])
+                        runTest("eth_getBlockByNumber", [
+                            "latest",
+                            false
+                        ], "latest")
                     ];
                 case 1:
-                    _ref = _slicedToArray.apply(void 0, [
-                        _state.sent(),
-                        2
-                    ]), eeEarliestBlock = _ref[0], ethersEarliestBlock = _ref[1];
-                    testBlockEquality(eeEarliestBlock, ethersEarliestBlock);
+                    _state.sent();
                     return [
                         2
                     ];
             }
         });
     }));
-    it("should match web3.js -- earliest", /*#__PURE__*/ _asyncToGenerator(function() {
-        var _ref, eeEarliestBlock, web3EarliestBlock;
-        return __generator(this, function(_state) {
+    it("should match mocked block -- earliest", /*#__PURE__*/ _async_to_generator(function() {
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
                     return [
                         4,
-                        Promise.all([
-                            essentialEthProvider.getBlock("earliest"),
-                            web3Provider.eth.getBlock("earliest")
-                        ])
+                        runTest("eth_getBlockByNumber", [
+                            "earliest",
+                            false
+                        ], "earliest")
                     ];
                 case 1:
-                    _ref = _slicedToArray.apply(void 0, [
-                        _state.sent(),
-                        2
-                    ]), eeEarliestBlock = _ref[0], web3EarliestBlock = _ref[1];
-                    testBlockEquality(eeEarliestBlock, web3EarliestBlock);
+                    _state.sent();
                     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) {
+    var blockNumber = 1000000; // a certain block number for testing
+    it("should match mocked block -- specific block number as decimal integer. (block #".concat(blockNumber, ")"), /*#__PURE__*/ _async_to_generator(function() {
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
                     return [
                         4,
-                        Promise.all([
-                            essentialEthProvider.getBlock(blockNumber),
-                            ethersProvider.getBlock(blockNumber)
-                        ])
+                        runTest("eth_getBlockByNumber", [
+                            tinyBig(blockNumber).toHexString(),
+                            false
+                        ], blockNumber)
                     ];
                 case 1:
-                    _ref = _slicedToArray.apply(void 0, [
-                        _state.sent(),
-                        2
-                    ]), eeRandomBlock = _ref[0], ethersRandomBlock = _ref[1];
-                    testBlockEquality(eeRandomBlock, ethersRandomBlock);
+                    _state.sent();
                     return [
                         2
                     ];
@@ -379,99 +310,105 @@ describe("provider.getBlock", function() {
         });
     }));
     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) {
+    it("should match mocked block -- block by hash. (hash = ".concat(blockHash, ")"), /*#__PURE__*/ _async_to_generator(function() {
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
                     return [
                         4,
-                        Promise.all([
-                            essentialEthProvider.getBlock(blockHash),
-                            ethersProvider.getBlock(blockHash)
-                        ])
+                        runTest("eth_getBlockByHash", [
+                            blockHash,
+                            false
+                        ], blockHash)
                     ];
                 case 1:
-                    _ref = _slicedToArray.apply(void 0, [
-                        _state.sent(),
-                        2
-                    ]), eeBlockByHash = _ref[0], ethersBlockByHash = _ref[1];
-                    testBlockEquality(eeBlockByHash, ethersBlockByHash);
+                    _state.sent();
                     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) {
+});
+describe("provider.getBlock error handling", function() {
+    it("should handle empty 200 http response", /*#__PURE__*/ _async_to_generator(function() {
+        var spy;
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
+                    mockOf(unfetch.default).mockResolvedValueOnce({
+                        text: function() {
+                            return Promise.resolve("200 OK");
+                        }
+                    });
+                    spy = jest.spyOn(unfetch, "default");
                     return [
                         4,
-                        Promise.all([
-                            essentialEthProvider.getBlock(blockHash),
-                            web3Provider.eth.getBlock(blockHash)
-                        ])
+                        provider.getBlock("earliest").catch(function() {
+                            var _ref = _async_to_generator(function(error) {
+                                return _ts_generator(this, function(_state) {
+                                    // error message is Invalid JSON RPC response: "200 OK"
+                                    expect('Invalid JSON RPC response: "200 OK"').toBe(error.message);
+                                    return [
+                                        2
+                                    ];
+                                });
+                            });
+                            return function(error) {
+                                return _ref.apply(this, arguments);
+                            };
+                        }())
                     ];
                 case 1:
-                    _ref = _slicedToArray.apply(void 0, [
-                        _state.sent(),
-                        2
-                    ]), eeBlockByHash = _ref[0], web3BlockByHash = _ref[1];
-                    testBlockEquality(eeBlockByHash, web3BlockByHash);
+                    _state.sent();
+                    expect(spy).toHaveBeenCalledWith(rpcUrl, buildFetchInit(buildRPCPostBody("eth_getBlockByNumber", [
+                        "earliest",
+                        false
+                    ])));
                     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) {
+    it("should handle empty JSON object", /*#__PURE__*/ _async_to_generator(function() {
+        var spy;
+        return _ts_generator(this, function(_state) {
             switch(_state.label){
                 case 0:
-                    expect.assertions(1);
-                    essentialEth = new JsonRpcProvider(fakeUrls.notRPCButRealHttp);
+                    mockOf(unfetch.default).mockResolvedValueOnce({
+                        text: function() {
+                            return Promise.resolve("{}");
+                        }
+                    });
+                    spy = jest.spyOn(unfetch, "default");
                     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);
+                        provider.getBlock("earliest").catch(function() {
+                            var _ref = _async_to_generator(function(error) {
+                                return _ts_generator(this, function(_state) {
+                                    // error message is Invalid JSON RPC response: {}
+                                    expect(error.message).toBe("Invalid JSON RPC response: {}");
                                     return [
                                         2
                                     ];
                                 });
                             });
-                            return function(essentialEthError) {
+                            return function(error) {
                                 return _ref.apply(this, arguments);
                             };
                         }())
                     ];
                 case 1:
                     _state.sent();
+                    expect(spy).toHaveBeenCalledWith(rpcUrl, buildFetchInit(buildRPCPostBody("eth_getBlockByNumber", [
+                        "earliest",
+                        false
+                    ])));
                     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);
-//     });
-//   });
-// });
 });