essential-eth 0.5.0 → 0.5.1

package/lib/cjs/index.d.ts

@@ -8,8 +8,9 @@ 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, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hexZeroPad, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };
+export * from './utils/bytes';
+export * from './utils/solidity-keccak256';
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };

package/lib/cjs/index.js

@@ -1,6 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TinyBig = exports.Contract = exports.hexZeroPad = exports.gweiToEther = exports.weiToEther = exports.toChecksumAddress = exports.tinyBig = exports.JsonRpcProvider = exports.jsonRpcProvider = exports.isAddress = exports.etherToGwei = exports.etherToWei = void 0;
+exports.TinyBig = exports.Contract = exports.gweiToEther = exports.weiToEther = exports.toChecksumAddress = exports.tinyBig = exports.JsonRpcProvider = exports.jsonRpcProvider = exports.isAddress = exports.etherToGwei = exports.etherToWei = void 0;
 const Contract_1 = require("./classes/Contract");
 Object.defineProperty(exports, "Contract", { enumerable: true, get: function () { return Contract_1.Contract; } });
 const JsonRpcProvider_1 = require("./providers/JsonRpcProvider");
@@ -15,11 +29,11 @@ const ether_to_wei_1 = require("./utils/ether-to-wei");
 Object.defineProperty(exports, "etherToWei", { enumerable: true, get: function () { return ether_to_wei_1.etherToWei; } });
 const gwei_to_ether_1 = require("./utils/gwei-to-ether");
 Object.defineProperty(exports, "gweiToEther", { enumerable: true, get: function () { return gwei_to_ether_1.gweiToEther; } });
-const hex_zero_pad_1 = require("./utils/hex-zero-pad");
-Object.defineProperty(exports, "hexZeroPad", { enumerable: true, get: function () { return hex_zero_pad_1.hexZeroPad; } });
 const is_address_1 = require("./utils/is-address");
 Object.defineProperty(exports, "isAddress", { enumerable: true, get: function () { return is_address_1.isAddress; } });
 const to_checksum_address_1 = require("./utils/to-checksum-address");
 Object.defineProperty(exports, "toChecksumAddress", { enumerable: true, get: function () { return to_checksum_address_1.toChecksumAddress; } });
 const wei_to_ether_1 = require("./utils/wei-to-ether");
 Object.defineProperty(exports, "weiToEther", { enumerable: true, get: function () { return wei_to_ether_1.weiToEther; } });
+__exportStar(require("./utils/bytes"), exports);
+__exportStar(require("./utils/solidity-keccak256"), exports);

package/lib/cjs/logger/logger.d.ts

@@ -0,0 +1,11 @@
+declare class Logger {
+    private packageVersion;
+    constructor();
+    throwError(message: string, args: {
+        [key: string]: any;
+    }): never;
+    throwArgumentError(message: string, arg: string, value: any): never;
+    checkSafeUint53(value: number, message?: string): void;
+}
+export declare const logger: Logger;
+export {};

package/lib/cjs/logger/logger.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const package_version_1 = require("./package-version");
+class Logger {
+    constructor() {
+        this.packageVersion = package_version_1.version;
+    }
+    throwError(message, args) {
+        const argsLength = Object.keys(args).length;
+        throw new Error(`${message} (${Object.entries(args).map(([key, value], index) => `${key}=${value}${index < argsLength - 1 && ', '}`)}, version=essential-eth@${this.packageVersion})`);
+    }
+    throwArgumentError(message, arg, value) {
+        throw new Error(`${message} (argument="${arg}" value=${value}, version=essential-eth@${this.packageVersion})`);
+    }
+    checkSafeUint53(value, message = 'value not safe') {
+        if (typeof value !== 'number') {
+            return;
+        }
+        if (value < 0 || value >= 0x1fffffffffffff) {
+            this.throwError(message, {
+                operation: 'checkSafeInteger',
+                fault: 'out-of-safe-range',
+                value: value,
+            });
+        }
+        if (value % 1) {
+            this.throwError(message, {
+                operation: 'checkSafeInteger',
+                fault: 'non-integer',
+                value: value,
+            });
+        }
+    }
+}
+exports.logger = new Logger();

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

@@ -0,0 +1 @@
+export declare const version = "0.5.1";

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = void 0;
+// Generated by genversion.
+exports.version = '0.5.1';

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

@@ -58,7 +58,7 @@ export declare class JsonRpcProvider {
      *   }
      *```
      */
-    getBlock(timeFrame: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
+    getBlock(timeFrame?: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
     /**
      * Returns the network this provider is connected to
      */

package/lib/cjs/providers/JsonRpcProvider.js

@@ -73,7 +73,7 @@ class JsonRpcProvider {
      *   }
      *```
      */
-    getBlock(timeFrame, returnTransactionObjects = false) {
+    getBlock(timeFrame = 'latest', returnTransactionObjects = false) {
         return __awaiter(this, void 0, void 0, function* () {
             let rpcTimeFrame;
             if (typeof timeFrame === 'number') {

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

@@ -215,6 +215,7 @@ declare const _default: {
     "2153": string[];
     "2213": string[];
     "2221": string[];
+    "2223": string[];
     "2559": string[];
     "3000": string[];
     "3001": string[];
@@ -233,6 +234,8 @@ declare const _default: {
     "4918": string[];
     "5197": string[];
     "5315": string[];
+    "5551": string[];
+    "5553": string[];
     "5700": string[];
     "5777": string[];
     "5851": string[];
@@ -351,6 +354,7 @@ declare const _default: {
     "11155111": string[];
     "13371337": string[];
     "18289463": string[];
+    "20180430": string[];
     "20181205": string[];
     "28945486": string[];
     "35855456": string[];

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

@@ -655,6 +655,9 @@ exports.default = {
     "2221": [
         "kava"
     ],
+    "2223": [
+        "VChain"
+    ],
     "2559": [
         "ktoc"
     ],
@@ -709,6 +712,12 @@ exports.default = {
     "5315": [
         "UZMI"
     ],
+    "5551": [
+        "Nahmii"
+    ],
+    "5553": [
+        "Nahmii testnet"
+    ],
     "5700": [
         "tsys"
     ],
@@ -1063,6 +1072,9 @@ exports.default = {
     "18289463": [
         "ilt"
     ],
+    "20180430": [
+        "spectrum"
+    ],
     "20181205": [
         "qki"
     ],

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

@@ -12,6 +12,13 @@ export declare class TinyBig extends Big {
     toHexString(): string;
     toNumber(): number;
     toString(): string;
+    /**
+     * @param {String} str
+     * @param {String} padChar
+     * @param {Number} length
+     */
+    private padAndChop;
+    toTwos(bitCount: number): Big;
 }
 /**
  * Helper factory function so that you don't have to type "new" when instantiating a new TinyBig

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

@@ -12,13 +12,15 @@ const helpers_1 = require("./helpers");
  */
 class TinyBig extends big_js_1.default {
     constructor(value) {
-        try {
-            super(value);
-        }
-        catch (e) {
-            console.error(`TinyBig cannot parse value (value=${value})`);
-            throw e;
-        }
+        super(value);
+        /**
+         * @param {String} str
+         * @param {String} padChar
+         * @param {Number} length
+         */
+        this.padAndChop = (str, padChar, length) => {
+            return (Array(length).fill(padChar).join('') + str).slice(length * -1);
+        };
     }
     /**
      * Used anytime you're passing in "value" to ethers or web3
@@ -36,6 +38,22 @@ class TinyBig extends big_js_1.default {
         }
         return (0, helpers_1.scientificStrToDecimalStr)(super.toString());
     }
+    toTwos(bitCount) {
+        let binaryStr;
+        if (this.gte(0)) {
+            const twosComp = this.toNumber().toString(2);
+            binaryStr = this.padAndChop(twosComp, '0', bitCount || twosComp.length);
+        }
+        else {
+            binaryStr = this.plus(Math.pow(2, bitCount)).toNumber().toString(2);
+            if (Number(binaryStr) < 0) {
+                throw new Error('Cannot calculate twos complement');
+            }
+        }
+        const binary = `0b${binaryStr}`;
+        const decimal = Number(binary);
+        return tinyBig(decimal);
+    }
 }
 exports.TinyBig = TinyBig;
 /**

package/lib/cjs/utils/bytes.d.ts

@@ -0,0 +1,90 @@
+export declare type Bytes = ArrayLike<number>;
+/**
+ * @example
+ * [1,2,3]
+ *
+ * @example
+ * 0x123
+ *
+ * @example
+ * '0x123'
+ */
+export declare type BytesLike = Bytes | string | number;
+export interface DataOptions {
+    allowMissingPrefix?: boolean;
+    hexPad?: 'left' | 'right' | null;
+}
+export interface Hexable {
+    toHexString(): string;
+}
+export declare type SignatureLike = {
+    r: string;
+    s?: string;
+    _vs?: string;
+    recoveryParam?: number;
+    v?: number;
+} | BytesLike;
+export interface Signature {
+    r: string;
+    s: string;
+    _vs: string;
+    recoveryParam: number;
+    v: number;
+    yParityAndS: string;
+    compact: string;
+}
+export declare function isBytesLike(value: any): value is BytesLike;
+export declare function isBytes(value: any): value is Bytes;
+export declare function arrayify(value: BytesLike | Hexable | number, options?: DataOptions): Uint8Array;
+export declare function concat(items: ReadonlyArray<BytesLike>): Uint8Array;
+export declare function stripZeros(value: BytesLike): Uint8Array;
+export declare function zeroPad(value: BytesLike, length: number): Uint8Array;
+export declare function isHexString(value: any, length?: number): boolean;
+/**
+ * @example
+ * ```js
+ * hexlify(4);
+ * // '0x04'
+ *
+ * hexlify(14);
+ * // '0x0e'
+ * ```
+ */
+export declare function hexlify(value: BytesLike | Hexable | number | bigint, options?: DataOptions): string;
+export declare function hexDataLength(data: BytesLike): number | null;
+export declare function hexDataSlice(data: BytesLike, offset: number, endOffset?: number): string;
+export declare function hexConcat(items: ReadonlyArray<BytesLike>): string;
+export declare function hexValue(value: BytesLike | Hexable | number | bigint): string;
+export declare function hexStripZeros(value: BytesLike): string;
+/**
+ * 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(value: BytesLike, length: number): string;