web3util 4.3.2

package/lib/commonjs/promise_helpers.d.ts

@@ -0,0 +1,47 @@
+export declare type Timer = ReturnType<typeof setInterval>;
+export declare type Timeout = ReturnType<typeof setTimeout>;
+/**
+ * An alternative to the node function `isPromise` that exists in `util/types` because it is not available on the browser.
+ * @param object - to check if it is a `Promise`
+ * @returns `true` if it is an `object` or a `function` that has a `then` function. And returns `false` otherwise.
+ */
+export declare function isPromise(object: unknown): boolean;
+export declare type AsyncFunction<T, K = unknown> = (...args: K[]) => Promise<T>;
+export declare function waitWithTimeout<T>(awaitable: Promise<T> | AsyncFunction<T>, timeout: number, error: Error): Promise<T>;
+export declare function waitWithTimeout<T>(awaitable: Promise<T> | AsyncFunction<T>, timeout: number): Promise<T | undefined>;
+/**
+ * Repeatedly calls an async function with a given interval until the result of the function is defined (not undefined or null),
+ * or until a timeout is reached. It returns promise and intervalId.
+ * @param func - The function to call.
+ * @param interval - The interval in milliseconds.
+ */
+export declare function pollTillDefinedAndReturnIntervalId<T>(func: AsyncFunction<T>, interval: number): [Promise<Exclude<T, undefined>>, Timer];
+/**
+ * Repeatedly calls an async function with a given interval until the result of the function is defined (not undefined or null),
+ * or until a timeout is reached.
+ * pollTillDefinedAndReturnIntervalId() function should be used instead of pollTillDefined if you need IntervalId in result.
+ * This function will be deprecated in next major release so use pollTillDefinedAndReturnIntervalId().
+ * @param func - The function to call.
+ * @param interval - The interval in milliseconds.
+ */
+export declare function pollTillDefined<T>(func: AsyncFunction<T>, interval: number): Promise<Exclude<T, undefined>>;
+/**
+ * Enforce a timeout on a promise, so that it can be rejected if it takes too long to complete
+ * @param timeout - The timeout to enforced in milliseconds.
+ * @param error - The error to throw if the timeout is reached.
+ * @returns A tuple of the timeout id and the promise that will be rejected if the timeout is reached.
+ *
+ * @example
+ * ```ts
+ * const [timerId, promise] = web3.utils.rejectIfTimeout(100, new Error('time out'));
+ * ```
+ */
+export declare function rejectIfTimeout(timeout: number, error: Error): [Timer, Promise<never>];
+/**
+ * Sets an interval that repeatedly executes the given cond function with the specified interval between each call.
+ * If the condition is met, the interval is cleared and a Promise that rejects with the returned value is returned.
+ * @param cond - The function/condition to call.
+ * @param interval - The interval in milliseconds.
+ * @returns - an array with the interval ID and the Promise.
+ */
+export declare function rejectIfConditionAtInterval<T>(cond: AsyncFunction<T | undefined>, interval: number): [Timer, Promise<never>];

package/lib/commonjs/promise_helpers.js

@@ -0,0 +1,155 @@
+"use strict";
+/*
+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/>.
+*/
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rejectIfConditionAtInterval = exports.rejectIfTimeout = exports.pollTillDefined = exports.pollTillDefinedAndReturnIntervalId = exports.waitWithTimeout = exports.isPromise = void 0;
+const web3_validator_1 = require("web3-validator");
+/**
+ * An alternative to the node function `isPromise` that exists in `util/types` because it is not available on the browser.
+ * @param object - to check if it is a `Promise`
+ * @returns `true` if it is an `object` or a `function` that has a `then` function. And returns `false` otherwise.
+ */
+function isPromise(object) {
+    return ((typeof object === 'object' || typeof object === 'function') &&
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        typeof object.then === 'function');
+}
+exports.isPromise = isPromise;
+/**
+ * Wait for a promise but interrupt it if it did not resolve within a given timeout.
+ * If the timeout reached, before the promise code resolve, either throw an error if an error object was provided, or return `undefined`.
+ * @param awaitable - The promise or function to wait for.
+ * @param timeout - The timeout in milliseconds.
+ * @param error - (Optional) The error to throw if the timeout reached.
+ */
+function waitWithTimeout(awaitable, timeout, error) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let timeoutId;
+        const result = yield Promise.race([
+            awaitable instanceof Promise ? awaitable : awaitable(),
+            new Promise((resolve, reject) => {
+                timeoutId = setTimeout(() => (error ? reject(error) : resolve(undefined)), timeout);
+            }),
+        ]);
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+        if (result instanceof Error) {
+            throw result;
+        }
+        return result;
+    });
+}
+exports.waitWithTimeout = waitWithTimeout;
+/**
+ * Repeatedly calls an async function with a given interval until the result of the function is defined (not undefined or null),
+ * or until a timeout is reached. It returns promise and intervalId.
+ * @param func - The function to call.
+ * @param interval - The interval in milliseconds.
+ */
+function pollTillDefinedAndReturnIntervalId(func, interval) {
+    let intervalId;
+    const polledRes = new Promise((resolve, reject) => {
+        intervalId = setInterval((function intervalCallbackFunc() {
+            (() => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const res = yield waitWithTimeout(func, interval);
+                    if (!(0, web3_validator_1.isNullish)(res)) {
+                        clearInterval(intervalId);
+                        resolve(res);
+                    }
+                }
+                catch (error) {
+                    clearInterval(intervalId);
+                    reject(error);
+                }
+            }))();
+            return intervalCallbackFunc;
+        })(), // this will immediate invoke first call
+        interval);
+    });
+    return [polledRes, intervalId];
+}
+exports.pollTillDefinedAndReturnIntervalId = pollTillDefinedAndReturnIntervalId;
+/**
+ * Repeatedly calls an async function with a given interval until the result of the function is defined (not undefined or null),
+ * or until a timeout is reached.
+ * pollTillDefinedAndReturnIntervalId() function should be used instead of pollTillDefined if you need IntervalId in result.
+ * This function will be deprecated in next major release so use pollTillDefinedAndReturnIntervalId().
+ * @param func - The function to call.
+ * @param interval - The interval in milliseconds.
+ */
+function pollTillDefined(func, interval) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return pollTillDefinedAndReturnIntervalId(func, interval)[0];
+    });
+}
+exports.pollTillDefined = pollTillDefined;
+/**
+ * Enforce a timeout on a promise, so that it can be rejected if it takes too long to complete
+ * @param timeout - The timeout to enforced in milliseconds.
+ * @param error - The error to throw if the timeout is reached.
+ * @returns A tuple of the timeout id and the promise that will be rejected if the timeout is reached.
+ *
+ * @example
+ * ```ts
+ * const [timerId, promise] = web3.utils.rejectIfTimeout(100, new Error('time out'));
+ * ```
+ */
+function rejectIfTimeout(timeout, error) {
+    let timeoutId;
+    const rejectOnTimeout = new Promise((_, reject) => {
+        timeoutId = setTimeout(() => {
+            reject(error);
+        }, timeout);
+    });
+    return [timeoutId, rejectOnTimeout];
+}
+exports.rejectIfTimeout = rejectIfTimeout;
+/**
+ * Sets an interval that repeatedly executes the given cond function with the specified interval between each call.
+ * If the condition is met, the interval is cleared and a Promise that rejects with the returned value is returned.
+ * @param cond - The function/condition to call.
+ * @param interval - The interval in milliseconds.
+ * @returns - an array with the interval ID and the Promise.
+ */
+function rejectIfConditionAtInterval(cond, interval) {
+    let intervalId;
+    const rejectIfCondition = new Promise((_, reject) => {
+        intervalId = setInterval(() => {
+            (() => __awaiter(this, void 0, void 0, function* () {
+                const error = yield cond();
+                if (error) {
+                    clearInterval(intervalId);
+                    reject(error);
+                }
+            }))();
+        }, interval);
+    });
+    return [intervalId, rejectIfCondition];
+}
+exports.rejectIfConditionAtInterval = rejectIfConditionAtInterval;
+//# sourceMappingURL=promise_helpers.js.map

package/lib/commonjs/promise_helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise_helpers.js","sourceRoot":"","sources":["../../src/promise_helpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;;;;;;;;;;AAEF,mDAA2C;AAK3C;;;;GAIG;AACH,SAAgB,SAAS,CAAC,MAAe;IACxC,OAAO,CACN,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,UAAU,CAAC;QAC5D,sEAAsE;QACtE,OAAQ,MAA4B,CAAC,IAAI,KAAK,UAAU,CACxD,CAAC;AACH,CAAC;AAND,8BAMC;AAcD;;;;;;GAMG;AACH,SAAsB,eAAe,CACpC,SAAwC,EACxC,OAAe,EACf,KAAa;;QAEb,IAAI,SAA8B,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;YACjC,SAAS,YAAY,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE;YACtD,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAClD,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YACrF,CAAC,CAAC;SACF,CAAC,CAAC;QACH,IAAI,SAAS,EAAE;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;SACxB;QACD,IAAI,MAAM,YAAY,KAAK,EAAE;YAC5B,MAAM,MAAM,CAAC;SACb;QACD,OAAO,MAAM,CAAC;IACf,CAAC;CAAA;AAnBD,0CAmBC;AAED;;;;;GAKG;AACH,SAAgB,kCAAkC,CACjD,IAAsB,EACtB,QAAgB;IAEhB,IAAI,UAA6B,CAAC;IAClC,MAAM,SAAS,GAAG,IAAI,OAAO,CAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxE,UAAU,GAAG,WAAW,CACvB,CAAC,SAAS,oBAAoB;YAC7B,CAAC,GAAS,EAAE;gBACX,IAAI;oBACH,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;oBAElD,IAAI,CAAC,IAAA,0BAAS,EAAC,GAAG,CAAC,EAAE;wBACpB,aAAa,CAAC,UAAU,CAAC,CAAC;wBAC1B,OAAO,CAAC,GAAuC,CAAC,CAAC;qBACjD;iBACD;gBAAC,OAAO,KAAK,EAAE;oBACf,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC1B,MAAM,CAAC,KAAK,CAAC,CAAC;iBACd;YACF,CAAC,CAAA,CAAC,EAAa,CAAC;YAChB,OAAO,oBAAoB,CAAC;QAC7B,CAAC,CAAC,EAAE,EAAE,wCAAwC;QAC9C,QAAQ,CACR,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,SAAsD,EAAE,UAAW,CAAC,CAAC;AAC9E,CAAC;AA5BD,gFA4BC;AAED;;;;;;;GAOG;AACH,SAAsB,eAAe,CACpC,IAAsB,EACtB,QAAgB;;QAEhB,OAAO,kCAAkC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;CAAA;AALD,0CAKC;AACD;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,OAAe,EAAE,KAAY;IAC5D,IAAI,SAA4B,CAAC;IACjC,MAAM,eAAe,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QACxD,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QACf,CAAC,EAAE,OAAO,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,SAAU,EAAE,eAAe,CAAC,CAAC;AACtC,CAAC;AARD,0CAQC;AACD;;;;;;GAMG;AACH,SAAgB,2BAA2B,CAC1C,IAAkC,EAClC,QAAgB;IAEhB,IAAI,UAA6B,CAAC;IAClC,MAAM,iBAAiB,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC1D,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE;YAC7B,CAAC,GAAS,EAAE;gBACX,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,CAAC;gBAC3B,IAAI,KAAK,EAAE;oBACV,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC1B,MAAM,CAAC,KAAK,CAAC,CAAC;iBACd;YACF,CAAC,CAAA,CAAC,EAAa,CAAC;QACjB,CAAC,EAAE,QAAQ,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,UAAW,EAAE,iBAAiB,CAAC,CAAC;AACzC,CAAC;AAjBD,kEAiBC"}

package/lib/commonjs/random.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Returns a random byte array by the given bytes size
+ * @param size - The size of the random byte array returned
+ * @returns - random byte array
+ *
+ * @example
+ * ```ts
+ * console.log(web3.utils.randomBytes(32));
+ * > Uint8Array(32) [
+ *       93, 172, 226,  32,  33, 176, 156, 156,
+ *       182,  30, 240,   2,  69,  96, 174, 197,
+ *       33, 136, 194, 241, 197, 156, 110, 111,
+ *       66,  87,  17,  88,  67,  48, 245, 183
+ *    ]
+ * ```
+ */
+export declare const randomBytes: (size: number) => Uint8Array;
+/**
+ * Returns a random hex string by the given bytes size
+ * @param byteSize - The size of the random hex string returned
+ * @returns - random hex string
+ *
+ * ```ts
+ * console.log(web3.utils.randomHex(32));
+ * > 0x139f5b88b72a25eab053d3b57fe1f8a9dbc62a526b1cb1774d0d7db1c3e7ce9e
+ * ```
+ */
+export declare const randomHex: (byteSize: number) => string;

package/lib/commonjs/random.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+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/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randomHex = exports.randomBytes = void 0;
+/**
+ * @module Utils
+ */
+const random_js_1 = require("ethereum-cryptography/random.js");
+const converters_js_1 = require("./converters.js");
+/**
+ * Returns a random byte array by the given bytes size
+ * @param size - The size of the random byte array returned
+ * @returns - random byte array
+ *
+ * @example
+ * ```ts
+ * console.log(web3.utils.randomBytes(32));
+ * > Uint8Array(32) [
+ *       93, 172, 226,  32,  33, 176, 156, 156,
+ *       182,  30, 240,   2,  69,  96, 174, 197,
+ *       33, 136, 194, 241, 197, 156, 110, 111,
+ *       66,  87,  17,  88,  67,  48, 245, 183
+ *    ]
+ * ```
+ */
+const randomBytes = (size) => (0, random_js_1.getRandomBytesSync)(size);
+exports.randomBytes = randomBytes;
+/**
+ * Returns a random hex string by the given bytes size
+ * @param byteSize - The size of the random hex string returned
+ * @returns - random hex string
+ *
+ * ```ts
+ * console.log(web3.utils.randomHex(32));
+ * > 0x139f5b88b72a25eab053d3b57fe1f8a9dbc62a526b1cb1774d0d7db1c3e7ce9e
+ * ```
+ */
+const randomHex = (byteSize) => (0, converters_js_1.bytesToHex)((0, exports.randomBytes)(byteSize));
+exports.randomHex = randomHex;
+//# sourceMappingURL=random.js.map

package/lib/commonjs/random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.js","sourceRoot":"","sources":["../../src/random.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAEF;;GAEG;AAEH,+DAAqE;AACrE,mDAA6C;AAE7C;;;;;;;;;;;;;;;GAeG;AACI,MAAM,WAAW,GAAG,CAAC,IAAY,EAAc,EAAE,CAAC,IAAA,8BAAkB,EAAC,IAAI,CAAC,CAAC;AAArE,QAAA,WAAW,eAA0D;AAElF;;;;;;;;;GASG;AACI,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAU,EAAE,CAAC,IAAA,0BAAU,EAAC,IAAA,mBAAW,EAAC,QAAQ,CAAC,CAAC,CAAC;AAA5E,QAAA,SAAS,aAAmE"}

package/lib/commonjs/socket_provider.d.ts

@@ -0,0 +1,128 @@
+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;
+}