CU-86dtu1h0f - Add new function to AbstractWalletConnectEIP155Adapter…

… to get a custom signer

common/changes/@cityofzion/wallet-connect-sdk-wallet-core/main_2024-06-14-02-03.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/wallet-connect-sdk-wallet-core",
+      "comment": "Add getCustomSigner function to AbstractWalletConnectEIP155Adapter ",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@cityofzion/wallet-connect-sdk-wallet-core"
+}

packages/wallet-connect-sdk-wallet-core/package.json

@@ -40,7 +40,8 @@
     "@walletconnect/web3wallet": "^1.12.1",
     "moment": "^2.29.4",
     "@cityofzion/neon-dappkit": "0.4.2",
-    "ethers": "5.7.2"
+    "ethers": "5.7.2",
+    "@ethersproject/abstract-signer": "~5.7.0"
   },
   "devDependencies": {
     "@types/node": "^20.1.3",

packages/wallet-connect-sdk-wallet-core/src/adapters/AbstractWalletConnectEIP155Adapter.ts

@@ -1,14 +1,24 @@
+import { TypedDataSigner } from '@ethersproject/abstract-signer'
 import { TAdapterMethodParam } from '../types'
 import { ethers } from 'ethers'
 
+export type TCustomSigner = ethers.Signer & TypedDataSigner
+
 /* Some methods are named in snakecase, as Ethereum methods are in snakecase and the SDK does not make any transformer for the method called by the dapp. */
 export abstract class AbstractWalletConnectEIP155Adapter {
   protected async getServices(args: TAdapterMethodParam) {
     const rpcAddress = await this.getRPCUrl(args)
-    const accountString = await this.getAccountString(args)
-
     const provider = new ethers.providers.JsonRpcProvider(rpcAddress)
-    const wallet = new ethers.Wallet(accountString)
+    let wallet: TCustomSigner
+
+    const customSigner = await this.getCustomSigner()
+    if (customSigner) {
+      wallet = customSigner
+    } else {
+      const accountString = await this.getAccountString(args)
+      wallet = new ethers.Wallet(accountString)
+    }
+
     return {
       wallet,
       provider,
@@ -88,6 +98,10 @@ export abstract class AbstractWalletConnectEIP155Adapter {
     return hash
   }
 
+  async getCustomSigner(): Promise<TCustomSigner | undefined> {
+    return undefined
+  }
+
   abstract getAccountString(args: TAdapterMethodParam): Promise<string>
 
   abstract getRPCUrl(args: TAdapterMethodParam): Promise<string>