@dynamic-labs/ethereum 4.0.0-alpha.51 → 4.0.0-alpha.52

package/CHANGELOG.md

@@ -1,4 +1,6 @@
 
+## [4.0.0-alpha.52](https://github.com/dynamic-labs/dynamic-auth/compare/v4.0.0-alpha.51...v4.0.0-alpha.52) (2025-01-02)
+
 ## [4.0.0-alpha.51](https://github.com/dynamic-labs/dynamic-auth/compare/v4.0.0-alpha.50...v4.0.0-alpha.51) (2024-12-30)
 
 

package/package.cjs

@@ -3,6 +3,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var version = "4.0.0-alpha.51";
+var version = "4.0.0-alpha.52";
 
 exports.version = version;

package/package.js

@@ -1,4 +1,4 @@
 'use client'
-var version = "4.0.0-alpha.51";
+var version = "4.0.0-alpha.52";
 
 export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/ethereum",
-  "version": "4.0.0-alpha.51",
+  "version": "4.0.0-alpha.52",
   "description": "A React SDK for implementing wallet web3 authentication and authorization to your website.",
   "author": "Dynamic Labs, Inc.",
   "license": "MIT",
@@ -24,14 +24,14 @@
     "eventemitter3": "5.0.1",
     "buffer": "6.0.3",
     "@metamask/sdk": "0.30.1",
-    "@dynamic-labs/assert-package-version": "4.0.0-alpha.51",
-    "@dynamic-labs/embedded-wallet-evm": "4.0.0-alpha.51",
-    "@dynamic-labs/ethereum-core": "4.0.0-alpha.51",
-    "@dynamic-labs/logger": "4.0.0-alpha.51",
-    "@dynamic-labs/types": "4.0.0-alpha.51",
-    "@dynamic-labs/utils": "4.0.0-alpha.51",
-    "@dynamic-labs/wallet-book": "4.0.0-alpha.51",
-    "@dynamic-labs/wallet-connector-core": "4.0.0-alpha.51"
+    "@dynamic-labs/assert-package-version": "4.0.0-alpha.52",
+    "@dynamic-labs/embedded-wallet-evm": "4.0.0-alpha.52",
+    "@dynamic-labs/ethereum-core": "4.0.0-alpha.52",
+    "@dynamic-labs/logger": "4.0.0-alpha.52",
+    "@dynamic-labs/types": "4.0.0-alpha.52",
+    "@dynamic-labs/utils": "4.0.0-alpha.52",
+    "@dynamic-labs/wallet-book": "4.0.0-alpha.52",
+    "@dynamic-labs/wallet-connector-core": "4.0.0-alpha.52"
   },
   "peerDependencies": {
     "viem": "^2.7.12"

package/src/walletConnect/walletConnect.cjs

@@ -18,47 +18,154 @@ var EventEmitter__default = /*#__PURE__*/_interopDefaultLegacy(EventEmitter);
 
 const activeAccountKey = (walletName) => `dynamic-wc2-active-account-${walletName}`;
 const sessionTopicKey = (walletName) => `dynamic-wc2-session-topic-${walletName}`;
-const swicthedNetworkKey = (walletName) => `dynamic-wc2-switched-network-${walletName}`;
 const currentChainKey = (walletName) => `dynamic-wc2-current-chain-${walletName}`;
 const ee = new EventEmitter__default["default"]();
 class WalletConnect extends ethereumCore.EthereumWalletConnector {
+    supportsNetworkSwitching() {
+        return true;
+    }
     constructor(opts) {
-        var _a;
         super(opts);
         this.isInitialized = false;
         this.canConnectViaQrCode = true;
         this.isWalletConnect = true;
         this.preferredChains = [];
-        // 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';
         this.preferredChains = opts.walletConnectPreferredChains || [];
-        this.hasSwitchedNetwork =
-            (_a = Boolean(localStorage.getItem(this.swicthedNetworkKey))) !== null && _a !== void 0 ? _a : false;
         const lsCurrentChain = localStorage.getItem(this.currentChainKey);
         this.currentChainId = lsCurrentChain
             ? utils.parseIntSafe(lsCurrentChain)
             : undefined;
     }
-    getMappedChains() {
-        return (this.evmNetworks
-            // Filters out palm that crashes Trust Wallet
-            .filter((network) => network.chainId !== 11297108109)
-            .map((network) => `eip155:${network.chainId}`));
+    /**
+     * This method is used to get the address of the active account.
+     * It will re-initialize the provider if the provider is not found.
+     * @param opts
+     * @returns
+     */
+    getAddress(opts) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const activeAccount = this.getActiveAccount();
+            if (activeAccount === null || activeAccount === void 0 ? void 0 : activeAccount.address) {
+                return activeAccount.address;
+            }
+            if (!WalletConnect.provider || !((_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.signer.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 utils.sleep(1000);
+                if (!WalletConnect.provider || !((_b = WalletConnect.provider) === null || _b === void 0 ? void 0 : _b.signer.uri)) {
+                    walletConnectorCore.logger.debug('No WC2 provider was found after init attempt, aborting');
+                    throw new utils.DynamicError('No provider found');
+                }
+                else {
+                    walletConnectorCore.logger.debug('provider was successfully initialized, continuing');
+                }
+            }
+            // Set Deep links
+            walletConnectorCore.performPlatformSpecificConnectionMethod(WalletConnect.provider.signer.uri, this.metadata.deepLinks, {
+                onDesktopUri: opts === null || opts === void 0 ? void 0 : opts.onDesktopUri,
+                onDisplayUri: opts === null || opts === void 0 ? void 0 : opts.onDisplayUri,
+            }, this.deepLinkPreference);
+            return new Promise((resolve, reject) => {
+                if (!WalletConnect.provider) {
+                    reject(new utils.DynamicError('No provider found'));
+                    return;
+                }
+                const onFail = () => {
+                    walletConnectorCore.logger.debug('onConnection faile re-initializing provider');
+                    const error = new utils.DynamicError('Connection rejected. Please try again.');
+                    error.code = 'connection_rejected';
+                    if (WalletConnect.provider) {
+                        WalletConnect.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,
+                        // otherwise they will trigger the iOS bug where they are redirected to the app store
+                        this.init();
+                        walletConnectorCore.logger.debug('provider was re-initialized in onConnection fail, continuing');
+                    }
+                    reject(error);
+                    // We must clean up the onConnect and onFail listeners
+                    // whenever the connection attempt either succeeds or fails
+                    cleanupListeners();
+                };
+                const onConnect = () => {
+                    var _a;
+                    walletConnectorCore.logger.debug('onConnection success, setting session');
+                    const session = (_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.session;
+                    if (!session) {
+                        walletConnectorCore.logger.debug('onConnection success, but no session found rejecting');
+                        reject(new utils.DynamicError('No session found'));
+                        return;
+                    }
+                    this.setSession(session);
+                    this.setWCActiveAccount(session.namespaces.eip155.accounts[0].split(':')[2]);
+                    this.getNetwork().then((chainId) => {
+                        var _a, _b;
+                        walletConnectorCore.logger.debug('onConnection success, resolving, chainId:', chainId);
+                        this.currentChainId = chainId;
+                        walletConnectorCore.logger.debug('onConnection success, resolving, activeAccountAddress:', (_a = this.getActiveAccount()) === null || _a === void 0 ? void 0 : _a.address);
+                        resolve((_b = this.getActiveAccount()) === null || _b === void 0 ? void 0 : _b.address);
+                    });
+                    // We must clean up the onConnect and onFail listeners
+                    // whenever the connection attempt either succeeds or fails
+                    cleanupListeners();
+                };
+                const cleanupListeners = () => {
+                    var _a;
+                    ee.off('walletconnect_connection_failed', onFail);
+                    (_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.off('connect', onConnect);
+                };
+                ee.on('walletconnect_connection_failed', onFail);
+                WalletConnect.provider.on('connect', onConnect);
+            });
+        });
+    }
+    init() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            walletConnectorCore.logger.debug('init was called', this.name);
+            yield this.initProvider();
+            yield this.initConnection();
+            this.isInitialized = true;
+        });
     }
-    getMappedChainsByPreferredOrder() {
-        const allChains = this.getMappedChains();
-        const reorderedChains = this.preferredChains.filter((chain) => allChains.includes(chain));
-        const remainingChains = allChains.filter((chain) => !this.preferredChains.includes(chain));
-        return [...reorderedChains, ...remainingChains].map((chain) => Number(chain.split(':')[1]));
+    // We need to add a gate to this method since we will be calling it asynchronously
+    // from different places (such as setShowAuthFlow), which means there's a chance for
+    // a race condition to happen where createInitProviderPromise is called multiple times
+    initProvider() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            walletConnectorCore.logger.debug('initProvider was called', this.name);
+            const { provider } = WalletConnect;
+            if (!provider) {
+                walletConnectorCore.logger.debug('provider is undefined', this.name);
+                if (this.initializePromise === undefined) {
+                    this.initializePromise = this.createInitProviderPromise();
+                }
+                yield this.initializePromise;
+            }
+        });
+    }
+    createInitProviderPromise() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            WalletConnect.provider = yield this.createProvider();
+            this.teardownEventListeners();
+            this.setupEventListeners();
+        });
     }
     initConnection() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
+            walletConnectorCore.logger.debug('initConnection was called', this.name);
             const { provider } = WalletConnect;
             if (!provider) {
                 throw new utils.DynamicError('No provider found (init connection)');
@@ -75,6 +182,7 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
     }
     createProvider() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
+            walletConnectorCore.logger.debug('createProvider was called', this.name);
             return EthereumProvider__default["default"].init({
                 events: ['chainChanged', 'accountsChanged'],
                 methods: [],
@@ -96,65 +204,49 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
             });
         });
     }
-    getWalletClientFromInitializedProvider() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const walletConnect = this.createProvider();
-            const walletClient = viem.createWalletClient({
-                account: this.getActiveAccount(),
-                transport: viem.custom(yield walletConnect),
-            });
-            return walletClient;
-        });
-    }
-    createInitProviderPromise() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            WalletConnect.provider = yield this.createProvider();
-            this.teardownEventListeners();
-            this.setupEventListeners();
-        });
-    }
-    // We need to add a gate to this method since we will be calling it asynchronously
-    // from different places (such as setShowAuthFlow), which means there's a chance for
-    // a race condition to happen where createInitProviderPromise is called multiple times
-    initProvider() {
+    refreshSession() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const { provider } = WalletConnect;
-            if (!provider) {
-                if (this.initializePromise === undefined) {
-                    this.initializePromise = this.createInitProviderPromise();
+            var _a, _b, _c, _d, _e;
+            walletConnectorCore.logger.debug('refreshSession was called', this.name);
+            if ((_b = (_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.session) === null || _b === void 0 ? void 0 : _b.topic) {
+                if (localStorage.getItem(this.sessionTopicKey) ===
+                    ((_d = (_c = WalletConnect.provider) === null || _c === void 0 ? void 0 : _c.session) === null || _d === void 0 ? void 0 : _d.topic)) {
+                    this.session = WalletConnect.provider.session;
+                    this.setActiveAccount(((_e = localStorage.getItem(this.activeAccountKey)) !== null && _e !== void 0 ? _e : undefined));
                 }
-                yield this.initializePromise;
             }
-        });
-    }
-    refreshSession() {
-        var _a, _b, _c, _d, _e;
-        if ((_b = (_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.session) === null || _b === void 0 ? void 0 : _b.topic) {
-            if (localStorage.getItem(this.sessionTopicKey) ===
-                ((_d = (_c = WalletConnect.provider) === null || _c === void 0 ? void 0 : _c.session) === null || _d === void 0 ? void 0 : _d.topic)) {
-                this.session = WalletConnect.provider.session;
-                this.setActiveAccount(((_e = localStorage.getItem(this.activeAccountKey)) !== null && _e !== void 0 ? _e : undefined));
+            const walletClient = this.getWalletClient();
+            const walletChainId = yield walletClient.getChainId();
+            walletConnectorCore.logger.debug('checking selected chain in refreshSession', this.name, walletChainId, this.currentChainId);
+            if (this.currentChainId && this.currentChainId !== walletChainId) {
+                walletConnectorCore.logger.debug('switching to selected chain', this.currentChainId);
+                yield walletClient.switchChain({ id: this.currentChainId });
             }
-        }
-    }
-    init() {
-        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);
+    getMappedChainsByPreferredOrder() {
+        const allChains = this.evmNetworks.map((network) => `eip155:${network.chainId}`);
+        const reorderedChains = this.preferredChains.filter((chain) => allChains.includes(chain));
+        const remainingChains = allChains.filter((chain) => !this.preferredChains.includes(chain));
+        return [...reorderedChains, ...remainingChains].map((chain) => Number(chain.split(':')[1]));
     }
-    get swicthedNetworkKey() {
-        return swicthedNetworkKey(this.key);
+    getWalletClient(chainId) {
+        walletConnectorCore.logger.debug('getWalletClient was called', this.name);
+        const walletConnect = WalletConnect.provider || this.createProvider();
+        const walletClient = viem.createWalletClient({
+            account: this.getActiveAccount(),
+            chain: ethereumCore.chainsMap[chainId !== null && chainId !== void 0 ? chainId : String(this.currentChainId)],
+            transport: viem.custom({
+                request: (args) => _tslib.__awaiter(this, void 0, void 0, function* () {
+                    const provider = yield walletConnect;
+                    return provider.request(args);
+                }),
+            }),
+        });
+        return walletClient;
     }
-    get currentChainKey() {
-        return currentChainKey(this.key);
+    get currentChainId() {
+        return this._currentChainId;
     }
     set currentChainId(value) {
         this._currentChainId = value;
@@ -165,23 +257,14 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
             localStorage.removeItem(this.currentChainKey);
         }
     }
-    get currentChainId() {
-        return this._currentChainId;
-    }
-    set hasSwitchedNetwork(value) {
-        this._hasSwitchedNetwork = value;
-        if (value) {
-            localStorage.setItem(this.swicthedNetworkKey, value.toString());
-        }
-        else {
-            localStorage.removeItem(this.swicthedNetworkKey);
-        }
+    get sessionTopicKey() {
+        return sessionTopicKey(this.key);
     }
-    get hasSwitchedNetwork() {
-        return this._hasSwitchedNetwork;
+    get activeAccountKey() {
+        return activeAccountKey(this.key);
     }
-    supportsNetworkSwitching() {
-        return true;
+    get currentChainKey() {
+        return currentChainKey(this.key);
     }
     setupEventListeners() {
         if (!WalletConnect.provider) {
@@ -206,7 +289,6 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
                 }
                 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 });
@@ -235,91 +317,6 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
         WalletConnect.provider.off('session_event', this.sessionEventHandler);
         WalletConnect.provider.off('session_delete', this.sessionDeleteHandler);
     }
-    getWalletClient(chainId) {
-        if (!WalletConnect.provider) {
-            return;
-        }
-        return viem.createWalletClient({
-            account: this.getActiveAccount(),
-            chain: ethereumCore.chainsMap[chainId !== null && chainId !== void 0 ? chainId : String(this.currentChainId)],
-            transport: viem.custom(WalletConnect.provider),
-        });
-    }
-    getAddress(opts) {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const activeAccount = this.getActiveAccount();
-            if (activeAccount === null || activeAccount === void 0 ? void 0 : activeAccount.address) {
-                return activeAccount.address;
-            }
-            if (!WalletConnect.provider || !((_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.signer.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 utils.sleep(1000);
-                if (!WalletConnect.provider || !((_b = WalletConnect.provider) === null || _b === void 0 ? void 0 : _b.signer.uri)) {
-                    walletConnectorCore.logger.debug('No WC2 provider found, escaping and throwing error');
-                    throw new utils.DynamicError('No provider found');
-                }
-            }
-            walletConnectorCore.performPlatformSpecificConnectionMethod(WalletConnect.provider.signer.uri, this.metadata.deepLinks, {
-                onDesktopUri: opts === null || opts === void 0 ? void 0 : opts.onDesktopUri,
-                onDisplayUri: opts === null || opts === void 0 ? void 0 : opts.onDisplayUri,
-            }, this.deepLinkPreference);
-            return new Promise((resolve, reject) => {
-                if (!WalletConnect.provider) {
-                    reject(new utils.DynamicError('No provider found'));
-                    return;
-                }
-                const onFail = () => {
-                    const error = new utils.DynamicError('Connection rejected. Please try again.');
-                    error.code = 'connection_rejected';
-                    if (WalletConnect.provider) {
-                        WalletConnect.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,
-                        // otherwise they will trigger the iOS bug where they are redirected to the app store
-                        this.init();
-                    }
-                    reject(error);
-                    // We must clean up the onConnect and onFail listeners
-                    // whenever the connection attempt either succeeds or fails
-                    cleanupListeners();
-                };
-                const onConnect = () => {
-                    var _a;
-                    const session = (_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.session;
-                    if (!session) {
-                        reject(new utils.DynamicError('No session found'));
-                        return;
-                    }
-                    this.setSession(session);
-                    this.setWCActiveAccount(session.namespaces.eip155.accounts[0].split(':')[2]);
-                    this.getNetwork().then((chainId) => {
-                        var _a;
-                        this.currentChainId = chainId;
-                        resolve((_a = this.getActiveAccount()) === null || _a === void 0 ? void 0 : _a.address);
-                    });
-                    // We must clean up the onConnect and onFail listeners
-                    // whenever the connection attempt either succeeds or fails
-                    cleanupListeners();
-                };
-                const cleanupListeners = () => {
-                    var _a;
-                    ee.off('walletconnect_connection_failed', onFail);
-                    (_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.off('connect', onConnect);
-                };
-                ee.on('walletconnect_connection_failed', onFail);
-                WalletConnect.provider.on('connect', onConnect);
-            });
-        });
-    }
     /**
      * 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
@@ -379,7 +376,7 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
                 if (!activeAccount) {
                     return;
                 }
-                const walletClient = yield this.getWalletClientFromInitializedProvider();
+                const walletClient = yield this.getWalletClient();
                 return walletClient.signMessage({
                     account: activeAccount,
                     message: messageToSign,
@@ -411,7 +408,6 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
             var _a;
             this.clearActiveAccount();
             this.clearSession();
-            this.hasSwitchedNetwork = false;
             this.currentChainId = undefined;
             if (!((_a = WalletConnect.provider) === null || _a === void 0 ? void 0 : _a.session)) {
                 return;
@@ -457,27 +453,18 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
             if (this.switchNetworkOnlyFromWallet) {
                 throw new utils.DynamicError('Network switching is only supported through the wallet');
             }
-            if (!this.supportsNetworkSwitching()) {
-                throw new utils.DynamicError('Network switching not supported');
-            }
-            const walletClient = yield this.getWalletClientFromInitializedProvider();
-            if (this.isMetaMask()) {
-                const deepLink = this.getDeepLink();
-                if (deepLink) {
-                    window.location.href = deepLink;
-                }
-            }
+            const walletClient = yield this.getWalletClient();
             yield _super.providerSwitchNetwork.call(this, { network, provider: walletClient });
             this.currentChainId = network.chainId;
-            this.hasSwitchedNetwork = true;
             this.emit('chainChange', { chain: String(network.chainId) });
         });
     }
     getConnectedAccounts() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             if (this.isInitialized === false) {
+                // TODO why not just call init()?
                 yield this.initProvider();
-                this.refreshSession();
+                yield this.refreshSession();
                 this.isInitialized = true;
             }
             const activeAccount = this.getActiveAccount();
@@ -487,21 +474,11 @@ class WalletConnect extends ethereumCore.EthereumWalletConnector {
             return [activeAccount.address];
         });
     }
-    isMetaMask() {
-        var _a, _b, _c, _d, _e;
-        return ((_e = (_d = (_c = (_b = (_a = this.session) === null || _a === void 0 ? void 0 : _a.peer) === null || _b === void 0 ? void 0 : _b.metadata) === null || _c === void 0 ? void 0 : _c.name) === null || _d === void 0 ? void 0 : _d.toLowerCase().startsWith('metamask')) !== null && _e !== void 0 ? _e : false);
-    }
     getSupportedNetworks() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             var _a;
             yield this.initProvider();
-            this.refreshSession();
-            if (this.isMetaMask()) {
-                if (this.hasSwitchedNetwork) {
-                    return [String(this.currentChainId)];
-                }
-                return this.evmNetworks.map((network) => network.chainId.toString());
-            }
+            yield this.refreshSession();
             if (!this.session) {
                 return [];
             }