Feat/add additional required methods props to wc (#1883)

Sednaoui · leightkt · Adamj1232 · web-flow · commit 25707f8261a3 · 2023-08-28T13:18:12.000-06:00
* add ability to pass additionalRequiredMethods in WalletConnectOptions

* bump minor version to alpha.1

* add documentation for additionalRequiredMethods

* bump @walletconnect/ethereum-provider to ^2.10.0

* Add to internal demo and docs, update readme

---------

Co-authored-by: Kat Leight &lt;33187102+leightkt@users.noreply.github.com&gt;
Co-authored-by: Adam Carpenter &lt;adamcarpenter86@gmail.com&gt;
diff --git a/docs/package.json b/docs/package.json
@@ -80,7 +80,7 @@
     "@web3-onboard/trust": "^2.0.4",
     "@web3-onboard/uauth": "^2.1.1",
     "@web3-onboard/venly": "^2.0.0",
-    "@web3-onboard/walletconnect": "^2.4.2",
+    "@web3-onboard/walletconnect": "^2.4.6-alpha.1",
     "@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/[...26]walletconnect/+page.md b/docs/src/routes/docs/[...4]wallets/[...26]walletconnect/+page.md
@@ -87,6 +87,11 @@ type WalletConnectOptions = {
        * `undefined` by default, see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
        */
       qrModalOptions?: EthereumProviderOptions['qrModalOptions']
+      /**
+       * Additional required methods to be added to the default list of ['eth_sendTransaction', 'personal_sign']
+       * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/advanced/providers/ethereum#required-and-optional-methods
+       */
+      additionalRequiredMethods?: string[] | undefined
       /**
        * Additional methods to be added to the default list of ['eth_sendTransaction',  'eth_signTransaction',  'personal_sign',  'eth_sign',  'eth_signTypedData',  'eth_signTypedData_v4']
        * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
diff --git a/packages/demo/package.json b/packages/demo/package.json
@@ -56,7 +56,7 @@
     "@web3-onboard/trust": "^2.0.3",
     "@web3-onboard/uauth": "^2.1.2",
     "@web3-onboard/venly": "^2.0.0",
-    "@web3-onboard/walletconnect": "^2.4.5",
+    "@web3-onboard/walletconnect": "^2.4.6-alpha.1",
     "@web3-onboard/web3auth": "^2.2.2",
     "@web3-onboard/xdefi": "^2.0.5-alpha.1",
     "@web3-onboard/zeal": "^2.0.3",
diff --git a/packages/demo/src/App.svelte b/packages/demo/src/App.svelte
@@ -117,7 +117,8 @@
 
   const walletConnect = walletConnectModule({
     handleUri: uri => console.log(uri),
-    projectId: 'f6bd6e2911b56f5ac3bc8b2d0e2d7ad5'
+    projectId: 'f6bd6e2911b56f5ac3bc8b2d0e2d7ad5',
+    additionalOptionalMethods: ['someSillyShit']
   })
   const portis = portisModule({
     apiKey: 'b2b7586f-2b1e-4c30-a7fb-c2d1533b153b'
diff --git a/packages/walletconnect/README.md b/packages/walletconnect/README.md
@@ -68,6 +68,11 @@ type WalletConnectOptions = {
        * `undefined` by default, see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
        */
       qrModalOptions?: EthereumProviderOptions['qrModalOptions']
+      /**
+       * Additional required methods to be added to the default list of ['eth_sendTransaction', 'personal_sign']
+       * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/advanced/providers/ethereum#required-and-optional-methods
+       */
+      additionalRequiredMethods?: string[] | undefined
       /**
        * Additional methods to be added to the default list of ['eth_sendTransaction',  'eth_signTransaction',  'personal_sign',  'eth_sign',  'eth_signTypedData',  'eth_signTypedData_v4']
        * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
diff --git a/packages/walletconnect/package.json b/packages/walletconnect/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/walletconnect",
-  "version": "2.4.5",
+  "version": "2.4.6-alpha.1",
   "description": "WalletConnect SDK module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardised spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
   "keywords": [
     "Ethereum",
@@ -61,7 +61,7 @@
   "dependencies": {
     "@ethersproject/providers": "5.5.0",
     "@walletconnect/client": "^1.8.0",
-    "@walletconnect/ethereum-provider": "2.9.2",
+    "@walletconnect/ethereum-provider": "^2.10.0",
     "@walletconnect/modal": "2.6.1",
     "@walletconnect/qrcode-modal": "^1.8.0",
     "@web3-onboard/common": "^2.3.3",
diff --git a/packages/walletconnect/src/index.ts b/packages/walletconnect/src/index.ts
@@ -59,6 +59,11 @@ export type WalletConnectOptions = {
        * `undefined` by default, see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
        */
       qrModalOptions?: EthereumProviderOptions['qrModalOptions']
+      /**
+       * Additional required methods to be added to the default list of ['eth_sendTransaction', 'personal_sign']
+       * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/advanced/providers/ethereum#required-and-optional-methods
+       */
+      additionalRequiredMethods?: string[] | undefined
       /**
        * Additional methods to be added to the default list of ['eth_sendTransaction',  'eth_signTransaction',  'personal_sign',  'eth_sign',  'eth_signTypedData',  'eth_signTypedData_v4']
        * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
diff --git a/packages/walletconnect/src/v2.ts b/packages/walletconnect/src/v2.ts
@@ -1,6 +1,7 @@
-import type { CoreTypes } from '@walletconnect/types'
-import type { EthereumProvider } from '@walletconnect/ethereum-provider'
+import { REQUIRED_METHODS } from '@walletconnect/ethereum-provider'
 import type { EthereumProviderOptions } from '@walletconnect/ethereum-provider/dist/types/EthereumProvider'
+import type { EthereumProvider } from '@walletconnect/ethereum-provider'
+import type { CoreTypes } from '@walletconnect/types'
 
 import type {
   Chain,
@@ -34,6 +35,7 @@ function walletConnect(options: WalletConnectOptions): WalletInit {
     requiredChains,
     optionalChains,
     qrModalOptions,
+    additionalRequiredMethods,
     additionalOptionalMethods,
     dappUrl
   } = options
@@ -56,10 +58,7 @@ function walletConnect(options: WalletConnectOptions): WalletInit {
 
         const getMetaData = (): CoreTypes.Metadata | undefined => {
           if (!appMetadata) return undefined
-          const url =
-            dappUrl ||
-            appMetadata.explore ||
-            ''
+          const url = dappUrl || appMetadata.explore || ''
 
           !url &&
             !url.length &&
@@ -105,6 +104,13 @@ function walletConnect(options: WalletConnectOptions): WalletInit {
               optionalChains.map(chainID => parseInt(chainID))
             : chains.map(({ id }) => parseInt(id, 16))
 
+        const requiredMethodsSet = new Set(
+          additionalRequiredMethods && Array.isArray(additionalRequiredMethods)
+            ? [...additionalRequiredMethods, ...REQUIRED_METHODS]
+            : REQUIRED_METHODS
+        )
+        const requiredMethods = Array.from(requiredMethodsSet)
+
         const optionalMethods =
           additionalOptionalMethods && Array.isArray(additionalOptionalMethods)
             ? [...additionalOptionalMethods, ...methods]
@@ -113,6 +119,7 @@ function walletConnect(options: WalletConnectOptions): WalletInit {
         const connector = await EthereumProvider.init({
           projectId,
           chains: requiredChainsParsed, // default to mainnet
+          methods: requiredMethods,
           optionalChains: optionalChainsParsed,
           optionalMethods,
           showQrModal: true,
diff --git a/packages/walletconnect/src/validation.ts b/packages/walletconnect/src/validation.ts
@@ -30,6 +30,7 @@ const wcOptions = Joi.object({
   requiredChains: Joi.array().items(Joi.number()).optional(),
   optionalChains: Joi.array().items(Joi.number()).optional(),
   qrModalOptions: Joi.object().optional(),
+  additionalRequiredMethods: Joi.array().items(Joi.string()).optional(),
   additionalOptionalMethods: Joi.array().items(Joi.string()).optional()
 })
 
diff --git a/yarn.lock b/yarn.lock
