@dynamic-labs/ethereum 0.18.0-RC.2 → 0.18.0-RC.21

package/src/walletConnect/walletConnectV2.cjs

@@ -5,27 +5,34 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var _tslib = require('../../_virtual/_tslib.cjs');
 var Provider = require('@walletconnect/universal-provider');
 var ethers = require('ethers');
+var EventEmitter = require('eventemitter3');
 var walletConnectorCore = require('@dynamic-labs/wallet-connector-core');
 var walletBook = require('@dynamic-labs/wallet-book');
 var utils = require('@dynamic-labs/utils');
 var EthWalletConnector = require('../EthWalletConnector.cjs');
+var parseIntSafe = require('../utils/parseIntSafe.cjs');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var Provider__default = /*#__PURE__*/_interopDefaultLegacy(Provider);
+var EventEmitter__default = /*#__PURE__*/_interopDefaultLegacy(EventEmitter);
 
+const activeAccountKey = (walletName) => `dynamic-wc2-active-account-${walletName}`;
 const sessionTopicKey = (walletName) => `dynamic-wc2-session-topic-${walletName}`;
+const ee = new EventEmitter__default["default"]();
 class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
     constructor(opts) {
         super(opts);
         this.supportedChains = ['EVM', 'ETH'];
         this.connectedChain = 'EVM';
+        this.isInitialized = false;
         this.canConnectViaQrCode = true;
         this.isWalletConnect = true;
         this.name = opts.walletName;
         this.projectId = opts.projectId;
     }
     initConnection() {
+        var _a;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             const { provider } = WalletConnectV2;
             if (!provider) {
@@ -35,44 +42,73 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             if (provider === null || provider === void 0 ? void 0 : provider.uri) {
                 return;
             }
-            yield provider.connect({
+            const defaultChain = ((_a = this.evmNetworks) === null || _a === void 0 ? void 0 : _a.length)
+                ? this.evmNetworks[0].chainId
+                : 1;
+            provider
+                .connect({
                 namespaces: {
+                    eip155: {
+                        chains: [`eip155:${defaultChain}`],
+                        events: ['chainChanged', 'accountsChanged'],
+                        methods: ['personal_sign', 'eth_sendTransaction'],
+                        rpcMap: this.evmNetworkRpcMap(),
+                    },
+                },
+                optionalNamespaces: {
                     eip155: {
                         chains: this.evmNetworks
-                            // filtering out Palm for now since it causes Trust to crash
-                            .filter((network) => network.chainId !== 11297108109)
+                            // Filters out mainnet which is required and palm that crashes Trust Wallet
+                            .filter((network) => network.chainId !== 11297108109 &&
+                            network.chainId !== defaultChain)
                             .map((network) => `eip155:${network.chainId}`),
-                        events: ['chainChanged', 'accountsChanged'],
+                        events: [],
                         methods: [
-                            'eth_sendTransaction',
+                            'eth_signTypedData',
                             'eth_signTransaction',
                             'eth_sign',
                             'personal_sign',
-                            'eth_signTypedData',
+                            'eth_sendTransaction',
+                            'eth_signTypedData_v4',
                         ],
                         rpcMap: this.evmNetworkRpcMap(),
                     },
                 },
+            })
+                .catch((e) => {
+                walletConnectorCore.logger.error(e);
+                ee.emit('walletconnect_connection_failed');
             });
         });
     }
+    createInitProviderPromise() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const provider = yield Provider__default["default"].init({
+                logger: walletConnectorCore.logger.logLevel.toLowerCase() === 'debug' ? 'debug' : undefined,
+                projectId: this.projectId,
+            });
+            WalletConnectV2.provider = provider;
+        });
+    }
     initProvider() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            let { provider } = WalletConnectV2;
+            const { provider } = WalletConnectV2;
             if (!provider) {
-                provider = yield Provider__default["default"].init({
-                    projectId: this.projectId,
-                });
-                WalletConnectV2.provider = provider;
+                if (this.initializePromise === undefined) {
+                    this.initializePromise = this.createInitProviderPromise();
+                }
+                yield this.initializePromise;
             }
         });
     }
     refreshSession() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         if ((_b = (_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.session) === null || _b === void 0 ? void 0 : _b.topic) {
             if (localStorage.getItem(this.sessionTopicKey) ===
                 ((_d = (_c = WalletConnectV2.provider) === null || _c === void 0 ? void 0 : _c.session) === null || _d === void 0 ? void 0 : _d.topic)) {
                 this.session = WalletConnectV2.provider.session;
+                this.activeAccount =
+                    (_e = localStorage.getItem(this.activeAccountKey)) !== null && _e !== void 0 ? _e : undefined;
             }
         }
     }
@@ -80,11 +116,26 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             yield this.initProvider();
             yield this.initConnection();
+            this.isInitialized = true;
         });
     }
     get sessionTopicKey() {
         return sessionTopicKey(this.key);
     }
+    get activeAccountKey() {
+        return activeAccountKey(this.key);
+    }
+    getDeepLink() {
+        var _a;
+        const wallet = walletBook.getWalletBookWallet(this.walletBook, this.name);
+        if (!utils.isMobile() && !((_a = wallet.desktop) === null || _a === void 0 ? void 0 : _a.native)) {
+            return undefined;
+        }
+        return walletConnectorCore.getDeepLink({
+            metadata: wallet,
+            mode: 'regular',
+        });
+    }
     supportsNetworkSwitching() {
         return true;
     }
@@ -100,23 +151,30 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             }
             const { name, data } = params.event;
             if (name === 'chainChanged') {
-                if (typeof data !== 'string') {
+                const chainId = parseIntSafe.parseIntSafe(data);
+                if (chainId === undefined) {
                     walletConnectorCore.logger.debug(`received unexpected data for chainChanged: ${data} with type ${typeof data}}`);
                     return;
                 }
-                (_a = listeners.onChainChange) === null || _a === void 0 ? void 0 : _a.call(listeners, data);
+                (_a = listeners.onChainChange) === null || _a === void 0 ? void 0 : _a.call(listeners, String(chainId));
+                // When a user switches network from their wallet, we need the provider to change network
+                // such that any future calls to `getNetwork` will return the correct network
+                this.switchNetwork({ networkChainId: chainId });
             }
             else if (name === 'accountsChanged') {
-                if (typeof data !== 'string' || !Array.isArray(data)) {
+                if (!Array.isArray(data)) {
                     walletConnectorCore.logger.debug(`received unexpected data for accountsChanged: ${data} with type ${typeof data}}`);
                     return;
                 }
-                (_b = listeners.onAccountChange) === null || _b === void 0 ? void 0 : _b.call(listeners, data);
+                // eslint-disable-next-line prefer-destructuring
+                const account = data[0].split(':')[2];
+                this.setActiveAccount(account);
+                (_b = listeners.onAccountChange) === null || _b === void 0 ? void 0 : _b.call(listeners, [account]);
             }
         });
         WalletConnectV2.provider.client.on('session_delete', () => _tslib.__awaiter(this, void 0, void 0, function* () {
             var _a;
-            localStorage.removeItem(this.sessionTopicKey);
+            this.endSession();
             yield ((_a = listeners.onDisconnect) === null || _a === void 0 ? void 0 : _a.call(listeners));
         }));
     }
@@ -127,38 +185,39 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
         WalletConnectV2.provider.client.removeAllListeners('session_event');
         WalletConnectV2.provider.client.removeAllListeners('session_delete');
     }
-    getDeepLink() {
-        var _a, _b;
-        if (!((_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.uri))
-            return;
-        const wallet = walletBook.getWalletBookWallet(this.walletBook, this.name);
-        if (!utils.isMobile() && !((_b = wallet.desktop) === null || _b === void 0 ? void 0 : _b.native)) {
-            return undefined;
-        }
-        return walletConnectorCore.getDeepLink({
-            metadata: wallet,
-            mode: 'regular',
-            uri: WalletConnectV2.provider.uri,
-        });
-    }
     getWeb3Provider() {
         if (!WalletConnectV2.provider) {
-            throw new Error('No provider found');
+            return;
         }
         return new ethers.ethers.providers.Web3Provider(WalletConnectV2.provider, 'any');
     }
     fetchPublicAddress(opts) {
+        var _a, _b;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            if (this.session) {
-                return this.session.namespaces.eip155.accounts[0].split(':')[2];
+            if (this.activeAccount) {
+                return this.activeAccount;
             }
-            if (!WalletConnectV2.provider) {
-                throw new utils.DynamicError('No provider found');
-            }
-            if (!WalletConnectV2.provider.uri) {
-                throw new utils.DynamicError('No uri found');
+            if (!WalletConnectV2.provider || !((_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.uri)) {
+                walletConnectorCore.logger.debug('No WC2 provider found, re-initializing...');
+                yield this.endSession();
+                yield this.init();
+                // sleep 1 s to wait for connect call to finish
+                // the connect call isn't await-ed because it only resolves once
+                // the connection is established, but we need to wait for it to
+                // finish setting up the connection URI and making it available
+                // on the provider
+                yield new Promise((resolve) => setTimeout(resolve, 1000));
+                if (!WalletConnectV2.provider || !((_b = WalletConnectV2.provider) === null || _b === void 0 ? void 0 : _b.uri)) {
+                    walletConnectorCore.logger.debug('No WC2 provider found, escaping and throwing error');
+                    throw new utils.DynamicError('No provider found');
+                }
             }
             const metadata = walletBook.getWalletBookWallet(this.walletBook, this.name);
+            if (utils.isMobile()) {
+                // eslint-disable-next-line max-len
+                // see: https://dynamiclabsgroup.slack.com/archives/C04J69TS3JR/p1689918262752199?thread_ts=1689633771.128409&cid=C04J69TS3JR
+                localStorage.setItem('WALLETCONNECT_DEEPLINK_CHOICE', JSON.stringify({ href: this.getDeepLink(), name: metadata.name }));
+            }
             walletConnectorCore.performPlatformSpecificConnectionMethod(WalletConnectV2.provider.uri, metadata, {
                 onDesktopUri: opts === null || opts === void 0 ? void 0 : opts.onDesktopUri,
                 onDisplayUri: opts === null || opts === void 0 ? void 0 : opts.onDisplayUri,
@@ -168,18 +227,56 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
                     reject(new utils.DynamicError('No provider found'));
                     return;
                 }
+                ee.on('walletconnect_connection_failed', () => {
+                    const error = new utils.DynamicError('Connection rejected. Please try again.');
+                    error.code = 'connection_rejected';
+                    if (WalletConnectV2.provider) {
+                        WalletConnectV2.provider.uri = undefined;
+                    }
+                    reject(error);
+                });
                 WalletConnectV2.provider.on('connect', ({ session }) => {
                     if (!session) {
                         reject(new utils.DynamicError('No session found'));
                     }
-                    this.session = session;
-                    localStorage.setItem(this.sessionTopicKey, session.topic);
-                    resolve(this.session.namespaces.eip155.accounts[0].split(':')[2]);
+                    this.setSession(session);
+                    this.setActiveAccount(session.namespaces.eip155.accounts[0].split(':')[2]);
+                    resolve(this.activeAccount);
+                });
+            });
+        });
+    }
+    /**
+     * WalletConnect V2 will fail to send the sign message request if the chainId
+     * is not the same as the one in the session. This method will wait for the
+     * chainId to change and then retry the sign message request.
+     *
+     * Otherwise it will just return the result of the sign message request.
+     *
+     * @param signMessageFn - Function to sign message with provider
+     * @param messageToSign - Message to sign
+     * @returns
+     */
+    waitForSignMessage(signMessageFn, messageToSign) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const raceConditionPromise = new Promise((resolve) => {
+                // Create listener for chain change event
+                this.setupEventListeners({
+                    onChainChange: () => _tslib.__awaiter(this, void 0, void 0, function* () {
+                        resolve({ success: false });
+                    }),
                 });
+                signMessageFn(messageToSign).then((result) => resolve({ signedMessage: result, success: true }));
             });
+            const signedMessageResult = yield raceConditionPromise;
+            if (signedMessageResult.success === false) {
+                return signMessageFn(messageToSign);
+            }
+            return signedMessageResult.signedMessage;
         });
     }
     signMessage(messageToSign) {
+        var _a, _b;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             if (!this.session) {
                 throw new utils.DynamicError('no session');
@@ -189,39 +286,69 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             }
             const metadata = walletBook.getWalletBookWallet(this.walletBook, this.name);
             if (utils.isMobile()) {
-                // for sign message, no uri is needed because the uri encodes connection details,
-                // and at this point we are already connected
-                const deepLink = walletConnectorCore.getDeepLink({ metadata, mode: 'regular' });
+                const deepLink = ((_a = metadata['mobile']) === null || _a === void 0 ? void 0 : _a.native) || ((_b = metadata['mobile']) === null || _b === void 0 ? void 0 : _b.universal) || '';
                 window.location.href = deepLink;
             }
-            // eslint-disable-next-line prefer-destructuring
-            const address = this.session.namespaces.eip155.accounts[0].split(':')[2];
             const web3Provider = this.getWeb3Provider();
-            return web3Provider.send('personal_sign', [
-                walletConnectorCore.utf8ToHex(messageToSign, true),
-                address,
-            ]);
+            if (!web3Provider) {
+                throw new utils.DynamicError('No web3 provider found');
+            }
+            const signMessageFn = (messageToSign) => _tslib.__awaiter(this, void 0, void 0, function* () {
+                return web3Provider.send('personal_sign', [
+                    walletConnectorCore.utf8ToHex(messageToSign, true),
+                    this.activeAccount,
+                ]);
+            });
+            const response = yield this.waitForSignMessage(signMessageFn, messageToSign);
+            return response;
         });
     }
+    clearActiveAccount() {
+        localStorage.removeItem(this.activeAccountKey);
+        this.activeAccount = undefined;
+    }
+    clearSession() {
+        localStorage.removeItem(this.sessionTopicKey);
+        this.session = undefined;
+    }
+    setActiveAccount(account) {
+        localStorage.setItem(this.activeAccountKey, account);
+        this.activeAccount = account;
+    }
+    setSession(session) {
+        localStorage.setItem(this.sessionTopicKey, session.topic);
+        this.session = session;
+    }
     endSession() {
+        var _a;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            if (!this.session) {
-                return;
-            }
-            if (!WalletConnectV2.provider) {
+            localStorage.removeItem('WALLETCONNECT_DEEPLINK_CHOICE');
+            this.clearActiveAccount();
+            this.clearSession();
+            if (!((_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.session)) {
                 return;
             }
             try {
                 yield WalletConnectV2.provider.disconnect();
-                WalletConnectV2.provider.uri = undefined;
-                localStorage.removeItem(this.sessionTopicKey);
-                this.session = undefined;
+                // We must unset provider on logout so that a new session can be established
+                // If we don't then the provider will still have the old session and will hang
+                WalletConnectV2.provider = undefined;
+                this.initializePromise = undefined; // Needed so we can re-initiliza the provider
             }
             catch (e) {
                 walletConnectorCore.logger.debug(e);
             }
         });
     }
+    getNetwork() {
+        const _super = Object.create(null, {
+            getNetwork: { get: () => super.getNetwork }
+        });
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            yield this.initProvider();
+            return _super.getNetwork.call(this);
+        });
+    }
     providerSwitchNetwork({ network, provider, }) {
         const _super = Object.create(null, {
             providerSwitchNetwork: { get: () => super.providerSwitchNetwork }
@@ -244,13 +371,33 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
         });
     }
     getConnectedAccounts() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            yield this.initProvider();
+            this.refreshSession();
+            this.isInitialized = true;
+            if (!this.activeAccount) {
+                return [];
+            }
+            return [this.activeAccount];
+        });
+    }
+    getSupportedNetworks() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             yield this.initProvider();
             this.refreshSession();
             if (!this.session) {
                 return [];
             }
-            return [this.session.namespaces.eip155.accounts[0].split(':')[2]];
+            const chains = [];
+            // Some wallet (i.e ZenGo) use namespaces.account to list supported chains
+            // while others use keys within the namespaces object
+            Object.keys(this.session.namespaces).forEach((key) => {
+                if (key.startsWith('eip155:')) {
+                    chains.push(key.split(':')[1]);
+                }
+            });
+            this.session.namespaces.eip155.accounts.forEach((account) => chains.push(account.split(':')[1]));
+            return chains.length ? chains : undefined;
         });
     }
 }

package/src/walletConnect/walletConnectV2.d.ts

@@ -12,27 +12,50 @@ export declare class WalletConnectV2 extends EthWalletConnector {
     connectedChain: Chain;
     name: string;
     session: SessionTypes.Struct | undefined;
+    activeAccount: string | undefined;
+    isInitialized: boolean;
+    initializePromise: Promise<void> | undefined;
     canConnectViaQrCode: boolean;
     isWalletConnect: boolean;
     private static provider;
     private projectId?;
     constructor(opts: WalletConnectorV2Opts);
     private initConnection;
+    private createInitProviderPromise;
     private initProvider;
     private refreshSession;
     init(): Promise<void>;
     get sessionTopicKey(): string;
+    get activeAccountKey(): string;
+    getDeepLink(): string | undefined;
     supportsNetworkSwitching(): boolean;
     setupEventListeners(listeners: WalletEventListeners): void;
     teardownEventListeners(): void;
-    getDeepLink(): string | undefined;
-    getWeb3Provider(): ethers.providers.Web3Provider;
+    getWeb3Provider(): ethers.providers.Web3Provider | undefined;
     fetchPublicAddress(opts?: FetchPublicAddressOpts): Promise<string | undefined>;
+    /**
+     * WalletConnect V2 will fail to send the sign message request if the chainId
+     * is not the same as the one in the session. This method will wait for the
+     * chainId to change and then retry the sign message request.
+     *
+     * Otherwise it will just return the result of the sign message request.
+     *
+     * @param signMessageFn - Function to sign message with provider
+     * @param messageToSign - Message to sign
+     * @returns
+     */
+    protected waitForSignMessage(signMessageFn: (messageToSign: string) => Promise<string | undefined>, messageToSign: string): Promise<string | undefined>;
     signMessage(messageToSign: string): Promise<string | undefined>;
+    private clearActiveAccount;
+    private clearSession;
+    private setActiveAccount;
+    private setSession;
     endSession(): Promise<void>;
+    getNetwork(): Promise<number | undefined>;
     providerSwitchNetwork({ network, provider, }: {
         network: EvmNetwork;
         provider: ethers.providers.Web3Provider;
     }): Promise<void>;
     getConnectedAccounts(): Promise<string[]>;
+    getSupportedNetworks(): Promise<string[] | undefined>;
 }