Merge branch '4.x' into ok/7017-Research-Snyk-Advisor-score-to-make-improvements

avkos · avkos · commit c8c0bf436ec3 · 2024-05-30T11:12:58.000-04:00
diff --git a/docs/.snyk b/docs/.snyk
@@ -0,0 +1,36 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.25.0
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-BRACES-6838727:
+    - '*':
+        reason: Docusaurus issue
+        expires: 3024-06-26T17:29:07.153Z
+        created: 2024-05-27T17:29:07.159Z
+  SNYK-JS-EXPRESS-6474509:
+    - '*':
+        reason: Docusaurus issue
+        expires: 3024-06-26T17:29:31.142Z
+        created: 2024-05-27T17:29:31.149Z
+  SNYK-JS-INFLIGHT-6095116:
+    - '*':
+        reason: Docusaurus issue
+        expires: 3024-06-26T17:29:51.622Z
+        created: 2024-05-27T17:29:51.628Z
+  SNYK-JS-MICROMATCH-6838728:
+    - '*':
+        reason: Docusaurus issue
+        expires: 3024-06-26T17:30:47.237Z
+        created: 2024-05-27T17:30:47.240Z
+  SNYK-JS-SERIALIZEJAVASCRIPT-6147607:
+    - '*':
+        reason: Docusaurus issue
+        expires: 3024-06-26T17:31:06.652Z
+        created: 2024-05-27T17:31:06.656Z
+  SNYK-JS-WEBPACKDEVMIDDLEWARE-6476555:
+    - '*':
+        reason: Docusaurus issue
+        expires: 3024-06-26T20:52:00.793Z
+        created: 2024-05-27T20:52:00.797Z
+
+patch: {}
diff --git a/docs/docs/guides/advanced/_category_.yml b/docs/docs/guides/advanced/_category_.yml
@@ -2,4 +2,4 @@ label: '🧠 Advanced'
 collapsible: true
 collapsed: true
 link: null
-position: 15
+position: 11
diff --git a/docs/docs/guides/events_subscriptions/_category_.yml b/docs/docs/guides/events_subscriptions/_category_.yml
@@ -2,4 +2,4 @@ label: '🔔 Events subscription'
 collapsible: true
 collapsed: true
 link: null
-position: 7
+position: 5
diff --git a/docs/docs/guides/feedback/index.md b/docs/docs/guides/feedback/index.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 18
+sidebar_position: 17
 sidebar_label: '🗣️ Feedback'
 ---
 
diff --git a/docs/docs/guides/getting_started/quickstart.md b/docs/docs/guides/getting_started/quickstart.md
@@ -43,7 +43,7 @@ import { Web3 } from 'web3';
 
 ## Initialize `Web3` with a provider
 
-[Providers](/guides/web3_providers_guide/) are objects that are responsible for enabling connectivity with the Ethereum network. The `Web3` object must be initialized with a valid provider to function as intended. Web3.js supports [HTTP](/guides/web3_providers_guide/#http-provider), [WebSocket](/guides/web3_providers_guide/#websocket-provider), and [IPC](/guides/web3_providers_guide/#ipc-provider) providers, and exposes packages for working with each type of provider.
+[Providers](/guides/web3_providers_guide/) are services that are responsible for enabling connectivity with the Ethereum network. The `Web3` object must be initialized with a valid provider to function as intended. Web3.js supports [HTTP](/guides/web3_providers_guide/#http-provider), [WebSocket](/guides/web3_providers_guide/#websocket-provider), and [IPC](/guides/web3_providers_guide/#ipc-provider) providers, and exposes packages for working with each type of provider.
 
 Web3.js is in compliance with [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193), the Ethereum Provider JavaScript API, so any EIP-1193 provider can be used to initialize the `Web3` object.
 
@@ -248,7 +248,7 @@ console.log(eventTransfer);
 Web3.js allows user to subscribe to events for real-time notification of important contract interactions. Here is an example of creating a subscription to the Uniswap token's `Transfer` event:
 
 :::note
-You MUST initialize the `Web3` object with a [WebSocket](/guides/web3_providers_guide/#websocket-provider) provider to subscribe to live events.
+HTTP providers do not support real-time event subscriptions. Use one of the other [provider types](/guides/web3_providers_guide/#providers-types) to subscribe to real-time events.
 :::
 
 ```ts
diff --git a/docs/docs/guides/hardhat_tutorial/_category_.yml b/docs/docs/guides/hardhat_tutorial/_category_.yml
@@ -2,4 +2,4 @@ label: '⛑️ Hardhat Tutorial'
 collapsible: true
 collapsed: true
 link: null
-position: 3
+position: 6
diff --git a/docs/docs/guides/migration_from_other_libs/_category_.yml b/docs/docs/guides/migration_from_other_libs/_category_.yml
@@ -2,4 +2,4 @@ label: '🔄 Migration Guides'
 collapsible: true
 collapsed: true
 link: null
-position: 12
+position: 15
diff --git a/docs/docs/guides/resources_and_troubleshooting/index.md b/docs/docs/guides/resources_and_troubleshooting/index.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 17
+sidebar_position: 16
 sidebar_label: '📚 Resources & Troubleshooting'
 ---
 # Resources & Troubleshooting
diff --git a/docs/docs/guides/smart_contracts/_category_.yml b/docs/docs/guides/smart_contracts/_category_.yml
@@ -2,4 +2,4 @@ label: '📜 Smart Contracts'
 collapsible: true
 collapsed: true
 link: null
-position: 6
+position: 4
diff --git a/docs/docs/guides/wagmi_usage/_category_.yml b/docs/docs/guides/wagmi_usage/_category_.yml
@@ -2,4 +2,4 @@ label: '🔄 Wagmi usage'
 collapsible: true
 collapsed: true
 link: null
-position: 13
+position: 14
diff --git a/docs/docs/guides/wallet/_category_.yml b/docs/docs/guides/wallet/_category_.yml
@@ -2,4 +2,4 @@ label: '🔑 Wallet and Accounts '
 collapsible: true
 collapsed: true
 link: null
-position: 5
+position: 3
diff --git a/docs/docs/guides/wallet/metamask.md b/docs/docs/guides/wallet/metamask.md
@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-sidebar_label: Connecting to Metamask
+sidebar_label: 'Tutorial: Connecting to Metamask'
 ---
 
 # Connecting to Metamask
diff --git a/docs/docs/guides/wallet/node_wallet.md b/docs/docs/guides/wallet/node_wallet.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 8
 sidebar_label: 'Tutorial: Node Wallet'
 ---
 
diff --git a/docs/docs/guides/wallet/signing.md b/docs/docs/guides/wallet/signing.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 6
 sidebar_label: 'Tutorial: Signing operations'
 ---
 
diff --git a/docs/docs/guides/wallet/transactions.md b/docs/docs/guides/wallet/transactions.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 7
 sidebar_label: 'Tutorial: Sending Transactions'
 ---
 
diff --git a/docs/docs/guides/wallet/web3_modal_guide/_category_.yml b/docs/docs/guides/wallet/web3_modal_guide/_category_.yml
@@ -2,4 +2,4 @@ label: '📱 WalletConnect Tutorial'
 collapsible: true
 collapsed: true
 link: null
-position: 14
+position: 5
diff --git a/docs/docs/guides/wallet/web3_modal_guide/index.mdx b/docs/docs/guides/wallet/web3_modal_guide/index.mdx
@@ -104,8 +104,8 @@ const USDTAddress = '0xdac17f958d2ee523a2206206994597c13d831ec7';
 function Components() {
   const { isConnected } = useWeb3ModalAccount()
   const { walletProvider } = useWeb3ModalProvider()
-  const [USDTBalance, setUSDTBalance] = useState(0); 
-  const [smartContractName, setSmartContractName] = useState(''); 
+  const [USDTBalance, setUSDTBalance] = useState(0);
+  const [smartContractName, setSmartContractName] = useState('');
 
   async function getContractInfo() {
     if (!isConnected) throw Error('not connected');
@@ -126,5 +126,5 @@ function Components() {
 ```
 
 :::info
-- To learn how to set up Web3modal with vue, click [here](/guides/web3_modal_guide/vue).
-:::
+- To learn how to set up Web3modal with vue, click [here](/guides/wallet/web3_modal_guide/vue).
+:::
diff --git a/docs/docs/guides/wallet/web3_modal_guide/vue.md b/docs/docs/guides/wallet/web3_modal_guide/vue.md
diff --git a/docs/docs/guides/web3_config/_category_.yml b/docs/docs/guides/web3_config/_category_.yml
@@ -2,4 +2,4 @@ label: '⚙️ Web3 config'
 collapsible: true
 collapsed: true
 link: null
-position: 16
+position: 7
diff --git a/docs/docs/guides/web3_plugin_guide/_category_.yml b/docs/docs/guides/web3_plugin_guide/_category_.yml
@@ -2,4 +2,4 @@ label: '🛠️ Web3 Plugin 🧩'
 collapsible: true
 collapsed: true
 link: null
-position: 2
+position: 12
diff --git a/docs/docs/guides/web3_providers_guide/_category_.yml b/docs/docs/guides/web3_providers_guide/_category_.yml
@@ -2,4 +2,4 @@ label: '🔌 Providers'
 collapsible: true
 collapsed: true
 link: null
-position: 4
+position: 2
diff --git a/docs/docs/guides/web3_providers_guide/index.md b/docs/docs/guides/web3_providers_guide/index.md
diff --git a/docs/docs/guides/web3_upgrade_guide/_category_.yml b/docs/docs/guides/web3_upgrade_guide/_category_.yml
diff --git a/packages/web3/.snyk b/packages/web3/.snyk
diff --git a/tools/eslint-config-base-web3/.snyk b/tools/eslint-config-base-web3/.snyk
