essential-eth 0.5.6 → 0.5.9

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

@@ -10,12 +10,18 @@ export declare class JsonRpcProvider extends BaseProvider {
     post(body: Record<string, unknown>): Promise<any>;
     /**
      * @param rpcUrl The URL to your Eth node. Consider POKT or Infura
+     * @example
+     * `https://free-eth-node.com/api/eth`
+     * @example
+     * `https://mainnet.infura.io/v3/YOUR-PROJECT-ID`
      */
     constructor(rpcUrl?: string);
 }
 /**
  * Helper function to avoid "new"
  *
+ * @param rpcUrl the RPC URL to post requests to
+ * @returns an initiated {@link JsonRpcProvider}
  * @example
  * ```javascript
  * jsonRpcProvider().getBlock('latest').then(block => {

package/lib/cjs/providers/JsonRpcProvider.js

@@ -17,6 +17,10 @@ class JsonRpcProvider extends BaseProvider_1.BaseProvider {
     }
     /**
      * @param rpcUrl The URL to your Eth node. Consider POKT or Infura
+     * @example
+     * `https://free-eth-node.com/api/eth`
+     * @example
+     * `https://mainnet.infura.io/v3/YOUR-PROJECT-ID`
      */
     constructor(rpcUrl = 'https://free-eth-node.com/api/eth') {
         super([rpcUrl]);
@@ -26,6 +30,8 @@ exports.JsonRpcProvider = JsonRpcProvider;
 /**
  * Helper function to avoid "new"
  *
+ * @param rpcUrl the RPC URL to post requests to
+ * @returns an initiated {@link JsonRpcProvider}
  * @example
  * ```javascript
  * jsonRpcProvider().getBlock('latest').then(block => {

package/lib/cjs/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/cjs/providers/utils/chains-info.js

@@ -619,6 +619,12 @@ exports.default = {
     "1337": [
         "cennz-old"
     ],
+    "1506": [
+        "Sherpax"
+    ],
+    "1507": [
+        "Sherpax Testnet"
+    ],
     "1618": [
         "cate"
     ],
@@ -739,6 +745,9 @@ exports.default = {
     "4102": [
         "aioz-testnet"
     ],
+    "4181": [
+        "PHI"
+    ],
     "4689": [
         "iotex-mainnet"
     ],
@@ -841,6 +850,12 @@ exports.default = {
     "10823": [
         "CCP"
     ],
+    "10946": [
+        "quadrans"
+    ],
+    "10947": [
+        "quadranstestnet"
+    ],
     "11111": [
         "WAGMI"
     ],
@@ -880,6 +895,9 @@ exports.default = {
     "24734": [
         "mintme"
     ],
+    "26863": [
+        "OAC"
+    ],
     "30067": [
         "Piece"
     ],
@@ -985,6 +1003,12 @@ exports.default = {
     "71393": [
         "ckb"
     ],
+    "71401": [
+        "gw-testnet-v1"
+    ],
+    "71402": [
+        "gw-mainnet-v1"
+    ],
     "73799": [
         "vt"
     ],
@@ -1093,9 +1117,15 @@ exports.default = {
     "421611": [
         "arb-rinkeby"
     ],
+    "432201": [
+        "Dexalot"
+    ],
     "444900": [
         "wlkt"
     ],
+    "474142": [
+        "oc"
+    ],
     "512512": [
         "cmp"
     ],
@@ -1117,6 +1147,9 @@ exports.default = {
     "1337702": [
         "kintsugi"
     ],
+    "1337802": [
+        "kiln"
+    ],
     "2203181": [
         "platondev"
     ],
@@ -1232,6 +1265,6 @@ exports.default = {
         "mole"
     ],
     "868455272153094": [
-        "gw-testnet-v1"
+        "gw-testnet-v1-deprecated"
     ]
 };

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

@@ -1 +1,17 @@
+/**
+ * Converts a string in scientific notation formatting to string in decimal format
+ *
+ * @param scientificString a string in scientific format to convert to decimal
+ * @returns a string of a decimal number equivalent to the specified scientificString
+ * @example
+ * ```javascript
+ * scientificStrToDecimalStr('2.3e-5');
+ * // '0.000023'
+ * ```
+ * @example
+ * ```javascript
+ * scientificStrToDecimalStr('2.3e+5');
+ * // '230000'
+ * ```
+ */
 export declare function scientificStrToDecimalStr(scientificString: string): string;

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

@@ -1,7 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.scientificStrToDecimalStr = void 0;
-// strips both leading and trailing zeroes
+/**
+ * Strips both leading and trailing zeroes from a number string
+ *
+ * @param numberString the string of numbers to strip zeros from
+ * @returns a string of numbers without leading or trailing zeros
+ * @example
+ * ```javascript
+ * stripTrailingZeros('0005280');
+ * // '5280'
+ * ```
+ */
 function stripTrailingZeroes(numberString) {
     const isNegative = numberString.startsWith('-');
     numberString = numberString.replace('-', '');
@@ -17,6 +27,22 @@ function stripTrailingZeroes(numberString) {
     }
     return `${isNegative ? '-' : ''}${numberString}`;
 }
+/**
+ * Converts a string in scientific notation formatting to string in decimal format
+ *
+ * @param scientificString a string in scientific format to convert to decimal
+ * @returns a string of a decimal number equivalent to the specified scientificString
+ * @example
+ * ```javascript
+ * scientificStrToDecimalStr('2.3e-5');
+ * // '0.000023'
+ * ```
+ * @example
+ * ```javascript
+ * scientificStrToDecimalStr('2.3e+5');
+ * // '230000'
+ * ```
+ */
 function scientificStrToDecimalStr(scientificString) {
     // Does not contain "e" nor "E"
     if (!scientificString.match(/e/i /* lowercase and uppercase E */)) {

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

@@ -1,21 +1,45 @@
 import Big from 'big.js';
 /**
  * A wrapper around [big.js](https://github.com/MikeMcl/big.js) which expands scientific notation and creates a "toHexString" function.
- * * This is the return type of every operation on ether, wei, etc.
+ * This is the return type of every operation on ether, wei, etc.
  */
 export declare class TinyBig extends Big {
     constructor(value: string | number | TinyBig | Big);
     /**
      * Used anytime you're passing in "value" to ethers or web3
      * For now, TypeScript will complain that `TinyBig` is not a `BigNumberish`. You can // @ts-ignore or call this
+     *
+     * @returns the TinyBig represented as a hex string
+     * @example
+     * ```javascript
+     * tinyBig(293).toHexString();
+     * // '0x125'
+     * ```
+     * @example
+     * ```javascript
+     * tinyBig(681365874).toHexString();
+     * // '0x289cd172'
      */
     toHexString(): string;
     toNumber(): number;
     toString(): string;
     /**
-     * @param {String} str
-     * @param {String} padChar
-     * @param {Number} length
+     * Eithers pads or shortens a string to a specified length
+     *
+     * @param str the string to pad or chop
+     * @param padChar the character to pad the string with
+     * @param length the desired length of the given string
+     * @returns a string of the desired length, either padded with the specified padChar or with the beginning of the string chopped off
+     * @example
+     * ```javascript
+     * padAndChop('essential-eth', 'a', 8);
+     * // 'tial-eth'
+     * ```
+     * @example
+     * ```javascript
+     * padAndChop('essential-eth', 'A', 20);
+     * // 'AAAAAAAessential-eth'
+     * ```
      */
     private padAndChop;
     toTwos(bitCount: number): Big;
@@ -23,6 +47,8 @@ export declare class TinyBig extends Big {
 /**
  * Helper factory function so that you don't have to type "new" when instantiating a new TinyBig
  *
+ * @param value the value to initiate the TinyBig with
+ * @returns an initiated {@link TinyBig}
  * @example
  * ```javascript
  * tinyBig(10).times(3).toNumber()

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

@@ -5,18 +5,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tinyBig = exports.TinyBig = void 0;
 const big_js_1 = __importDefault(require("big.js"));
+const hex_to_decimal_1 = require("../../classes/utils/hex-to-decimal");
 const helpers_1 = require("./helpers");
 /**
  * A wrapper around [big.js](https://github.com/MikeMcl/big.js) which expands scientific notation and creates a "toHexString" function.
- * * This is the return type of every operation on ether, wei, etc.
+ * This is the return type of every operation on ether, wei, etc.
  */
 class TinyBig extends big_js_1.default {
     constructor(value) {
+        if (typeof value === 'string' && value.startsWith('0x')) {
+            value = (0, hex_to_decimal_1.hexToDecimal)(value);
+        }
         super(value);
         /**
-         * @param {String} str
-         * @param {String} padChar
-         * @param {Number} length
+         * Eithers pads or shortens a string to a specified length
+         *
+         * @param str the string to pad or chop
+         * @param padChar the character to pad the string with
+         * @param length the desired length of the given string
+         * @returns a string of the desired length, either padded with the specified padChar or with the beginning of the string chopped off
+         * @example
+         * ```javascript
+         * padAndChop('essential-eth', 'a', 8);
+         * // 'tial-eth'
+         * ```
+         * @example
+         * ```javascript
+         * padAndChop('essential-eth', 'A', 20);
+         * // 'AAAAAAAessential-eth'
+         * ```
          */
         this.padAndChop = (str, padChar, length) => {
             return (Array(length).fill(padChar).join('') + str).slice(length * -1);
@@ -25,6 +42,17 @@ class TinyBig extends big_js_1.default {
     /**
      * Used anytime you're passing in "value" to ethers or web3
      * For now, TypeScript will complain that `TinyBig` is not a `BigNumberish`. You can // @ts-ignore or call this
+     *
+     * @returns the TinyBig represented as a hex string
+     * @example
+     * ```javascript
+     * tinyBig(293).toHexString();
+     * // '0x125'
+     * ```
+     * @example
+     * ```javascript
+     * tinyBig(681365874).toHexString();
+     * // '0x289cd172'
      */
     toHexString() {
         return `0x${BigInt(this.toString()).toString(16)}`;
@@ -59,6 +87,8 @@ exports.TinyBig = TinyBig;
 /**
  * Helper factory function so that you don't have to type "new" when instantiating a new TinyBig
  *
+ * @param value the value to initiate the TinyBig with
+ * @returns an initiated {@link TinyBig}
  * @example
  * ```javascript
  * tinyBig(10).times(3).toNumber()

package/lib/cjs/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>;
 }>;
 /** Exact response from backend */
@@ -29,9 +33,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/cjs/types/Filter.types.d.ts

@@ -0,0 +1,16 @@
+import { BlockTag } from './Block.types';
+export interface EventFilter {
+    address?: string;
+    topics?: Array<string | Array<string> | null>;
+}
+/**
+ * @param fromBlock block as starting point for range, inclusive
+ * @param toBlock block as ending point for range, inclusive
+ */
+export interface Filter extends EventFilter {
+    fromBlock?: BlockTag;
+    toBlock?: BlockTag;
+}
+export interface FilterByBlockHash extends EventFilter {
+    blockHash?: string;
+}

package/lib/cjs/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;
@@ -22,6 +24,7 @@ export declare type TransactionResponse = Modify<RPCTransaction, {
 }>;
 /**
  * Type that contains information from the receipt of a transaction
+ *
  * * Similar to [`Type TransactionReceipt on ethers.providers`](https://docs.ethers.io/v5/api/providers/types/#providers-TransactionReceipt)
  */
 export declare type TransactionReceipt = Modify<RPCTransactionReceipt, {
@@ -37,11 +40,35 @@ export declare type TransactionReceipt = Modify<RPCTransactionReceipt, {
     byzantium: boolean;
     confirmations: number;
 }>;
+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;
+}
 /**
  * Type for the logs that are included in transaction receipts
- * * Similar to [`Type Log on ethers.providers`](https://docs.ethers.io/v5/api/providers/types/#providers-Log)
+ * Similar to [`Type Log on ethers.providers`](https://docs.ethers.io/v5/api/providers/types/#providers-Log)
  */
-export declare type Log = Modify<Omit<RPCLog, 'removed'>, {
+export declare type Log = Modify<RPCLog, {
     blockNumber: number;
     logIndex: number;
     transactionIndex: number;