essential-eth 0.5.6 → 0.5.9

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

@@ -0,0 +1,34 @@
+import Big from 'big.js';
+import { TinyBig } from '../../shared/tiny-big/tiny-big';
+import { hexlify } from '../../utils/bytes';
+export function prepareTransaction(transaction) {
+    const preparedTransaction = Object.assign({}, transaction);
+    Object.keys(transaction).forEach((key) => {
+        switch (key) {
+            case 'gas':
+            case 'gasPrice':
+            case 'nonce':
+            case 'maxFeePerGas':
+            case 'maxPriorityFeePerGas':
+            case 'value': {
+                const value = transaction[key];
+                if (value instanceof TinyBig) {
+                    preparedTransaction[key] = value.toHexString();
+                }
+                else if (value instanceof Big) {
+                    preparedTransaction[key] = `0x${BigInt(value.toString()).toString(16)}`;
+                }
+                else if (typeof transaction[key] === 'number')
+                    preparedTransaction[key] =
+                        '0x' + transaction[key].toString(16);
+                else
+                    preparedTransaction[key] = transaction[key].toString();
+                break;
+            }
+            case 'data':
+                preparedTransaction[key] = hexlify(transaction[key]);
+                break;
+        }
+    });
+    return preparedTransaction;
+}

package/lib/esm/index.d.ts

@@ -4,8 +4,9 @@ import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag, RPCBlock } from './types/Block.types';
 import { ContractTypes, JSONABI, JSONABIArgument } from './types/Contract.types';
+import { Filter, FilterByBlockHash } from './types/Filter.types';
 import { Network } from './types/Network.types';
-import { BlockTransactionResponse, Log, RPCLog, RPCTransaction, RPCTransactionReceipt, TransactionReceipt, TransactionResponse } from './types/Transaction.types';
+import { BlockTransactionResponse, Log, RPCLog, RPCTransaction, RPCTransactionReceipt, RPCTransactionRequest, TransactionReceipt, TransactionRequest, TransactionResponse } from './types/Transaction.types';
 import { computeAddress } from './utils/compute-address';
 import { computePublicKey } from './utils/compute-public-key';
 import { etherToGwei } from './utils/ether-to-gwei';
@@ -17,9 +18,8 @@ import { splitSignature } from './utils/split-signature';
 import { toChecksumAddress } from './utils/to-checksum-address';
 import { toUtf8Bytes } from './utils/to-utf8-bytes';
 import { weiToEther } from './utils/wei-to-ether';
-export * from './providers/types';
 export * from './utils/bytes';
 export * from './utils/hash-message';
 export * from './utils/keccak256';
 export * from './utils/solidity-keccak256';
-export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hashMessage, splitSignature, toUtf8Bytes, computeAddress, computePublicKey, Contract, TinyBig, BaseContract, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, RPCBlock, RPCTransaction, RPCTransactionReceipt, TransactionReceipt, BlockTag, RPCLog, Log, BlockTransactionResponse, ConstructorOptions, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hashMessage, splitSignature, toUtf8Bytes, computeAddress, computePublicKey, Contract, TinyBig, BaseContract, BlockResponse, ContractTypes, Filter, FilterByBlockHash, JSONABI, JSONABIArgument, Network, TransactionResponse, RPCBlock, RPCTransaction, RPCTransactionReceipt, TransactionRequest, RPCTransactionRequest, TransactionReceipt, BlockTag, RPCLog, Log, BlockTransactionResponse, ConstructorOptions, };

package/lib/esm/index.js

@@ -13,7 +13,6 @@ import { splitSignature } from './utils/split-signature';
 import { toChecksumAddress } from './utils/to-checksum-address';
 import { toUtf8Bytes } from './utils/to-utf8-bytes';
 import { weiToEther } from './utils/wei-to-ether';
-export * from './providers/types';
 export * from './utils/bytes';
 export * from './utils/hash-message';
 export * from './utils/keccak256';

package/lib/esm/logger/package-version.d.ts

@@ -1 +1 @@
-export declare const version = "0.5.6";
+export declare const version = "0.5.9";

package/lib/esm/logger/package-version.js

@@ -1 +1 @@
-export const version = '0.5.6';
+export const version = '0.5.9';

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

@@ -1,8 +1,8 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag } from '../types/Block.types';
+import { Filter, FilterByBlockHash } from '../types/Filter.types';
 import { Network } from '../types/Network.types';
-import { TransactionReceipt, TransactionResponse } from '../types/Transaction.types';
-import { TransactionRequest } from './types';
+import { Log, TransactionReceipt, TransactionRequest, TransactionResponse } from '../types/Transaction.types';
 export declare abstract class BaseProvider {
     abstract selectRpcUrl(): string;
     abstract post(body: Record<string, unknown>): Promise<any>;
@@ -17,5 +17,8 @@ export declare abstract class BaseProvider {
     getBlock(timeFrame?: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
     getGasPrice(): Promise<TinyBig>;
     getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
+    getCode(address: string, blockTag?: BlockTag): Promise<string>;
     estimateGas(transaction: TransactionRequest): Promise<TinyBig>;
+    getLogs(filter: Filter | FilterByBlockHash): Promise<Array<Log>>;
+    call(transaction: TransactionRequest, blockTag?: BlockTag): Promise<string>;
 }

package/lib/esm/providers/BaseProvider.js

@@ -8,12 +8,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { cleanBlock } from '../classes/utils/clean-block';
+import { cleanLog } from '../classes/utils/clean-log';
 import { cleanTransaction } from '../classes/utils/clean-transaction';
 import { cleanTransactionReceipt } from '../classes/utils/clean-transaction-receipt';
 import { buildRPCPostBody, post } from '../classes/utils/fetchers';
 import { hexToDecimal } from '../classes/utils/hex-to-decimal';
+import { prepareTransaction } from '../classes/utils/prepare-transaction';
+import { logger } from '../logger/logger';
 import { tinyBig } from '../shared/tiny-big/tiny-big';
 import chainsInfo from './utils/chains-info';
+function prepBlockTag(blockTag) {
+    return typeof blockTag === 'number'
+        ? tinyBig(blockTag).toHexString()
+        : blockTag;
+}
 export class BaseProvider {
     constructor(rpcUrls) {
         this._rpcUrls = [];
@@ -64,29 +72,22 @@ export class BaseProvider {
     }
     getTransactionCount(address, blockTag = 'latest') {
         return __awaiter(this, void 0, void 0, function* () {
-            if (typeof blockTag === 'number') {
-                blockTag = `0x${blockTag.toString(16)}`;
-            }
+            blockTag = prepBlockTag(blockTag);
             const transactionCount = (yield this.post(buildRPCPostBody('eth_getTransactionCount', [address, blockTag])));
             return Number(hexToDecimal(transactionCount));
         });
     }
     getBlock(timeFrame = 'latest', returnTransactionObjects = false) {
         return __awaiter(this, void 0, void 0, function* () {
-            let rpcTimeFrame;
             let type = 'Number';
-            if (typeof timeFrame === 'number') {
-                rpcTimeFrame = `0x${timeFrame.toString(16)}`;
-            }
-            else if (timeFrame.startsWith('0x')) {
-                rpcTimeFrame = timeFrame;
+            if (typeof timeFrame === 'string' && timeFrame.length === 66) {
                 type = 'Hash';
             }
             else {
-                rpcTimeFrame = timeFrame;
+                timeFrame = prepBlockTag(timeFrame);
             }
             const rpcBlock = (yield this.post(buildRPCPostBody(`eth_getBlockBy${type}`, [
-                rpcTimeFrame,
+                timeFrame,
                 returnTransactionObjects,
             ])));
             return cleanBlock(rpcBlock, returnTransactionObjects);
@@ -100,15 +101,57 @@ export class BaseProvider {
     }
     getBalance(address, blockTag = 'latest') {
         return __awaiter(this, void 0, void 0, function* () {
+            blockTag = prepBlockTag(blockTag);
             const hexBalance = (yield this.post(buildRPCPostBody('eth_getBalance', [address, blockTag])));
             return tinyBig(hexToDecimal(hexBalance));
         });
     }
+    getCode(address, blockTag = 'latest') {
+        return __awaiter(this, void 0, void 0, function* () {
+            blockTag = prepBlockTag(blockTag);
+            const contractCode = (yield this.post(buildRPCPostBody('eth_getCode', [address, blockTag])));
+            return contractCode;
+        });
+    }
     estimateGas(transaction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const body = buildRPCPostBody('eth_estimateGas', [transaction]);
-            const gasUsed = (yield this.post(body));
+            const rpcTransaction = prepareTransaction(transaction);
+            const gasUsed = (yield this.post(buildRPCPostBody('eth_estimateGas', [rpcTransaction])));
             return tinyBig(hexToDecimal(gasUsed));
         });
     }
+    getLogs(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filterByRange = filter;
+            if (filterByRange.fromBlock)
+                filterByRange.fromBlock = prepBlockTag(filterByRange.fromBlock);
+            if (filterByRange.toBlock)
+                filterByRange.toBlock = prepBlockTag(filterByRange.toBlock);
+            const rpcLogs = (yield this.post(buildRPCPostBody('eth_getLogs', [filter])));
+            const logs = rpcLogs.map((log) => cleanLog(log, false));
+            return logs;
+        });
+    }
+    call(transaction, blockTag = 'latest') {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (transaction.gasPrice &&
+                (transaction.maxPriorityFeePerGas || transaction.maxFeePerGas)) {
+                logger.throwError('Cannot specify both "gasPrice" and ("maxPriorityFeePerGas" or "maxFeePerGas")', {
+                    gasPrice: transaction.gasPrice,
+                    maxFeePerGas: transaction.maxFeePerGas,
+                    maxPriorityFeePerGas: transaction.maxPriorityFeePerGas,
+                });
+            }
+            if (transaction.maxFeePerGas && transaction.maxPriorityFeePerGas) {
+                logger.throwError('Cannot specify both "maxFeePerGas" and "maxPriorityFeePerGas"', {
+                    maxFeePerGas: transaction.maxFeePerGas,
+                    maxPriorityFeePerGas: transaction.maxPriorityFeePerGas,
+                });
+            }
+            blockTag = prepBlockTag(blockTag);
+            const rpcTransaction = prepareTransaction(transaction);
+            const transactionRes = (yield this.post(buildRPCPostBody('eth_call', [rpcTransaction, blockTag])));
+            return transactionRes;
+        });
+    }
 }

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

@@ -203,6 +203,8 @@ declare const _default: {
     "1287": string[];
     "1288": string[];
     "1337": string[];
+    "1506": string[];
+    "1507": string[];
     "1618": string[];
     "1620": string[];
     "1657": string[];
@@ -243,6 +245,7 @@ declare const _default: {
     "3967": string[];
     "4002": string[];
     "4102": string[];
+    "4181": string[];
     "4689": string[];
     "4690": string[];
     "4918": string[];
@@ -277,6 +280,8 @@ declare const _default: {
     "10001": string[];
     "10101": string[];
     "10823": string[];
+    "10946": string[];
+    "10947": string[];
     "11111": string[];
     "11437": string[];
     "12051": string[];
@@ -290,6 +295,7 @@ declare const _default: {
     "22023": string[];
     "24484": string[];
     "24734": string[];
+    "26863": string[];
     "30067": string[];
     "31102": string[];
     "31337": string[];
@@ -325,6 +331,8 @@ declare const _default: {
     "70002": string[];
     "70103": string[];
     "71393": string[];
+    "71401": string[];
+    "71402": string[];
     "73799": string[];
     "78110": string[];
     "80001": string[];
@@ -361,7 +369,9 @@ declare const _default: {
     "333888": string[];
     "333999": string[];
     "421611": string[];
+    "432201": string[];
     "444900": string[];
+    "474142": string[];
     "512512": string[];
     "666666": string[];
     "888888": string[];
@@ -369,6 +379,7 @@ declare const _default: {
     "1313114": string[];
     "1313500": string[];
     "1337702": string[];
+    "1337802": string[];
     "2203181": string[];
     "7762959": string[];
     "11155111": string[];

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

@@ -615,6 +615,12 @@ export default {
     "1337": [
         "cennz-old"
     ],
+    "1506": [
+        "Sherpax"
+    ],
+    "1507": [
+        "Sherpax Testnet"
+    ],
     "1618": [
         "cate"
     ],
@@ -735,6 +741,9 @@ export default {
     "4102": [
         "aioz-testnet"
     ],
+    "4181": [
+        "PHI"
+    ],
     "4689": [
         "iotex-mainnet"
     ],
@@ -837,6 +846,12 @@ export default {
     "10823": [
         "CCP"
     ],
+    "10946": [
+        "quadrans"
+    ],
+    "10947": [
+        "quadranstestnet"
+    ],
     "11111": [
         "WAGMI"
     ],
@@ -876,6 +891,9 @@ export default {
     "24734": [
         "mintme"
     ],
+    "26863": [
+        "OAC"
+    ],
     "30067": [
         "Piece"
     ],
@@ -981,6 +999,12 @@ export default {
     "71393": [
         "ckb"
     ],
+    "71401": [
+        "gw-testnet-v1"
+    ],
+    "71402": [
+        "gw-mainnet-v1"
+    ],
     "73799": [
         "vt"
     ],
@@ -1089,9 +1113,15 @@ export default {
     "421611": [
         "arb-rinkeby"
     ],
+    "432201": [
+        "Dexalot"
+    ],
     "444900": [
         "wlkt"
     ],
+    "474142": [
+        "oc"
+    ],
     "512512": [
         "cmp"
     ],
@@ -1113,6 +1143,9 @@ export default {
     "1337702": [
         "kintsugi"
     ],
+    "1337802": [
+        "kiln"
+    ],
     "2203181": [
         "platondev"
     ],
@@ -1228,6 +1261,6 @@ export default {
         "mole"
     ],
     "868455272153094": [
-        "gw-testnet-v1"
+        "gw-testnet-v1-deprecated"
     ]
 };

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

@@ -1,7 +1,11 @@
 import Big from 'big.js';
+import { hexToDecimal } from '../../classes/utils/hex-to-decimal';
 import { scientificStrToDecimalStr } from './helpers';
 export class TinyBig extends Big {
     constructor(value) {
+        if (typeof value === 'string' && value.startsWith('0x')) {
+            value = hexToDecimal(value);
+        }
         super(value);
         this.padAndChop = (str, padChar, length) => {
             return (Array(length).fill(padChar).join('') + str).slice(length * -1);

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

@@ -1,12 +1,16 @@
+import { TinyBig } from './../shared/tiny-big/tiny-big';
 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;
+    baseFeePerGas: TinyBig;
+    difficulty: TinyBig;
+    gasLimit: TinyBig;
+    gasUsed: TinyBig;
+    nonce: TinyBig;
     number: number;
-    size: number;
-    timestamp: number;
-    baseFeePerGas: number;
+    size: TinyBig;
+    timestamp: TinyBig;
+    totalDifficulty: TinyBig;
     transactions: Array<string | BlockTransactionResponse>;
 }>;
 export interface RPCBlock {
@@ -28,9 +32,9 @@ export interface RPCBlock {
     stateRoot: string;
     timestamp: string;
     totalDifficulty: string;
-    transactions: Array<string> | Array<RPCTransaction>;
+    transactions: Array<string | RPCTransaction>;
     transactionsRoot: string;
-    uncles: unknown[];
+    uncles: Array<string>;
 }
 export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
 export {};

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

@@ -0,0 +1,12 @@
+import { BlockTag } from './Block.types';
+export interface EventFilter {
+    address?: string;
+    topics?: Array<string | Array<string> | null>;
+}
+export interface Filter extends EventFilter {
+    fromBlock?: BlockTag;
+    toBlock?: BlockTag;
+}
+export interface FilterByBlockHash extends EventFilter {
+    blockHash?: string;
+}

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

@@ -1,4 +1,6 @@
+import type Big from 'big.js';
 import { TinyBig } from '../shared/tiny-big/tiny-big';
+import { BytesLike } from './../utils/bytes';
 declare type Modify<T, R> = Omit<T, keyof R> & R;
 export interface RPCTransaction extends RPCBlockTransaction {
     maxFeePerGas: string;
@@ -7,14 +9,14 @@ export interface RPCTransaction extends RPCBlockTransaction {
 export declare type TransactionResponse = Modify<RPCTransaction, {
     blockNumber: number;
     chainId: number;
-    nonce: number;
+    gas: TinyBig;
+    gasLimit: TinyBig;
+    gasPrice: TinyBig;
+    nonce: TinyBig;
     transactionIndex: number;
     type: number;
     v: number;
     value: TinyBig;
-    gasPrice: TinyBig;
-    gas: TinyBig;
-    gasLimit: TinyBig;
 } & {
     maxFeePerGas: TinyBig;
     maxPriorityFeePerGas: TinyBig;
@@ -33,7 +35,31 @@ export declare type TransactionReceipt = Modify<RPCTransactionReceipt, {
     byzantium: boolean;
     confirmations: number;
 }>;
-export declare type Log = Modify<Omit<RPCLog, 'removed'>, {
+export interface RPCTransactionRequest {
+    from?: string;
+    to: string;
+    gas?: string;
+    gasPrice?: string;
+    value?: string;
+    data?: BytesLike;
+    nonce?: string;
+    maxPriorityFeePerGas?: string;
+    maxFeePerGas?: string;
+}
+export interface TransactionRequest {
+    to?: string;
+    from?: string;
+    nonce?: TinyBig | string | Big | number;
+    gas?: TinyBig | number | Big | string;
+    gasPrice?: TinyBig | Big | string | number;
+    data?: BytesLike;
+    value?: TinyBig | string | Big | number;
+    chainId?: number;
+    type?: number;
+    maxPriorityFeePerGas?: TinyBig | string | Big | number;
+    maxFeePerGas?: TinyBig | string | Big | number;
+}
+export declare type Log = Modify<RPCLog, {
     blockNumber: number;
     logIndex: number;
     transactionIndex: number;

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

@@ -1,2 +1,2 @@
 import { BytesLike } from './bytes';
-export declare const keccak256: (data: BytesLike) => string;
+export declare function keccak256(data: BytesLike): string;

package/lib/esm/utils/keccak256.js

@@ -1,5 +1,5 @@
 import { Keccak } from 'sha3';
-export const keccak256 = (data) => {
+export function keccak256(data) {
     let bufferableData;
     if (typeof data === 'string') {
         bufferableData = Buffer.from(data.replace(/^0x/, ''), 'hex');
@@ -10,4 +10,4 @@ export const keccak256 = (data) => {
     const keccak = new Keccak(256);
     const addressHash = '0x' + keccak.update(bufferableData).digest('hex');
     return addressHash;
-};
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS for Ethereum",
-  "version": "0.5.6",
+  "version": "0.5.9",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -14,7 +14,28 @@
   },
   "repository": "https://github.com/dawsbot/essential-eth.git",
   "author": "@dawsbot",
+  "size-limit": [
+    {
+      "name": "etherToWei",
+      "path": "src/index.ts",
+      "import": "{ etherToWei }",
+      "limit": "3.9kb"
+    },
+    {
+      "name": "JsonRpcProvider",
+      "path": "src/index.ts",
+      "import": "{ JsonRpcProvider }",
+      "limit": "22kb"
+    },
+    {
+      "name": "Contract",
+      "path": "src/index.ts",
+      "import": "{ Contract }",
+      "limit": "18kb"
+    }
+  ],
   "scripts": {
+    "size": "size-limit",
     "test": "npm-run-all --parallel jest compile lint",
     "test:all-node-versions": "npx trevor",
     "lint": "eslint --cache --fix .",
@@ -22,7 +43,7 @@
     "tsc:esm": "tsc -p tsconfig.json",
     "tsc:cjs": "tsc -p tsconfig-cjs.json",
     "build": "rm -rf lib && npm run compile",
-    "build:readme": ". ./scripts/markdown-magic/build-readme.sh",
+    "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()",
     "update-deps": "sh ./scripts/pre-commit.sh",
@@ -34,6 +55,7 @@
     "doc": "typedoc"
   },
   "devDependencies": {
+    "@size-limit/preset-small-lib": "^7.0.8",
     "@types/body-parser": "^1.19.1",
     "@types/eslint": "^8.4.2",
     "@types/express": "^4.17.13",
@@ -41,13 +63,14 @@
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
     "@types/prettier": "^2.4.4",
-    "@typescript-eslint/eslint-plugin": "^5.25.0",
-    "@typescript-eslint/parser": "^5.25.0",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
     "eslint": "^8.16.0",
     "eslint-plugin-jest": "^26.2.2",
-    "ethers": "^5.6.7",
+    "eslint-plugin-jsdoc": "38.0.2",
+    "ethers": "^5.6.8",
     "express": "^4.17.1",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
@@ -58,6 +81,7 @@
     "perf_hooks": "^0.0.1",
     "prettier": "^2.6.2",
     "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",
@@ -67,7 +91,7 @@
   "dependencies": {
     "@noble/secp256k1": "^1.5.5",
     "@types/big.js": "^6.1.3",
-    "big.js": "^6.1.1",
+    "big.js": "^6.2.0",
     "isomorphic-unfetch": "^3.1.0",
     "sha3": "^2.1.4"
   },