Update WC docs

blocknative · Jun 9, 2023 · 77eaccf · 77eaccf
1 parent bef7700
commit 77eaccf
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 11 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -51,7 +51,7 @@
   "dependencies": {
     "@web3-onboard/cede-store": "^2.0.2",
     "@web3-onboard/coinbase": "^2.2.4",
-    "@web3-onboard/core": "^2.20.0-alpha.1",
+    "@web3-onboard/core": "^2.20.1",
     "@web3-onboard/dcent": "^2.2.7",
     "@web3-onboard/enkrypt": "^2.0.4",
     "@web3-onboard/fortmatic": "^2.0.19",
@@ -60,7 +60,7 @@
     "@web3-onboard/gas": "^2.1.8",
     "@web3-onboard/gnosis": "^2.1.10",
     "@web3-onboard/infinity-wallet": "^2.0.4",
-    "@web3-onboard/injected-wallets": "^2.9.0",
+    "@web3-onboard/injected-wallets": "^2.10.0",
     "@web3-onboard/keepkey": "^2.3.7",
     "@web3-onboard/keystone": "^2.3.7",
     "@web3-onboard/ledger": "^2.4.6",
@@ -76,7 +76,7 @@
     "@web3-onboard/trust": "^2.0.4",
     "@web3-onboard/uauth": "^2.0.5",
     "@web3-onboard/venly": "^2.0.0-alpha.1",
-    "@web3-onboard/walletconnect": "^2.3.8",
+    "@web3-onboard/walletconnect": "^2.3.9",
     "@web3-onboard/web3auth": "^2.2.3",
     "@web3-onboard/xdefi": "^2.0.4",
     "@web3-onboard/zeal": "^2.0.4",

diff --git a/docs/src/routes/docs/[...4]wallets/[...24]walletconnect/+page.md b/docs/src/routes/docs/[...4]wallets/[...24]walletconnect/+page.md
@@ -54,7 +54,6 @@ type WalletConnectOptions = {
        * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com)
        */
       projectId: string
-
       /**
        * Defaults to version: 1 - this behavior will be deprecated after the WalletConnect v1 sunset
        */
@@ -67,9 +66,9 @@ type WalletConnectOptions = {
        */
       requiredChains?: number[] | undefined
       /**
-       * `undefined` by default, see https://docs.walletconnect.com/2.0/web3modal/options
+       * `undefined` by default, see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
        */
-      qrModalOptions?: Web3ModalConfig
+      qrModalOptions?: EthereumProviderOptions['qrModalOptions']
     }
 )
 ```
@@ -97,7 +96,11 @@ const wcV2InitOptions = {
   /**
    * Optional function to handle WalletConnect URI when it becomes available
    */
-  handleUri: (uri) => console.log(uri)
+  handleUri: (uri) => console.log(uri),
+  /**
+   * Chains required to be supported by all wallets connecting to your DApp
+   */
+  requiredChains: [1, 56]
 }
 
 // initialize the module with options

diff --git a/packages/walletconnect/README.md b/packages/walletconnect/README.md
@@ -35,7 +35,6 @@ type WalletConnectOptions = {
        * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com)
        */
       projectId: string
-
       /**
        * Defaults to version: 1 - this behavior will be deprecated after the WalletConnect v1 sunset
        */
@@ -48,9 +47,9 @@ type WalletConnectOptions = {
        */
       requiredChains?: number[] | undefined
       /**
-       * `undefined` by default, see https://docs.walletconnect.com/2.0/web3modal/options
+       * `undefined` by default, see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
        */
-      qrModalOptions?: Web3ModalConfig
+      qrModalOptions?: EthereumProviderOptions['qrModalOptions']
     }
 )
 ```
@@ -74,7 +73,11 @@ const wcV2InitOptions = {
   /**
    * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com)
    */
-  projectId: 'abc123...'
+  projectId: 'abc123...',
+  /**
+   * Chains required to be supported by all wallets connecting to your DApp
+   */
+  requiredChains: [1, 56]
 }
 
 // initialize the module with options