@dynamic-labs/ethereum 0.18.0-RC.8 → 0.18.0-RC.9

package/CHANGELOG.md

@@ -1,4 +1,25 @@
 
+## [0.18.0-RC.9](https://github.com/dynamic-labs/DynamicAuth/compare/v0.18.0-RC.8...v0.18.0-RC.9) (2023-07-04)
+
+
+### Features
+
+* add Network Not Supported prompt to connect-only & show prompt before sign in connect-sign mode ([#2474](https://github.com/dynamic-labs/DynamicAuth/issues/2474)) ([8d5bfa9](https://github.com/dynamic-labs/DynamicAuth/commit/8d5bfa97ca4da50e06ce258a38a63e7407a795f6))
+* **DYN-2602:** add ability to unlink connected wallet ([#2494](https://github.com/dynamic-labs/DynamicAuth/issues/2494)) ([389861b](https://github.com/dynamic-labs/DynamicAuth/commit/389861bc0281baec379b1593e529cef3467f3326))
+* **DYN-2604:** add chainId property to walletsByChain object ([#2405](https://github.com/dynamic-labs/DynamicAuth/issues/2405)) ([d9b42f7](https://github.com/dynamic-labs/DynamicAuth/commit/d9b42f7b1d53dac1ed0228ecb5e56a44c6abd8d2))
+* **DynamicAuthLayout:** show connected wallet progress ([#2567](https://github.com/dynamic-labs/DynamicAuth/issues/2567)) ([a20ff6f](https://github.com/dynamic-labs/DynamicAuth/commit/a20ff6f32b360ccc699d2a271c7a96751ae87d29))
+* **DynamicBridgeFlow:** add bridge flow ([#2543](https://github.com/dynamic-labs/DynamicAuth/issues/2543)) ([79c4c87](https://github.com/dynamic-labs/DynamicAuth/commit/79c4c870d47a0c853c292a8d913bd9be9e209a15))
+
+
+### Bug Fixes
+
+* don't force required chain to eth in case is not enabled ([#2537](https://github.com/dynamic-labs/DynamicAuth/issues/2537)) ([b01d6c9](https://github.com/dynamic-labs/DynamicAuth/commit/b01d6c9e91e9971e82739c5a2c900de4768f977c))
+* log out if there's any session sync issue ([#2545](https://github.com/dynamic-labs/DynamicAuth/issues/2545)) ([29972fa](https://github.com/dynamic-labs/DynamicAuth/commit/29972fad1067f5550a61f6e2cd9adcaf811fd268))
+* persist chain to WalletConnect session when changed in wallet ([#2556](https://github.com/dynamic-labs/DynamicAuth/issues/2556)) ([fc9ec35](https://github.com/dynamic-labs/DynamicAuth/commit/fc9ec3501de1e3235adee4df95b296dc22cce23e))
+* WC2 sign-message on non-selected chain ([#2544](https://github.com/dynamic-labs/DynamicAuth/issues/2544)) ([48a4384](https://github.com/dynamic-labs/DynamicAuth/commit/48a4384f77c29775e0c28ed335956cfbd6f89ca3))
+* **wcv2:** add eth_signTypedData_v4 to optional methods ([#2527](https://github.com/dynamic-labs/DynamicAuth/issues/2527)) ([b99474b](https://github.com/dynamic-labs/DynamicAuth/commit/b99474b81b083134762be0fe9554a6f049b3edda))
+* **wcv2:** allow getWeb3Provider to wait to provider init ([#2523](https://github.com/dynamic-labs/DynamicAuth/issues/2523)) ([d9c7fee](https://github.com/dynamic-labs/DynamicAuth/commit/d9c7fee10d2a6c766043515e19829fd7e3d5b2ef))
+
 ## [0.18.0-RC.8](https://github.com/dynamic-labs/DynamicAuth/compare/v0.18.0-RC.7...v0.18.0-RC.8) (2023-06-29)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/ethereum",
-  "version": "0.18.0-RC.8",
+  "version": "0.18.0-RC.9",
   "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.18.0-RC.8",
-    "@dynamic-labs/types": "0.18.0-RC.8",
-    "@dynamic-labs/utils": "0.18.0-RC.8",
-    "@dynamic-labs/wallet-book": "0.18.0-RC.8",
-    "@dynamic-labs/wallet-connector-core": "0.18.0-RC.8"
+    "@dynamic-labs/rpc-providers": "0.18.0-RC.9",
+    "@dynamic-labs/types": "0.18.0-RC.9",
+    "@dynamic-labs/utils": "0.18.0-RC.9",
+    "@dynamic-labs/wallet-book": "0.18.0-RC.9",
+    "@dynamic-labs/wallet-connector-core": "0.18.0-RC.9"
   },
   "peerDependencies": {}
 }

package/src/walletConnect/walletConnect.cjs

@@ -139,6 +139,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

@@ -131,6 +131,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: {
@@ -66,6 +69,7 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
                             'eth_sign',
                             'personal_sign',
                             'eth_sendTransaction',
+                            'eth_signTypedData_v4',
                         ],
                         rpcMap: this.evmNetworkRpcMap(),
                     },
@@ -80,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;
@@ -141,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)) {
@@ -168,7 +176,7 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
     }
     getWeb3Provider() {
         if (!WalletConnectV2.provider) {
-            throw new Error('No provider found');
+            return;
         }
         return new ethers.ethers.providers.Web3Provider(WalletConnectV2.provider, 'any');
     }
@@ -222,6 +230,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) {
         var _a, _b;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -237,23 +274,16 @@ class WalletConnectV2 extends EthWalletConnector.EthWalletConnector {
                 window.location.href = deepLink;
             }
             const web3Provider = this.getWeb3Provider();
-            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;
+            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;
         });
     }
@@ -283,7 +313,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);
@@ -350,18 +382,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

@@ -30,8 +30,20 @@ export declare class WalletConnectV2 extends EthWalletConnector {
     supportsNetworkSwitching(): boolean;
     setupEventListeners(listeners: WalletEventListeners): void;
     teardownEventListeners(): void;
-    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;
@@ -45,5 +57,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: {
@@ -57,6 +60,7 @@ class WalletConnectV2 extends EthWalletConnector {
                             'eth_sign',
                             'personal_sign',
                             'eth_sendTransaction',
+                            'eth_signTypedData_v4',
                         ],
                         rpcMap: this.evmNetworkRpcMap(),
                     },
@@ -71,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;
@@ -132,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)) {
@@ -159,7 +167,7 @@ class WalletConnectV2 extends EthWalletConnector {
     }
     getWeb3Provider() {
         if (!WalletConnectV2.provider) {
-            throw new Error('No provider found');
+            return;
         }
         return new ethers.providers.Web3Provider(WalletConnectV2.provider, 'any');
     }
@@ -213,6 +221,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) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
@@ -228,23 +265,16 @@ class WalletConnectV2 extends EthWalletConnector {
                 window.location.href = deepLink;
             }
             const web3Provider = this.getWeb3Provider();
-            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;
+            if (!web3Provider) {
+                throw new DynamicError('No web3 provider found');
             }
+            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;
         });
     }
@@ -274,7 +304,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);
@@ -341,18 +373,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 };