add removeListener events to EIP1193Provider

+ update CHANGELOG + Fix some events types at `SocketProvider`
web3 · Jun 22, 2023 · 6c59986 · 6c59986
1 parent 89b2cd3
commit 6c59986
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 8 deletions.
diff --git a/packages/web3-types/CHANGELOG.md b/packages/web3-types/CHANGELOG.md
@@ -121,6 +121,15 @@ Documentation:
 
 ## [Unreleased]
 
+### Added
+
+-   Added the `SimpleProvider` interface which has only `request(args)` method that is compatible with EIP-1193 (#6210)
+-   Added the `Eip1193EventName` type that contains the possible events names according to EIP-1193 (#6210)
+
+### Changed
+
+-   The `EIP1193Provider` class has now all the events (for `on` and `removeListener`) according to EIP-1193 (#6210)
+
 ### Fixed
 
 -   Fixed bug #6185, now web3.js compiles on typescript v5 (#6195)
diff --git a/packages/web3-types/src/web3_base_provider.ts b/packages/web3-types/src/web3_base_provider.ts
@@ -108,12 +108,25 @@ export type ProviderChainId = string;
 
 export type ProviderAccounts = string[];
 
+export type Eip1193EventName =
+	| 'connect'
+	| 'disconnect'
+	| 'message'
+	| 'chainChanged'
+	| 'accountsChanged';
+
 export interface EIP1193Provider<API extends Web3APISpec> extends SimpleProvider<API> {
 	on(event: 'connect', listener: (info: ProviderInfo) => void): void;
 	on(event: 'disconnect', listener: (error: ProviderRpcError) => void): void;
 	on(event: 'message', listener: (message: ProviderMessage) => void): void;
 	on(event: 'chainChanged', listener: (chainId: ProviderChainId) => void): void;
 	on(event: 'accountsChanged', listener: (accounts: ProviderAccounts) => void): void;
+
+	removeListener(event: 'connect', listener: (info: ProviderInfo) => void): void;
+	removeListener(event: 'disconnect', listener: (error: ProviderRpcError) => void): void;
+	removeListener(event: 'message', listener: (message: ProviderMessage) => void): void;
+	removeListener(event: 'chainChanged', listener: (chainId: ProviderChainId) => void): void;
+	removeListener(event: 'accountsChanged', listener: (accounts: ProviderAccounts) => void): void;
 }
 
 // Provider interface compatible with EIP-1193

diff --git a/packages/web3-utils/src/socket_provider.ts b/packages/web3-utils/src/socket_provider.ts
@@ -16,6 +16,7 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 import {
 	ConnectionEvent,
+	Eip1193EventName,
 	EthExecutionAPI,
 	JsonRpcBatchRequest,
 	JsonRpcBatchResponse,
@@ -223,8 +224,11 @@ export abstract class SocketProvider<
 		listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>,
 	): void;
 	public on<T = JsonRpcResult, P = unknown>(
-		type: string | 'disconnect' | 'connect' | 'chainChanged' | 'accountsChanged',
-		listener: Web3Eip1193ProviderEventCallback<P> | Web3ProviderEventCallback<T>,
+		type: string | Eip1193EventName,
+		listener:
+			| Web3Eip1193ProviderEventCallback<P>
+			| Web3ProviderMessageEventCallback<T>
+			| Web3ProviderEventCallback<T>,
 	): void {
 		this._eventEmitter.on(type, listener);
 	}
@@ -249,15 +253,20 @@ export abstract class SocketProvider<
 	): void;
 	public once<T = JsonRpcResult>(
 		type: 'message',
-		listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderEventCallback<T>,
+		listener:
+			| Web3Eip1193ProviderEventCallback<ProviderMessage>
+			| Web3ProviderMessageEventCallback<T>,
 	): void;
 	public once<T = JsonRpcResult>(
 		type: string,
 		listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>,
 	): void;
 	public once<T = JsonRpcResult, P = unknown>(
-		type: string | 'disconnect' | 'connect' | 'chainChanged' | 'accountsChanged',
-		listener: Web3Eip1193ProviderEventCallback<P> | Web3ProviderEventCallback<T>,
+		type: string | Eip1193EventName,
+		listener:
+			| Web3Eip1193ProviderEventCallback<P>
+			| Web3ProviderMessageEventCallback<T>
+			| Web3ProviderEventCallback<T>,
 	): void {
 		this._eventEmitter.once(type, listener);
 	}
@@ -285,15 +294,20 @@ export abstract class SocketProvider<
 	): void;
 	public removeListener<T = JsonRpcResult>(
 		type: 'message',
-		listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderEventCallback<T>,
+		listener:
+			| Web3Eip1193ProviderEventCallback<ProviderMessage>
+			| Web3ProviderMessageEventCallback<T>,
 	): void;
 	public removeListener<T = JsonRpcResult>(
 		type: string,
 		listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>,
 	): void;
 	public removeListener<T = JsonRpcResult, P = unknown>(
-		type: string | 'disconnect' | 'connect' | 'chainChanged' | 'accountsChanged',
-		listener: Web3Eip1193ProviderEventCallback<P> | Web3ProviderEventCallback<T>,
+		type: string | Eip1193EventName,
+		listener:
+			| Web3Eip1193ProviderEventCallback<P>
+			| Web3ProviderMessageEventCallback<T>
+			| Web3ProviderEventCallback<T>,
 	): void {
 		this._eventEmitter.removeListener(type, listener);
 	}