essential-eth 0.5.0 → 0.5.4

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

@@ -0,0 +1,172 @@
+export declare type Bytes = ArrayLike<number>;
+/**
+ * @example
+ * [1,2,3]
+ *
+ * @example
+ * 0x123
+ *
+ * @example
+ * '0x123'
+ */
+export declare type BytesLike = Bytes | string;
+export declare type BytesLikeWithNumber = BytesLike | 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;
+}
+/**
+ * Returns true if and only if value is a valid [Bytes](#bytes) or DataHexString
+ * * Same as [`ethers.utils.isBytesLike`](https://docs.ethers.io/v5/api/utils/bytes/#utils-isBytesLike)
+ *
+ * @example
+ * ```js
+ * isBytesLike([1,2,3]);
+ * // true
+ * ```
+ *
+ * @example
+ * ```js
+ * isBytesLike(false);
+ * // false
+ * ```
+ *
+ * @example
+ * ```js
+ * isBytesLike(new Uint8Array(1));
+ * // true
+ * ```
+ */
+export declare function isBytesLike(value: any): value is BytesLike;
+/**
+ * Returns true if and only if value is a valid [Bytes](#bytes)
+ * * Same as [`ethers.utils.isBytes`](https://docs.ethers.io/v5/api/utils/bytes/#utils-isBytes)
+ *
+ * @example
+ * ```js
+ * isBytes([1,2,3]);
+ * // true
+ * ```
+ *
+ * @example
+ * ```js
+ * isBytes(false);
+ * // false
+ * ```
+ *
+ * @example
+ * ```js
+ * isBytes(new Uint8Array(1));
+ * // true
+ * ```
+ */
+export declare function isBytes(value: any): value is Bytes;
+/**
+ * Converts DataHexStringOrArrayish to a Uint8Array
+ * * Same as [`ethers.utils.arrayify`](https://docs.ethers.io/v5/api/utils/bytes/#utils-arrayify)
+ *
+ * @example
+ * ```js
+ * arrayify(1);
+ * // Uint8Array(1) [ 1 ]
+ * ```
+ *
+ * @example
+ * ```js
+ * arrayify(0x1234);
+ * // Uint8Array(2) [ 18, 52 ]
+ * ```
+ *
+ * @example
+ * ```js
+ * arrayify('0x1', { hexPad: 'right' });
+ * // Uint8Array(1) [ 16 ]
+ * ```
+ */
+export declare function arrayify(value: BytesLike | Hexable | number, options?: DataOptions): Uint8Array;
+/**
+ * Concatenates all the BytesLike in arrayOfBytesLike into a single Uint8Array.
+ * * Same as [`ethers.utils.concat`](https://docs.ethers.io/v5/api/utils/bytes/#utils-concat)
+ *
+ * @example
+ * ```js
+ * concat([0, 1]);
+ * // Uint8Array(2) [ 0, 1 ]
+ * ```
+ */
+export declare function concat(arrayOfBytesLike: ReadonlyArray<BytesLikeWithNumber>): Uint8Array;
+export declare function stripZeros(value: BytesLike): Uint8Array;
+export declare function zeroPad(value: BytesLike, length: number): Uint8Array;
+/**
+ * Returns true if and only if object is a valid hex string.
+ * If length is specified and object is not a valid DataHexString of length bytes, an InvalidArgument error is thrown.
+ * * Same as [`ethers.utils.isHexString`](https://docs.ethers.io/v5/api/utils/bytes/#utils-isHexString)
+ */
+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: BytesLikeWithNumber, 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: BytesLikeWithNumber, length: number): string;