essential-eth 0.4.9 → 0.5.0

package/lib/cjs/utils/wei-to-ether.js

@@ -4,26 +4,26 @@ exports.weiToEther = void 0;
 const tiny_big_1 = require("../shared/tiny-big/tiny-big");
 const validate_type_1 = require("../shared/validate-type");
 /**
- * Convert from Ether to Wei
+ * Convert from Wei to Ether
  *
- * Similar to ["formatEther" in ethers.js](https://docs.ethers.io/v4/api-utils.html#ether-strings-and-wei)
+ * Similar to ["formatEther" in ethers.js](https://docs.ethers.io/v5/api/utils/display-logic/#utils-formatEther)
  *
- * Similar to ["fromWei" in web3](https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html#fromwei)
+ * Similar to ["fromWei" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#fromwei)
  *
  * @example
  * ```javascript
- * etherToWei('1000').toString()
- * // '1000000000000000000000'
- * etherToWei(1000).toString()
- * '1000000000000000000000'
+ * weiToEther('1000000000000000000000').toString()
+ * // '1000'
+ * weiToEther(1000000000000000000000).toString()
+ * // '1000'
  * ```
  *
  * @example
  * ```javascript
- * etherToWei('1000').toNumber()
- * // 1000000000000000000000
- * etherToWei(1000).toNumber()
- * // 1000000000000000000000
+ * weiToEther('1000000000000000000000').toNumber()
+ * // 1000
+ * weiToEther(1000000000000000000000).toNumber()
+ * // 1000
  * ```
  */
 function weiToEther(weiQuantity) {

package/lib/esm/classes/utils/clean-block.d.ts

@@ -1,3 +1,3 @@
-import { Block } from '../..';
+import { BlockResponse } from '../..';
 import { RPCBlock } from '../../types/Block.types';
-export declare function cleanBlock(block: RPCBlock, returnTransactionObjects: boolean): Block;
+export declare function cleanBlock(block: RPCBlock, returnTransactionObjects: boolean): BlockResponse;

package/lib/esm/classes/utils/clean-block.js

@@ -27,7 +27,8 @@ export function cleanBlock(block, returnTransactionObjects) {
         }
     });
     if (returnTransactionObjects) {
-        cleanedBlock.transactions.forEach((transaction, index) => {
+        const txns = block.transactions;
+        txns.forEach((transaction, index) => {
             cleanedBlock.transactions[index] = cleanTransaction(transaction);
         });
     }

package/lib/esm/classes/utils/clean-transaction.d.ts

@@ -1,2 +1,2 @@
-import { RPCTransaction, Transaction } from '../../types/Transaction.types';
-export declare function cleanTransaction(transaction: RPCTransaction): Transaction;
+import { RPCTransaction, TransactionResponse } from '../../types/Transaction.types';
+export declare function cleanTransaction(transaction: RPCTransaction): TransactionResponse;

package/lib/esm/classes/utils/clean-transaction.js

@@ -1,4 +1,4 @@
-import { toChecksumAddress } from '../..';
+import { tinyBig, toChecksumAddress } from '../..';
 import { hexToDecimal } from './hex-to-decimal';
 export function cleanTransaction(transaction) {
     const cleanedTransaction = Object.assign({}, transaction);
@@ -7,22 +7,26 @@ export function cleanTransaction(transaction) {
             return;
         switch (key) {
             case 'blockNumber':
-            case 'gas':
+            case 'chainId':
             case 'nonce':
             case 'transactionIndex':
             case 'type':
+            case 'v':
                 cleanedTransaction[key] = Number(hexToDecimal(transaction[key]));
                 break;
-            case 'gasPrice':
-            case 'value':
-                cleanedTransaction[key] = hexToDecimal(transaction[key]);
-                break;
             case 'from':
             case 'to':
                 if (transaction[key]) {
                     cleanedTransaction[key] = toChecksumAddress(transaction[key]);
                 }
                 break;
+            case 'value':
+            case 'gas':
+            case 'gasPrice':
+            case 'maxFeePerGas':
+            case 'maxPriorityFeePerGas':
+                cleanedTransaction[key] = tinyBig(hexToDecimal(transaction[key]));
+                break;
         }
     });
     return cleanedTransaction;

package/lib/esm/classes/utils/fetchers.d.ts

@@ -1,9 +1,9 @@
 export declare function post(url: string, body: Record<string, unknown>): Promise<any>;
-declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice';
-export declare function buildRPCPostBody(method: RPCMethodName, params: any[]): {
+declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash';
+export declare function buildRPCPostBody(method: RPCMethodName, params: unknown[]): {
     jsonrpc: string;
     id: number;
     method: RPCMethodName;
-    params: any[];
+    params: unknown[];
 };
 export {};

package/lib/esm/index.d.ts

@@ -1,12 +1,15 @@
 import { Contract } from './classes/Contract';
 import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
-import { Block } from './types/Block.types';
+import { BlockResponse } from './types/Block.types';
 import { ContractTypes, JSONABI, JSONABIArgument } from './types/Contract.types';
 import { Network } from './types/Network.types';
-import { Transaction } from './types/Transaction.types';
+import { TransactionResponse } from './types/Transaction.types';
+import { etherToGwei } from './utils/ether-to-gwei';
 import { etherToWei } from './utils/ether-to-wei';
+import { gweiToEther } from './utils/gwei-to-ether';
+import { hexZeroPad } from './utils/hex-zero-pad';
 import { isAddress } from './utils/is-address';
 import { toChecksumAddress } from './utils/to-checksum-address';
 import { weiToEther } from './utils/wei-to-ether';
-export { etherToWei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, Contract, TinyBig, Block, ContractTypes, JSONABI, JSONABIArgument, Network, Transaction, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hexZeroPad, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };

package/lib/esm/index.js

@@ -1,8 +1,11 @@
 import { Contract } from './classes/Contract';
 import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
+import { etherToGwei } from './utils/ether-to-gwei';
 import { etherToWei } from './utils/ether-to-wei';
+import { gweiToEther } from './utils/gwei-to-ether';
+import { hexZeroPad } from './utils/hex-zero-pad';
 import { isAddress } from './utils/is-address';
 import { toChecksumAddress } from './utils/to-checksum-address';
 import { weiToEther } from './utils/wei-to-ether';
-export { etherToWei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, Contract, TinyBig, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hexZeroPad, Contract, TinyBig, };

package/lib/esm/providers/JsonRpcProvider.d.ts

@@ -1,11 +1,15 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
-import { Block } from '../types/Block.types';
+import { BlockResponse, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
+import { TransactionResponse } from '../types/Transaction.types';
 export declare class JsonRpcProvider {
     readonly _rpcUrl: string;
+    private post;
     constructor(rpcUrl?: string);
-    getBlock(timeFrame: 'latest' | 'earliest' | 'pending' | number, returnTransactionObjects?: boolean): Promise<Block>;
+    getBlock(timeFrame: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
     getNetwork(): Promise<Network>;
     getGasPrice(): Promise<TinyBig>;
+    getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
+    getTransaction(hash: string): Promise<TransactionResponse>;
 }
 export declare function jsonRpcProvider(rpcUrl?: string): JsonRpcProvider;

package/lib/esm/providers/JsonRpcProvider.js

@@ -8,12 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { cleanBlock } from '../classes/utils/clean-block';
+import { cleanTransaction } from '../classes/utils/clean-transaction';
 import { buildRPCPostBody, post } from '../classes/utils/fetchers';
 import { hexToDecimal } from '../classes/utils/hex-to-decimal';
 import { tinyBig } from '../shared/tiny-big/tiny-big';
 import chainsInfo from './utils/chains-info';
 export class JsonRpcProvider {
     constructor(rpcUrl) {
+        this.post = (body) => post(this._rpcUrl, body);
         this._rpcUrl = rpcUrl || 'https://free-eth-node.com/api/eth';
     }
     getBlock(timeFrame, returnTransactionObjects = false) {
@@ -25,23 +27,17 @@ export class JsonRpcProvider {
             else {
                 rpcTimeFrame = timeFrame;
             }
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield post(this._rpcUrl, buildRPCPostBody('eth_getBlockByNumber', [
-                    rpcTimeFrame,
-                    returnTransactionObjects,
-                ]));
-            });
-            const nodeResponse = (yield req());
-            return cleanBlock(nodeResponse, returnTransactionObjects);
+            const rpcBlock = (yield this.post(buildRPCPostBody('eth_getBlockByNumber', [
+                rpcTimeFrame,
+                returnTransactionObjects,
+            ])));
+            return cleanBlock(rpcBlock, returnTransactionObjects);
         });
     }
     getNetwork() {
         return __awaiter(this, void 0, void 0, function* () {
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield post(this._rpcUrl, buildRPCPostBody('eth_chainId', []));
-            });
-            const nodeResponse = (yield req());
-            const chainId = hexToDecimal(nodeResponse);
+            const hexChainId = (yield this.post(buildRPCPostBody('eth_chainId', [])));
+            const chainId = hexToDecimal(hexChainId);
             const info = chainsInfo[chainId];
             return {
                 chainId: Number(chainId),
@@ -52,11 +48,26 @@ export class JsonRpcProvider {
     }
     getGasPrice() {
         return __awaiter(this, void 0, void 0, function* () {
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield post(this._rpcUrl, buildRPCPostBody('eth_gasPrice', []));
-            });
-            const nodeResponse = (yield req());
-            return tinyBig(hexToDecimal(nodeResponse));
+            const hexGasPrice = (yield this.post(buildRPCPostBody('eth_gasPrice', [])));
+            return tinyBig(hexToDecimal(hexGasPrice));
+        });
+    }
+    getBalance(address, blockTag = 'latest') {
+        return __awaiter(this, void 0, void 0, function* () {
+            const hexBalance = (yield this.post(buildRPCPostBody('eth_getBalance', [address, blockTag])));
+            return tinyBig(hexToDecimal(hexBalance));
+        });
+    }
+    getTransaction(hash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [rpcTransaction, blockNumber] = yield Promise.all([
+                this.post(buildRPCPostBody('eth_getTransactionByHash', [hash])),
+                this.getBlock('latest'),
+            ]);
+            const cleanedTransaction = cleanTransaction(rpcTransaction);
+            cleanedTransaction.confirmations =
+                blockNumber.number - cleanedTransaction.blockNumber + 1;
+            return cleanedTransaction;
         });
     }
 }

package/lib/esm/providers/test/rpc-urls.d.ts

@@ -1,3 +1,10 @@
 export declare const fakeUrls: {
     readonly notRPCButRealHttp: "https://httpstat.us/200";
 };
+export declare const rpcUrls: {
+    mainnet: string;
+    gno: string;
+    bnb: string;
+    arb1: string;
+    gor: string;
+};

package/lib/esm/providers/test/rpc-urls.js

@@ -1,3 +1,10 @@
 export const fakeUrls = {
     notRPCButRealHttp: 'https://httpstat.us/200',
 };
+export const rpcUrls = {
+    mainnet: `${process.env.RPC_ORIGIN}/api/eth`,
+    gno: `${process.env.RPC_ORIGIN}/api/gno`,
+    bnb: `${process.env.RPC_ORIGIN}/api/bnb`,
+    arb1: `${process.env.RPC_ORIGIN}/api/arb1`,
+    gor: `${process.env.RPC_ORIGIN}/api/gor`,
+};

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

@@ -66,7 +66,9 @@ declare const _default: {
     "76": string[];
     "77": string[];
     "78": string[];
+    "79": string[];
     "80": string[];
+    "81": string[];
     "82": string[];
     "83": string[];
     "85": string[];
@@ -123,6 +125,7 @@ declare const _default: {
     "262": string[];
     "269": string[];
     "288": string[];
+    "300": string[];
     "321": string[];
     "322": string[];
     "333": string[];
@@ -146,6 +149,7 @@ declare const _default: {
     "600": string[];
     "666": string[];
     "686": string[];
+    "700": string[];
     "707": string[];
     "708": string[];
     "721": string[];
@@ -169,6 +173,7 @@ declare const _default: {
     "999": string[];
     "1001": string[];
     "1007": string[];
+    "1008": string[];
     "1010": string[];
     "1012": string[];
     "1022": string[];
@@ -197,6 +202,7 @@ declare const _default: {
     "1688": string[];
     "1856": string[];
     "1898": string[];
+    "1984": string[];
     "1987": string[];
     "2001": string[];
     "2020": string[];
@@ -205,6 +211,8 @@ declare const _default: {
     "2025": string[];
     "2100": string[];
     "2101": string[];
+    "2152": string[];
+    "2153": string[];
     "2213": string[];
     "2221": string[];
     "2559": string[];
@@ -259,6 +267,7 @@ declare const _default: {
     "16000": string[];
     "16001": string[];
     "19845": string[];
+    "21337": string[];
     "21816": string[];
     "24484": string[];
     "24734": string[];
@@ -288,6 +297,7 @@ declare const _default: {
     "62320": string[];
     "63000": string[];
     "63001": string[];
+    "69420": string[];
     "70000": string[];
     "70001": string[];
     "70002": string[];

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

@@ -204,9 +204,15 @@ export default {
     "78": [
         "primuschain"
     ],
+    "79": [
+        "zenith"
+    ],
     "80": [
         "GeneChain"
     ],
+    "81": [
+        "VIL"
+    ],
     "82": [
         "Meter"
     ],
@@ -375,6 +381,9 @@ export default {
     "288": [
         "Boba"
     ],
+    "300": [
+        "ogc"
+    ],
     "321": [
         "kcs"
     ],
@@ -444,6 +453,9 @@ export default {
     "686": [
         "kar"
     ],
+    "700": [
+        "SNS"
+    ],
     "707": [
         "bcs"
     ],
@@ -513,6 +525,9 @@ export default {
     "1007": [
         "tnew"
     ],
+    "1008": [
+        "eun"
+    ],
     "1010": [
         "EVC"
     ],
@@ -577,7 +592,7 @@ export default {
         "mrock"
     ],
     "1337": [
-        "cennz-a"
+        "cennz-old"
     ],
     "1618": [
         "cate"
@@ -597,6 +612,9 @@ export default {
     "1898": [
         "boya"
     ],
+    "1984": [
+        "euntest"
+    ],
     "1987": [
         "egem"
     ],
@@ -621,6 +639,12 @@ export default {
     "2101": [
         "esp"
     ],
+    "2152": [
+        "fra"
+    ],
+    "2153": [
+        "findora-testnet"
+    ],
     "2213": [
         "evanesco"
     ],
@@ -783,6 +807,9 @@ export default {
     "19845": [
         "btcix"
     ],
+    "21337": [
+        "cennz-a"
+    ],
     "21816": [
         "oml"
     ],
@@ -870,6 +897,9 @@ export default {
     "63001": [
         "ecs-testnet"
     ],
+    "69420": [
+        "cndr"
+    ],
     "70000": [
         "TKM0"
     ],

package/lib/esm/shared/tiny-big/tiny-big.js

@@ -2,7 +2,13 @@ import Big from 'big.js';
 import { scientificStrToDecimalStr } from './helpers';
 export class TinyBig extends Big {
     constructor(value) {
-        super(value);
+        try {
+            super(value);
+        }
+        catch (e) {
+            console.error(`TinyBig cannot parse value (value=${value})`);
+            throw e;
+        }
     }
     toHexString() {
         return `0x${BigInt(this.toString()).toString(16)}`;

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

@@ -1,27 +1,14 @@
-import { RPCTransaction, Transaction } from './Transaction.types';
-export interface Block {
-    baseFeePerGas: string;
-    difficulty: number;
-    extraData: string;
+import { BlockTransactionResponse, RPCTransaction } from './Transaction.types';
+declare type Modify<T, R> = Omit<T, keyof R> & R;
+export declare type BlockResponse = Modify<RPCBlock, {
     gasLimit: number;
     gasUsed: number;
-    hash: string;
-    logsBloom: string;
-    miner: string;
-    mixHash: string;
-    nonce: string;
     number: number;
-    parentHash: string;
-    receiptsRoot: string;
-    sha3Uncles: string;
     size: number;
-    stateRoot: string;
     timestamp: number;
-    totalDifficulty: number;
-    transactions: string[] | Transaction[];
-    transactionsRoot: string;
-    uncles: unknown[];
-}
+    baseFeePerGas: number;
+    transactions: Array<string | BlockTransactionResponse>;
+}>;
 export interface RPCBlock {
     baseFeePerGas: string;
     difficulty: string;
@@ -45,3 +32,5 @@ export interface RPCBlock {
     transactionsRoot: string;
     uncles: unknown[];
 }
+export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
+export {};

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

@@ -1,23 +1,30 @@
-export interface Transaction {
-    blockHash: string;
+import { TinyBig } from '../shared/tiny-big/tiny-big';
+declare type Modify<T, R> = Omit<T, keyof R> & R;
+export interface RPCTransaction extends RPCBlockTransaction {
+    maxFeePerGas: string;
+    maxPriorityFeePerGas: string;
+}
+export declare type TransactionResponse = Modify<RPCTransaction, {
     blockNumber: number;
-    from: string;
-    gas: number;
-    gasPrice: string;
-    hash: string;
-    input: string;
+    chainId: number;
     nonce: number;
-    r: string;
-    s: string;
-    to: string;
     transactionIndex: number;
     type: number;
-    v: string;
-    value: string;
-}
-export interface RPCTransaction {
+    v: number;
+    value: TinyBig;
+    gasPrice: TinyBig;
+    gas: TinyBig;
+    gasLimit: TinyBig;
+} & {
+    maxFeePerGas: TinyBig;
+    maxPriorityFeePerGas: TinyBig;
+    confirmations: number;
+}>;
+export declare type BlockTransactionResponse = Omit<TransactionResponse, 'maxFeePerGas' | 'maxPriorityFeePerGas'>;
+export interface RPCBlockTransaction {
     blockHash: string;
     blockNumber: string;
+    chainId: string;
     from: string;
     gas: string;
     gasPrice: string;
@@ -32,3 +39,4 @@ export interface RPCTransaction {
     v: string;
     value: string;
 }
+export {};

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/hex-zero-pad.d.ts

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

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

@@ -0,0 +1,17 @@
+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')}`;
+}

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",
+  "version": "0.5.0",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -36,13 +36,13 @@
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
     "@types/prettier": "^2.4.4",
-    "@typescript-eslint/eslint-plugin": "^5.17.0",
-    "@typescript-eslint/parser": "^5.17.0",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
-    "eslint": "^8.12.0",
-    "eslint-plugin-jest": "^26.1.3",
-    "ethers": "^5.6.2",
+    "eslint": "^8.13.0",
+    "eslint-plugin-jest": "^26.1.4",
+    "ethers": "^5.6.3",
     "express": "^4.17.1",
     "husky": "^4.3.0",
     "jest": "^27.5.1",
@@ -56,7 +56,7 @@
     "ts-node": "^10.2.1",
     "typedoc": "^0.22.13",
     "typescript": "^4.6.3",
-    "web3": "^1.7.1"
+    "web3": "^1.7.3"
   },
   "dependencies": {
     "@types/big.js": "^6.1.3",