@dynamic-labs/wagmi-connector 1.0.0-alpha.5 → 1.0.0-alpha.7

package/CHANGELOG.md

@@ -1,4 +1,31 @@
 
+## [1.0.0-alpha.7](https://github.com/dynamic-labs/DynamicAuth/compare/v1.0.0-alpha.6...v1.0.0-alpha.7) (2023-12-05)
+
+
+### Features
+
+* add support for Turnkey HD wallets and backwards compatiblity for private key wallets ([#4011](https://github.com/dynamic-labs/DynamicAuth/issues/4011)) ([75c5258](https://github.com/dynamic-labs/DynamicAuth/commit/75c5258da494d5d4dfa8b96655303dd9645f2269))
+
+
+### Bug Fixes
+
+* add close button to wallets list ([#4036](https://github.com/dynamic-labs/DynamicAuth/issues/4036)) ([a2b988b](https://github.com/dynamic-labs/DynamicAuth/commit/a2b988bdfc662af6f85d37a79ed6666c483aa447))
+* add support for embedded wallets in connect-only ([#4041](https://github.com/dynamic-labs/DynamicAuth/issues/4041)) ([ceea635](https://github.com/dynamic-labs/DynamicAuth/commit/ceea635b69e2a0c2636b47fbd30639d69dba7a1c))
+* embedded wallet invalid stored chain breaking network picker ([#4050](https://github.com/dynamic-labs/DynamicAuth/issues/4050)) ([2e2384b](https://github.com/dynamic-labs/DynamicAuth/commit/2e2384ba37407d9164cce47e23f5d5f469f7e062))
+* handle insufficient funds from AA provider ([#4027](https://github.com/dynamic-labs/DynamicAuth/issues/4027)) ([6b9cc88](https://github.com/dynamic-labs/DynamicAuth/commit/6b9cc886f4f2590094bd50aba195c07a5532dfa4))
+* prevent double logout caused by wagmi sync ([#4048](https://github.com/dynamic-labs/DynamicAuth/issues/4048)) ([c66c81c](https://github.com/dynamic-labs/DynamicAuth/commit/c66c81c80839aa9ce1cfae76f4afce12e34f3513))
+* properly detect network switch for secondary wallets ([#4038](https://github.com/dynamic-labs/DynamicAuth/issues/4038)) ([f87174d](https://github.com/dynamic-labs/DynamicAuth/commit/f87174de0892dd057401eaf3c0bc68d974add0fc))
+* **use-wallets-connected-state:** update state on wallet id change ([#4045](https://github.com/dynamic-labs/DynamicAuth/issues/4045)) ([ca3a835](https://github.com/dynamic-labs/DynamicAuth/commit/ca3a8359eae386bffa758ed646ac14af8360a7f8))
+* user should be able to see the full passkey name on management view ([#4043](https://github.com/dynamic-labs/DynamicAuth/issues/4043)) ([7bc1b70](https://github.com/dynamic-labs/DynamicAuth/commit/7bc1b7043cbc9f0e21df78a57efc3e6938a99db2))
+* users should be able to easily find passkey recovery ([#4058](https://github.com/dynamic-labs/DynamicAuth/issues/4058)) ([0202ae9](https://github.com/dynamic-labs/DynamicAuth/commit/0202ae98c96544dec5ac357dc77000996e32ad33))
+
+## [1.0.0-alpha.6](https://github.com/dynamic-labs/DynamicAuth/compare/v1.0.0-alpha.5...v1.0.0-alpha.6) (2023-11-29)
+
+
+### Bug Fixes
+
+* transaction layout show alert ([#4024](https://github.com/dynamic-labs/DynamicAuth/issues/4024)) ([52057f5](https://github.com/dynamic-labs/DynamicAuth/commit/52057f54ebc32464b2486a2328cb6310caf85208)), closes [#4020](https://github.com/dynamic-labs/DynamicAuth/issues/4020)
+
 ## [1.0.0-alpha.5](https://github.com/dynamic-labs/DynamicAuth/compare/v1.0.0-alpha.4...v1.0.0-alpha.5) (2023-11-29)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/wagmi-connector",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/dynamic-labs/DynamicAuth.git",
@@ -11,10 +11,10 @@
     "react": "^17.0.2 || ^18.0.0",
     "viem": "^1.1.0",
     "wagmi": "^1.2.0",
-    "@dynamic-labs/rpc-providers": "1.0.0-alpha.5",
-    "@dynamic-labs/sdk-react-core": "1.0.0-alpha.5",
-    "@dynamic-labs/types": "1.0.0-alpha.5",
-    "@dynamic-labs/wallet-connector-core": "1.0.0-alpha.5",
+    "@dynamic-labs/rpc-providers": "1.0.0-alpha.7",
+    "@dynamic-labs/sdk-react-core": "1.0.0-alpha.7",
+    "@dynamic-labs/types": "1.0.0-alpha.7",
+    "@dynamic-labs/wallet-connector-core": "1.0.0-alpha.7",
     "eventemitter3": "5.0.1"
   },
   "license": "MIT",

package/src/lib/Connector.d.ts

@@ -1,3 +1,4 @@
+import { MutableRefObject } from 'react';
 import { Address, Connector as BaseWagmiConnector, ConnectorData, Chain } from 'wagmi';
 import { Account, Transport, WalletClient } from 'viem';
 import { WalletConnector } from '@dynamic-labs/sdk-react-core';
@@ -7,10 +8,13 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
     id: string;
     name: string;
     ready: boolean;
-    constructor({ chains, handleLogOut, walletConnector, }: {
+    /** See this variable's reason in it's definition in DynamicContext */
+    preventWagmiSyncFromCallingLogout: MutableRefObject<boolean>;
+    constructor({ chains, handleLogOut, walletConnector, preventWagmiSyncFromCallingLogout, }: {
         chains: Chain[];
         handleLogOut: () => Promise<void>;
         walletConnector: WalletConnector;
+        preventWagmiSyncFromCallingLogout: MutableRefObject<boolean>;
     });
     _onAccountsChanged({ accounts }: {
         accounts: string[];
@@ -49,20 +53,20 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
         type: string;
         uid: string;
         addChain: (args: import("viem").AddChainParameters) => Promise<void>;
-        deployContract: <const TAbi extends import("viem").Abi | readonly unknown[], TChainOverride extends Chain | undefined>(args: import("viem").DeployContractParameters<TAbi, Chain, Account, TChainOverride>) => Promise<`0x${string}`>;
+        deployContract: <const TAbi extends import("viem").Abi | readonly unknown[], TChainOverride extends Chain | undefined = undefined>(args: import("viem").DeployContractParameters<TAbi, Chain, Account, TChainOverride>) => Promise<`0x${string}`>;
         getAddresses: () => Promise<import("viem").GetAddressesReturnType>;
         getChainId: () => Promise<number>;
         getPermissions: () => Promise<import("viem").GetPermissionsReturnType>;
-        prepareTransactionRequest: <TChainOverride_1 extends Chain | undefined>(args: import("viem").PrepareTransactionRequestParameters<Chain, Account, TChainOverride_1>) => Promise<import("viem").PrepareTransactionRequestReturnType>;
+        prepareTransactionRequest: <TChainOverride_1 extends Chain | undefined = undefined>(args: import("viem").PrepareTransactionRequestParameters<Chain, Account, TChainOverride_1>) => Promise<import("viem").PrepareTransactionRequestReturnType>;
         requestAddresses: () => Promise<import("viem").RequestAddressesReturnType>;
         requestPermissions: (args: {
             [x: string]: Record<string, any>;
             eth_accounts: Record<string, any>;
         }) => Promise<import("viem").RequestPermissionsReturnType>;
         sendRawTransaction: (args: import("viem/_types/actions/wallet/sendRawTransaction").SendRawTransactionParameters) => Promise<`0x${string}`>;
-        sendTransaction: <TChainOverride_2 extends Chain | undefined>(args: import("viem").SendTransactionParameters<Chain, Account, TChainOverride_2>) => Promise<`0x${string}`>;
+        sendTransaction: <TChainOverride_2 extends Chain | undefined = undefined>(args: import("viem").SendTransactionParameters<Chain, Account, TChainOverride_2>) => Promise<`0x${string}`>;
         signMessage: (args: import("viem").SignMessageParameters<Account>) => Promise<`0x${string}`>;
-        signTransaction: <TChainOverride_3 extends Chain | undefined>(args: import("viem/_types/actions/wallet/signTransaction").SignTransactionParameters<Chain, Account, TChainOverride_3>) => Promise<`0x${string}`>;
+        signTransaction: <TChainOverride_3 extends Chain | undefined = undefined>(args: import("viem/_types/actions/wallet/signTransaction").SignTransactionParameters<Chain, Account, TChainOverride_3>) => Promise<`0x${string}`>;
         signTypedData: <const TTypedData extends {
             [x: string]: readonly import("viem").TypedDataParameter[];
             [x: `string[${string}]`]: undefined;
@@ -273,7 +277,7 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
         }, TPrimaryType extends string>(args: import("viem").SignTypedDataParameters<TTypedData, TPrimaryType, Account>) => Promise<`0x${string}`>;
         switchChain: (args: import("viem").SwitchChainParameters) => Promise<void>;
         watchAsset: (args: import("viem").WatchAssetParams) => Promise<boolean>;
-        writeContract: <const TAbi_1 extends import("viem").Abi | readonly unknown[], TFunctionName extends string, TChainOverride_4 extends Chain | undefined>(args: import("viem").WriteContractParameters<TAbi_1, TFunctionName, Chain, Account, TChainOverride_4>) => Promise<`0x${string}`>;
+        writeContract: <const TAbi_1 extends import("viem").Abi | readonly unknown[], TFunctionName extends string, TChainOverride_4 extends Chain | undefined = undefined>(args: import("viem").WriteContractParameters<TAbi_1, TFunctionName, Chain, Account, TChainOverride_4>) => Promise<`0x${string}`>;
         extend: <const client extends {
             [x: string]: unknown;
             account?: undefined;
@@ -287,7 +291,7 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
             transport?: undefined;
             type?: undefined;
             uid?: undefined;
-        }>(fn: (client: import("viem").Client<Transport, Chain, Account, import("viem").WalletRpcSchema, import("viem").WalletActions<Chain, Account>>) => client) => import("viem").Client<Transport, Chain, Account, import("viem").WalletRpcSchema, { [K in keyof client]: client[K]; } & import("viem").WalletActions<Chain, Account>>;
+        } & Partial<Pick<import("viem").PublicActions, "getChainId" | "prepareTransactionRequest" | "sendRawTransaction" | "call" | "createContractEventFilter" | "createEventFilter" | "estimateContractGas" | "estimateGas" | "getBlock" | "getBlockNumber" | "getContractEvents" | "getEnsText" | "getFilterChanges" | "getGasPrice" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "readContract" | "simulateContract" | "uninstallFilter" | "watchBlockNumber" | "watchContractEvent"> & Pick<import("viem").WalletActions, "sendTransaction" | "writeContract">>>(fn: (client: import("viem").Client<Transport, Chain, Account, import("viem").WalletRpcSchema, import("viem").WalletActions<Chain, Account>>) => client) => import("viem").Client<Transport, Chain, Account, import("viem").WalletRpcSchema, { [K in keyof client]: client[K]; } & import("viem").WalletActions<Chain, Account>>;
     } | {
         account: {
             address: `0x${string}`;
@@ -309,14 +313,14 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
         type: string;
         uid: string;
         addChain: (args: import("viem").AddChainParameters) => Promise<void>;
-        deployContract: <const TAbi_2 extends import("viem").Abi | readonly unknown[], TChainOverride_5 extends Chain | undefined>(args: import("viem").DeployContractParameters<TAbi_2, Chain, {
+        deployContract: <const TAbi_2 extends import("viem").Abi | readonly unknown[], TChainOverride_5 extends Chain | undefined = undefined>(args: import("viem").DeployContractParameters<TAbi_2, Chain, {
             address: `0x${string}`;
             type: "json-rpc";
         }, TChainOverride_5>) => Promise<`0x${string}`>;
         getAddresses: () => Promise<import("viem").GetAddressesReturnType>;
         getChainId: () => Promise<number>;
         getPermissions: () => Promise<import("viem").GetPermissionsReturnType>;
-        prepareTransactionRequest: <TChainOverride_6 extends Chain | undefined>(args: import("viem").PrepareTransactionRequestParameters<Chain, {
+        prepareTransactionRequest: <TChainOverride_6 extends Chain | undefined = undefined>(args: import("viem").PrepareTransactionRequestParameters<Chain, {
             address: `0x${string}`;
             type: "json-rpc";
         }, TChainOverride_6>) => Promise<import("viem").PrepareTransactionRequestReturnType>;
@@ -326,7 +330,7 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
             eth_accounts: Record<string, any>;
         }) => Promise<import("viem").RequestPermissionsReturnType>;
         sendRawTransaction: (args: import("viem/_types/actions/wallet/sendRawTransaction").SendRawTransactionParameters) => Promise<`0x${string}`>;
-        sendTransaction: <TChainOverride_7 extends Chain | undefined>(args: import("viem").SendTransactionParameters<Chain, {
+        sendTransaction: <TChainOverride_7 extends Chain | undefined = undefined>(args: import("viem").SendTransactionParameters<Chain, {
             address: `0x${string}`;
             type: "json-rpc";
         }, TChainOverride_7>) => Promise<`0x${string}`>;
@@ -334,7 +338,7 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
             address: `0x${string}`;
             type: "json-rpc";
         }>) => Promise<`0x${string}`>;
-        signTransaction: <TChainOverride_8 extends Chain | undefined>(args: import("viem/_types/actions/wallet/signTransaction").SignTransactionParameters<Chain, {
+        signTransaction: <TChainOverride_8 extends Chain | undefined = undefined>(args: import("viem/_types/actions/wallet/signTransaction").SignTransactionParameters<Chain, {
             address: `0x${string}`;
             type: "json-rpc";
         }, TChainOverride_8>) => Promise<`0x${string}`>;
@@ -551,7 +555,7 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
         }>) => Promise<`0x${string}`>;
         switchChain: (args: import("viem").SwitchChainParameters) => Promise<void>;
         watchAsset: (args: import("viem").WatchAssetParams) => Promise<boolean>;
-        writeContract: <const TAbi_3 extends import("viem").Abi | readonly unknown[], TFunctionName_1 extends string, TChainOverride_9 extends Chain | undefined>(args: import("viem").WriteContractParameters<TAbi_3, TFunctionName_1, Chain, {
+        writeContract: <const TAbi_3 extends import("viem").Abi | readonly unknown[], TFunctionName_1 extends string, TChainOverride_9 extends Chain | undefined = undefined>(args: import("viem").WriteContractParameters<TAbi_3, TFunctionName_1, Chain, {
             address: `0x${string}`;
             type: "json-rpc";
         }, TChainOverride_9>) => Promise<`0x${string}`>;
@@ -568,7 +572,7 @@ export declare class Connector extends BaseWagmiConnector<WalletClient<Transport
             transport?: undefined;
             type?: undefined;
             uid?: undefined;
-        }>(fn: (client: import("viem").Client<import("viem").CustomTransport, Chain, {
+        } & Partial<Pick<import("viem").PublicActions, "getChainId" | "prepareTransactionRequest" | "sendRawTransaction" | "call" | "createContractEventFilter" | "createEventFilter" | "estimateContractGas" | "estimateGas" | "getBlock" | "getBlockNumber" | "getContractEvents" | "getEnsText" | "getFilterChanges" | "getGasPrice" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "readContract" | "simulateContract" | "uninstallFilter" | "watchBlockNumber" | "watchContractEvent"> & Pick<import("viem").WalletActions, "sendTransaction" | "writeContract">>>(fn: (client: import("viem").Client<import("viem").CustomTransport, Chain, {
             address: `0x${string}`;
             type: "json-rpc";
         }, import("viem").WalletRpcSchema, import("viem").WalletActions<Chain, {

package/src/lib/Connector.js

@@ -3,7 +3,7 @@ import { Connector as Connector$1 } from 'wagmi';
 import { getAddress, createWalletClient, custom, toHex } from 'viem';
 
 class Connector extends Connector$1 {
-    constructor({ chains, handleLogOut, walletConnector, }) {
+    constructor({ chains, handleLogOut, walletConnector, preventWagmiSyncFromCallingLogout, }) {
         super({ chains, options: undefined });
         // wagmi properties
         this.id = 'dynamic';
@@ -26,6 +26,7 @@ class Connector extends Connector$1 {
         this.handleLogOut = handleLogOut;
         this.walletConnector = walletConnector;
         this.id = `dynamic-${walletConnector.key}`;
+        this.preventWagmiSyncFromCallingLogout = preventWagmiSyncFromCallingLogout;
     }
     _onAccountsChanged({ accounts }) {
         this.onAccountsChanged(accounts);
@@ -56,13 +57,21 @@ class Connector extends Connector$1 {
         });
     }
     disconnect() {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             this.walletConnector.removeListener('accountChange', this._onAccountsChanged, this);
             this.walletConnector.removeListener('chainChange', this._onChainChanged, this);
             this.walletConnector.removeListener('disconnect', this._onDisconnect, this);
-            yield ((_a = this.walletConnector) === null || _a === void 0 ? void 0 : _a.endSession());
-            yield ((_b = this.handleLogOut) === null || _b === void 0 ? void 0 : _b.call(this));
+            if (!this.preventWagmiSyncFromCallingLogout.current) {
+                yield this.walletConnector.endSession();
+                yield this.handleLogOut();
+            }
+            /**
+             * In our own Dynamic Wagmi sync component, we will flip the flag to true before calling disconnect,
+             * and here it automatically flips back to false afterwards. This will prevent the Connector from
+             * calling handleLogOut when we are the ones calling disconnect, but will preserve the existing behavior
+             * for customers who use useDisconnect directly.
+             */
+            this.preventWagmiSyncFromCallingLogout.current = false;
         });
     }
     getAccount() {

package/src/lib/DynamicWagmiConnector.js

@@ -1,12 +1,12 @@
-import React, { useEffect, useMemo } from 'react';
+import React, { useRef, useEffect, useMemo } from 'react';
 import { configureChains, mainnet, createConfig, WagmiConfig } from 'wagmi';
 import { publicProvider } from 'wagmi/providers/public';
 import { useDynamicContext } from '@dynamic-labs/sdk-react-core';
 import { Connector } from './Connector.js';
-import { SyncDynamicWagmi } from './SyncDynamicWagmi.js';
+import { getConnector } from './getConnector.js';
 import { getWagmiChainsFromDynamicChains } from './getWagmiChainsFromDynamicChains.js';
 import { getWagmiProvidersFromDynamicChains } from './getWagmiProvidersFromDynamicChains.js';
-import { getConnector } from './getConnector.js';
+import { SyncDynamicWagmi } from './SyncDynamicWagmi.js';
 
 const { publicClient } = configureChains([mainnet], [publicProvider()]);
 const config = createConfig({
@@ -15,6 +15,11 @@ const config = createConfig({
 });
 const DynamicWagmiConnector = ({ evmNetworks: customerSuppliedEvmNetworks, children, }) => {
     const { networkConfigurations, handleLogOut, connectedWallets, linkedWallets, authMode, sendWagmiSettings, } = useDynamicContext();
+    /**
+     * This will prevent the wagmi Connector from calling handleLogOut when we are the ones calling disconnect
+     * as a result of a handleLogOut call (see SyncDynamicWagmi), but will preserve the existing behavior for customers.
+     */
+    const preventWagmiSyncFromCallingLogout = useRef(false);
     /**
      * Linked wallets are only available on connect-and-sign mode and the connected wallets
      * are only available on connect-only mode, the wallet const represents the current available
@@ -41,8 +46,9 @@ const DynamicWagmiConnector = ({ evmNetworks: customerSuppliedEvmNetworks, child
     const connector = useMemo(() => getConnector(wallets, (wallet) => new Connector({
         chains,
         handleLogOut,
+        preventWagmiSyncFromCallingLogout,
         walletConnector: wallet.connector,
-    })), [wallets, chains, handleLogOut]);
+    })), [wallets, chains, handleLogOut, preventWagmiSyncFromCallingLogout]);
     /**
      * Updating the wagmi config must be done in a useEffect because
      * when setting the public client and connectors, wagmi will fire
@@ -57,7 +63,7 @@ const DynamicWagmiConnector = ({ evmNetworks: customerSuppliedEvmNetworks, child
     }, [connector, publicClient, webSocketPublicClient]);
     // use React.createElement to prevent bunding react/jsx-runtime,
     // which is not compatible when bundling apps using React 17
-    return React.createElement(WagmiConfig, { config: config }, React.createElement(SyncDynamicWagmi, { connector, wallets }, children));
+    return React.createElement(WagmiConfig, { config: config }, React.createElement(SyncDynamicWagmi, { connector, preventWagmiSyncFromCallingLogout, wallets }, children));
 };
 
 export { DynamicWagmiConnector };

package/src/lib/SyncDynamicWagmi.d.ts

@@ -1,10 +1,11 @@
-import React from 'react';
+import React, { MutableRefObject } from 'react';
 import { Wallet } from '@dynamic-labs/sdk-react-core';
 import { Connector } from './Connector';
 export type SyncDynamicWagmiProps = React.PropsWithChildren<{
     connector: Connector | undefined;
     wallets: Wallet[];
+    preventWagmiSyncFromCallingLogout: MutableRefObject<boolean>;
 }>;
-export declare const SyncDynamicWagmi: ({ children, connector, wallets, }: SyncDynamicWagmiProps) => React.FunctionComponentElement<{
+export declare const SyncDynamicWagmi: ({ children, connector, wallets, preventWagmiSyncFromCallingLogout, }: SyncDynamicWagmiProps) => React.FunctionComponentElement<{
     children?: React.ReactNode;
 }>;

package/src/lib/SyncDynamicWagmi.js

@@ -2,7 +2,7 @@ import React, { useRef, useEffect } from 'react';
 import { useConfig, useConnect, useDisconnect } from 'wagmi';
 import { useDynamicContext } from '@dynamic-labs/sdk-react-core';
 
-const SyncDynamicWagmi = ({ children, connector, wallets, }) => {
+const SyncDynamicWagmi = ({ children, connector, wallets, preventWagmiSyncFromCallingLogout, }) => {
     const { status: clientStatus } = useConfig();
     const { connect } = useConnect();
     const { disconnect } = useDisconnect();
@@ -21,6 +21,11 @@ const SyncDynamicWagmi = ({ children, connector, wallets, }) => {
              * layouts
              */
             if (isConnected) {
+                /**
+                 * This will prevent the Connector from calling handleLogOut when we are the ones calling disconnect,
+                 * but will preserve the existing behavior for customers who use useDisconnect directly.
+                 */
+                preventWagmiSyncFromCallingLogout.current = true;
                 disconnect();
                 lastConnectedConnectorId.current = undefined;
             }
@@ -42,6 +47,7 @@ const SyncDynamicWagmi = ({ children, connector, wallets, }) => {
         connector,
         disconnect,
         lastConnectedConnectorId,
+        preventWagmiSyncFromCallingLogout,
         walletConnector,
         wallets,
     ]);