essential-eth 0.9.2-beta.3 → 0.9.2-beta.4

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

@@ -1,10 +1,58 @@
-import Big from 'big.js';
-export declare class TinyBig extends Big {
-    constructor(value: string | number | TinyBig | Big);
-    toHexString(): string;
-    toNumber(): number;
-    toString(): string;
-    private padAndChop;
-    toTwos(bitCount: number): Big;
-}
-export declare function tinyBig(value: string | number | TinyBig | Big): TinyBig;
+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.
+ */
+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;
+    /**
+     * 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;
+}
+/**
+ * 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()
+ * // 30
+ * ```
+ */
+export declare function tinyBig(value: string | number | TinyBig | Big): TinyBig;

package/dist/cjs/shared/validate-type.d.ts

@@ -1,3 +1,3 @@
-type JSPrimitiveTypes = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
-export declare const validateType: (value: unknown, allowedTypes: JSPrimitiveTypes[]) => void;
-export {};
+type JSPrimitiveTypes = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
+export declare const validateType: (value: unknown, allowedTypes: JSPrimitiveTypes[]) => void;
+export {};

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

@@ -1,40 +1,41 @@
-import type { TinyBig } from './../shared/tiny-big/tiny-big';
-import type { BlockTransactionResponse, RPCTransaction } from './Transaction.types';
-type Modify<T, R> = Omit<T, keyof R> & R;
-export type BlockResponse = Modify<RPCBlock, {
-    baseFeePerGas: TinyBig;
-    difficulty: TinyBig;
-    gasLimit: TinyBig;
-    gasUsed: TinyBig;
-    nonce: TinyBig;
-    number: number;
-    size: TinyBig;
-    timestamp: TinyBig;
-    totalDifficulty: TinyBig;
-    transactions: Array<string | BlockTransactionResponse>;
-}>;
-export interface RPCBlock {
-    baseFeePerGas: string;
-    difficulty: string;
-    extraData: string;
-    gasLimit: string;
-    gasUsed: string;
-    hash: string;
-    logsBloom: string;
-    miner: string;
-    mixHash: string;
-    nonce: string;
-    number: string;
-    parentHash: string;
-    receiptsRoot: string;
-    sha3Uncles: string;
-    size: string;
-    stateRoot: string;
-    timestamp: string;
-    totalDifficulty: string;
-    transactions: Array<string | RPCTransaction>;
-    transactionsRoot: string;
-    uncles: Array<string>;
-}
-export type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
-export {};
+import type { TinyBig } from './../shared/tiny-big/tiny-big';
+import type { BlockTransactionResponse, RPCTransaction } from './Transaction.types';
+type Modify<T, R> = Omit<T, keyof R> & R;
+export type BlockResponse = Modify<RPCBlock, {
+    baseFeePerGas: TinyBig;
+    difficulty: TinyBig;
+    gasLimit: TinyBig;
+    gasUsed: TinyBig;
+    nonce: TinyBig;
+    number: number;
+    size: TinyBig;
+    timestamp: TinyBig;
+    totalDifficulty: TinyBig;
+    transactions: Array<string | BlockTransactionResponse>;
+}>;
+/** Exact response from backend */
+export interface RPCBlock {
+    baseFeePerGas: string;
+    difficulty: string;
+    extraData: string;
+    gasLimit: string;
+    gasUsed: string;
+    hash: string;
+    logsBloom: string;
+    miner: string;
+    mixHash: string;
+    nonce: string;
+    number: string;
+    parentHash: string;
+    receiptsRoot: string;
+    sha3Uncles: string;
+    size: string;
+    stateRoot: string;
+    timestamp: string;
+    totalDifficulty: string;
+    transactions: Array<string | RPCTransaction>;
+    transactionsRoot: string;
+    uncles: Array<string>;
+}
+export type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
+export {};

package/dist/cjs/types/Contract.types.d.ts

@@ -1,24 +1,24 @@
-export type ContractTypes = 'bool' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | 'bytes17' | 'bytes18' | 'bytes19' | 'bytes20' | 'bytes21' | 'bytes22' | 'bytes23' | 'bytes24' | 'bytes25' | 'bytes26' | 'bytes27' | 'bytes28' | 'bytes29' | 'bytes30' | 'bytes31' | 'bytes32' | 'bytes32[]' | 'address' | 'address payable' | 'address[4]' | 'address[100]' | 'uint256' | 'uint256[100]' | 'uint8' | 'uint32' | string;
-export type ContractInterface = JSONABI;
-export type ContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
-export interface JSONABIArgument {
-    anonymous?: false;
-    inputs: {
-        internalType?: ContractTypes | string;
-        name: string;
-        type: ContractTypes;
-        indexed?: boolean;
-    }[];
-    name?: string;
-    outputs?: {
-        internalType?: ContractTypes | string;
-        name: string;
-        type: ContractTypes;
-    }[];
-    stateMutability?: 'view' | 'nonpayable' | string;
-    type: 'function' | 'event' | 'constructor' | 'error' | 'fallback';
-    gas?: number;
-    constant?: boolean;
-    payable?: boolean;
-}
-export type JSONABI = JSONABIArgument[];
+export type ContractTypes = 'bool' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | 'bytes17' | 'bytes18' | 'bytes19' | 'bytes20' | 'bytes21' | 'bytes22' | 'bytes23' | 'bytes24' | 'bytes25' | 'bytes26' | 'bytes27' | 'bytes28' | 'bytes29' | 'bytes30' | 'bytes31' | 'bytes32' | 'bytes32[]' | 'address' | 'address payable' | 'address[4]' | 'address[100]' | 'uint256' | 'uint256[100]' | 'uint8' | 'uint32' | string;
+export type ContractInterface = JSONABI;
+export type ContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
+export interface JSONABIArgument {
+    anonymous?: false;
+    inputs: {
+        internalType?: ContractTypes | string;
+        name: string;
+        type: ContractTypes;
+        indexed?: boolean;
+    }[];
+    name?: string;
+    outputs?: {
+        internalType?: ContractTypes | string;
+        name: string;
+        type: ContractTypes;
+    }[];
+    stateMutability?: 'view' | 'nonpayable' | string;
+    type: 'function' | 'event' | 'constructor' | 'error' | 'fallback';
+    gas?: number;
+    constant?: boolean;
+    payable?: boolean;
+}
+export type JSONABI = JSONABIArgument[];

package/dist/cjs/types/FeeData.types.d.ts

@@ -1,7 +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;
-}
+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/cjs/types/Filter.types.d.ts

@@ -1,12 +1,16 @@
-import type { 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;
-}
+import type { 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/dist/cjs/types/Network.types.d.ts

@@ -1,5 +1,8 @@
-export interface Network {
-    chainId: number;
-    ensAddress: string | null;
-    name: string;
-}
+/**
+ * A trimmed version of https://chainid.network/chains.json
+ */
+export interface Network {
+    chainId: number;
+    ensAddress: string | null;
+    name: string;
+}

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

@@ -1,113 +1,123 @@
-import type Big from 'big.js';
-import type { TinyBig } from '../shared/tiny-big/tiny-big';
-import type { BytesLike } from './../utils/bytes';
-type Modify<T, R> = Omit<T, keyof R> & R;
-export interface RPCTransaction extends RPCBlockTransaction {
-    maxFeePerGas: string;
-    maxPriorityFeePerGas: string;
-}
-export type TransactionResponse = Modify<RPCTransaction, {
-    blockNumber: number;
-    chainId: number;
-    gas: TinyBig;
-    gasLimit: TinyBig;
-    gasPrice: TinyBig;
-    nonce: TinyBig;
-    transactionIndex: number;
-    type: number;
-    v: number;
-    value: TinyBig;
-} & {
-    maxFeePerGas: TinyBig;
-    maxPriorityFeePerGas: TinyBig;
-    confirmations: number;
-}>;
-export type TransactionReceipt = Modify<RPCTransactionReceipt, {
-    blockNumber: number;
-    cumulativeGasUsed: TinyBig;
-    effectiveGasPrice: TinyBig;
-    gasUsed: TinyBig;
-    logs: Array<Log>;
-    status: number;
-    transactionIndex: number;
-    type: number;
-} & {
-    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;
-}
-export type Log = Modify<RPCLog, {
-    blockNumber: number;
-    logIndex: number;
-    transactionIndex: number;
-}>;
-export type BlockTransactionResponse = Omit<TransactionResponse, 'maxFeePerGas' | 'maxPriorityFeePerGas'>;
-export interface RPCBlockTransaction {
-    blockHash: string;
-    blockNumber: string;
-    chainId: string;
-    from: string;
-    gas: string;
-    gasPrice: string;
-    hash: string;
-    input: string;
-    nonce: string;
-    r: string;
-    s: string;
-    to: string;
-    transactionIndex: string;
-    type: string;
-    v: string;
-    value: string;
-}
-export interface RPCTransactionReceipt {
-    blockHash: string;
-    blockNumber: string;
-    contractAddress: string;
-    cumulativeGasUsed: string;
-    effectiveGasPrice: string;
-    from: string;
-    gasUsed: string;
-    logs: Array<RPCLog>;
-    logsBloom: string;
-    status: string;
-    to: string;
-    transactionHash: string;
-    transactionIndex: string;
-    type: string;
-}
-export interface RPCLog {
-    address: string;
-    blockHash: string;
-    blockNumber: string;
-    data: string;
-    logIndex: string;
-    removed?: boolean;
-    topics: Array<string>;
-    transactionHash: string;
-    transactionIndex: string;
-}
-export {};
+import type Big from 'big.js';
+import type { TinyBig } from '../shared/tiny-big/tiny-big';
+import type { BytesLike } from './../utils/bytes';
+type Modify<T, R> = Omit<T, keyof R> & R;
+export interface RPCTransaction extends RPCBlockTransaction {
+    maxFeePerGas: string;
+    maxPriorityFeePerGas: string;
+}
+export type TransactionResponse = Modify<RPCTransaction, {
+    blockNumber: number;
+    chainId: number;
+    gas: TinyBig;
+    gasLimit: TinyBig;
+    gasPrice: TinyBig;
+    nonce: TinyBig;
+    transactionIndex: number;
+    type: number;
+    v: number;
+    value: TinyBig;
+} & {
+    maxFeePerGas: TinyBig;
+    maxPriorityFeePerGas: TinyBig;
+    confirmations: number;
+}>;
+/**
+ * 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 type TransactionReceipt = Modify<RPCTransactionReceipt, {
+    blockNumber: number;
+    cumulativeGasUsed: TinyBig;
+    effectiveGasPrice: TinyBig;
+    gasUsed: TinyBig;
+    logs: Array<Log>;
+    status: number;
+    transactionIndex: number;
+    type: number;
+} & {
+    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)
+ */
+export type Log = Modify<RPCLog, {
+    blockNumber: number;
+    logIndex: number;
+    transactionIndex: number;
+}>;
+export 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;
+    hash: string;
+    input: string;
+    nonce: string;
+    r: string;
+    s: string;
+    to: string;
+    transactionIndex: string;
+    type: string;
+    v: string;
+    value: string;
+}
+export interface RPCTransactionReceipt {
+    blockHash: string;
+    blockNumber: string;
+    contractAddress: string;
+    cumulativeGasUsed: string;
+    effectiveGasPrice: string;
+    from: string;
+    gasUsed: string;
+    logs: Array<RPCLog>;
+    logsBloom: string;
+    status: string;
+    to: string;
+    transactionHash: string;
+    transactionIndex: string;
+    type: string;
+}
+export interface RPCLog {
+    address: string;
+    blockHash: string;
+    blockNumber: string;
+    data: string;
+    logIndex: string;
+    removed?: boolean;
+    topics: Array<string>;
+    transactionHash: string;
+    transactionIndex: string;
+}
+export {};