essential-eth 0.4.8 → 0.4.9-alpha.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.4.8",
+  "version": "0.4.9-alpha.01",
   "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": {
@@ -37,29 +35,27 @@
     "@types/jest": "^27.4.1",
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
-    "@types/prettier": "^2.4.0",
-    "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.13.0",
-    "@typescript-eslint/parser": "^5.13.0",
+    "@types/prettier": "^2.4.4",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
-    "eslint": "^8.10.0",
-    "eslint-plugin-jest": "^26.1.1",
-    "ethers": "^5.5.4",
+    "eslint": "^8.12.0",
+    "eslint-plugin-jest": "^26.1.3",
+    "ethers": "^5.6.2",
     "express": "^4.17.1",
     "husky": "^4.3.0",
     "jest": "^27.5.1",
     "jest-dev-server": "^6.0.3",
-    "just-omit": "^1.2.0",
-    "lint-staged": "^12.3.4",
+    "just-omit": "^2.0.1",
+    "lint-staged": "^12.3.7",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.2",
     "prettier-plugin-organize-imports": "^2.3.4",
-    "supertest": "^6.1.6",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
-    "typedoc": "^0.22.12",
-    "typescript": "^4.6.2",
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.3",
     "web3": "^1.7.1"
   },
   "dependencies": {
@@ -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,19 +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
 
@@ -27,7 +26,7 @@
 
 ---
 
-<br>
+<br/>
 
 - ⚡️ A replacement for `web3` and `ethers`
 - 🏎 [The TINIEST code size possible](https://bundlephobia.com/package/essential-eth)
@@ -35,7 +34,7 @@
 - 🧪 Tested to match both `web3` and `ethers`
 - 🌲 Tree-shaking and no side-effects
 - 🙌 Supports multiple JS versions (CommonJS and ESM)
-  - ✅ Node 16, 14, 12, & 10
+  - ✅ Node 17, 16, 14, & 12
   - ✅ Web
 
 <br/>
@@ -189,12 +188,38 @@ 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/>
+
 #### `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>
 ```
 
@@ -225,7 +250,7 @@ xdaiProvider.getNetwork();
 
 #### `getBlock`
 
-Returns a [Block](src/types/Block.types.ts)
+Returns a Block
 
 ```typescript
 // Same API as web3.eth.getBlock