Feature/wallet connect 2.0 (#236)

* added walletconnect 2.0 support

Author: poocart

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "etherspot",
-  "version": "1.43.9",
+  "version": "1.44.0",
   "description": "Etherspot SDK",
   "keywords": [
     "ether",
@@ -45,6 +45,7 @@
     "@etherspot/contracts": "1.9.9",
     "@lifi/sdk": "1.6.4",
     "@nerdwallet/apollo-cache-policies": "1.2.1",
+    "@walletconnect/universal-provider": "^2.10.0",
     "class-transformer": "0.4.0",
     "class-validator": "0.14.0",
     "cross-fetch": "3.1.5",

package.json

@@ -180,7 +180,14 @@ import {
   KnownContract,
 } from './transactions';
 import { State, StateService } from './state';
-import { WalletService, isWalletProvider, WalletProviderLike } from './wallet';
+import {
+  WalletService,
+  isWalletProvider,
+  WalletProviderLike,
+  isWalletConnectProvider,
+  WalletConnect2WalletProvider,
+  EthereumProvider,
+} from './wallet';
 
 /**
  * Sdk
@@ -196,7 +203,10 @@ export class Sdk {
   constructor(walletProvider: WalletProviderLike, optionsLike?: EnvNames | SdkOptions) {
     let options: SdkOptions = {};
 
-    if (!isWalletProvider(walletProvider)) {
+    let walletConnectProvider;
+    if (isWalletConnectProvider(walletProvider)) {
+      walletConnectProvider = new WalletConnect2WalletProvider(walletProvider as EthereumProvider);
+    } else if (!isWalletProvider(walletProvider)) {
       throw new Exception('Invalid wallet provider');
     }
 
@@ -239,7 +249,7 @@ export class Sdk {
 
     this.services = {
       networkService: new NetworkService(networkOptions, networkName),
-      walletService: new WalletService(walletProvider, {
+      walletService: new WalletService(walletConnectProvider ?? walletProvider, {
         omitProviderNetworkCheck: omitWalletProviderNetworkCheck,
       }),
       sessionService: new SessionService({

src/sdk/sdk.ts

@@ -4,5 +4,6 @@ export * from './key.wallet-provider';
 export * from './meta-mask.wallet-provider';
 export * from './utils';
 export * from './wallet-connect.wallet-provider';
+export * from './wallet-connect-2.wallet-provider';
 export * from './web3.wallet-provider';
 export * from './web3eip1193.wallet-provider';

src/sdk/wallet/providers/index.ts

@@ -1,4 +1,5 @@
 import { BytesLike, Wallet } from 'ethers';
+import type UniversalProvider from '@walletconnect/universal-provider';
 import { UniqueSubject } from '../../common';
 import { NetworkNames } from '../../network';
 
@@ -25,6 +26,20 @@ export interface Web3eip1193Provider {
   request(args: RequestArguments): any;
 }
 
+export declare class EthereumProvider {
+  accounts: string[];
+  signer: InstanceType<typeof UniversalProvider>;
+  chainId: number;
+  request<T = unknown>(args: RequestArguments): Promise<T>;
+  sendAsync(args: RequestArguments, callback: (error: Error | null, response: any) => void): void;
+  disconnect(): Promise<void>;
+  on(event: string, callback: (error: Error | null, payload: any | null) => void): void;
+  once(event: string, callback: (error: Error | null, payload: any | null) => void): void;
+  removeListener(event: string, callback: (error: Error | null, payload: any | null) => void): void;
+  off(event: string, callback: (error: Error | null, payload: any | null) => void): void;
+  readonly isWalletConnect?: boolean;
+}
+
 export interface WalletConnectConnector {
   accounts: string[];
   chainId: number;
@@ -36,4 +51,4 @@ export interface WalletLike {
   privateKey: string;
 }
 
-export type WalletProviderLike = string | WalletLike | WalletProvider;
+export type WalletProviderLike = string | WalletLike | WalletProvider | EthereumProvider;

src/sdk/wallet/providers/interfaces.ts

@@ -1 +1,2 @@
 export * from './is-wallet-provider';
+export * from './is-wallet-connect-provider';

src/sdk/wallet/providers/utils/index.ts

@@ -0,0 +1,5 @@
+import { EthereumProvider, WalletProviderLike } from '../interfaces';
+
+export function isWalletConnectProvider(provider: WalletProviderLike): boolean {
+  return typeof provider === 'object' && (provider as EthereumProvider)?.isWalletConnect;
+}

src/sdk/wallet/providers/utils/is-wallet-connect-provider.ts

@@ -0,0 +1,60 @@
+import { BytesLike } from 'ethers';
+import { toHex } from '../../common';
+import { DynamicWalletProvider } from './dynamic.wallet-provider';
+import { EthereumProvider } from './interfaces';
+
+export class WalletConnect2WalletProvider extends DynamicWalletProvider {
+  constructor(readonly provider: EthereumProvider) {
+    super('WalletConnect2');
+
+    try {
+      const {
+        accounts: [address],
+        chainId,
+      } = provider;
+
+      this.setAddress(address);
+      this.setNetworkName(chainId);
+    } catch (err) {
+      //
+    }
+
+    this.updateSessionHandler = this.updateSessionHandler.bind(this);
+
+    provider.on('connect', this.updateSessionHandler);
+    provider.on('session_event', this.updateSessionHandler);
+    provider.on('disconnect', () => {
+      this.setAddress(null);
+      this.setNetworkName(null);
+    });
+  }
+
+  async signMessage(message: BytesLike): Promise<string> {
+    const response = await this.provider.signer.request({
+      method: 'personal_sign',
+      params: [toHex(message), this.address],
+    });
+
+    return typeof response === 'string' ? response : null;
+  }
+
+  protected updateSessionHandler(error: Error, payload: { params: { accounts: string[]; chainId: number } }): void {
+    let address: string = null;
+    let chainId: number = null;
+
+    if (!error) {
+      try {
+        ({
+          accounts: [address],
+          chainId,
+        } = payload.params[0]);
+      } catch (err) {
+        address = null;
+        chainId = null;
+      }
+    }
+
+    this.setAddress(address);
+    this.setNetworkName(chainId);
+  }
+}

src/sdk/wallet/providers/wallet-connect-2.wallet-provider.ts

@@ -17,7 +17,8 @@
       "ES5",
       "es2015.collection",
       "es2015.iterable"
-    ]
+    ],
+    "skipLibCheck": true
   },
   "include": [
     "./examples/**/*.ts",