Merge branch '4.x' into fix-native

Author: jdevcs

.github/CONTRIBUTING.md

@@ -1,10 +1,10 @@
 # Contributing
 
-Thank you for contributing to web3.js! We appreciate your interest and welcome any contributions that can help improve our documentation, functionality, addressing bugs, or any other aspects that can contribute to the overall improvement of our project. Before you start contributing, please take a moment to review the guidelines below.
+Thank you for contributing to Web3.js! We appreciate your interest and welcome any contributions that can help improve our documentation, functionality, address bugs, or any other aspects that can contribute to the overall improvement of our project. Before you start contributing, please take a moment to review the guidelines below.
 
 ## Help and Support
 
-If you face any issues while contributing, or you want any type of support, we encourage you to join our [Discord Community](https://discord.com/invite/3shNX8cqGR) and ask any question in the `#web3js-general` channel, and/or submit a [New Issue](https://github.com/web3/web3.js/issues/new).
+If you face any issues while contributing or want any type of support, we encourage you to join our [Discord Community](https://discord.com/invite/3shNX8cqGR), ask any question in the `#web3js-general` channel, and/or submit a [new issue](https://github.com/web3/web3.js/issues/new).
 
 ## Prerequisites
 
@@ -15,12 +15,12 @@ If you face any issues while contributing, or you want any type of support, we e
 
 1. **Fork the docs:** Start by forking our repository to your GitHub account.
 
-2. **Clone the repo:** Clone the forked repository to your local machine using the following command
+2. **Clone the repo:** Clone the forked repository to your local machine using the following command:
 ```bash
 git clone https://github.com/your-username/web3.js.git
 ```
 3. **Create a Branch:** Create a new branch for your changes with a descriptive name.
-    **NOTE: The branch name must include the issue number (if there is no issue created for your contribution, please create one)**
+    **NOTE: The branch name must include the issue number (if there is no issue created for your contribution, please create one).**
 ```bash
 git checkout -b issue-name-1234
 ```
@@ -32,7 +32,7 @@ yarn
 ```
 6. **Make your changes:**...
 
-7. Check changes in local environment: Run the command `yarn start` and you'll see a local environment in `localhost:3000` with the docs
+7. Check changes in the local environment: Run the command `yarn start` and you'll see a local environment in `localhost:3000` with the documents.
 
 8. **Commit your changes:** `git add .` and `git commit -m 'descriptive msg'` 
 
@@ -41,9 +41,9 @@ yarn
 git push origin branch-name
 ```
 
-10. **Open a Pull request(PR):** Provide a detailed description of your changes, the problem you are solving, and any additional context(you can use the PR template).
+10. **Open a Pull Request (PR):** Provide a detailed description of your changes, the problem you are solving, and any additional context (you can use the PR template).
 
-11. **Wait for review**: Before merging any branch into the main branch, it must be approved by 2 devs, after succesfully approved, you can `Squash and merge` your branch, Please be responsive to any feedback on your pull request and make necessary changes based on the review.
+11. **Wait for review**: Before merging any branch into the main branch, it must be approved by two devs, after it is successfully approved, you can `Squash and merge` your branch, Please be responsive to any feedback on your pull request and make necessary changes based on the review.
 
 ## Guidelines for Pull Requests and Releases (Web3 4.x)
 
@@ -54,25 +54,25 @@ that **Web3 not break**.
 ### Pull Requests for substantive changes (e.g. everything except comments and docs)
 
 1.  Any PR that introduces a logic change should include tests. (In many cases, the tests will take more time to write than the actual code).
-1.  All PRs should sit for 72 hours with the `pleasereview` tag in order to garner feedback.
+1.  All PRs should sit for 72 hours with the `please review` tag to garner feedback.
 1.  No PR should be merged until it has been reviewed, passes CI, and all reviews' comments are
     addressed.
 1.  PRs should:
     1.  have a narrow, well-defined focus.
     1.  make the smallest set of changes possible to achieve their goal.
     1.  include a clear description in the opening comment.
     1.  preserve the conventions and stylistic consistency of any files they modify.
-1.  Given the choice between a conservative change that mostly works and an adventurous change which seems better but introduces uncertainty - prefer the conservative change.
+1.  Given the choice between a conservative change that mostly works and an adventurous change that seems better but introduces uncertainty - prefer the conservative change.
 
 ### Reviews
 
-The end goal of review is to suggest useful improvements to the author. Reviews should finish with approval unless there are issues that would result in:
+The end goal of the review is to suggest useful improvements to the author. Reviews should finish with approval unless there are issues that would result in:
 
-1.  Buggy behaviour.
+1.  Buggy behavior.
 1.  Undue maintenance burden.
-1.  Pessimisation (i.e. speed reduction / meaningful build-size increases).
+1.  Pessimisation (i.e. speed reduction or meaningful build-size increases).
 1.  Feature reduction (i.e. it removes some aspect of functionality that users rely on).
-1.  Avoidable risk (i.e it's difficult to test or hard to anticipate the implications of, without
+1.  Avoidable risk (i.e. it's difficult to test or hard to anticipate the implications of, without
     being strictly necessary to fix something broken).
 
 Read more in [Review Guidelines](./REVIEW.md).
@@ -85,9 +85,9 @@ Read more in [Review Guidelines](./REVIEW.md).
 1.  Changes should trigger a new `rc` release and set the release clock back enough that reviewers have the time they need to test new changes.
 1.  Regular maintainers should manually test the `rc` against a Node project and the published
     minified bundle in a browser context. An external reviewer should verify they've done the same.
-1.  A release PR must be approved at least by two known contributors of the web3.js project.
+1.  A release PR must be approved at least by two known contributors to the web3.js project.
 
-Read more in [Release Guidelines](./RELEASE.md).
+Read more in the [Release Guidelines](./RELEASE.md).
 
 ### Emergencies
 

.github/workflows/build.yml

@@ -89,13 +89,12 @@ jobs:
                 uses: actions/cache/restore@v3
                 with:
                     path: packages/web3/dist/4.x.json
-                    key: web3-bundle-stats-4x-${{github.sha}}
+                    key: web3-bundle-stats-4x-${{github.event.pull_request.base.sha}}
             -   run: yarn build:web:analyze
                 env:
                     STATS_FILE: ${{ github.ref_name }}.json
             -   name: Compare bundle stats
-                uses: github/webpack-bundlesize-compare-action@v1
-                if: github.event_name != 'push'
+                uses: github/webpack-bundlesize-compare-action@v1.8.2
                 continue-on-error: true
                 with:
                     github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -105,9 +104,10 @@ jobs:
                 uses: actions/cache/save@v3
                 if: github.event_name == 'push' && github.ref == 'refs/heads/4.x'
                 with:
-                    path: packages/web3/dist/4.x.json
+                    path: packages/web3/dist/${{ github.ref_name }}.json
                     key: web3-bundle-stats-4x-${{github.sha}}
 
+
     unit:
         name: Unit Tests
         needs: build
@@ -239,7 +239,7 @@ jobs:
                     path: ./
                     key: web3-18-${{github.sha}}
                 # @octokit/core not supported on node 16, so I can't add it to the package.json
-            -   run: npm install --no-package-lock --no-save --force @octokit/core
+            -   run: npm install --no-package-lock --no-save --force @octokit/core@5.1.0
             -   name: Restore main branch benchmark data
                 uses: actions/cache/restore@v3
                 with:

docs/docs/guides/web3_providers_guide/eip6963.md

@@ -9,9 +9,11 @@ sidebar_label: 'EIP-6963: Multi Injected Provider Discovery'
 
 EIP-6963 proposes the "Multi Injected Provider Discovery" standard, which aims to enhance the discoverability and interaction with multiple injected Ethereum providers in a browser environment. Injected providers refer to browser extensions or other injected scripts that provide access to an Ethereum provider within the context of a web application.
 
-Web3.js library has utility function for discovery of injected providers using `requestEIP6963Providers()` function. When `requestEIP6963Providers()` is used it returns `eip6963Providers` Map object. This Map object is in global scope so every time `requestEIP6963Providers()` function is called it will update Map object and return it. 
+Web3.js library has utility functions for discovery of injected providers using `requestEIP6963Providers()` and `onNewProviderDiscovered(eventDetails)`. 
 
-`eip6963Providers` Map object has provider's `UUID` as keys and `EIP6963ProviderDetail` as values. `EIP6963ProviderDetail` is:
+`onNewProviderDiscovered(eventDetails)` can be used to subscribe to events of provider discovery & providers map update and `requestEIP6963Providers()` returns Promise object that resolves to `Map<string, EIP6963ProviderDetail>` object containing list of providers. For updated providers `eip6963:providersMapUpdated` event is emitted and it has updated Map object. This event can be subscribed as mentioned earlier using `onNewProviderDiscovered(eventDetails)`
+
+`eip6963ProvidersMap` object has provider's `UUID` as keys and `EIP6963ProviderDetail` as values. `EIP6963ProviderDetail` is:
 
 ```ts
 export interface EIP6963ProviderDetail {
@@ -40,8 +42,15 @@ Following code snippet demonstrates usage of `requestEIP6963Providers()` functio
 
 import { Web3 } from 'web3';
 
-const providers = Web3.requestEIP6963Providers();
+// Following will subscribe to event that will be triggered when providers map is updated.
+
+Web3.onNewProviderDiscovered((provider) => {
+  console.log(provider.detail); // This will log the populated providers map object, provider.detail has Map of all providers yet discovered
+   // add logic here for updating UI of your DApp
+});
 
+// Call the function and wait for the promise to resolve
+let providers = await Web3.requestEIP6963Providers();
 for (const [key, value] of providers) {
     console.log(value);
 

docs/docs/guides/web3_upgrade_guide/1.x/accounts_migration_guide.md

@@ -34,3 +34,14 @@ const wallet = web3.eth.accounts.wallet.create(1, 'optionalEntropy'); // entropy
 const account = web3.eth.accounts.wallet.create(1, 'optionalEntropy'); // will result in an error
 const account = web3.eth.accounts.wallet.create(); // correct way
 ```
+
+## stripHexPrefix method
+
+In 1.x `stripHexPrefix` method is located in the `web3-utils` package, in 4.x this has been moved to `web3-eth-accounts`
+
+```typescript
+import { stripHexPrefix } from 'web3-eth-accounts';
+
+console.log(stripHexPrefix('0x123')); // "123"
+
+```

docs/docs/guides/web3_upgrade_guide/1.x/web3_utils_migration_guide.md

@@ -79,6 +79,16 @@ isHex('-0x'); // in 1.x used to return `true`. But changed in 4.x to return `fal
 
 isHexStrict('-0x'); // in 1.x used to return `true`. But changed in 4.x to return `false`
 // `false`
+```
+## stripHexPrefix method
+
+In 1.x `stripHexPrefix` method is located in the `web3-utils` package, in 4.x this has been moved to `web3-eth-accounts`
+
+```typescript
+import { stripHexPrefix } from 'web3-eth-accounts';
+
+console.log(stripHexPrefix('0x123')); // "123"
+
 ```
 
 ## Other functions

packages/web3-utils/src/index.ts

@@ -33,4 +33,4 @@ export * from './web3_eip1193_provider.js';
 export * from './socket_provider.js';
 export * from './uint8array.js';
 // for backwards compatibility with v1
-export {AbiItem} from 'web3-types';
+export { AbiItem } from 'web3-types';

packages/web3-utils/src/objects.ts

@@ -36,7 +36,7 @@ export const mergeDeep = (
 	destination: Record<string, unknown>,
 	...sources: Record<string, unknown>[]
 ): Record<string, unknown> => {
-	const result = destination; // clone deep here
+	const result = { ...destination }; // clone deep here
 	if (!isIterable(result)) {
 		return result;
 	}

packages/web3/src/providers.exports.ts

@@ -19,3 +19,4 @@ export { Eip1193Provider, SocketProvider } from 'web3-utils';
 
 export * as http from 'web3-providers-http';
 export * as ws from 'web3-providers-ws';
+export * from './web3_eip6963.js';

packages/web3/src/web3.ts

@@ -44,7 +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';
+import { onNewProviderDiscovered, requestEIP6963Providers } from './web3_eip6963.js';
 
 export class Web3<
 	CustomRegisteredSubscription extends {
@@ -54,6 +54,7 @@ export class Web3<
 	public static version = Web3PkgInfo.version;
 	public static utils = utils;
 	public static requestEIP6963Providers = requestEIP6963Providers;
+	public static onNewProviderDiscovered = onNewProviderDiscovered;
 	public static modules = {
 		Web3Eth,
 		Iban,

packages/web3/src/web3_eip6963.ts

@@ -44,28 +44,48 @@ export interface EIP6963RequestProviderEvent extends Event {
   type: Eip6963EventName.eip6963requestProvider;
 }
 
-export const eip6963Providers: Map<string, EIP6963ProviderDetail> = new Map();
+export const eip6963ProvidersMap: Map<string, EIP6963ProviderDetail> = new Map();
 
-export const requestEIP6963Providers = () => {
+export const web3ProvidersMapUpdated = "web3:providersMapUpdated";
+export interface EIP6963ProvidersMapUpdateEvent extends CustomEvent {
+  type: string;
+  detail: Map<string, EIP6963ProviderDetail>;
+}
 
-  if (typeof window === 'undefined')
-    throw new Error(
-      "window object not available, EIP-6963 is intended to be used within a browser"
-    );
+export const requestEIP6963Providers = async () => 
+   new Promise((resolve, reject) => {
+    if (typeof window === 'undefined') {
+      reject(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(
+      eip6963ProvidersMap.set(
         event.detail.info.uuid,
         event.detail);
+
+      const newEvent: EIP6963ProvidersMapUpdateEvent = new CustomEvent(
+        web3ProvidersMapUpdated,
+        { detail: eip6963ProvidersMap }
+        );
+
+      window.dispatchEvent(newEvent);
+      resolve(eip6963ProvidersMap);
+
     }
   );
 
   window.dispatchEvent(new Event(Eip6963EventName.eip6963requestProvider));
 
-  return eip6963Providers;
-}
+  });
 
 
+export const onNewProviderDiscovered = (callback: (providerEvent: EIP6963AnnounceProviderEvent) => void) => {
+  if (typeof window === 'undefined') {
+    throw new Error("window object not available, EIP-6963 is intended to be used within a browser");
+  }
+  window.addEventListener(web3ProvidersMapUpdated as any, callback );
+}
+