@dynamic-labs/ethereum 1.3.0 → 1.4.0

package/src/walletConnect/walletConnectV2.js

@@ -1,10 +1,12 @@
 import { __awaiter } from '../../_virtual/_tslib.js';
-import Provider from '@walletconnect/universal-provider';
+import EthereumProvider from '@walletconnect/ethereum-provider';
 import EventEmitter from 'eventemitter3';
 import { createWalletClient, custom } from 'viem';
+import { toAccount } from 'viem/accounts';
 import { logger, performPlatformSpecificConnectionMethod, getDeepLink } from '@dynamic-labs/wallet-connector-core';
 import { getWalletBookWallet } from '@dynamic-labs/wallet-book';
 import { DynamicError, isMobile } from '@dynamic-labs/utils';
+import { chainsMap } from '@dynamic-labs/viem-utils';
 import { EthWalletConnector } from '../EthWalletConnector.js';
 import { parseIntSafe } from '../utils/parseIntSafe.js';
 
@@ -26,6 +28,8 @@ class WalletConnectV2 extends EthWalletConnector {
         // When trying to switch network for MetaMask, the switch promise gets stuck
         // if the switch got trigged once already, so we need to keep track of that
         this._hasSwitchedNetwork = false;
+        this.sessionEventHandler = () => { };
+        this.sessionDeleteHandler = () => { };
         this.name = opts.walletName;
         this.projectId = opts.projectId;
         this.deepLinkPreference = opts.deepLinkPreference || 'native';
@@ -51,7 +55,7 @@ class WalletConnectV2 extends EthWalletConnector {
         }
         const reorderedChains = this.preferredChains.filter((chain) => allChains.includes(chain));
         const remainingChains = allChains.filter((chain) => !this.preferredChains.includes(chain));
-        return [...reorderedChains, ...remainingChains];
+        return [...reorderedChains, ...remainingChains].map((chain) => Number(chain.split(':')[1]));
     }
     initConnection() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -60,44 +64,51 @@ class WalletConnectV2 extends EthWalletConnector {
                 throw new DynamicError('No provider found (init connection)');
             }
             // this means there is already a connection in progress, so don't call connect again
-            if (provider === null || provider === void 0 ? void 0 : provider.uri) {
+            if (provider === null || provider === void 0 ? void 0 : provider.signer.uri) {
                 return;
             }
-            const optionalNamespaces = {
-                eip155: {
-                    chains: this.getMappedChainsByPreferredOrder(),
-                    events: ['chainChanged', 'accountsChanged'],
-                    methods: [
-                        'eth_chainId',
-                        'eth_signTypedData',
-                        'eth_signTransaction',
-                        'eth_sign',
-                        'personal_sign',
-                        'eth_sendTransaction',
-                        'eth_signTypedData_v4',
-                        'wallet_switchEthereumChain',
-                        'wallet_addEthereumChain',
-                    ],
-                    rpcMap: this.evmNetworkRpcMap(),
-                },
-            };
-            provider
-                .connect({
-                optionalNamespaces,
-            })
-                .catch((e) => {
+            provider.connect().catch((e) => {
                 logger.error(e);
                 ee.emit('walletconnect_connection_failed', e);
             });
         });
     }
-    createInitProviderPromise() {
+    createProvider() {
         return __awaiter(this, void 0, void 0, function* () {
-            const provider = yield Provider.init({
-                logger: logger.logLevel.toLowerCase() === 'debug' ? 'debug' : undefined,
+            return EthereumProvider.init({
+                events: ['chainChanged', 'accountsChanged'],
+                methods: [],
+                optionalChains: this.getMappedChainsByPreferredOrder(),
+                optionalMethods: [
+                    'eth_chainId',
+                    'eth_signTypedData',
+                    'eth_signTransaction',
+                    'eth_sign',
+                    'personal_sign',
+                    'eth_sendTransaction',
+                    'eth_signTypedData_v4',
+                    'wallet_switchEthereumChain',
+                    'wallet_addEthereumChain',
+                ],
                 projectId: this.projectId,
+                rpcMap: this.evmNetworkRpcMap(),
+                showQrModal: false,
+            });
+        });
+    }
+    getWalletClientFromInitializedProvider() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const walletConnect = this.createProvider();
+            const walletClient = createWalletClient({
+                account: this.activeAccount ? toAccount(this.activeAccount) : undefined,
+                transport: custom(yield walletConnect),
             });
-            WalletConnectV2.provider = provider;
+            return walletClient;
+        });
+    }
+    createInitProviderPromise() {
+        return __awaiter(this, void 0, void 0, function* () {
+            WalletConnectV2.provider = yield this.createProvider();
             this.teardownEventListeners();
             this.setupEventListeners();
         });
@@ -173,7 +184,7 @@ class WalletConnectV2 extends EthWalletConnector {
         if (!WalletConnectV2.provider) {
             return;
         }
-        WalletConnectV2.provider.client.on('session_event', ({ params }) => {
+        this.sessionEventHandler = ({ params, }) => {
             logger.debug('session_event was called', { params });
             if (!params || !params.event) {
                 logger.debug('session_event was called without params or params.event');
@@ -182,12 +193,17 @@ class WalletConnectV2 extends EthWalletConnector {
             const { name, data } = params.event;
             if (name === 'chainChanged') {
                 const chainId = parseIntSafe(data);
+                if (chainId === this.currentChainId) {
+                    logger.debug(`ignoring chainChanged event with same chain id as current chain id: ${chainId}`);
+                    return;
+                }
                 if (chainId === undefined) {
                     logger.debug(`received unexpected data for chainChanged: ${data} with type ${typeof data}}`);
                     return;
                 }
                 this.currentChainId = chainId;
                 this.emit('chainChange', { chain: String(chainId) });
+                this.hasSwitchedNetwork = true;
                 // 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 });
@@ -201,24 +217,28 @@ class WalletConnectV2 extends EthWalletConnector {
                 const account = data[0].split(':')[2];
                 this.setActiveAccount(account);
             }
-        });
-        WalletConnectV2.provider.client.on('session_delete', () => __awaiter(this, void 0, void 0, function* () {
+        };
+        WalletConnectV2.provider.on('session_event', this.sessionEventHandler);
+        this.sessionDeleteHandler = () => __awaiter(this, void 0, void 0, function* () {
             this.endSession();
             this.emit('disconnect');
-        }));
+        });
+        WalletConnectV2.provider.on('session_delete', this.sessionDeleteHandler);
     }
     teardownEventListeners() {
         if (!WalletConnectV2.provider) {
             return;
         }
-        WalletConnectV2.provider.client.removeAllListeners('session_event');
-        WalletConnectV2.provider.client.removeAllListeners('session_delete');
+        WalletConnectV2.provider.off('session_event', this.sessionEventHandler);
+        WalletConnectV2.provider.off('session_delete', this.sessionDeleteHandler);
     }
-    getWalletClient() {
+    getWalletClient(chainId) {
         if (!WalletConnectV2.provider) {
             return;
         }
         return createWalletClient({
+            account: this.activeAccount ? toAccount(this.activeAccount) : undefined,
+            chain: chainsMap[chainId !== null && chainId !== void 0 ? chainId : String(this.currentChainId)],
             transport: custom(WalletConnectV2.provider),
         });
     }
@@ -228,7 +248,7 @@ class WalletConnectV2 extends EthWalletConnector {
             if (this.activeAccount) {
                 return this.activeAccount;
             }
-            if (!WalletConnectV2.provider || !((_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.uri)) {
+            if (!WalletConnectV2.provider || !((_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.signer.uri)) {
                 logger.debug('No WC2 provider found, re-initializing...');
                 yield this.endSession();
                 yield this.init();
@@ -238,13 +258,13 @@ class WalletConnectV2 extends EthWalletConnector {
                 // 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)) {
+                if (!WalletConnectV2.provider || !((_b = WalletConnectV2.provider) === null || _b === void 0 ? void 0 : _b.signer.uri)) {
                     logger.debug('No WC2 provider found, escaping and throwing error');
                     throw new DynamicError('No provider found');
                 }
             }
             const metadata = getWalletBookWallet(this.walletBook, this.key);
-            performPlatformSpecificConnectionMethod(WalletConnectV2.provider.uri, metadata, {
+            performPlatformSpecificConnectionMethod(WalletConnectV2.provider.signer.uri, metadata, {
                 onDesktopUri: opts === null || opts === void 0 ? void 0 : opts.onDesktopUri,
                 onDisplayUri: opts === null || opts === void 0 ? void 0 : opts.onDisplayUri,
             }, this.deepLinkPreference);
@@ -257,7 +277,7 @@ class WalletConnectV2 extends EthWalletConnector {
                     const error = new DynamicError('Connection rejected. Please try again.');
                     error.code = 'connection_rejected';
                     if (WalletConnectV2.provider) {
-                        WalletConnectV2.provider.uri = undefined;
+                        WalletConnectV2.provider.signer.uri = undefined;
                         // this is needed for mobile to work when using universal links.
                         // if the user cancels the connection, we need to re-initialize the provider
                         // so that the async work is done ahead of time, before the user tries to connect again,
@@ -266,13 +286,19 @@ class WalletConnectV2 extends EthWalletConnector {
                     }
                     reject(error);
                 });
-                WalletConnectV2.provider.on('connect', ({ session }) => {
+                WalletConnectV2.provider.on('connect', () => {
+                    var _a;
+                    const session = (_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.session;
                     if (!session) {
                         reject(new DynamicError('No session found'));
+                        return;
                     }
                     this.setSession(session);
                     this.setActiveAccount(session.namespaces.eip155.accounts[0].split(':')[2]);
-                    resolve(this.activeAccount);
+                    this.getNetwork().then((chainId) => {
+                        this.currentChainId = chainId;
+                        resolve(this.activeAccount);
+                    });
                 });
             });
         });
@@ -290,10 +316,12 @@ class WalletConnectV2 extends EthWalletConnector {
      */
     waitForSignMessage(signMessageFn, messageToSign) {
         return __awaiter(this, void 0, void 0, function* () {
-            const raceConditionPromise = new Promise((resolve) => {
+            const raceConditionPromise = new Promise((resolve, reject) => {
                 // Create listener for chain change event
                 this.on('chainChange', () => resolve({ success: false }));
-                signMessageFn(messageToSign).then((result) => resolve({ signedMessage: result, success: true }));
+                signMessageFn(messageToSign)
+                    .then((result) => resolve({ signedMessage: result, success: true }))
+                    .catch(reject);
             });
             const signedMessageResult = yield raceConditionPromise;
             if (signedMessageResult.success === false) {
@@ -312,7 +340,7 @@ class WalletConnectV2 extends EthWalletConnector {
             metadata,
             mode: 'regular',
             preference: this.deepLinkPreference,
-            uri: (_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.uri,
+            uri: (_a = WalletConnectV2.provider) === null || _a === void 0 ? void 0 : _a.signer.uri,
         });
         if (!deepLink) {
             return;
@@ -326,10 +354,6 @@ class WalletConnectV2 extends EthWalletConnector {
             if (!this.session) {
                 throw new DynamicError('no session');
             }
-            const web3Provider = this.getWalletClient();
-            if (!web3Provider) {
-                throw new DynamicError('No WalletConnect provider found to handle signing');
-            }
             const deepLink = this.getDeepLink();
             if (isMobile() && deepLink) {
                 window.location.href = deepLink;
@@ -339,7 +363,8 @@ class WalletConnectV2 extends EthWalletConnector {
                 if (!activeAccount) {
                     return;
                 }
-                return web3Provider.signMessage({
+                const walletClient = yield this.getWalletClientFromInitializedProvider();
+                return walletClient.signMessage({
                     account: activeAccount,
                     message: messageToSign,
                 });
@@ -398,11 +423,17 @@ class WalletConnectV2 extends EthWalletConnector {
             return _super.getNetwork.call(this);
         });
     }
-    providerSwitchNetwork({ network, provider, }) {
+    providerSwitchNetwork({ network, }) {
         const _super = Object.create(null, {
             providerSwitchNetwork: { get: () => super.providerSwitchNetwork }
         });
         return __awaiter(this, void 0, void 0, function* () {
+            const supportedNetworks = yield this.getSupportedNetworks();
+            if (!(supportedNetworks === null || supportedNetworks === void 0 ? void 0 : supportedNetworks.includes(network.chainId.toString()))) {
+                const error = new DynamicError('Network switching is not available at this time. The user should manually switch network in their wallet');
+                error.code = 'network_switching_only_available_in_wallet';
+                throw error;
+            }
             const currentNetworkId = yield this.getNetwork();
             if (currentNetworkId && currentNetworkId === network.chainId) {
                 return;
@@ -413,10 +444,14 @@ class WalletConnectV2 extends EthWalletConnector {
             if (!this.supportsNetworkSwitching()) {
                 throw new DynamicError('Network switching not supported');
             }
-            if (!provider) {
-                throw new DynamicError('Provider not found');
+            const walletClient = yield this.getWalletClientFromInitializedProvider();
+            if (this.isMetaMask()) {
+                const deepLink = this.getDeepLink();
+                if (deepLink) {
+                    window.location.href = deepLink;
+                }
             }
-            yield _super.providerSwitchNetwork.call(this, { network, provider });
+            yield _super.providerSwitchNetwork.call(this, { network, provider: walletClient });
             this.currentChainId = network.chainId;
             this.hasSwitchedNetwork = true;
             this.emit('chainChange', { chain: String(network.chainId) });
@@ -442,13 +477,14 @@ class WalletConnectV2 extends EthWalletConnector {
     getSupportedNetworks() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            // MM allows you to switch to any network the first time, even if it's not enabled in MM
-            // so we should consider all networks as supported if network switching hasn't been triggered yet
-            if (this.isMetaMask() && !this.hasSwitchedNetwork) {
-                return this.evmNetworks.map((network) => network.chainId.toString());
-            }
             yield this.initProvider();
             this.refreshSession();
+            if (this.isMetaMask()) {
+                if (this.hasSwitchedNetwork) {
+                    return [String(this.currentChainId)];
+                }
+                return this.evmNetworks.map((network) => network.chainId.toString());
+            }
             if (!this.session) {
                 return [];
             }

package/src/walletConnect/client/client.cjs

@@ -1,201 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _tslib = require('../../../_virtual/_tslib.cjs');
-var Client = require('@walletconnect/client');
-var viem = require('viem');
-var walletConnectorCore = require('@dynamic-labs/wallet-connector-core');
-var utils = require('@dynamic-labs/utils');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var Client__default = /*#__PURE__*/_interopDefaultLegacy(Client);
-
-const initClient = (key, bridge, settings) => {
-    const storageId = `walletconnect-${key}`;
-    const session = localStorage.getItem(storageId);
-    const clientArgs = session
-        ? { session: JSON.parse(session), storageId }
-        : { bridge, storageId };
-    return new Client__default["default"](Object.assign(Object.assign({}, clientArgs), settings));
-};
-/**
- * Attach event handlers to WalletConnect events.
- */
-const setupWalletConnectEventListeners = (walletConnector, client) => {
-    if (!client) {
-        return;
-    }
-    let prevAccount;
-    let prevChain;
-    if (client.connected) {
-        // eslint-disable-next-line prefer-destructuring
-        prevAccount = client.accounts[0];
-        prevChain = client.chainId;
-    }
-    client.on('disconnect', () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-        walletConnector.emit('disconnect');
-    }));
-    client.on('session_update', (_, payload) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-        // eslint-disable-next-line prefer-destructuring
-        const { accounts, chainId } = payload.params[0];
-        const didAccountChange = !walletConnectorCore.isSameAddress(prevAccount || '', accounts[0], 'eip155');
-        const didChainChange = prevChain !== chainId;
-        // eslint-disable-next-line prefer-destructuring
-        prevAccount = accounts[0];
-        prevChain = chainId;
-        if (didAccountChange) {
-            walletConnector.emit('accountChange', { accounts });
-        }
-        if (didChainChange) {
-            walletConnector.emit('chainChange', { chain: String(chainId) });
-        }
-    }));
-};
-const teardownWalletConnectEventListeners = (client) => {
-    client.off('disconnect');
-    client.off('session_update');
-};
-/**
- * Initialize a client from a stored session and terminate the connection.
- */
-const killWalletConnectSession = (client) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-    try {
-        if (client === null || client === void 0 ? void 0 : client.connected) {
-            yield client.killSession();
-        }
-    }
-    catch (e) {
-        walletConnectorCore.logger.debug(e);
-    }
-});
-const createSession = (client) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-    return new Promise((resolve, reject) => {
-        client.on('connect', (error, payload) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-            if (error)
-                throw error;
-            resolve(payload);
-        }));
-        client.on('disconnect', (error, payload) => {
-            reject(error || payload.params[0].message);
-        });
-    });
-});
-const fetchWalletConnectEVMPublicAddress = (metadata, wcClient, deepLinkPreference, opts) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    if (wcClient.connected) {
-        const [accountPublicAddress] = wcClient.accounts;
-        return accountPublicAddress;
-    }
-    // createSession will trigger the QR code...
-    yield wcClient.createSession();
-    walletConnectorCore.performPlatformSpecificConnectionMethod(wcClient.uri, metadata, {
-        onDesktopUri: opts === null || opts === void 0 ? void 0 : opts.onDesktopUri,
-        onDisplayUri: opts === null || opts === void 0 ? void 0 : opts.onDisplayUri,
-    }, deepLinkPreference);
-    const payload = yield createSession(wcClient);
-    (_a = opts === null || opts === void 0 ? void 0 : opts.onConnect) === null || _a === void 0 ? void 0 : _a.call(opts, payload);
-    const [accountPublicAddress] = payload.params[0].accounts;
-    return accountPublicAddress;
-});
-const signWalletConnectPersonalMessage = (messageToSign, metadata, client, deepLinkPreference, rpcProvider) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-    var _b, _c;
-    const isCryptoWallet = ((_b = client === null || client === void 0 ? void 0 : client.peerMeta) === null || _b === void 0 ? void 0 : _b.name) === 'Crypto.com | DeFi Wallet' ||
-        ((_c = client === null || client === void 0 ? void 0 : client.peerMeta) === null || _c === void 0 ? void 0 : _c.name) === 'DeFi Wallet';
-    if (!client || !client.connected) {
-        return;
-    }
-    const [accountPublicAddress] = client.accounts;
-    if (utils.isMobile()) {
-        const deepLink = walletConnectorCore.getDeepLink({
-            metadata,
-            mode: 'regular',
-            preference: deepLinkPreference,
-            uri: client.uri,
-        });
-        window.location.href = deepLink;
-    }
-    try {
-        // This delay is required for Crypto.com DeFi wallet, when there is no delay the app
-        // will not open the pop-up to sign. That seems to be a limitation in the standalone client
-        // so the delay is required to allow the users to sign the message
-        if (isCryptoWallet && utils.isMobile()) {
-            yield sleep(4000);
-        }
-        else {
-            // The delay of 1 second is necessary for some of the wallets to open the sign UI in the
-            // correct order, without this some wallets like Trust or OKX will no open properly,
-            // and not allowing the user to sign the message
-            yield sleep(1000);
-        }
-        const signature = yield client.signPersonalMessage([
-            messageToSign,
-            accountPublicAddress,
-        ]);
-        yield waitForSafeTransactionOrTimeout(accountPublicAddress, signature, messageToSign, client, rpcProvider);
-        return signature;
-    }
-    catch (e) {
-        walletConnectorCore.logger.debug(e);
-        throw e;
-    }
-});
-const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-// Successful value as defined by the EIP
-// https://eips.ethereum.org/EIPS/eip-1271#specification
-const MAGIC_VALUE = '0x1626ba7e';
-const IS_VALID_SIGNATURE_ABI = [
-    'function isValidSignature(bytes32 _message, bytes _signature) public view returns (bytes4)',
-];
-const waitForSafeTransactionOrTimeout = (accountPublicAddress, signature, messageToSign, client, rpcProvider) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-    var _d;
-    if (signature === '0x' &&
-        // this is what wallet connect client returns there's no `safe` or `Safe`
-        // exact string anywhere, so this seems like the best proxy
-        ((_d = client.peerMeta) === null || _d === void 0 ? void 0 : _d.name) === 'WalletConnect Safe App') {
-        if (!rpcProvider) {
-            return;
-        }
-        const safeTransactionPromise = waitForSafeTransaction(accountPublicAddress, signature, messageToSign, yield rpcProvider());
-        const timeoutPromise = new Promise((resolve) => {
-            setTimeout(resolve, 120000);
-        });
-        yield Promise.race([safeTransactionPromise, timeoutPromise]);
-    }
-});
-// this is a hack for safe
-// before sending the signature downstream, we need to make sure
-// the transaction is recorded first on the blockchain
-// redcoast verify WILL fail if it attempts to verify the signature
-// that has not yet been properly processed!
-const waitForSafeTransaction = (accountPublicAddress, signature, messageToSign, rpcProvider) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
-    // wait for safe wallet to finish txn on the blockchain contract
-    for (let i = 0; i < 120; i++) {
-        try {
-            // this will result in an exception if the transaction is still not ready
-            // we need to catch it below
-            const result = yield (rpcProvider === null || rpcProvider === void 0 ? void 0 : rpcProvider.readContract({
-                abi: IS_VALID_SIGNATURE_ABI,
-                address: accountPublicAddress,
-                args: [viem.hashMessage(messageToSign), signature],
-                functionName: 'isValidSignature',
-            }));
-            if (result === MAGIC_VALUE)
-                return;
-        }
-        catch (err) {
-            walletConnectorCore.logger.info('Safe transaction cannot be validated yet. Retrying.');
-        }
-        // try again after 2 seconds
-        yield sleep(2000);
-    }
-});
-
-exports.createSession = createSession;
-exports.fetchWalletConnectEVMPublicAddress = fetchWalletConnectEVMPublicAddress;
-exports.initClient = initClient;
-exports.killWalletConnectSession = killWalletConnectSession;
-exports.setupWalletConnectEventListeners = setupWalletConnectEventListeners;
-exports.signWalletConnectPersonalMessage = signWalletConnectPersonalMessage;
-exports.teardownWalletConnectEventListeners = teardownWalletConnectEventListeners;