add ability to pass additionalRequiredMethods in WalletConnectOptions

Author: Sednaoui

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

packages/walletconnect/src/v2.ts

@@ -1,5 +1,5 @@
 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 {
@@ -34,6 +34,7 @@ function walletConnect(options: WalletConnectOptions): WalletInit {
     requiredChains,
     optionalChains,
     qrModalOptions,
+    additionalRequiredMethods,
     additionalOptionalMethods,
     dappUrl
   } = options
@@ -105,6 +106,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 +121,7 @@ function walletConnect(options: WalletConnectOptions): WalletInit {
         const connector = await EthereumProvider.init({
           projectId,
           chains: requiredChainsParsed, // default to mainnet
+          methods: requiredMethods,
           optionalChains: optionalChainsParsed,
           optionalMethods,
           showQrModal: true,

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()
 })