@dynamic-labs/ethereum 0.19.0-alpha.2 → 0.19.0-alpha.21

package/src/walletConnect/client/client.d.ts

@@ -1,17 +1,17 @@
-import Client from '@walletconnect/client';
-import { ethers } from 'ethers';
-import { FetchPublicAddressOpts, PayloadParams, WalletEventListeners } from '@dynamic-labs/wallet-connector-core';
-import { WalletSchema } from '@dynamic-labs/wallet-book';
-export declare const initClient: (name: string, bridge: string, settings?: any) => Client;
-/**
- * Attach event handlers to WalletConnect events.
- */
-export declare const setupWalletConnectEventListeners: (opts: WalletEventListeners, client: Client) => void;
-export declare const teardownWalletConnectEventListeners: (client: Client) => void;
-/**
- * Initialize a client from a stored session and terminate the connection.
- */
-export declare const killWalletConnectSession: (client: Client) => Promise<void>;
-export declare const createSession: (client: Client) => Promise<PayloadParams>;
-export declare const fetchWalletConnectEVMPublicAddress: (metadata: WalletSchema, wcClient: Client, opts?: FetchPublicAddressOpts) => Promise<string | undefined>;
-export declare const signWalletConnectPersonalMessage: (messageToSign: string, metadata: WalletSchema, client: Client, rpcProvider?: () => Promise<ethers.providers.JsonRpcProvider | undefined>) => Promise<string | undefined>;
+import Client from '@walletconnect/client';
+import { PublicClient } from 'viem';
+import { FetchPublicAddressOpts, PayloadParams, DeepLinkVariant, WalletConnector } from '@dynamic-labs/wallet-connector-core';
+import { WalletSchema } from '@dynamic-labs/wallet-book';
+export declare const initClient: (name: string, bridge: string, settings?: any) => Client;
+/**
+ * Attach event handlers to WalletConnect events.
+ */
+export declare const setupWalletConnectEventListeners: (walletConnector: WalletConnector, client: Client) => void;
+export declare const teardownWalletConnectEventListeners: (client: Client) => void;
+/**
+ * Initialize a client from a stored session and terminate the connection.
+ */
+export declare const killWalletConnectSession: (client: Client) => Promise<void>;
+export declare const createSession: (client: Client) => Promise<PayloadParams>;
+export declare const fetchWalletConnectEVMPublicAddress: (metadata: WalletSchema, wcClient: Client, deepLinkPreference: DeepLinkVariant, opts?: FetchPublicAddressOpts) => Promise<string | undefined>;
+export declare const signWalletConnectPersonalMessage: (messageToSign: string, metadata: WalletSchema, client: Client, deepLinkPreference: DeepLinkVariant, rpcProvider?: () => Promise<PublicClient | undefined>) => Promise<string | undefined>;

package/src/walletConnect/client/client.js

@@ -1,184 +1,187 @@
 import { __awaiter } from '../../../_virtual/_tslib.js';
 import Client from '@walletconnect/client';
-import { Contract, ethers } from 'ethers';
+import { hashMessage } from 'viem';
 import { isSameAddress, logger, performPlatformSpecificConnectionMethod, getDeepLink } from '@dynamic-labs/wallet-connector-core';
 import { isMobile } from '@dynamic-labs/utils';
 
-const initClient = (name, bridge, settings) => {
-    const storageId = `walletconnect-${name}`;
-    const session = localStorage.getItem(storageId);
-    const clientArgs = session
-        ? { session: JSON.parse(session), storageId }
-        : { bridge, storageId };
-    return new Client(Object.assign(Object.assign({}, clientArgs), settings));
-};
-/**
- * Attach event handlers to WalletConnect events.
- */
-const setupWalletConnectEventListeners = (opts, 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', () => __awaiter(void 0, void 0, void 0, function* () {
-        var _a;
-        yield ((_a = opts.onDisconnect) === null || _a === void 0 ? void 0 : _a.call(opts));
-    }));
-    client.on('session_update', (_, payload) => __awaiter(void 0, void 0, void 0, function* () {
-        var _b, _c;
-        // eslint-disable-next-line prefer-destructuring
-        const { accounts, chainId } = payload.params[0];
-        const didAccountChange = !isSameAddress(prevAccount || '', accounts[0], 'eip155');
-        const didChainChange = prevChain !== chainId;
-        // eslint-disable-next-line prefer-destructuring
-        prevAccount = accounts[0];
-        prevChain = chainId;
-        if (didAccountChange) {
-            yield ((_b = opts.onAccountChange) === null || _b === void 0 ? void 0 : _b.call(opts, accounts));
-        }
-        if (didChainChange) {
-            yield ((_c = opts.onChainChange) === null || _c === void 0 ? void 0 : _c.call(opts, 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) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        if (client === null || client === void 0 ? void 0 : client.connected) {
-            yield client.killSession();
-        }
-    }
-    catch (e) {
-        logger.debug(e);
-    }
-});
-const createSession = (client) => __awaiter(void 0, void 0, void 0, function* () {
-    return new Promise((resolve, reject) => {
-        client.on('connect', (error, payload) => __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, opts) => __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();
-    performPlatformSpecificConnectionMethod(wcClient.uri, metadata, {
-        onDesktopUri: opts === null || opts === void 0 ? void 0 : opts.onDesktopUri,
-        onDisplayUri: opts === null || opts === void 0 ? void 0 : opts.onDisplayUri,
-    });
-    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, rpcProvider) => __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 (isMobile()) {
-        const deepLink = getDeepLink({
-            metadata,
-            mode: 'regular',
-            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 && 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) {
-        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) => __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 contract = new Contract(accountPublicAddress, IS_VALID_SIGNATURE_ABI, yield rpcProvider());
-        const safeTransactionPromise = waitForSafeTransaction(signature, messageToSign, contract);
-        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 = (signature, messageToSign, contract) => __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 contract.isValidSignature(ethers.utils.hashMessage(messageToSign), signature);
-            if (result === MAGIC_VALUE)
-                return;
-        }
-        catch (err) {
-            logger.info('Safe transaction cannot be validated yet. Retrying.');
-        }
-        // try again after 2 seconds
-        yield sleep(2000);
-    }
+const initClient = (name, bridge, settings) => {
+    const storageId = `walletconnect-${name}`;
+    const session = localStorage.getItem(storageId);
+    const clientArgs = session
+        ? { session: JSON.parse(session), storageId }
+        : { bridge, storageId };
+    return new Client(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', () => __awaiter(void 0, void 0, void 0, function* () {
+        walletConnector.emit('disconnect');
+    }));
+    client.on('session_update', (_, payload) => __awaiter(void 0, void 0, void 0, function* () {
+        // eslint-disable-next-line prefer-destructuring
+        const { accounts, chainId } = payload.params[0];
+        const didAccountChange = !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) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        if (client === null || client === void 0 ? void 0 : client.connected) {
+            yield client.killSession();
+        }
+    }
+    catch (e) {
+        logger.debug(e);
+    }
+});
+const createSession = (client) => __awaiter(void 0, void 0, void 0, function* () {
+    return new Promise((resolve, reject) => {
+        client.on('connect', (error, payload) => __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) => __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();
+    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) => __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 (isMobile()) {
+        const deepLink = 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 && 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) {
+        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) => __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) => __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: [hashMessage(messageToSign), signature],
+                functionName: 'isValidSignature',
+            }));
+            if (result === MAGIC_VALUE)
+                return;
+        }
+        catch (err) {
+            logger.info('Safe transaction cannot be validated yet. Retrying.');
+        }
+        // try again after 2 seconds
+        yield sleep(2000);
+    }
 });
 
 export { createSession, fetchWalletConnectEVMPublicAddress, initClient, killWalletConnectSession, setupWalletConnectEventListeners, signWalletConnectPersonalMessage, teardownWalletConnectEventListeners };

package/src/walletConnect/client/index.d.ts

@@ -1 +1 @@
-export * from './client';
+export * from './client';

package/src/walletConnect/client/types.d.ts

@@ -1,4 +1,4 @@
-import Client from '@walletconnect/client';
-export type InitializeWalletConnectClientOpts = {
-    bridge?: Client['bridge'];
-};
+import Client from '@walletconnect/client';
+export type InitializeWalletConnectClientOpts = {
+    bridge?: Client['bridge'];
+};

package/src/walletConnect/fetchWalletConnectWallets.cjs

@@ -5,59 +5,44 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var walletConnectV2 = require('./walletConnectV2.cjs');
 var walletConnect = require('./walletConnect.cjs');
 
-// These wallets are either not supported or implement their
-// own WalletConnect connector
-const filteredWalletConnectWallets = [
-    'MetaMask',
-    'Gnosis Safe',
-    'Trust',
-    'lilico',
-    'Keplr',
-    'Zerion',
-    'Rabby',
-    'Exodus',
-    'OKX Wallet',
-];
-const fetchWalletConnectWallets = ({ isWalletConnectV2Enabled, walletBook, }) => {
-    var _a;
-    return Object.values((_a = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) !== null && _a !== void 0 ? _a : {})
-        .filter((wallet) => wallet.walletConnect &&
-        !filteredWalletConnectWallets.includes(wallet.shortName || wallet.name))
-        .map((wallet) => {
-        var _a;
-        const { shortName } = wallet;
-        const name = shortName || wallet.name;
-        // justification: we filtered out null/undefined above
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        if (isWalletConnectV2Enabled &&
-            ((_a = wallet.walletConnect.sdks) === null || _a === void 0 ? void 0 : _a.includes('sign_v2'))) {
-            return class extends walletConnectV2.WalletConnectV2 {
-                constructor(props) {
-                    super(Object.assign(Object.assign({}, props), { walletName: name }));
-                }
-            };
-        }
-        else {
-            return class extends walletConnect.WalletConnect {
-                constructor(props) {
-                    super(Object.assign(Object.assign({}, props), { walletName: name }));
-                }
-            };
-        }
-    });
-};
-const getWalletConnectConnector = ({ isWalletConnectV2Enabled, }) => isWalletConnectV2Enabled
-    ? class extends walletConnectV2.WalletConnectV2 {
-        constructor(props) {
-            super(Object.assign(Object.assign({}, props), { walletName: 'WalletConnect' }));
-        }
-    }
-    : class extends walletConnect.WalletConnect {
-        constructor(props) {
-            super(Object.assign(Object.assign({}, props), { walletName: 'WalletConnect' }));
-        }
+const fetchWalletConnectWallets = ({ isWalletConnectV2Enabled, walletBook, }) => {
+    var _a;
+    return Object.values((_a = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) !== null && _a !== void 0 ? _a : {})
+        .filter((wallet) => wallet.walletConnect && !wallet.filterFromWalletConnect)
+        .map((wallet) => {
+        var _a;
+        const { shortName } = wallet;
+        const name = shortName || wallet.name;
+        // justification: we filtered out null/undefined above
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        if (isWalletConnectV2Enabled &&
+            ((_a = wallet.walletConnect.sdks) === null || _a === void 0 ? void 0 : _a.includes('sign_v2'))) {
+            return class extends walletConnectV2.WalletConnectV2 {
+                constructor(props) {
+                    super(Object.assign(Object.assign({}, props), { walletName: name }));
+                }
+            };
+        }
+        else {
+            return class extends walletConnect.WalletConnect {
+                constructor(props) {
+                    super(Object.assign(Object.assign({}, props), { walletName: name }));
+                }
+            };
+        }
+    });
+};
+const getWalletConnectConnector = ({ isWalletConnectV2Enabled, }) => isWalletConnectV2Enabled
+    ? class extends walletConnectV2.WalletConnectV2 {
+        constructor(props) {
+            super(Object.assign(Object.assign({}, props), { walletName: 'WalletConnect' }));
+        }
+    }
+    : class extends walletConnect.WalletConnect {
+        constructor(props) {
+            super(Object.assign(Object.assign({}, props), { walletName: 'WalletConnect' }));
+        }
     };
 
 exports.fetchWalletConnectWallets = fetchWalletConnectWallets;
-exports.filteredWalletConnectWallets = filteredWalletConnectWallets;
 exports.getWalletConnectConnector = getWalletConnectConnector;

package/src/walletConnect/fetchWalletConnectWallets.d.ts

@@ -1,10 +1,9 @@
-import { WalletBookSchema } from '@dynamic-labs/wallet-book';
-import { WalletConnectorConstructor } from '@dynamic-labs/wallet-connector-core';
-export declare const filteredWalletConnectWallets: string[];
-export declare const fetchWalletConnectWallets: ({ isWalletConnectV2Enabled, walletBook, }: {
-    isWalletConnectV2Enabled: boolean;
-    walletBook: WalletBookSchema;
-}) => Array<WalletConnectorConstructor>;
-export declare const getWalletConnectConnector: ({ isWalletConnectV2Enabled, }: {
-    isWalletConnectV2Enabled: boolean;
-}) => WalletConnectorConstructor;
+import { WalletBookSchema } from '@dynamic-labs/wallet-book';
+import { WalletConnectorConstructor } from '@dynamic-labs/wallet-connector-core';
+export declare const fetchWalletConnectWallets: ({ isWalletConnectV2Enabled, walletBook, }: {
+    isWalletConnectV2Enabled: boolean;
+    walletBook: WalletBookSchema;
+}) => Array<WalletConnectorConstructor>;
+export declare const getWalletConnectConnector: ({ isWalletConnectV2Enabled, }: {
+    isWalletConnectV2Enabled: boolean;
+}) => WalletConnectorConstructor;