6201 multi provider

packages/web3/CHANGELOG.md

@@ -191,4 +191,8 @@ Documentation:
 
 -   Dependencies updated ( details are in root changelog )
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+
+-   Added EIP-6963 utility function `requestEIP6963Providers` for multi provider discovery 

packages/web3/src/web3.ts

@@ -44,6 +44,7 @@ import abi from './abi.js';
 import { initAccountsForContext } from './accounts.js';
 import { Web3EthInterface } from './types.js';
 import { Web3PkgInfo } from './version.js';
+import { requestEIP6963Providers } from './web3_eip6963.js';
 
 export class Web3<
 	CustomRegisteredSubscription extends {
@@ -52,6 +53,7 @@ export class Web3<
 > extends Web3Context<EthExecutionAPI, CustomRegisteredSubscription & RegisteredSubscription> {
 	public static version = Web3PkgInfo.version;
 	public static utils = utils;
+	public static requestEIP6963Providers = requestEIP6963Providers;
 	public static modules = {
 		Web3Eth,
 		Iban,

packages/web3/src/web3_eip6963.ts

@@ -0,0 +1,71 @@
+/*
+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 { Web3APISpec, EIP1193Provider } from "web3-types";
+
+
+export enum Eip6963EventName {
+  eip6963announceProvider = 'eip6963:announceProvider',
+  eip6963requestProvider = 'eip6963:requestProvider',
+};
+
+export interface EIP6963ProviderInfo {
+  uuid: string;
+  name: string;
+  icon: string;
+  rdns: string;
+}
+
+export interface EIP6963ProviderDetail<API = Web3APISpec> {
+  info: EIP6963ProviderInfo;
+  provider: EIP1193Provider<API>;
+}
+
+export interface EIP6963AnnounceProviderEvent<API = Web3APISpec> extends CustomEvent {
+  type: Eip6963EventName.eip6963announceProvider;
+  detail: EIP6963ProviderDetail<API>;
+}
+
+export interface EIP6963RequestProviderEvent extends Event {
+  type: Eip6963EventName.eip6963requestProvider;
+}
+
+export const eip6963Providers: Map<string, EIP6963ProviderDetail> = new Map();
+
+export const requestEIP6963Providers = () => {
+
+  if (typeof window === 'undefined')
+    throw new Error(
+      "window object not available, EIP-6963 is intended to be used within a browser"
+    );
+
+  window.addEventListener(
+    Eip6963EventName.eip6963announceProvider as any,
+    (event: EIP6963AnnounceProviderEvent) => {
+
+      eip6963Providers.set(
+        event.detail.info.uuid,
+        event.detail);
+    }
+  );
+
+  window.dispatchEvent(new Event(Eip6963EventName.eip6963requestProvider));
+
+  return eip6963Providers;
+}
+
+

packages/web3/test/unit/web3eip6963.test.ts

@@ -0,0 +1,86 @@
+/*
+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 {
+	EIP6963AnnounceProviderEvent,
+	EIP6963ProviderDetail,
+	Eip6963EventName,
+	eip6963Providers,
+	requestEIP6963Providers
+} from "../../src/web3_eip6963";
+
+describe('requestEIP6963Providers', () => {
+
+	it('should request EIP6963 providers and store them in eip6963Providers', () => {
+
+		const mockProviderDetail: EIP6963ProviderDetail = {
+			info: {
+				uuid: '1',
+				name: 'MockProvider',
+				icon: 'icon-path',
+				rdns: 'mock.rdns'
+			},
+
+			provider: {} as any
+		};
+
+		const mockAnnounceEvent: EIP6963AnnounceProviderEvent = {
+			type: Eip6963EventName.eip6963announceProvider,
+			detail: mockProviderDetail
+		} as any;
+
+		// Mock the window object
+		(global as any).window = {
+			addEventListener: jest.fn(),
+			dispatchEvent: jest.fn()
+		};
+
+		// Call the function
+		requestEIP6963Providers();
+
+		// Validate event listener setup and event dispatch
+		expect((global as any).window.addEventListener)
+			.toHaveBeenCalledWith(Eip6963EventName.eip6963announceProvider, expect.any(Function));
+
+		expect((global as any).window.dispatchEvent).toHaveBeenCalled();
+
+		// Simulate the announce event
+		// Access the mock function calls for addEventListener
+		const addEventListenerMockCalls = (global as any).window.addEventListener.mock.calls;
+
+		// Retrieve the first call to addEventListener and access its second argument
+		const eventListenerArg = addEventListenerMockCalls[0][1];
+
+		// Now "eventListenerArg" represents the function to be called when the event occurs
+		const announceEventListener = eventListenerArg;
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-call
+		announceEventListener(mockAnnounceEvent);
+
+		// Validate if the provider detail is stored in the eip6963Providers map
+		expect(eip6963Providers.get('1')).toEqual(mockProviderDetail);
+	});
+
+	it('should throw an error if window object is not available', () => {
+		// Remove the window object
+		delete (global as any).window;
+
+		// Call the function and expect it to throw an error
+		expect(() => {
+			requestEIP6963Providers();
+		}).toThrow("window object not available, EIP-6963 is intended to be used within a browser");
+	});
+});