essential-eth 0.4.9 → 0.5.0

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

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fakeUrls = void 0;
+exports.rpcUrls = exports.fakeUrls = void 0;
 exports.fakeUrls = {
     notRPCButRealHttp: 'https://httpstat.us/200',
 };
+exports.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/cjs/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/cjs/providers/utils/chains-info.js

@@ -208,9 +208,15 @@ exports.default = {
     "78": [
         "primuschain"
     ],
+    "79": [
+        "zenith"
+    ],
     "80": [
         "GeneChain"
     ],
+    "81": [
+        "VIL"
+    ],
     "82": [
         "Meter"
     ],
@@ -379,6 +385,9 @@ exports.default = {
     "288": [
         "Boba"
     ],
+    "300": [
+        "ogc"
+    ],
     "321": [
         "kcs"
     ],
@@ -448,6 +457,9 @@ exports.default = {
     "686": [
         "kar"
     ],
+    "700": [
+        "SNS"
+    ],
     "707": [
         "bcs"
     ],
@@ -517,6 +529,9 @@ exports.default = {
     "1007": [
         "tnew"
     ],
+    "1008": [
+        "eun"
+    ],
     "1010": [
         "EVC"
     ],
@@ -581,7 +596,7 @@ exports.default = {
         "mrock"
     ],
     "1337": [
-        "cennz-a"
+        "cennz-old"
     ],
     "1618": [
         "cate"
@@ -601,6 +616,9 @@ exports.default = {
     "1898": [
         "boya"
     ],
+    "1984": [
+        "euntest"
+    ],
     "1987": [
         "egem"
     ],
@@ -625,6 +643,12 @@ exports.default = {
     "2101": [
         "esp"
     ],
+    "2152": [
+        "fra"
+    ],
+    "2153": [
+        "findora-testnet"
+    ],
     "2213": [
         "evanesco"
     ],
@@ -787,6 +811,9 @@ exports.default = {
     "19845": [
         "btcix"
     ],
+    "21337": [
+        "cennz-a"
+    ],
     "21816": [
         "oml"
     ],
@@ -874,6 +901,9 @@ exports.default = {
     "63001": [
         "ecs-testnet"
     ],
+    "69420": [
+        "cndr"
+    ],
     "70000": [
         "TKM0"
     ],

package/lib/cjs/shared/tiny-big/tiny-big.d.ts

@@ -15,5 +15,11 @@ export declare class TinyBig extends Big {
 }
 /**
  * Helper factory function so that you don't have to type "new" when instantiating a new TinyBig
+ *
+ * @example
+ * ```javascript
+ * tinyBig(10).times(3).toNumber()
+ * // 30
+ * ```
  */
 export declare function tinyBig(value: string | number | TinyBig | Big): TinyBig;

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

@@ -12,7 +12,13 @@ const helpers_1 = require("./helpers");
  */
 class TinyBig extends big_js_1.default {
     constructor(value) {
-        super(value);
+        try {
+            super(value);
+        }
+        catch (e) {
+            console.error(`TinyBig cannot parse value (value=${value})`);
+            throw e;
+        }
     }
     /**
      * Used anytime you're passing in "value" to ethers or web3
@@ -34,6 +40,12 @@ class TinyBig extends big_js_1.default {
 exports.TinyBig = TinyBig;
 /**
  * Helper factory function so that you don't have to type "new" when instantiating a new TinyBig
+ *
+ * @example
+ * ```javascript
+ * tinyBig(10).times(3).toNumber()
+ * // 30
+ * ```
  */
 function tinyBig(value) {
     return new TinyBig(value);

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

@@ -1,27 +1,15 @@
-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>;
+}>;
+/** Exact response from backend */
 export interface RPCBlock {
     baseFeePerGas: string;
     difficulty: string;
@@ -45,3 +33,5 @@ export interface RPCBlock {
     transactionsRoot: string;
     uncles: unknown[];
 }
+export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
+export {};

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

@@ -1,23 +1,31 @@
-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'>;
+/** What JSONRPC responds with in getBlock transaction array */
+export interface RPCBlockTransaction {
     blockHash: string;
     blockNumber: string;
+    chainId: string;
     from: string;
     gas: string;
     gasPrice: string;
@@ -32,3 +40,4 @@ export interface RPCTransaction {
     v: string;
     value: string;
 }
+export {};

package/lib/cjs/utils/ether-to-gwei.d.ts

@@ -0,0 +1,26 @@
+import Big from 'big.js';
+import { TinyBig } from '../shared/tiny-big/tiny-big';
+/**
+ * Convert from Ether to Gwei
+ *
+ * No direct equivalent in ether.js; requires multiple functions to achieve.
+ *
+ * No direct equivalent in web3; requires multiple functions to achieve.
+ *
+ * @example
+ * ```javascript
+ * etherToGwei('1000').toString()
+ * // '1000000000000'
+ * etherToGwei(1000).toString()
+ * // '1000000000000'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * etherToGwei('1000').toNumber()
+ * // 1000000000000
+ * etherToGwei(1000).toNumber()
+ * // 1000000000000
+ * ```
+ */
+export declare function etherToGwei(etherQuantity: string | number | TinyBig | Big): TinyBig;

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.etherToGwei = void 0;
+const tiny_big_1 = require("../shared/tiny-big/tiny-big");
+const validate_type_1 = require("../shared/validate-type");
+/**
+ * Convert from Ether to Gwei
+ *
+ * No direct equivalent in ether.js; requires multiple functions to achieve.
+ *
+ * No direct equivalent in web3; requires multiple functions to achieve.
+ *
+ * @example
+ * ```javascript
+ * etherToGwei('1000').toString()
+ * // '1000000000000'
+ * etherToGwei(1000).toString()
+ * // '1000000000000'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * etherToGwei('1000').toNumber()
+ * // 1000000000000
+ * etherToGwei(1000).toNumber()
+ * // 1000000000000
+ * ```
+ */
+function etherToGwei(etherQuantity) {
+    (0, validate_type_1.validateType)(etherQuantity, ['string', 'number', 'object']);
+    const result = (0, tiny_big_1.tinyBig)(etherQuantity).times('1000000000');
+    return (0, tiny_big_1.tinyBig)(result);
+}
+exports.etherToGwei = etherToGwei;

package/lib/cjs/utils/ether-to-wei.d.ts

@@ -1,9 +1,11 @@
 import Big from 'big.js';
 import { TinyBig } from '../shared/tiny-big/tiny-big';
 /**
- * Similar to ["parseEther" in ethers.js](https://docs.ethers.io/v4/api-utils.html#ether-strings-and-wei)
+ * Convert Ether to Wei
  *
- * Similar to ["toWei" in web3](https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html?highlight=towei#towei)
+ * Similar to ["parseEther" in ethers.js](https://docs.ethers.io/v5/api/utils/display-logic/#utils-parseEther)
+ *
+ * Similar to ["toWei" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#towei)
  *
  * @example
  * ```javascript

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

@@ -4,9 +4,11 @@ exports.etherToWei = void 0;
 const tiny_big_1 = require("../shared/tiny-big/tiny-big");
 const validate_type_1 = require("../shared/validate-type");
 /**
- * Similar to ["parseEther" in ethers.js](https://docs.ethers.io/v4/api-utils.html#ether-strings-and-wei)
+ * Convert Ether to Wei
  *
- * Similar to ["toWei" in web3](https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html?highlight=towei#towei)
+ * Similar to ["parseEther" in ethers.js](https://docs.ethers.io/v5/api/utils/display-logic/#utils-parseEther)
+ *
+ * Similar to ["toWei" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#towei)
  *
  * @example
  * ```javascript

package/lib/cjs/utils/gwei-to-ether.d.ts

@@ -0,0 +1,26 @@
+import Big from 'big.js';
+import { TinyBig } from './../shared/tiny-big/tiny-big';
+/**
+ * Convert from Gwei to Ether
+ *
+ * No direct equivalent in ethers.js; requires multiple functions to achieve.
+ *
+ * No direct equivalent in web3; requires multiple functions to achieve.
+ *
+ * @example
+ * ```javascript
+ * gweiToEther('1000000000000').toString()
+ * // '1000'
+ * gweiToEther(1000000000000).toString()
+ * // '1000'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * gweiToEther('1000000000000').toNumber()
+ * // 1000
+ * gweiToEther(1000000000000).toNumber()
+ * // 1000
+ * ```
+ */
+export declare function gweiToEther(gweiQuantity: string | number | TinyBig | Big): TinyBig;

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gweiToEther = void 0;
+const tiny_big_1 = require("../shared/tiny-big/tiny-big");
+const validate_type_1 = require("../shared/validate-type");
+/**
+ * Convert from Gwei to Ether
+ *
+ * No direct equivalent in ethers.js; requires multiple functions to achieve.
+ *
+ * No direct equivalent in web3; requires multiple functions to achieve.
+ *
+ * @example
+ * ```javascript
+ * gweiToEther('1000000000000').toString()
+ * // '1000'
+ * gweiToEther(1000000000000).toString()
+ * // '1000'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * gweiToEther('1000000000000').toNumber()
+ * // 1000
+ * gweiToEther(1000000000000).toNumber()
+ * // 1000
+ * ```
+ */
+function gweiToEther(gweiQuantity) {
+    (0, validate_type_1.validateType)(gweiQuantity, ['string', 'number', 'object']);
+    const result = (0, tiny_big_1.tinyBig)(gweiQuantity).div('1000000000');
+    return (0, tiny_big_1.tinyBig)(result);
+}
+exports.gweiToEther = gweiToEther;

package/lib/cjs/utils/hex-zero-pad.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Returns a hex string padded to a specified length of bytes.
+ *
+ * Similar to ["hexZeroPad" in ethers.js](https://docs.ethers.io/v5/api/utils/bytes/#utils-hexZeroPad)
+ *
+ * Differs from ["padLeft" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#padleft) because web3 counts by characters, not bytes.
+ *
+ * @param hexValue - A hex-string, hex-number, or decimal number (auto-converts to base-16) to be padded
+ * @param length - The final length in bytes
+ *
+ * @throws - If the value is not a hex string or number
+ * @throws - If the value is longer than the length
+ *
+ * @example
+ * ```javascript
+ * hexZeroPad('0x60', 2);
+ * // '0x0060'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * hexZeroPad(0x60, 3);
+ * // '0x000060'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * hexZeroPad('12345', 1);
+ * // Throws
+ * ```
+ */
+export declare function hexZeroPad(hexValue: string | number, length: number): string;

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hexZeroPad = void 0;
+const validate_type_1 = require("../shared/validate-type");
+/**
+ * Returns a hex string padded to a specified length of bytes.
+ *
+ * Similar to ["hexZeroPad" in ethers.js](https://docs.ethers.io/v5/api/utils/bytes/#utils-hexZeroPad)
+ *
+ * Differs from ["padLeft" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#padleft) because web3 counts by characters, not bytes.
+ *
+ * @param hexValue - A hex-string, hex-number, or decimal number (auto-converts to base-16) to be padded
+ * @param length - The final length in bytes
+ *
+ * @throws - If the value is not a hex string or number
+ * @throws - If the value is longer than the length
+ *
+ * @example
+ * ```javascript
+ * hexZeroPad('0x60', 2);
+ * // '0x0060'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * hexZeroPad(0x60, 3);
+ * // '0x000060'
+ * ```
+ *
+ * @example
+ * ```javascript
+ * hexZeroPad('12345', 1);
+ * // Throws
+ * ```
+ */
+function hexZeroPad(hexValue, length) {
+    (0, validate_type_1.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')}`;
+}
+exports.hexZeroPad = hexZeroPad;

package/lib/cjs/utils/is-address.d.ts

@@ -1,5 +1,24 @@
 /**
  * Returns a boolean as to whether the input is a valid address.
  * Does NOT support ICAP addresses
+ *
+ * @example
+ * ```javascript
+ * isAddress('0xc0deaf6bd3f0c6574a6a625ef2f22f62a5150eab');
+ * // true
+ * ```
+ *
+ * @example
+ * ```javascript
+ * isAddress('bad');
+ * // false
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Does NOT support ENS.
+ * isAddress('vitalik.eth');
+ * // false
+ * ```
  */
 export declare function isAddress(address: string): boolean;

package/lib/cjs/utils/is-address.js

@@ -6,6 +6,25 @@ const validate_type_1 = require("../shared/validate-type");
 /**
  * Returns a boolean as to whether the input is a valid address.
  * Does NOT support ICAP addresses
+ *
+ * @example
+ * ```javascript
+ * isAddress('0xc0deaf6bd3f0c6574a6a625ef2f22f62a5150eab');
+ * // true
+ * ```
+ *
+ * @example
+ * ```javascript
+ * isAddress('bad');
+ * // false
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Does NOT support ENS.
+ * isAddress('vitalik.eth');
+ * // false
+ * ```
  */
 function isAddress(address) {
     (0, validate_type_1.validateType)(address, ['string']);

package/lib/cjs/utils/to-checksum-address.d.ts

@@ -10,8 +10,8 @@
  * // '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
  * ```
  *
- * Similar to ["getAddress" in ethers.js](https://docs.ethers.io/v4/api-utils.html#utils-getaddress)
+ * Similar to ["getAddress" in ethers.js](https://docs.ethers.io/v5/api/utils/address/#utils-getAddress)
  *
- * Similar to ["toChecksumAddress" in web3](https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html#tochecksumaddress)
+ * Similar to ["toChecksumAddress" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#tochecksumaddress)
  */
 export declare function toChecksumAddress(address: string): string;

package/lib/cjs/utils/to-checksum-address.js

@@ -15,9 +15,9 @@ const validate_type_1 = require("../shared/validate-type");
  * // '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
  * ```
  *
- * Similar to ["getAddress" in ethers.js](https://docs.ethers.io/v4/api-utils.html#utils-getaddress)
+ * Similar to ["getAddress" in ethers.js](https://docs.ethers.io/v5/api/utils/address/#utils-getAddress)
  *
- * Similar to ["toChecksumAddress" in web3](https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html#tochecksumaddress)
+ * Similar to ["toChecksumAddress" in web3.js](https://web3js.readthedocs.io/en/v1.7.1/web3-utils.html#tochecksumaddress)
  */
 function toChecksumAddress(address) {
     (0, validate_type_1.validateType)(address, ['string']);

package/lib/cjs/utils/wei-to-ether.d.ts

@@ -1,26 +1,26 @@
 import Big from 'big.js';
-import { TinyBig } from './../shared/tiny-big/tiny-big';
+import { TinyBig } from '../shared/tiny-big/tiny-big';
 /**
- * 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
  * ```
  */
 export declare function weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig;