essential-eth 0.7.0 → 0.8.0

package/dist/cjs/logger/package-version.d.ts

@@ -1 +1 @@
-export declare const version = "0.7.0";
+export declare const version = "0.8.0";

package/dist/cjs/logger/package-version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export var version = "0.7.0";
+export var version = "0.8.0";

package/dist/cjs/providers/BaseProvider.d.ts

@@ -1,5 +1,6 @@
 import type { TinyBig } from '../shared/tiny-big/tiny-big';
 import type { BlockResponse, BlockTag } from '../types/Block.types';
+import type { FeeData } from '../types/FeeData.types';
 import type { Filter, FilterByBlockHash } from '../types/Filter.types';
 import type { Network } from '../types/Network.types';
 import type { Log, TransactionReceipt, TransactionRequest, TransactionResponse } from '../types/Transaction.types';
@@ -19,6 +20,7 @@ export declare abstract class BaseProvider {
     getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
     getCode(address: string, blockTag?: BlockTag): Promise<string>;
     estimateGas(transaction: TransactionRequest): Promise<TinyBig>;
+    getFeeData(): Promise<FeeData>;
     getLogs(filter: Filter | FilterByBlockHash): Promise<Array<Log>>;
     call(transaction: TransactionRequest, blockTag?: BlockTag): Promise<string>;
 }

package/dist/cjs/providers/BaseProvider.js

@@ -735,6 +735,65 @@ export var BaseProvider = /*#__PURE__*/ function() {
         })();
     };
     /**
+   * Returns the current recommended FeeData to use in a transaction.
+   * For an EIP-1559 transaction, the maxFeePerGas and maxPriorityFeePerGas should be used.
+   * For legacy transactions and networks which do not support EIP-1559, the gasPrice should be used.Returns an estimate of the amount of gas that would be required to submit transaction to the network.
+   *
+   * * [Identical](/docs/api#isd) to [`ethers.provider.getFeeData`](https://docs.ethers.org/v5/api/providers/provider/#Provider-getFeeData) in ethers.js
+   *
+   * @returns an object with gas estimates for the network currently
+   * @example
+   * ```javascript
+   * await provider.getFeeData();
+   * // {
+   * //   gasPrice: { TinyBig: "14184772639" },
+   * //   lastBaseFeePerGas: { TinyBig: "14038523098" },
+   * //   maxFeePerGas: { TinyBig: "29577046196" },
+   * //   maxPriorityFeePerGas: { TinyBig: "1500000000" }
+   * // }
+   * ```
+   */ _proto.getFeeData = function getFeeData() {
+        var _this = this;
+        return _asyncToGenerator(function() {
+            var _ref, block, gasPrice, lastBaseFeePerGas, maxFeePerGas, maxPriorityFeePerGas;
+            return __generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        return [
+                            4,
+                            Promise.all([
+                                _this.getBlock("latest"),
+                                _this.getGasPrice()
+                            ])
+                        ];
+                    case 1:
+                        _ref = _slicedToArray.apply(void 0, [
+                            _state.sent(),
+                            2
+                        ]), block = _ref[0], gasPrice = _ref[1];
+                        lastBaseFeePerGas = null, maxFeePerGas = null, maxPriorityFeePerGas = null;
+                        if (block && block.baseFeePerGas) {
+                            // We may want to compute this more accurately in the future,
+                            // using the formula "check if the base fee is correct".
+                            // See: https://eips.ethereum.org/EIPS/eip-1559
+                            lastBaseFeePerGas = block.baseFeePerGas;
+                            maxPriorityFeePerGas = tinyBig("1500000000");
+                            maxFeePerGas = tinyBig(block.baseFeePerGas.mul(2).add(maxPriorityFeePerGas));
+                        }
+                        return [
+                            2,
+                            {
+                                lastBaseFeePerGas: lastBaseFeePerGas,
+                                maxFeePerGas: maxFeePerGas,
+                                maxPriorityFeePerGas: maxPriorityFeePerGas,
+                                gasPrice: gasPrice
+                            }
+                        ];
+                }
+            });
+        })();
+    };
+    /**
    * Returns transaction receipt event logs that match a specified filter.
    * May return `[]` if parameters are too broad, even if logs exist.
    *

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

@@ -0,0 +1,212 @@
+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 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 _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 _slicedToArray(arr, i) {
+    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+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 { StaticJsonRpcProvider } from "@ethersproject/providers";
+import { JsonRpcProvider } from "../../JsonRpcProvider";
+import { rpcUrls } from "./../rpc-urls";
+var rpcUrl = rpcUrls.mainnet;
+var essentialEthProvider = new JsonRpcProvider(rpcUrl);
+var ethersProvider = new StaticJsonRpcProvider(rpcUrl);
+describe("provider.getFeeData", function() {
+    it("should match ethers.js", /*#__PURE__*/ _asyncToGenerator(function() {
+        var _ref, ethersFeeData, eeFeeData;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        Promise.all([
+                            ethersProvider.getFeeData(),
+                            essentialEthProvider.getFeeData()
+                        ])
+                    ];
+                case 1:
+                    _ref = _slicedToArray.apply(void 0, [
+                        _state.sent(),
+                        2
+                    ]), ethersFeeData = _ref[0], eeFeeData = _ref[1];
+                    expect(eeFeeData.gasPrice.toString()).toBe(// @ts-ignore
+                    ethersFeeData === null || ethersFeeData === void 0 ? void 0 : ethersFeeData.gasPrice.toString());
+                    // @ts-ignore
+                    expect(eeFeeData.lastBaseFeePerGas.toString()).toBe(// @ts-ignore
+                    ethersFeeData === null || ethersFeeData === void 0 ? void 0 : ethersFeeData.lastBaseFeePerGas.toString());
+                    // @ts-ignore
+                    expect(eeFeeData.maxFeePerGas.toString()).toBe(// @ts-ignore
+                    ethersFeeData === null || ethersFeeData === void 0 ? void 0 : ethersFeeData.maxFeePerGas.toString());
+                    // @ts-ignore
+                    expect(eeFeeData.maxPriorityFeePerGas.toString()).toBe(// @ts-ignore
+                    ethersFeeData === null || ethersFeeData === void 0 ? void 0 : ethersFeeData.maxPriorityFeePerGas.toString());
+                    return [
+                        2
+                    ];
+            }
+        });
+    }));
+});

package/dist/cjs/types/FeeData.types.d.ts

@@ -0,0 +1,7 @@
+import type { TinyBig } from '../shared/tiny-big/tiny-big';
+export interface FeeData {
+    gasPrice: TinyBig;
+    lastBaseFeePerGas: TinyBig | null;
+    maxFeePerGas: TinyBig | null;
+    maxPriorityFeePerGas: TinyBig | null;
+}

package/dist/cjs/types/FeeData.types.js

@@ -0,0 +1 @@
+export { };

package/dist/esm/logger/package-version.d.ts

@@ -1 +1 @@
-export declare const version = "0.7.0";
+export declare const version = "0.8.0";

package/dist/esm/logger/package-version.js

@@ -1 +1 @@
-export const version = '0.7.0';
+export const version = '0.8.0';

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

@@ -1,5 +1,6 @@
 import type { TinyBig } from '../shared/tiny-big/tiny-big';
 import type { BlockResponse, BlockTag } from '../types/Block.types';
+import type { FeeData } from '../types/FeeData.types';
 import type { Filter, FilterByBlockHash } from '../types/Filter.types';
 import type { Network } from '../types/Network.types';
 import type { Log, TransactionReceipt, TransactionRequest, TransactionResponse } from '../types/Transaction.types';
@@ -19,6 +20,7 @@ export declare abstract class BaseProvider {
     getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
     getCode(address: string, blockTag?: BlockTag): Promise<string>;
     estimateGas(transaction: TransactionRequest): Promise<TinyBig>;
+    getFeeData(): Promise<FeeData>;
     getLogs(filter: Filter | FilterByBlockHash): Promise<Array<Log>>;
     call(transaction: TransactionRequest, blockTag?: BlockTag): Promise<string>;
 }

package/dist/esm/providers/BaseProvider.js

@@ -120,6 +120,21 @@ export class BaseProvider {
             return tinyBig(hexToDecimal(gasUsed));
         });
     }
+    getFeeData() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [block, gasPrice] = yield Promise.all([
+                this.getBlock('latest'),
+                this.getGasPrice(),
+            ]);
+            let lastBaseFeePerGas = null, maxFeePerGas = null, maxPriorityFeePerGas = null;
+            if (block && block.baseFeePerGas) {
+                lastBaseFeePerGas = block.baseFeePerGas;
+                maxPriorityFeePerGas = tinyBig('1500000000');
+                maxFeePerGas = tinyBig(block.baseFeePerGas.mul(2).add(maxPriorityFeePerGas));
+            }
+            return { lastBaseFeePerGas, maxFeePerGas, maxPriorityFeePerGas, gasPrice };
+        });
+    }
     getLogs(filter) {
         return __awaiter(this, void 0, void 0, function* () {
             const filterByRange = filter;

package/dist/esm/types/FeeData.types.d.ts

@@ -0,0 +1,7 @@
+import type { TinyBig } from '../shared/tiny-big/tiny-big';
+export interface FeeData {
+    gasPrice: TinyBig;
+    lastBaseFeePerGas: TinyBig | null;
+    maxFeePerGas: TinyBig | null;
+    maxPriorityFeePerGas: TinyBig | null;
+}

package/dist/esm/types/FeeData.types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS for Ethereum",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "MIT",
   "sideEffects": false,
   "private": false,
@@ -30,13 +30,13 @@
       "name": "JsonRpcProvider",
       "path": "src/index.ts",
       "import": "{ JsonRpcProvider }",
-      "limit": "20.24kb"
+      "limit": "20.32kb"
     },
     {
       "name": "Contract",
       "path": "src/index.ts",
       "import": "{ Contract }",
-      "limit": "15.87kb"
+      "limit": "15.38kb"
     }
   ],
   "scripts": {

package/readme.md

@@ -91,6 +91,7 @@
   - [`getBlock`](#getblock)
   - [`getBlockNumber`](#getblocknumber)
   - [`getCode`](#getcode)
+  - [`getFeeData`](#getfeedata)
   - [`getGasPrice`](#getgasprice)
   - [`getLogs`](#getlogs)
   - [`getNetwork`](#getnetwork)
@@ -128,7 +129,7 @@ Browsers:
 
 ```html
 <!-- index.html -->
-<script src="https://unpkg.com/essential-eth@0.7.0"></script>
+<script src="https://unpkg.com/essential-eth@0.8.0"></script>
 ```
 
 <!-- ⛔️ AUTO-GENERATED-CONTENT:END (UNPKG_SCRIPT_TAG) -->
@@ -1195,6 +1196,34 @@ await jsonRpcProvider().getCode(
 
   <br/>
 
+#### [`getFeeData`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getfeedata)
+
+```typescript
+provider.getFeeData(): Promise<FeeData>
+```
+
+  <details>
+  <summary>View Example</summary>
+
+```js
+import { JsonRpcProvider } from 'essential-eth';
+const provider = new JsonRpcProvider('RPC URL HERE' /* Try Infura or POKT */);
+```
+
+```javascript
+await provider.getFeeData();
+// {
+//   gasPrice: { TinyBig: "14184772639" },
+//   lastBaseFeePerGas: { TinyBig: "14038523098" },
+//   maxFeePerGas: { TinyBig: "29577046196" },
+//   maxPriorityFeePerGas: { TinyBig: "1500000000" }
+// }
+```
+
+  </details>
+
+  <br/>
+
 #### [`getGasPrice`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getgasprice)
 
 ```typescript