essential-eth 0.6.2 → 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/dist/esm/utils/compute-address.js

@@ -1,6 +1,7 @@
-import { computePublicKey, toChecksumAddress } from '..';
 import { hexDataSlice } from './bytes';
+import { computePublicKey } from './compute-public-key';
 import { keccak256 } from './keccak256';
+import { toChecksumAddress } from './to-checksum-address';
 export function computeAddress(key) {
     if (!key.startsWith('0x04') &&
         !key.startsWith('0x03') &&

package/dist/esm/utils/hash-message.d.ts

@@ -1,2 +1,2 @@
-import type { Bytes } from '../index';
+import type { Bytes } from './bytes';
 export declare function hashMessage(message: Bytes | string): string;

package/dist/esm/utils/hash-message.js

@@ -1,4 +1,6 @@
-import { concat, keccak256, toUtf8Bytes } from '../index';
+import { concat } from './bytes';
+import { keccak256 } from './keccak256';
+import { toUtf8Bytes } from './to-utf8-bytes';
 const messagePrefix = '\x19Ethereum Signed Message:\n';
 export function hashMessage(message) {
     if (typeof message === 'string') {

package/dist/esm/utils/is-address.js

@@ -1,5 +1,5 @@
-import { toChecksumAddress } from '..';
 import { validateType } from '../shared/validate-type';
+import { toChecksumAddress } from './to-checksum-address';
 export function isAddress(address) {
     validateType(address, ['string']);
     try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS for Ethereum",
-  "version": "0.6.2",
+  "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": {
@@ -47,7 +47,7 @@
     "compile": "npm-run-all --parallel build:esm build:cjs build:umd",
     "build": "rm -rf dist && npm run compile",
     "build:esm": "tsc -p tsconfig.json",
-    "build:cjs": "tsc -p tsconfig-cjs.json",
+    "build:cjs": "swc src -d dist/cjs",
     "build:umd": "microbundle --external none --format umd",
     "build:readme": "bash ./scripts/markdown-magic/build-readme.sh",
     "jest": "jest",
@@ -62,6 +62,8 @@
   },
   "devDependencies": {
     "@size-limit/preset-small-lib": "^7.0.8",
+    "@swc/cli": "^0.1.57",
+    "@swc/core": "^1.3.21",
     "@types/body-parser": "^1.19.1",
     "@types/eslint": "^8.4.2",
     "@types/express": "^4.17.13",
@@ -76,7 +78,7 @@
     "eslint": "^8.16.0",
     "eslint-plugin-jest": "^26.2.2",
     "eslint-plugin-jsdoc": "38.0.2",
-    "ethers": "^5.7.0",
+    "ethers": "^5.7.2",
     "express": "^4.17.1",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
@@ -86,18 +88,18 @@
     "microbundle": "^0.15.0",
     "npm-run-all": "^4.1.5",
     "perf_hooks": "^0.0.1",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.4",
     "prettier-plugin-organize-imports": "^2.3.4",
     "size-limit": "^7.0.8",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
     "typedoc": "^0.22.15",
     "typescript": "^4.6.4",
-    "web3": "^1.7.5"
+    "web3": "^1.8.1"
   },
   "dependencies": {
     "@noble/secp256k1": "^1.5.5",
-    "@types/big.js": "^6.1.5",
+    "@types/big.js": "^6.1.6",
     "big.js": "^6.2.1",
     "isomorphic-unfetch": "^3.1.0",
     "sha3": "^2.1.4"

package/readme.md

@@ -91,6 +91,7 @@
   - [`getBlock`](#getblock)
   - [`getBlockNumber`](#getblocknumber)
   - [`getCode`](#getcode)
+  - [`getFeeData`](#getfeedata)
   - [`getGasPrice`](#getgasprice)
   - [`getLogs`](#getlogs)
   - [`getNetwork`](#getnetwork)
@@ -100,8 +101,12 @@
 - [Contract](#contract)
   - [`contractFunctionName(args)`](#contractfunctionnameargs)
 - [More Info](#more-info)
-  - [Identical vs Similar vs Dissimliar {#isd}](#identical-vs-similar-vs-dissimliar-isd)
+  - [Identical vs Similar vs Dissimilar {#isd}](#identical-vs-similar-vs-dissimilar-isd)
   - [Miscellaneous](#miscellaneous)
+  - [GitPOAP](#gitpoap)
+    - [What is a GitPOAP?](#what-is-a-gitpoap)
+    - [How can I claim?](#how-can-i-claim)
+    - [What issues should I start on first?](#what-issues-should-i-start-on-first)
 
 </details>
 
@@ -124,7 +129,7 @@ Browsers:
 
 ```html
 <!-- index.html -->
-<script src="https://unpkg.com/essential-eth@0.6.2"></script>
+<script src="https://unpkg.com/essential-eth@0.8.0"></script>
 ```
 
 <!-- ⛔️ AUTO-GENERATED-CONTENT:END (UNPKG_SCRIPT_TAG) -->
@@ -1191,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
@@ -1473,6 +1506,7 @@ Decoding support:
 - `uint256`
 - `bytes32`
 - `uint8`
+- `string` (only if there is one string output, not multiple yet)
 
 _Assume all types outside the above types will break for now_
 
@@ -1535,7 +1569,7 @@ Any function on a contract. Returns are the same as `ethers.js`, except that ins
 
 <br/>
 
-### Identical vs Similar vs Dissimliar {#isd}
+### Identical vs Similar vs Dissimilar {#isd}
 
 Throughout the documentation for `essential-eth`, you may notice that some functions are compared to `ethers.js` and `web3.js`. The keywords `identical`, `similar`, and `dissimilar` are used to help you migrate to `essential-eth`. Here's a guide on what these keywords mean:
 
@@ -1549,3 +1583,29 @@ Note: In `web3.js`, almost every method or function can be passed a callback. `e
 
 - [📓 View full docs](https://eeth.dev)
 - [📓 View changelog (by looking at releases diff)](https://github.com/dawsbot/essential-eth/releases)
+
+### GitPOAP
+
+In partnership with GitPOAP, Essential ETH wants to recognize **all** contributors for their contributions toward the growth of this library. Developers can validate their contributions on Github and showcase their GitPOAP as proof-of-work toward their Web3 identity.
+
+<br/>
+
+![Alt](https://www.gitpoap.io/_next/image?url=https%3A%2F%2Fassets.poap.xyz%2Fgitpoap3a-2023-essential-eth-contributor-2022-logo-1670961141021.png&w=750&q=75)
+
+<br/>
+
+#### What is a GitPOAP?
+
+GitPOAP is a contributor recognition platform built on top of the POAP Protocol (Proof of Attendance Protocol). Similar to a POAP, each GitPOAP represents a digital collectible. It serves as a badge of validation for the action taken by the individual. By serving as a bridge between Github and Web3, it allows repo maintainers to recognize contributors for their meaningful contributions. Learn more about GitPOAP, [here](https://www.gitpoap.io/).
+
+#### How can I claim?
+
+Here are two steps that you can take to qualify for a GitPOAP:
+
+1. Contribute to [any open issue](https://github.com/dawsbot/essential-eth/issues) and submit a PR. Upon approval of PR merge, the GitPOAP will automatically be issued to the Github account.
+
+2. Head to gitpoap.io and connect your GitHub account to mint!
+
+#### What issues should I start on first?
+
+We have set up a GitHub project [here](https://github.com/dawsbot/essential-eth/projects/1) for you to see all the issues by priority.