essential-eth 0.4.9-beta.4 → 0.4.11

package/lib/esm/providers/utils/chains-info.d.ts

@@ -45,6 +45,7 @@ declare const _default: {
     "51": string[];
     "52": string[];
     "53": string[];
+    "54": string[];
     "55": string[];
     "56": string[];
     "57": string[];
@@ -98,9 +99,11 @@ declare const _default: {
     "127": string[];
     "128": string[];
     "137": string[];
+    "141": string[];
     "142": string[];
     "162": string[];
     "163": string[];
+    "168": string[];
     "170": string[];
     "172": string[];
     "186": string[];
@@ -109,7 +112,10 @@ declare const _default: {
     "199": string[];
     "200": string[];
     "211": string[];
+    "218": string[];
     "222": string[];
+    "225": string[];
+    "226": string[];
     "246": string[];
     "250": string[];
     "256": string[];
@@ -117,6 +123,7 @@ declare const _default: {
     "262": string[];
     "269": string[];
     "288": string[];
+    "300": string[];
     "321": string[];
     "322": string[];
     "333": string[];
@@ -145,6 +152,7 @@ declare const _default: {
     "721": string[];
     "777": string[];
     "787": string[];
+    "788": string[];
     "803": string[];
     "820": string[];
     "821": string[];
@@ -162,6 +170,7 @@ declare const _default: {
     "999": string[];
     "1001": string[];
     "1007": string[];
+    "1008": string[];
     "1010": string[];
     "1012": string[];
     "1022": string[];
@@ -180,14 +189,19 @@ declare const _default: {
     "1280": string[];
     "1284": string[];
     "1285": string[];
+    "1286": string[];
     "1287": string[];
     "1288": string[];
+    "1337": string[];
     "1618": string[];
     "1620": string[];
     "1657": string[];
+    "1688": string[];
     "1856": string[];
     "1898": string[];
+    "1984": string[];
     "1987": string[];
+    "2001": string[];
     "2020": string[];
     "2021": string[];
     "2022": string[];
@@ -195,7 +209,10 @@ declare const _default: {
     "2100": string[];
     "2101": string[];
     "2213": string[];
+    "2221": string[];
     "2559": string[];
+    "3000": string[];
+    "3001": string[];
     "3331": string[];
     "3333": string[];
     "3334": string[];
@@ -205,12 +222,14 @@ declare const _default: {
     "3966": string[];
     "3967": string[];
     "4002": string[];
+    "4102": string[];
     "4689": string[];
     "4690": string[];
     "4918": string[];
     "5197": string[];
     "5315": string[];
     "5700": string[];
+    "5777": string[];
     "5851": string[];
     "5869": string[];
     "6626": string[];
@@ -243,6 +262,7 @@ declare const _default: {
     "16000": string[];
     "16001": string[];
     "19845": string[];
+    "21337": string[];
     "21816": string[];
     "24484": string[];
     "24734": string[];
@@ -259,6 +279,7 @@ declare const _default: {
     "43113": string[];
     "43114": string[];
     "44787": string[];
+    "45000": string[];
     "47805": string[];
     "49797": string[];
     "53935": string[];
@@ -300,10 +321,10 @@ declare const _default: {
     "110006": string[];
     "110007": string[];
     "110008": string[];
+    "200101": string[];
     "200625": string[];
     "201018": string[];
     "201030": string[];
-    "210309": string[];
     "210425": string[];
     "234666": string[];
     "246529": string[];
@@ -319,6 +340,7 @@ declare const _default: {
     "1313114": string[];
     "1313500": string[];
     "1337702": string[];
+    "2203181": string[];
     "7762959": string[];
     "11155111": string[];
     "13371337": string[];

package/lib/esm/providers/utils/chains-info.js

@@ -141,6 +141,9 @@ export default {
     "53": [
         "tcet"
     ],
+    "54": [
+        "OP"
+    ],
     "55": [
         "ZYX"
     ],
@@ -300,6 +303,9 @@ export default {
     "137": [
         "MATIC"
     ],
+    "141": [
+        "OPtest"
+    ],
     "142": [
         "dax"
     ],
@@ -309,6 +315,9 @@ export default {
     "163": [
         "pht"
     ],
+    "168": [
+        "aioz"
+    ],
     "170": [
         "hoosmartchain"
     ],
@@ -333,9 +342,18 @@ export default {
     "211": [
         "EDI"
     ],
+    "218": [
+        "SO1-old"
+    ],
     "222": [
         "ASK"
     ],
+    "225": [
+        "LA"
+    ],
+    "226": [
+        "TLA"
+    ],
     "246": [
         "ewt"
     ],
@@ -357,6 +375,9 @@ export default {
     "288": [
         "Boba"
     ],
+    "300": [
+        "ogc"
+    ],
     "321": [
         "kcs"
     ],
@@ -441,6 +462,9 @@ export default {
     "787": [
         "aca"
     ],
+    "788": [
+        "taero"
+    ],
     "803": [
         "haic"
     ],
@@ -492,6 +516,9 @@ export default {
     "1007": [
         "tnew"
     ],
+    "1008": [
+        "eun"
+    ],
     "1010": [
         "EVC"
     ],
@@ -546,12 +573,18 @@ export default {
     "1285": [
         "mriver"
     ],
+    "1286": [
+        "mrock-old"
+    ],
     "1287": [
         "mbase"
     ],
     "1288": [
         "mrock"
     ],
+    "1337": [
+        "cennz-old"
+    ],
     "1618": [
         "cate"
     ],
@@ -561,15 +594,24 @@ export default {
     "1657": [
         "bta"
     ],
+    "1688": [
+        "LUDAN"
+    ],
     "1856": [
         "tsf"
     ],
     "1898": [
         "boya"
     ],
+    "1984": [
+        "euntest"
+    ],
     "1987": [
         "egem"
     ],
+    "2001": [
+        "milkAda"
+    ],
     "2020": [
         "420"
     ],
@@ -591,9 +633,18 @@ export default {
     "2213": [
         "evanesco"
     ],
+    "2221": [
+        "kava"
+    ],
     "2559": [
         "ktoc"
     ],
+    "3000": [
+        "cennz-r"
+    ],
+    "3001": [
+        "cennz-n"
+    ],
     "3331": [
         "zcrbeach"
     ],
@@ -621,6 +672,9 @@ export default {
     "4002": [
         "tftm"
     ],
+    "4102": [
+        "aioz-testnet"
+    ],
     "4689": [
         "iotex-mainnet"
     ],
@@ -639,6 +693,9 @@ export default {
     "5700": [
         "tsys"
     ],
+    "5777": [
+        "dgcc"
+    ],
     "5851": [
         "Ontology Testnet"
     ],
@@ -735,6 +792,9 @@ export default {
     "19845": [
         "btcix"
     ],
+    "21337": [
+        "cennz-a"
+    ],
     "21816": [
         "oml"
     ],
@@ -783,6 +843,9 @@ export default {
     "44787": [
         "ALFA"
     ],
+    "45000": [
+        "autobahn"
+    ],
     "47805": [
         "REI"
     ],
@@ -906,6 +969,9 @@ export default {
     "110008": [
         "qkc-d-s7"
     ],
+    "200101": [
+        "milkTAda"
+    ],
     "200625": [
         "aka"
     ],
@@ -915,9 +981,6 @@ export default {
     "201030": [
         "alayadev"
     ],
-    "210309": [
-        "platondev"
-    ],
     "210425": [
         "platon"
     ],
@@ -963,6 +1026,9 @@ export default {
     "1337702": [
         "kintsugi"
     ],
+    "2203181": [
+        "platondev"
+    ],
     "7762959": [
         "music"
     ],

package/lib/esm/types/Block.types.d.ts

@@ -45,3 +45,4 @@ export interface RPCBlock {
     transactionsRoot: string;
     uncles: unknown[];
 }
+export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;

package/lib/esm/utils/ether-to-gwei.d.ts

@@ -0,0 +1,3 @@
+import Big from 'big.js';
+import { TinyBig } from '../shared/tiny-big/tiny-big';
+export declare function etherToGwei(etherQuantity: string | number | TinyBig | Big): TinyBig;

package/lib/esm/utils/ether-to-gwei.js

@@ -0,0 +1,7 @@
+import { tinyBig } from '../shared/tiny-big/tiny-big';
+import { validateType } from '../shared/validate-type';
+export function etherToGwei(etherQuantity) {
+    validateType(etherQuantity, ['string', 'number', 'object']);
+    const result = tinyBig(etherQuantity).times('1000000000');
+    return tinyBig(result);
+}

package/lib/esm/utils/gwei-to-ether.d.ts

@@ -0,0 +1,3 @@
+import Big from 'big.js';
+import { TinyBig } from './../shared/tiny-big/tiny-big';
+export declare function gweiToEther(gweiQuantity: string | number | TinyBig | Big): TinyBig;

package/lib/esm/utils/gwei-to-ether.js

@@ -0,0 +1,7 @@
+import { tinyBig } from '../shared/tiny-big/tiny-big';
+import { validateType } from '../shared/validate-type';
+export function gweiToEther(gweiQuantity) {
+    validateType(gweiQuantity, ['string', 'number', 'object']);
+    const result = tinyBig(gweiQuantity).div('1000000000');
+    return tinyBig(result);
+}

package/lib/esm/utils/wei-to-ether.d.ts

@@ -1,3 +1,3 @@
 import Big from 'big.js';
-import { TinyBig } from './../shared/tiny-big/tiny-big';
+import { TinyBig } from '../shared/tiny-big/tiny-big';
 export declare function weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.4.9-beta.4",
+  "version": "0.4.11",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -22,11 +22,9 @@
     "tsc:esm": "tsc -p tsconfig.json",
     "tsc:cjs": "tsc -p tsconfig-cjs.json",
     "build": "rm -rf lib && npm run compile",
-    "prepublishOnly": "npm run build && npm run build:website && npm run build:website:new-version",
+    "prepublishOnly": "npm run build",
     "jest": "jest",
     "build:chains-info": "npx ts-node scripts/fetch-chains-info.ts # used in getNetwork()",
-    "build:website": "sh scripts/build-website.sh",
-    "build:website:new-version": "typedoc --options typedoc/options-new-version.js",
     "pre-commit": "sh scripts/pre-commit.sh"
   },
   "devDependencies": {
@@ -38,9 +36,8 @@
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
     "@types/prettier": "^2.4.4",
-    "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.17.0",
-    "@typescript-eslint/parser": "^5.17.0",
+    "@typescript-eslint/eslint-plugin": "^5.18.0",
+    "@typescript-eslint/parser": "^5.18.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
     "eslint": "^8.12.0",
@@ -50,15 +47,14 @@
     "husky": "^4.3.0",
     "jest": "^27.5.1",
     "jest-dev-server": "^6.0.3",
-    "just-omit": "^1.2.0",
+    "just-omit": "^2.0.1",
     "lint-staged": "^12.3.7",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.6.1",
+    "prettier": "^2.6.2",
     "prettier-plugin-organize-imports": "^2.3.4",
-    "supertest": "^6.1.6",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
-    "typedoc": "^0.22.12",
+    "typedoc": "^0.22.13",
     "typescript": "^4.6.3",
     "web3": "^1.7.1"
   },
@@ -70,7 +66,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged && run-p pre-commit test build:website build:chains-info"
+      "pre-commit": "lint-staged && run-p pre-commit test build:chains-info"
     }
   },
   "lint-staged": {

package/readme.md

@@ -1,18 +1,18 @@
 <p align="center">
-  <a><img src="https://blog.ethereum.org/img/2018/08/grants_eth_logo.png" title="Logo" height="400"/></a>
+  <a><img src="https://user-images.githubusercontent.com/3408480/161474132-ae95d289-2298-46f1-b48d-9c02d88f7e38.png" title="Logo" height="400" /></a>
 </p>
 <p align="center">
   <b>
     Essential Eth
   </b>
-  <br>
-  <i>Ultralight Ethereum utilities for JS and TS</i>
-  <br>
+  <br/>
+  <i>A replacement for ethers & web3 that's 50x smaller</i>
+  <br/>
 </p>
 
 ---
 
-<br>
+<br/>
 
 ## Why you should replace Ethers.js and web3
 
@@ -26,7 +26,7 @@
 
 ---
 
-<br>
+<br/>
 
 - ⚡️ A replacement for `web3` and `ethers`
 - 🏎 [The TINIEST code size possible](https://bundlephobia.com/package/essential-eth)
@@ -126,6 +126,56 @@ weiToEther('1000000000000000000').toNumber();
 
 <br/>
 
+#### `gweiToEther`
+
+```typescript
+gweiToEther(gweiQuantity: string | number | TinyBig | Big): TinyBig
+```
+
+<details>
+  <summary>View Example</summary>
+
+```typescript
+import { gweiToEther } from 'essential-eth';
+
+gweiToEther(1000000000).toString();
+// "1"
+
+gweiToEther(1000000000).toNumber();
+// 1
+gweiToEther('1000000000').toNumber();
+// 1
+```
+
+</details>
+
+<br/>
+
+#### `etherToGwei`
+
+```typescript
+etherToGwei(etherQuantity: string | number | TinyBig | Big): TinyBig
+```
+
+<details>
+  <summary>View Example</summary>
+
+```typescript
+import { etherToGwei } from 'essential-eth';
+
+etherToGwei(0.000000001).toString();
+// "1"
+
+etherToGwei(0.000000001).toNumber();
+// 1
+etherToGwei('0.000000001').toNumber();
+// 1
+```
+
+</details>
+
+<br/>
+
 #### `toChecksumAddress`
 
 ```typescript
@@ -188,12 +238,65 @@ const essentialEth = new JsonRpcProvider(
 const essentialEth = new JsonRpcProvider();
 ```
 
+#### `getGasPrice`
+
+Returns the current gas price in gwei
+
+```typescript
+// Same as ethers.providers.getGasPrice
+getGasPrice(): Promise<TinyBig>
+```
+
+<details>
+  <summary>View Example</summary>
+
+```typescript
+import { JsonRpcProvider } from 'essential-eth';
+
+const provider = new JsonRpcProvider('https://free-eth-node.com/api/eth');
+provider.getGasPrice().toNumber();
+/*
+39695942769
+*/
+```
+
+</details>
+
+<br/>
+
+#### `getBalance`
+
+Returns the balance of an address at a given block
+
+```typescript
+// Same API as ethers.providers.getBalance
+// Same API as web3.eth.getBalance
+getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>
+```
+
+<details>
+  <summary>View Example</summary>
+
+```typescript
+import { JsonRpcProvider } from 'essential-eth';
+
+const provider = new JsonRpcProvider();
+await provider
+  .getBalance('0x7cB57B5A97eAbe94205C07890BE4c1aD31E486A8')
+  .then((balance) => console.log(balance.toString()));
+// "28798127851528138"
+```
+
+</details>
+
+<br/>
+
 #### `getNetwork`
 
-Returns a [Network](src/types/Network.types.ts)
+Returns a Network
 
 ```typescript
-// Same API as ethers getNetwork
+// Same API as ethers.providers.getNetwork
 getNetwork(): Promise<Network>
 ```
 
@@ -224,7 +327,7 @@ xdaiProvider.getNetwork();
 
 #### `getBlock`
 
-Returns a [Block](src/types/Block.types.ts)
+Returns a Block
 
 ```typescript
 // Same API as web3.eth.getBlock

package/lib/cjs/utils/index.d.ts

@@ -1,5 +0,0 @@
-import { etherToWei } from './ether-to-wei';
-import { isAddress } from './is-address';
-import { toChecksumAddress } from './to-checksum-address';
-import { weiToEther } from './wei-to-ether';
-export { etherToWei, isAddress, toChecksumAddress, weiToEther };

package/lib/cjs/utils/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.weiToEther = exports.toChecksumAddress = exports.isAddress = exports.etherToWei = void 0;
-const ether_to_wei_1 = require("./ether-to-wei");
-Object.defineProperty(exports, "etherToWei", { enumerable: true, get: function () { return ether_to_wei_1.etherToWei; } });
-const is_address_1 = require("./is-address");
-Object.defineProperty(exports, "isAddress", { enumerable: true, get: function () { return is_address_1.isAddress; } });
-const to_checksum_address_1 = require("./to-checksum-address");
-Object.defineProperty(exports, "toChecksumAddress", { enumerable: true, get: function () { return to_checksum_address_1.toChecksumAddress; } });
-const wei_to_ether_1 = require("./wei-to-ether");
-Object.defineProperty(exports, "weiToEther", { enumerable: true, get: function () { return wei_to_ether_1.weiToEther; } });

package/lib/esm/utils/index.d.ts

@@ -1,5 +0,0 @@
-import { etherToWei } from './ether-to-wei';
-import { isAddress } from './is-address';
-import { toChecksumAddress } from './to-checksum-address';
-import { weiToEther } from './wei-to-ether';
-export { etherToWei, isAddress, toChecksumAddress, weiToEther };

package/lib/esm/utils/index.js

@@ -1,5 +0,0 @@
-import { etherToWei } from './ether-to-wei';
-import { isAddress } from './is-address';
-import { toChecksumAddress } from './to-checksum-address';
-import { weiToEther } from './wei-to-ether';
-export { etherToWei, isAddress, toChecksumAddress, weiToEther };