essential-eth 0.5.0 → 0.5.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.5.0",
+  "version": "0.5.4",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -17,18 +17,21 @@
   "scripts": {
     "test": "npm-run-all --parallel jest compile lint",
     "test:all-node-versions": "npx trevor",
-    "lint": "eslint .",
+    "lint": "eslint --cache --fix .",
     "compile": "npm-run-all --parallel tsc:esm tsc:cjs",
     "tsc:esm": "tsc -p tsconfig.json",
     "tsc:cjs": "tsc -p tsconfig-cjs.json",
     "build": "rm -rf lib && npm run compile",
-    "prepublishOnly": "npm run build",
     "jest": "jest",
     "build:chains-info": "npx ts-node scripts/fetch-chains-info.ts # used in getNetwork()",
-    "pre-commit": "sh scripts/pre-commit.sh"
+    "update-deps": "sh ./scripts/pre-commit.sh",
+    "pre-commit": "run-p build:chains-info update-deps",
+    "prepare": "husky install",
+    "version": "npx genversion --es6 src/logger/package-version.ts && git add src/logger/package-version.ts",
+    "postversion": "git push --follow-tags",
+    "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@ethersproject/keccak256": "^5.4.0",
     "@types/body-parser": "^1.19.1",
     "@types/eslint": "^8.4.1",
     "@types/express": "^4.17.13",
@@ -36,26 +39,27 @@
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
     "@types/prettier": "^2.4.4",
-    "@typescript-eslint/eslint-plugin": "^5.19.0",
-    "@typescript-eslint/parser": "^5.19.0",
+    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/parser": "^5.21.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
-    "eslint": "^8.13.0",
-    "eslint-plugin-jest": "^26.1.4",
-    "ethers": "^5.6.3",
+    "eslint": "^8.14.0",
+    "eslint-plugin-jest": "^26.1.5",
+    "ethers": "^5.6.4",
     "express": "^4.17.1",
-    "husky": "^4.3.0",
+    "husky": "^7.0.4",
     "jest": "^27.5.1",
     "jest-dev-server": "^6.0.3",
     "just-omit": "^2.0.1",
-    "lint-staged": "^12.3.7",
+    "lint-staged": "^12.4.1",
     "npm-run-all": "^4.1.5",
+    "perf_hooks": "^0.0.1",
     "prettier": "^2.6.2",
     "prettier-plugin-organize-imports": "^2.3.4",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
     "typedoc": "^0.22.13",
-    "typescript": "^4.6.3",
+    "typescript": "^4.6.4",
     "web3": "^1.7.3"
   },
   "dependencies": {
@@ -64,15 +68,11 @@
     "isomorphic-unfetch": "^3.1.0",
     "sha3": "^2.1.4"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && run-p pre-commit test build:chains-info"
-    }
-  },
   "lint-staged": {
     "*.{js,jsx,ts,tsx,css,scss,md,json,html,yml,yaml}": [
       "prettier --write"
-    ]
+    ],
+    "*.{ts,tsx}": "eslint --cache --fix"
   },
   "prettier": {
     "trailingComma": "all",

package/readme.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://user-images.githubusercontent.com/3408480/163274699-ae4fb0f4-fca0-4745-bcd7-4868f80deaf6.png" title="Logo"/>
+  <img src="https://user-images.githubusercontent.com/3408480/163274699-ae4fb0f4-fca0-4745-bcd7-4868f80deaf6.png" height="220" title="Logo"/>
 
 </p>
 <p align="center">
@@ -8,7 +8,7 @@
     🪶 Essential Eth 🪶
   </b>
   <br/>
-  <i>A replacement for ethers & web3 that's 50x smaller</i>
+  <i>A replacement for ethers & web3 that's 20x smaller</i>
   <br/>
 </p>
 
@@ -37,6 +37,10 @@
 
 <br/>
 
+[![🧪 tests](https://github.com/Earnifi/essential-eth/actions/workflows/test.yml/badge.svg)](https://github.com/Earnifi/essential-eth/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/Earnifi/essential-eth/branch/master/graph/badge.svg?token=E44EK6RWTZ)](https://codecov.io/gh/Earnifi/essential-eth) ![](https://badgen.net/bundlephobia/minzip/essential-eth) ![](https://badgen.net/bundlephobia/tree-shaking/essential-eth) ![](https://img.shields.io/npm/v/essential-eth)
+
+<br/>
+
 ## Install
 
 ```sh
@@ -251,10 +255,35 @@ import { JsonRpcProvider } from 'essential-eth';
 const essentialEth = new JsonRpcProvider(
   'RPC URL HERE' /* Try POKT or Infura */,
 );
-// OR for very quick testing (limited to 500 requests)
+// OR for very quick testing (limited to 10,000 requests)
 const essentialEth = new JsonRpcProvider();
 ```
 
+<details>
+  <summary>Want a redundant provider that handles outages?</summary>
+
+```typescript
+import { FallthroughProvider } from 'essential-eth';
+
+// The FallthroughProvider handles falling through to the next valid URL.
+// It's dynamic to never trust one URL again when it fails * until it has tried all other provided URLs
+// The default timeout for a request is 8 seconds after which it moves to the next URL
+const provider = new FallthroughProvider([
+  'https://bad.com',
+  'https://free-eth-node.com/api/eth',
+]);
+provider.getGasPrice().toNumber();
+/*
+39695942769
+*/
+```
+
+</details>
+
+ <br/>
+
+#### [`getTransactionCount(address, blockTag?): Promise<number>`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#gettransactioncount)
+
 #### `getGasPrice`
 
 Returns the current gas price in gwei
@@ -617,11 +646,13 @@ Any function on a contract. Returns are the same as `ethers.js`, except that ins
 
 🧪 This repo is under active development. The API is less-fully featured than `web3` and `ethers`. More functions added often!
 
-![](https://badgen.net/bundlephobia/minzip/essential-eth) ![](https://badgen.net/bundlephobia/tree-shaking/essential-eth) ![](https://img.shields.io/npm/v/essential-eth) ![](https://badgen.net/bundlephobia/dependency-count/essential-eth)
-
 👨🏻‍💻 Breaking changes will exist between minor versions until `1.0.0` (Versions go `major.minor.patch`)
 
 <br/>
 
+![Alt](https://repobeats.axiom.co/api/embed/e479d8f777288a94cdde2fe3cdedf38d5243793d.svg 'Repobeats analytics image')
+
+<br/>
+
 - [📓 View full docs](https://essential-eth.vercel.app)
 - [📓 View changelog (by looking at releases diff)](https://github.com/dawsbot/essential-eth/releases)

package/lib/cjs/utils/hex-zero-pad.d.ts

@@ -1,32 +0,0 @@
-/**
- * Returns a hex string padded to a specified length of bytes.
- *
- * Similar to ["hexZeroPad" in ethers.js](https://docs.ethers.io/v5/api/utils/bytes/#utils-hexZeroPad)
- *
- * Differs from ["padLeft" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#padleft) because web3 counts by characters, not bytes.
- *
- * @param hexValue - A hex-string, hex-number, or decimal number (auto-converts to base-16) to be padded
- * @param length - The final length in bytes
- *
- * @throws - If the value is not a hex string or number
- * @throws - If the value is longer than the length
- *
- * @example
- * ```javascript
- * hexZeroPad('0x60', 2);
- * // '0x0060'
- * ```
- *
- * @example
- * ```javascript
- * hexZeroPad(0x60, 3);
- * // '0x000060'
- * ```
- *
- * @example
- * ```javascript
- * hexZeroPad('12345', 1);
- * // Throws
- * ```
- */
-export declare function hexZeroPad(hexValue: string | number, length: number): string;

package/lib/cjs/utils/hex-zero-pad.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hexZeroPad = void 0;
-const validate_type_1 = require("../shared/validate-type");
-/**
- * Returns a hex string padded to a specified length of bytes.
- *
- * Similar to ["hexZeroPad" in ethers.js](https://docs.ethers.io/v5/api/utils/bytes/#utils-hexZeroPad)
- *
- * Differs from ["padLeft" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#padleft) because web3 counts by characters, not bytes.
- *
- * @param hexValue - A hex-string, hex-number, or decimal number (auto-converts to base-16) to be padded
- * @param length - The final length in bytes
- *
- * @throws - If the value is not a hex string or number
- * @throws - If the value is longer than the length
- *
- * @example
- * ```javascript
- * hexZeroPad('0x60', 2);
- * // '0x0060'
- * ```
- *
- * @example
- * ```javascript
- * hexZeroPad(0x60, 3);
- * // '0x000060'
- * ```
- *
- * @example
- * ```javascript
- * hexZeroPad('12345', 1);
- * // Throws
- * ```
- */
-function hexZeroPad(hexValue, length) {
-    (0, validate_type_1.validateType)(hexValue, ['string', 'number']);
-    let val;
-    if (typeof hexValue === 'string') {
-        if (!hexValue.startsWith('0x'))
-            throw new Error(`value is not a hex string or number. Consider prepending with "0x" (value="${hexValue}")`);
-        val = hexValue.substring(2);
-    }
-    else {
-        val = hexValue.toString(16);
-    }
-    if (val.length > length * 2) {
-        throw new Error(`value is longer than length (hexValue=${hexValue}, length=${length})`);
-    }
-    return `0x${val.padStart(length * 2, '0')}`;
-}
-exports.hexZeroPad = hexZeroPad;

package/lib/esm/utils/hex-zero-pad.d.ts

@@ -1 +0,0 @@
-export declare function hexZeroPad(hexValue: string | number, length: number): string;

package/lib/esm/utils/hex-zero-pad.js

@@ -1,17 +0,0 @@
-import { validateType } from '../shared/validate-type';
-export function hexZeroPad(hexValue, length) {
-    validateType(hexValue, ['string', 'number']);
-    let val;
-    if (typeof hexValue === 'string') {
-        if (!hexValue.startsWith('0x'))
-            throw new Error(`value is not a hex string or number. Consider prepending with "0x" (value="${hexValue}")`);
-        val = hexValue.substring(2);
-    }
-    else {
-        val = hexValue.toString(16);
-    }
-    if (val.length > length * 2) {
-        throw new Error(`value is longer than length (hexValue=${hexValue}, length=${length})`);
-    }
-    return `0x${val.padStart(length * 2, '0')}`;
-}