@dynamic-labs/ethereum 0.17.18 → 0.17.20

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+### [0.17.20](https://github.com/dynamic-labs/DynamicAuth/compare/v0.17.19...v0.17.20) (2023-07-03)
+
+
+### Bug Fixes
+
+* persist chain to WalletConnect session when changed in wallet ([#2556](https://github.com/dynamic-labs/DynamicAuth/issues/2556)) ([#2562](https://github.com/dynamic-labs/DynamicAuth/issues/2562)) ([0415e6d](https://github.com/dynamic-labs/DynamicAuth/commit/0415e6d055e860ab63ebf0d249ca9cdd71dfdb83))
+
+### [0.17.19](https://github.com/dynamic-labs/DynamicAuth/compare/v0.17.18...v0.17.19) (2023-07-02)
+
+
+### Bug Fixes
+
+* log out if there's any session sync issue ([#2548](https://github.com/dynamic-labs/DynamicAuth/issues/2548)) ([3f92bab](https://github.com/dynamic-labs/DynamicAuth/commit/3f92bab1b6b317f4a024a68d4d220921bad3437c))
+* WC2 sign-message on non-selected chain ([#2551](https://github.com/dynamic-labs/DynamicAuth/issues/2551)) ([c455e53](https://github.com/dynamic-labs/DynamicAuth/commit/c455e530c964b2865ffd29529546faddf2a57096)), closes [#2544](https://github.com/dynamic-labs/DynamicAuth/issues/2544) [#2552](https://github.com/dynamic-labs/DynamicAuth/issues/2552) [#2525](https://github.com/dynamic-labs/DynamicAuth/issues/2525) [#2500](https://github.com/dynamic-labs/DynamicAuth/issues/2500) [#2546](https://github.com/dynamic-labs/DynamicAuth/issues/2546)
+* **wcv2:** don't force required chain to eth in case is not enabled ([#2538](https://github.com/dynamic-labs/DynamicAuth/issues/2538)) ([933dc20](https://github.com/dynamic-labs/DynamicAuth/commit/933dc20b300f0740a438810b9e65d693aae61689))
+
 ### [0.17.18](https://github.com/dynamic-labs/DynamicAuth/compare/v0.17.17...v0.17.18) (2023-06-29)
 
 ### [0.17.17](https://github.com/dynamic-labs/DynamicAuth/compare/v0.17.16...v0.17.17) (2023-06-29)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/ethereum",
-  "version": "0.17.18",
+  "version": "0.17.20",
   "repository": {
     "type": "git",
     "url": "https://github.com/dynamic-labs/DynamicAuth.git",
@@ -32,11 +32,11 @@
     "ethers": "5.7.2",
     "eventemitter3": "5.0.1",
     "buffer": "6.0.3",
-    "@dynamic-labs/rpc-providers": "0.17.18",
-    "@dynamic-labs/types": "0.17.18",
-    "@dynamic-labs/utils": "0.17.18",
-    "@dynamic-labs/wallet-book": "0.17.18",
-    "@dynamic-labs/wallet-connector-core": "0.17.18"
+    "@dynamic-labs/rpc-providers": "0.17.20",
+    "@dynamic-labs/types": "0.17.20",
+    "@dynamic-labs/utils": "0.17.20",
+    "@dynamic-labs/wallet-book": "0.17.20",
+    "@dynamic-labs/wallet-connector-core": "0.17.20"
   },
   "peerDependencies": {}
 }

package/src/walletConnect/walletConnect.cjs

@@ -141,6 +141,12 @@ class WalletConnect extends EthWalletConnector.EthWalletConnector {
             return client.accounts;
         });
     }
+    getSession() {
+        var _a;
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return (_a = this.client) === null || _a === void 0 ? void 0 : _a.session;
+        });
+    }
 }
 
 exports.WalletConnect = WalletConnect;

package/src/walletConnect/walletConnect.d.ts

@@ -3,6 +3,19 @@ import { ethers } from 'ethers';
 import { Chain, FetchPublicAddressOpts, WalletEventListeners } from '@dynamic-labs/wallet-connector-core';
 import { EvmNetwork } from '@dynamic-labs/types';
 import { EthWalletConnector, EthWalletConnectorOpts } from '../EthWalletConnector';
+type ConnectorSession = {
+    connected: boolean;
+    accounts: string[];
+    chainId: number;
+    bridge: string;
+    key: string;
+    clientId: string;
+    clientMeta: any;
+    peerId: string;
+    peerMeta: any;
+    handshakeId: number;
+    handshakeTopic: string;
+};
 export type WalletConnectOpts = EthWalletConnectorOpts & {
     walletConnectV1Bridge: string;
     walletName: string;
@@ -32,4 +45,6 @@ export declare class WalletConnect extends EthWalletConnector {
         provider: ethers.providers.Web3Provider;
     }): Promise<void>;
     getConnectedAccounts(): Promise<string[]>;
+    getSession(): Promise<ConnectorSession | undefined>;
 }
+export {};

package/src/walletConnect/walletConnect.js

@@ -133,6 +133,12 @@ class WalletConnect extends EthWalletConnector {
             return client.accounts;
         });
     }
+    getSession() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.client) === null || _a === void 0 ? void 0 : _a.session;
+        });
+    }
 }
 
 export { WalletConnect };

package/src/walletConnect/walletConnectV2.cjs

@@ -32,6 +32,7 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
         this.projectId = opts.projectId;
     }
     initConnection() {
+        var _a;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             const { provider } = WalletConnectV2;
             if (!provider) {
@@ -41,7 +42,9 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             if (provider === null || provider === void 0 ? void 0 : provider.uri) {
                 return;
             }
-            const defaultChain = 1;
+            const defaultChain = ((_a = this.evmNetworks) === null || _a === void 0 ? void 0 : _a.length)
+                ? this.evmNetworks[0].chainId
+                : 1;
             provider
                 .connect({
                 namespaces: {
@@ -81,6 +84,7 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
     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;
@@ -142,6 +146,9 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
                     return;
                 }
                 (_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 (!Array.isArray(data)) {
@@ -238,6 +245,35 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             });
         });
     }
+    /**
+     * 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) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             if (!this.session) {
@@ -262,23 +298,13 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             if (!web3Provider) {
                 throw new utils.DynamicError('No web3 provider found');
             }
-            const response = web3Provider.send('personal_sign', [
-                walletConnectorCore.utf8ToHex(messageToSign, true),
-                this.activeAccount,
-            ]);
-            try {
-                // A terrible hack to get MM to sign the message when it is on the wrong chain
-                // Since MM supports only one chain at a time, it just hangs when we call
-                // to sign, and it is not on Mainnet. For some magical reason,
-                // when we attempt to call again it just works.
-                if (this.key === 'metamask') {
-                    yield this.promiseWithTimeout(7000, response);
-                }
-            }
-            catch (e) {
-                walletConnectorCore.logger.debug('metmask failed to sign message');
-                throw e;
-            }
+            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;
         });
     }
@@ -308,7 +334,9 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             }
             try {
                 yield WalletConnectV2.provider.disconnect();
-                WalletConnectV2.provider.uri = 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;
             }
             catch (e) {
                 walletConnectorCore.logger.debug(e);
@@ -375,18 +403,6 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
             return chains.length ? chains : undefined;
         });
     }
-    // a HACK for MM to sign message when the selected chain is not mainnet
-    promiseWithTimeout(ms, promise) {
-        // Create a promise that rejects in <ms> milliseconds
-        const timeout = new Promise((_, reject) => {
-            const id = setTimeout(() => {
-                clearTimeout(id);
-                reject(new utils.DynamicError(undefined, 'metamask_timeout'));
-            }, ms);
-        });
-        // Returns a race between our timeout and the passed in promise
-        return Promise.race([promise, timeout]);
-    }
 }
 
 exports.WalletConnectV2 = WalletConnectV2;

package/src/walletConnect/walletConnectV2.d.ts

@@ -33,6 +33,18 @@ export declare class WalletConnectV2 extends EthWalletConnector {
     getDeepLink(): string | undefined;
     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;
@@ -46,5 +58,4 @@ export declare class WalletConnectV2 extends EthWalletConnector {
     }): Promise<void>;
     getConnectedAccounts(): Promise<string[]>;
     getSupportedNetworks(): Promise<string[] | undefined>;
-    private promiseWithTimeout;
 }

package/src/walletConnect/walletConnectV2.js

@@ -23,6 +23,7 @@ class WalletConnectV2 extends EthWalletConnector {
         this.projectId = opts.projectId;
     }
     initConnection() {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { provider } = WalletConnectV2;
             if (!provider) {
@@ -32,7 +33,9 @@ class WalletConnectV2 extends EthWalletConnector {
             if (provider === null || provider === void 0 ? void 0 : provider.uri) {
                 return;
             }
-            const defaultChain = 1;
+            const defaultChain = ((_a = this.evmNetworks) === null || _a === void 0 ? void 0 : _a.length)
+                ? this.evmNetworks[0].chainId
+                : 1;
             provider
                 .connect({
                 namespaces: {
@@ -72,6 +75,7 @@ class WalletConnectV2 extends EthWalletConnector {
     createInitProviderPromise() {
         return __awaiter(this, void 0, void 0, function* () {
             const provider = yield Provider.init({
+                logger: logger.logLevel.toLowerCase() === 'debug' ? 'debug' : undefined,
                 projectId: this.projectId,
             });
             WalletConnectV2.provider = provider;
@@ -133,6 +137,9 @@ class WalletConnectV2 extends EthWalletConnector {
                     return;
                 }
                 (_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 (!Array.isArray(data)) {
@@ -229,6 +236,35 @@ class WalletConnectV2 extends EthWalletConnector {
             });
         });
     }
+    /**
+     * 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 __awaiter(this, void 0, void 0, function* () {
+            const raceConditionPromise = new Promise((resolve) => {
+                // Create listener for chain change event
+                this.setupEventListeners({
+                    onChainChange: () => __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) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.session) {
@@ -253,23 +289,13 @@ class WalletConnectV2 extends EthWalletConnector {
             if (!web3Provider) {
                 throw new DynamicError('No web3 provider found');
             }
-            const response = web3Provider.send('personal_sign', [
-                utf8ToHex(messageToSign, true),
-                this.activeAccount,
-            ]);
-            try {
-                // A terrible hack to get MM to sign the message when it is on the wrong chain
-                // Since MM supports only one chain at a time, it just hangs when we call
-                // to sign, and it is not on Mainnet. For some magical reason,
-                // when we attempt to call again it just works.
-                if (this.key === 'metamask') {
-                    yield this.promiseWithTimeout(7000, response);
-                }
-            }
-            catch (e) {
-                logger.debug('metmask failed to sign message');
-                throw e;
-            }
+            const signMessageFn = (messageToSign) => __awaiter(this, void 0, void 0, function* () {
+                return web3Provider.send('personal_sign', [
+                    utf8ToHex(messageToSign, true),
+                    this.activeAccount,
+                ]);
+            });
+            const response = yield this.waitForSignMessage(signMessageFn, messageToSign);
             return response;
         });
     }
@@ -299,7 +325,9 @@ class WalletConnectV2 extends EthWalletConnector {
             }
             try {
                 yield WalletConnectV2.provider.disconnect();
-                WalletConnectV2.provider.uri = 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;
             }
             catch (e) {
                 logger.debug(e);
@@ -366,18 +394,6 @@ class WalletConnectV2 extends EthWalletConnector {
             return chains.length ? chains : undefined;
         });
     }
-    // a HACK for MM to sign message when the selected chain is not mainnet
-    promiseWithTimeout(ms, promise) {
-        // Create a promise that rejects in <ms> milliseconds
-        const timeout = new Promise((_, reject) => {
-            const id = setTimeout(() => {
-                clearTimeout(id);
-                reject(new DynamicError(undefined, 'metamask_timeout'));
-            }, ms);
-        });
-        // Returns a race between our timeout and the passed in promise
-        return Promise.race([promise, timeout]);
-    }
 }
 
 export { WalletConnectV2 };