essential-eth 0.5.11-next.1 → 0.5.12

package/package.json

@@ -1,18 +1,13 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS for Ethereum",
-  "version": "0.5.11-next.1",
+  "version": "0.5.12",
   "license": "MIT",
   "sideEffects": false,
-  "private": false,
-  "source": "src/index.ts",
-  "amdName": "essentialEth",
-  "main": "./dist/index.js",
-  "module": "./dist/index.module.js",
-  "umd:main": "./dist/index.umd.js",
-  "types": "./dist/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
   "files": [
-    "dist/"
+    "lib/"
   ],
   "bugs": {
     "url": "https://github.com/dawsbot/essential-eth/issues"
@@ -24,29 +19,30 @@
       "name": "etherToWei",
       "path": "src/index.ts",
       "import": "{ etherToWei }",
-      "limit": "3.58kb"
+      "limit": "3.9kb"
     },
     {
       "name": "JsonRpcProvider",
       "path": "src/index.ts",
       "import": "{ JsonRpcProvider }",
-      "limit": "20.24kb"
+      "limit": "22kb"
     },
     {
       "name": "Contract",
       "path": "src/index.ts",
       "import": "{ Contract }",
-      "limit": "15.86kb"
+      "limit": "18kb"
     }
   ],
   "scripts": {
     "size": "size-limit",
-    "test": "npm-run-all --parallel jest build lint",
+    "test": "npm-run-all --parallel jest compile lint",
     "test:all-node-versions": "npx trevor",
     "lint": "eslint --cache --fix .",
-    "build": "rm -rf dist && run-p build:most build:umd",
-    "build:most": "microbundle --target node --format esm,cjs",
-    "build:umd": "microbundle --external none --format umd",
+    "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",
     "build:readme": "bash ./scripts/markdown-magic/build-readme.sh",
     "jest": "jest",
     "build:chains-info": "npx ts-node scripts/fetch-chains-info.ts # used in getNetwork()",
@@ -81,7 +77,6 @@
     "jest-dev-server": "^6.0.3",
     "just-omit": "^2.0.1",
     "lint-staged": "^12.4.1",
-    "microbundle": "^0.15.0",
     "npm-run-all": "^4.1.5",
     "perf_hooks": "^0.0.1",
     "prettier": "^2.7.1",
@@ -90,7 +85,7 @@
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
     "typedoc": "^0.22.15",
-    "typescript": "^4.7.4",
+    "typescript": "^4.6.4",
     "web3": "^1.7.5"
   },
   "dependencies": {
@@ -110,12 +105,5 @@
     "trailingComma": "all",
     "tabWidth": 2,
     "singleQuote": true
-  },
-  "keywords": [
-    "ethereum",
-    "polygon",
-    "evm",
-    "web-performance",
-    "tiny"
-  ]
+  }
 }

package/readme.md

@@ -26,20 +26,12 @@
 
 <br/>
 
-- 🐜️ [tiny](https://bundlephobia.com/package/essential-eth)
-- 🔐 Strongly written TypeScript
-- 🧪 Matches both `ethers` and `web3`
-  - ⚡️ Near-identical API to `ethers`
-  - ⚡️ Similar but improved API to `web3`
-- 🙌 Works for all EVM chains
-  - 💎 Ethereum
-  - 🟣 Polygon
-  - 🔴 Optimism
-  - 🔵 Arbitrum
-  - [Many more](src/providers/utils/chains-info.ts)
-- 🧪 Strongly tested
+- 🏆️ <sub><sup>[smallest code size possible](https://bundlephobia.com/package/essential-eth)</sup></sub>
+- ʦ Fully typed with TypeScript (also works with JavaScript)
+- 🧪 Tested to match both `web3` and `ethers`
+- - ⚡️ Near-identical API to `ethers`
 - 🌲 Tree-shaking and no side-effects
-- 🙌 All common JS versions (CommonJS, ESM, UMD, modern)
+- 🙌 Supports multiple JS versions (CommonJS and ESM)
   - ✅ Node 18, 16, 14, & 12
   - ✅ Web
 
@@ -112,17 +104,10 @@
 ## Install
 
 ```sh
-npm install --save essential-eth # TypeScript included
+npm install --save essential-eth # TypeScript types load automatically
 
 # or yarn
-yarn add essential-eth # TypeScript included
-```
-
-Browsers:
-
-```html
-<!-- index.html -->
-<script src="https://unpkg.com/essential-eth@0.5.10"></script>
+yarn add essential-eth # TypeScript types load automatically
 ```
 
 <br/>
@@ -138,7 +123,7 @@ const { etherToWei } = require('essential-eth');
 
 <!-- ⛔️ AUTO-GENERATED-CONTENT:START (FUNCTIONS) -->
 
-#### [`arrayify`](https://eeth.dev/docs/api/modules#arrayify)
+#### [`arrayify`](https://essential-eth.vercel.app/docs/api/modules#arrayify)
 
 ```typescript
 arrayify(value: number | BytesLike | Hexable, options: DataOptions): Uint8Array
@@ -170,7 +155,7 @@ arrayify('0x1', { hexPad: 'right' });
 
   <br/>
 
-#### [`computeAddress`](https://eeth.dev/docs/api/modules#computeaddress)
+#### [`computeAddress`](https://essential-eth.vercel.app/docs/api/modules#computeaddress)
 
 ```typescript
 computeAddress(key: string): string
@@ -201,7 +186,7 @@ computeAddress(
 
   <br/>
 
-#### [`computePublicKey`](https://eeth.dev/docs/api/modules#computepublickey)
+#### [`computePublicKey`](https://essential-eth.vercel.app/docs/api/modules#computepublickey)
 
 ```typescript
 computePublicKey(privKey: BytesLike): string
@@ -233,7 +218,7 @@ computePublicKey([
 
   <br/>
 
-#### [`concat`](https://eeth.dev/docs/api/modules#concat)
+#### [`concat`](https://essential-eth.vercel.app/docs/api/modules#concat)
 
 ```typescript
 concat(arrayOfBytesLike: Array<BytesLikeWithNumber>): Uint8Array
@@ -255,7 +240,7 @@ concat([0, 1]);
 
   <br/>
 
-#### [`etherToGwei`](https://eeth.dev/docs/api/modules#ethertogwei)
+#### [`etherToGwei`](https://essential-eth.vercel.app/docs/api/modules#ethertogwei)
 
 ```typescript
 etherToGwei(etherQuantity: string | number | TinyBig | Big): TinyBig
@@ -286,7 +271,7 @@ etherToGwei(1000).toNumber();
 
   <br/>
 
-#### [`etherToWei`](https://eeth.dev/docs/api/modules#ethertowei)
+#### [`etherToWei`](https://essential-eth.vercel.app/docs/api/modules#ethertowei)
 
 ```typescript
 etherToWei(etherQuantity: string | number | TinyBig | Big): TinyBig
@@ -317,7 +302,7 @@ etherToWei(1000).toNumber();
 
   <br/>
 
-#### [`gweiToEther`](https://eeth.dev/docs/api/modules#gweitoether)
+#### [`gweiToEther`](https://essential-eth.vercel.app/docs/api/modules#gweitoether)
 
 ```typescript
 gweiToEther(gweiQuantity: string | number | TinyBig | Big): TinyBig
@@ -348,7 +333,7 @@ gweiToEther(1000000000000).toNumber();
 
   <br/>
 
-#### [`hashMessage`](https://eeth.dev/docs/api/modules#hashmessage)
+#### [`hashMessage`](https://essential-eth.vercel.app/docs/api/modules#hashmessage)
 
 ```typescript
 hashMessage(message: string | Bytes): string
@@ -370,7 +355,7 @@ hashMessage('Hello World');
 
   <br/>
 
-#### [`hexConcat`](https://eeth.dev/docs/api/modules#hexconcat)
+#### [`hexConcat`](https://essential-eth.vercel.app/docs/api/modules#hexconcat)
 
 ```typescript
 hexConcat(items: Array<BytesLike>): string
@@ -392,7 +377,7 @@ hexConcat([[2, 4, 0, 1], 9, '0x2934', '0x3947']);
 
   <br/>
 
-#### [`hexDataLength`](https://eeth.dev/docs/api/modules#hexdatalength)
+#### [`hexDataLength`](https://essential-eth.vercel.app/docs/api/modules#hexdatalength)
 
 ```typescript
 hexDataLength(data: BytesLike): undefined
@@ -419,7 +404,7 @@ hexDataLength('0x3925');
 
   <br/>
 
-#### [`hexDataSlice`](https://eeth.dev/docs/api/modules#hexdataslice)
+#### [`hexDataSlice`](https://essential-eth.vercel.app/docs/api/modules#hexdataslice)
 
 ```typescript
 hexDataSlice(data: BytesLikeWithNumber, offset: number, endOffset: number): string
@@ -441,7 +426,7 @@ hexDataSlice([20, 6, 48], 0, 2);
 
   <br/>
 
-#### [`hexStripZeros`](https://eeth.dev/docs/api/modules#hexstripzeros)
+#### [`hexStripZeros`](https://essential-eth.vercel.app/docs/api/modules#hexstripzeros)
 
 ```typescript
 hexStripZeros(value: BytesLike): string
@@ -463,7 +448,7 @@ hexStripZeros([0, 0, 0, 48]);
 
   <br/>
 
-#### [`hexValue`](https://eeth.dev/docs/api/modules#hexvalue)
+#### [`hexValue`](https://essential-eth.vercel.app/docs/api/modules#hexvalue)
 
 ```typescript
 hexValue(value: number | bigint | BytesLike | Hexable): string
@@ -490,7 +475,7 @@ hexValue([9, 4, 19, 4]);
 
   <br/>
 
-#### [`hexZeroPad`](https://eeth.dev/docs/api/modules#hexzeropad)
+#### [`hexZeroPad`](https://essential-eth.vercel.app/docs/api/modules#hexzeropad)
 
 ```typescript
 hexZeroPad(value: BytesLikeWithNumber, length: number): string
@@ -522,7 +507,7 @@ hexZeroPad('12345', 1);
 
   <br/>
 
-#### [`hexlify`](https://eeth.dev/docs/api/modules#hexlify)
+#### [`hexlify`](https://essential-eth.vercel.app/docs/api/modules#hexlify)
 
 ```typescript
 hexlify(value: number | bigint | BytesLike | Hexable, options: DataOptions): string
@@ -549,7 +534,7 @@ hexlify(14);
 
   <br/>
 
-#### [`isAddress`](https://eeth.dev/docs/api/modules#isaddress)
+#### [`isAddress`](https://essential-eth.vercel.app/docs/api/modules#isaddress)
 
 ```typescript
 isAddress(address: string): boolean
@@ -582,7 +567,7 @@ isAddress('vitalik.eth');
 
   <br/>
 
-#### [`isBytes`](https://eeth.dev/docs/api/modules#isbytes)
+#### [`isBytes`](https://essential-eth.vercel.app/docs/api/modules#isbytes)
 
 ```typescript
 isBytes(value: any): value
@@ -614,7 +599,7 @@ isBytes(new Uint8Array(1));
 
   <br/>
 
-#### [`isBytesLike`](https://eeth.dev/docs/api/modules#isbyteslike)
+#### [`isBytesLike`](https://essential-eth.vercel.app/docs/api/modules#isbyteslike)
 
 ```typescript
 isBytesLike(value: any): value
@@ -646,7 +631,7 @@ isBytesLike(new Uint8Array(1));
 
   <br/>
 
-#### [`isHexString`](https://eeth.dev/docs/api/modules#ishexstring)
+#### [`isHexString`](https://essential-eth.vercel.app/docs/api/modules#ishexstring)
 
 ```typescript
 isHexString(value: any, length: number): boolean
@@ -674,7 +659,7 @@ isHexString('0x4924', 4);
 
   <br/>
 
-#### [`jsonRpcProvider`](https://eeth.dev/docs/api/modules#jsonrpcprovider)
+#### [`jsonRpcProvider`](https://essential-eth.vercel.app/docs/api/modules#jsonrpcprovider)
 
 ```typescript
 jsonRpcProvider(rpcUrl: string): JsonRpcProvider
@@ -700,7 +685,7 @@ jsonRpcProvider()
 
   <br/>
 
-#### [`keccak256`](https://eeth.dev/docs/api/modules#keccak256)
+#### [`keccak256`](https://essential-eth.vercel.app/docs/api/modules#keccak256)
 
 ```typescript
 keccak256(data: BytesLike): string
@@ -725,7 +710,7 @@ keccak256('0x123');
 
   <br/>
 
-#### [`pack`](https://eeth.dev/docs/api/modules#pack)
+#### [`pack`](https://essential-eth.vercel.app/docs/api/modules#pack)
 
 ```typescript
 pack(types: Array<string>, values: Array<any>): string
@@ -749,7 +734,7 @@ pack(types, values);
 
   <br/>
 
-#### [`solidityKeccak256`](https://eeth.dev/docs/api/modules#soliditykeccak256)
+#### [`solidityKeccak256`](https://essential-eth.vercel.app/docs/api/modules#soliditykeccak256)
 
 ```typescript
 solidityKeccak256(types: Array<string>, values: Array<any>): string
@@ -783,7 +768,7 @@ solidityKeccak256(types, values);
 
   <br/>
 
-#### [`splitSignature`](https://eeth.dev/docs/api/modules#splitsignature)
+#### [`splitSignature`](https://essential-eth.vercel.app/docs/api/modules#splitsignature)
 
 ```typescript
 splitSignature(signature: SignatureLike): Signature
@@ -814,7 +799,7 @@ splitSignature(signature);
 
   <br/>
 
-#### [`stripZeros`](https://eeth.dev/docs/api/modules#stripzeros)
+#### [`stripZeros`](https://essential-eth.vercel.app/docs/api/modules#stripzeros)
 
 ```typescript
 stripZeros(value: BytesLike): Uint8Array
@@ -837,7 +822,7 @@ stripZeros('0x00002834');
 
   <br/>
 
-#### [`tinyBig`](https://eeth.dev/docs/api/modules#tinybig)
+#### [`tinyBig`](https://essential-eth.vercel.app/docs/api/modules#tinybig)
 
 ```typescript
 tinyBig(value: string | number | TinyBig | Big): TinyBig
@@ -859,7 +844,7 @@ tinyBig(10).times(3).toNumber();
 
   <br/>
 
-#### [`toChecksumAddress`](https://eeth.dev/docs/api/modules#tochecksumaddress)
+#### [`toChecksumAddress`](https://essential-eth.vercel.app/docs/api/modules#tochecksumaddress)
 
 ```typescript
 toChecksumAddress(address: string): string
@@ -885,7 +870,7 @@ Similar to ["toChecksumAddress" in web3.js](https://web3js.readthedocs.io/en/v1.
 
   <br/>
 
-#### [`toUtf8Bytes`](https://eeth.dev/docs/api/modules#toutf8bytes)
+#### [`toUtf8Bytes`](https://essential-eth.vercel.app/docs/api/modules#toutf8bytes)
 
 ```typescript
 toUtf8Bytes(data: string): Uint8Array
@@ -910,7 +895,7 @@ toUtf8Bytes('ethereum');
 
   <br/>
 
-#### [`weiToEther`](https://eeth.dev/docs/api/modules#weitoether)
+#### [`weiToEther`](https://essential-eth.vercel.app/docs/api/modules#weitoether)
 
 ```typescript
 weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig
@@ -941,7 +926,7 @@ weiToEther(1000000000000000000000).toNumber();
 
   <br/>
 
-#### [`zeroPad`](https://eeth.dev/docs/api/modules#zeropad)
+#### [`zeroPad`](https://essential-eth.vercel.app/docs/api/modules#zeropad)
 
 ```typescript
 zeroPad(value: BytesLike, length: number): Uint8Array
@@ -1010,7 +995,7 @@ provider.getGasPrice().toNumber();
 
 <!-- ⛔️ AUTO-GENERATED-CONTENT:START (PROVIDER) -->
 
-#### [`call`](https://eeth.dev/docs/api/classes/JsonRpcProvider#call)
+#### [`call`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#call)
 
 ```typescript
 provider.call(transaction: TransactionRequest, blockTag?: BlockTag): Promise<string>
@@ -1036,7 +1021,7 @@ await provider.call({
 
   <br/>
 
-#### [`estimateGas`](https://eeth.dev/docs/api/classes/JsonRpcProvider#estimategas)
+#### [`estimateGas`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#estimategas)
 
 ```typescript
 provider.estimateGas(transaction: TransactionRequest): Promise<TinyBig>
@@ -1064,7 +1049,7 @@ await provider.estimateGas({
 
   <br/>
 
-#### [`getBalance`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getbalance)
+#### [`getBalance`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getbalance)
 
 ```typescript
 provider.getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>
@@ -1087,7 +1072,7 @@ await provider.getBalance('0x7cB57B5A97eAbe94205C07890BE4c1aD31E486A8');
 
   <br/>
 
-#### [`getBlock`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getblock)
+#### [`getBlock`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getblock)
 
 ```typescript
 provider.getBlock(timeFrame?: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>
@@ -1138,7 +1123,7 @@ await provider.getBlock(14879862);
 
   <br/>
 
-#### [`getBlockNumber`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getblocknumber)
+#### [`getBlockNumber`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getblocknumber)
 
 ```typescript
 provider.getBlockNumber(): Promise<number>
@@ -1161,7 +1146,7 @@ await provider.getBlockNumber();
 
   <br/>
 
-#### [`getCode`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getcode)
+#### [`getCode`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getcode)
 
 ```typescript
 provider.getCode(address: string, blockTag?: BlockTag): Promise<string>
@@ -1187,7 +1172,7 @@ await jsonRpcProvider().getCode(
 
   <br/>
 
-#### [`getGasPrice`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getgasprice)
+#### [`getGasPrice`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getgasprice)
 
 ```typescript
 provider.getGasPrice(): Promise<TinyBig>
@@ -1210,7 +1195,7 @@ await provider.getGasPrice();
 
   <br/>
 
-#### [`getLogs`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getlogs)
+#### [`getLogs`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getlogs)
 
 ```typescript
 provider.getLogs(filter: Filter | FilterByBlockHash): Promise<Array<Log>>
@@ -1260,7 +1245,7 @@ provider.getLogs({
 
   <br/>
 
-#### [`getNetwork`](https://eeth.dev/docs/api/classes/JsonRpcProvider#getnetwork)
+#### [`getNetwork`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#getnetwork)
 
 ```typescript
 provider.getNetwork(): Promise<Network>
@@ -1288,7 +1273,7 @@ jsonRpcProvider('https://free-eth-node.com/api/MATIC').getNetwork();
 
   <br/>
 
-#### [`getTransaction`](https://eeth.dev/docs/api/classes/JsonRpcProvider#gettransaction)
+#### [`getTransaction`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#gettransaction)
 
 ```typescript
 provider.getTransaction(transactionHash: string): Promise<TransactionResponse>
@@ -1334,7 +1319,7 @@ await provider.getTransaction(
 
   <br/>
 
-#### [`getTransactionCount`](https://eeth.dev/docs/api/classes/JsonRpcProvider#gettransactioncount)
+#### [`getTransactionCount`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#gettransactioncount)
 
 ```typescript
 provider.getTransactionCount(address: string, blockTag?: BlockTag): Promise<number>
@@ -1375,7 +1360,7 @@ await provider.getTransactionCount(
 
   <br/>
 
-#### [`getTransactionReceipt`](https://eeth.dev/docs/api/classes/JsonRpcProvider#gettransactionreceipt)
+#### [`getTransactionReceipt`](https://essential-eth.vercel.app/docs/api/classes/JsonRpcProvider#gettransactionreceipt)
 
 ```typescript
 provider.getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>
@@ -1510,7 +1495,7 @@ const contract = new Contract(contractAddress, abi, provider);
 
 #### `contractFunctionName(args)`
 
-Any function on a contract. Returns are the same as `ethers.js`, except that instead of BigNumber, `essential-eth` always returns a [`TinyBig`](https://eeth.dev/classes/TinyBig.html)
+Any function on a contract. Returns are the same as `ethers.js`, except that instead of BigNumber, `essential-eth` always returns a [`TinyBig`](https://essential-eth.vercel.app/classes/TinyBig.html)
 
 <br/>
 <br/>
@@ -1543,5 +1528,5 @@ Note: In `web3.js`, almost every method or function can be passed a callback. `e
 
 ### Miscellaneous
 
-- [📓 View full docs](https://eeth.dev)
+- [📓 View full docs](https://essential-eth.vercel.app)
 - [📓 View changelog (by looking at releases diff)](https://github.com/dawsbot/essential-eth/releases)