@dynamic-labs/wallet-connector-core 3.0.0-alpha.8 → 3.0.0

package/src/lib/WalletConnector.d.ts

@@ -2,9 +2,11 @@ import EventEmitter from 'eventemitter3';
 import { WalletBookSchema, WalletSchema } from '@dynamic-labs/wallet-book';
 import type { JwtVerifiedCredential, WalletAdditionalAddress } from '@dynamic-labs/sdk-api-core';
 import { IChainRpcProviders } from '@dynamic-labs/rpc-providers';
+import { MobileExperience } from '@dynamic-labs/types';
 import { WalletBookSingleton } from './WalletBookSingleton';
 import { WalletConnectorExtension } from './WalletConnectorExtension';
 import { WalletConnectorCore } from './types';
+import { WalletConstructor, WalletProps } from './wallets';
 export declare const Chains: readonly ["ETH", "FLOW", "SOL", "EVM", "ALGO", "STARK", "ATOM", "COSMOS", "BTC"];
 export type Chain = typeof Chains[number];
 export declare const socialProviders: readonly ["google", "facebook", "apple", "github", "bitbucket", "gitlab", "linkedin", "twitter", "discord", "twitch", "microsoft"];
@@ -32,9 +34,10 @@ declare module './types' {
         }
     }
 }
-export type WalletConnector = WalletConnectorCore.WalletConnector;
+export type InternalWalletConnector = WalletConnectorCore.WalletConnector;
+export type WalletConnector = Pick<InternalWalletConnector, 'canConnectViaCustodialService' | 'canConnectViaQrCode' | 'canConnectViaSocial' | 'chainRpcProviders' | 'connect' | 'connectedChain' | 'createWallet' | 'constructorProps' | 'endSession' | 'getAddress' | 'getAdditionalAddresses' | 'getConnectedAccounts' | 'getDeepLink' | 'getMobileOrInstalledWallet' | 'getNetwork' | 'getSession' | 'initEventListener' | 'isAvailable' | 'isEmbeddedWallet' | 'isInitialized' | 'isInstalledOnBrowser' | 'isTestnet' | 'isWalletConnect' | 'key' | 'name' | 'parseAddress' | 'proveOwnership' | 'providerResources' | 'supportedChains' | 'supportsNetworkSwitching' | 'switchNetwork' | 'switchNetworkOnlyFromWallet' | 'teardownEventListeners'> & EventEmitter<WalletConnectorEventTypes>;
 export interface WalletConnectorConstructor {
-    new (props?: any): WalletConnector;
+    new (props?: any): InternalWalletConnector;
 }
 export type WalletConnectorsMethod = (props?: any) => WalletConnectorConstructor[];
 export type WalletConnectorEventTypes = {
@@ -46,12 +49,15 @@ export type WalletConnectorEventTypes = {
     }) => void;
     disconnect: () => void;
 };
-export declare abstract class WalletConnectorBase extends EventEmitter<WalletConnectorEventTypes> {
+export declare abstract class WalletConnectorBase<C extends WalletConstructor<any> = WalletConstructor<any>> extends EventEmitter<WalletConnectorEventTypes> {
     #private;
+    abstract ChainWallet: C;
+    createWallet(props: WalletProps<InternalWalletConnector>): import("./wallets").Wallet<any>;
     chainRpcProviders: IChainRpcProviders | undefined;
     constructorProps: any;
     _walletBookInstance: WalletBookSingleton;
     walletFallback: WalletSchema | undefined;
+    isGlobalTransaction: boolean;
     /**
      * We store the constructor props so that we can use them later on
      * in getMobileOrInstalledWallet which may fall back to a different class
@@ -70,6 +76,7 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
     initEventListener(): void;
     get walletBook(): WalletBookSchema;
     filter(): boolean;
+    get mobileExperience(): MobileExperience | undefined;
     /**
      * This flag corresponds to whether this wallet connector also requires its own email otp outside dynamic
      * @default false
@@ -92,6 +99,11 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      * @default false
      */
     canConnectViaSocial: boolean;
+    /**
+     * Prompt the user to choose accounts to connect (see behavior in MM)
+     * @default Promise<[]>
+     */
+    chooseAccountsToConnect(): Promise<string[]>;
     /**
      * Connect to the wallet or custodial service
      *
@@ -152,7 +164,7 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      *
      * @default Promise<undefined>
      */
-    getBalance(): Promise<string | undefined>;
+    getBalance(address: string): Promise<string | undefined>;
     /**
      * Get the address silently
      *
@@ -176,7 +188,7 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      *
      * @default Promise<undefined>
      */
-    getNameService(): Promise<NameServiceData | undefined>;
+    getNameService(address: string): Promise<NameServiceData | undefined>;
     /**
      * Get the RPC provider for the wallet
      *
@@ -184,28 +196,6 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      */
     getPublicClient(): Promise<unknown>;
     getPublicClient<T>(): Promise<T>;
-    /**
-     * @deprecated getWeb3Provider has been renamed to getWalletClient
-     * If you would like to still get the ethers web3Provider,
-     *  see our docs for enabling ethers: https://docs.dynamic.xyz/ethers
-     *
-     * Get the wallet provider
-     */
-    getWeb3Provider: {
-        (chainId?: string): unknown;
-        <T>(chainId?: string): T;
-    };
-    /**
-     * @deprecated getRpcProvider has been renamed to getPublicClient
-     * If you would like to still get the ethers rpcProvider,
-     *  see our docs for enabling ethers: https://docs.dynamic.xyz/ethers
-     *
-     * Get the rpc provider
-     */
-    getRpcProvider: {
-        (): Promise<unknown>;
-        <T>(): Promise<T>;
-    };
     /**
      * Get the session for the wallet
      * @default Promise<undefined>
@@ -275,13 +265,13 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      * @returns WalletConnector
      * @default this
      */
-    getMobileOrInstalledWallet(): WalletConnector;
+    getMobileOrInstalledWallet(): InternalWalletConnector;
     /**
      * In most cases this is an alias for `signMessage`
      *
      * @default Promise<undefined>
      */
-    proveOwnership(messageToSign: string): Promise<string | undefined>;
+    proveOwnership(address: string, messageToSign: string): Promise<string | undefined>;
     /**
      * Additional resources to add to the message to be signed
      *
@@ -299,7 +289,7 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      *
      * @default Promise<undefined>
      */
-    signMessage(messageToSign: string): Promise<string | undefined>;
+    signMessage(messageToSign: string, withAddress?: string): Promise<string | undefined>;
     /**
      * List of supported chains for this wallet
      */
@@ -337,4 +327,31 @@ export declare abstract class WalletConnectorBase extends EventEmitter<WalletCon
      * Receive the user verified credentials
      */
     setVerifiedCredentials(verifiedCredentials: JwtVerifiedCredential[]): void;
+    /**
+     * Whether the wallet allow for getting the address in the
+     * current chain.
+     * This is used for multi chain wallets.
+     * @default true
+     */
+    canGetChainAddress(): boolean;
+    /**
+     * Prompts the user to make expected wallet active
+     *
+     * @throws {WalletAddressMismatchError} If the active address does not match the expected address.
+     * @returns {Promise<void>} A promise that resolves when the active address matches the expected address,
+     * otherwise rejects with an error.
+     */
+    handleWalletNotActive({ activeAddress, expectedAddress, reconnectedAddress, }: {
+        expectedAddress: string;
+        activeAddress?: string;
+        reconnectedAddress?: string;
+    }): Promise<void>;
+    /**
+     * Validates if the address is connected and active in the wallet app
+     *
+     * @throws {WalletAddressMismatchError} If the active address does not match the expected address.
+     * @returns {Promise<void>} A promise that resolves if the active address matches the expected address,
+     * otherwise rejects with an error.
+     */
+    validateActiveWallet(expectedAddress: string): Promise<void>;
 }

package/src/lib/WalletConnector.js

@@ -2,6 +2,11 @@
 import { __classPrivateFieldGet, __awaiter } from '../../_virtual/_tslib.js';
 import EventEmitter from 'eventemitter3';
 import { getWalletBookWallet } from '@dynamic-labs/wallet-book';
+import { WalletAddressMismatchError } from '@dynamic-labs/utils';
+import { logger } from '../utils/logger.js';
+import { isSameAddress } from '../utils/isSameAddress/isSameAddress.js';
+import { getMobileExperience } from '../utils/getMobileExperience/getMobileExperience.js';
+import { isConnectorMethodSupported } from '../utils/isConnectorMethodSupported/isConnectorMethodSupported.js';
 import { WalletBookSingleton } from './WalletBookSingleton.js';
 
 /* eslint-disable @typescript-eslint/triple-slash-reference */
@@ -35,6 +40,10 @@ const socialProviders = [
     'microsoft',
 ];
 class WalletConnectorBase extends EventEmitter {
+    createWallet(props) {
+        const wallet = new this.ChainWallet(props);
+        return wallet;
+    }
     /**
      * We store the constructor props so that we can use them later on
      * in getMobileOrInstalledWallet which may fall back to a different class
@@ -44,6 +53,7 @@ class WalletConnectorBase extends EventEmitter {
     constructor(props) {
         super();
         this.chainRpcProviders = undefined;
+        this.isGlobalTransaction = false;
         _WalletConnectorBase_registeredExtensions.set(this, []);
         this.didSetup = false;
         /**
@@ -68,22 +78,6 @@ class WalletConnectorBase extends EventEmitter {
          * @default false
          */
         this.canConnectViaSocial = false;
-        /**
-         * @deprecated getWeb3Provider has been renamed to getWalletClient
-         * If you would like to still get the ethers web3Provider,
-         *  see our docs for enabling ethers: https://docs.dynamic.xyz/ethers
-         *
-         * Get the wallet provider
-         */
-        this.getWeb3Provider = this.getWalletClient;
-        /**
-         * @deprecated getRpcProvider has been renamed to getPublicClient
-         * If you would like to still get the ethers rpcProvider,
-         *  see our docs for enabling ethers: https://docs.dynamic.xyz/ethers
-         *
-         * Get the rpc provider
-         */
-        this.getRpcProvider = this.getPublicClient;
         /**
          * Flag if connector/provider is available
          *
@@ -132,6 +126,11 @@ class WalletConnectorBase extends EventEmitter {
         if (__classPrivateFieldGet(this, _WalletConnectorBase_registeredExtensions, "f").includes(extension.name)) {
             throw new Error(`You can only register a single extension of: ${extension.name}`);
         }
+        if (extension.name === 'global-wallet-extension') {
+            // only allow global wallet extension for evm embedded wallets
+            if (!this.isEmbeddedWallet || !this.supportedChains.includes('EVM'))
+                return;
+        }
         __classPrivateFieldGet(this, _WalletConnectorBase_registeredExtensions, "f").push(extension.name);
         extension.extend(this);
     }
@@ -157,6 +156,20 @@ class WalletConnectorBase extends EventEmitter {
             return false;
         }
     }
+    get mobileExperience() {
+        return getMobileExperience({
+            mobileExperienceProp: this.constructorProps.mobileExperience,
+            walletBook: this.walletBook,
+            walletKey: this.key,
+        });
+    }
+    /**
+     * Prompt the user to choose accounts to connect (see behavior in MM)
+     * @default Promise<[]>
+     */
+    chooseAccountsToConnect() {
+        return Promise.resolve([]);
+    }
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.getAddress();
@@ -220,7 +233,7 @@ class WalletConnectorBase extends EventEmitter {
      *
      * @default Promise<undefined>
      */
-    getBalance() {
+    getBalance(address) {
         return Promise.resolve(undefined);
     }
     /**
@@ -247,7 +260,7 @@ class WalletConnectorBase extends EventEmitter {
      *
      * @default Promise<undefined>
      */
-    getNameService() {
+    getNameService(address) {
         return Promise.resolve(undefined);
     }
     getPublicClient() {
@@ -301,8 +314,11 @@ class WalletConnectorBase extends EventEmitter {
      *
      * @default Promise<undefined>
      */
-    proveOwnership(messageToSign) {
-        return this.signMessage(messageToSign);
+    proveOwnership(address, messageToSign) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.validateActiveWallet(address);
+            return this.signMessage(messageToSign);
+        });
     }
     /**
      * Set up event listeners for the wallet
@@ -317,7 +333,7 @@ class WalletConnectorBase extends EventEmitter {
      *
      * @default Promise<undefined>
      */
-    signMessage(messageToSign) {
+    signMessage(messageToSign, withAddress) {
         return Promise.resolve(undefined);
     }
     /**
@@ -344,6 +360,93 @@ class WalletConnectorBase extends EventEmitter {
     setVerifiedCredentials(verifiedCredentials) {
         return;
     }
+    /**
+     * Whether the wallet allow for getting the address in the
+     * current chain.
+     * This is used for multi chain wallets.
+     * @default true
+     */
+    canGetChainAddress() {
+        return true;
+    }
+    /**
+     * Prompts the user to make expected wallet active
+     *
+     * @throws {WalletAddressMismatchError} If the active address does not match the expected address.
+     * @returns {Promise<void>} A promise that resolves when the active address matches the expected address,
+     * otherwise rejects with an error.
+     */
+    handleWalletNotActive(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ activeAddress, expectedAddress, reconnectedAddress, }) {
+            logger.debug('validateActiveWallet - wallet is not active', {
+                activeAddress,
+                expectedAddress,
+                reconnectedAddress,
+            });
+            const currentActiveAddress = activeAddress || reconnectedAddress || '';
+            const walletUiUtils = this.constructorProps
+                .walletUiUtils;
+            if (!walletUiUtils) {
+                throw new WalletAddressMismatchError(`Wallet ${expectedAddress !== null && expectedAddress !== void 0 ? expectedAddress : ''} is not currently active in ${this.name || this.key}.`, {
+                    activeAddress: currentActiveAddress,
+                    expectedAddress,
+                    walletName: this.name || this.key,
+                });
+            }
+            return walletUiUtils.syncWallet({
+                activeAddress: currentActiveAddress,
+                expectedAddress,
+                walletConnector: this,
+            });
+        });
+    }
+    /**
+     * Validates if the address is connected and active in the wallet app
+     *
+     * @throws {WalletAddressMismatchError} If the active address does not match the expected address.
+     * @returns {Promise<void>} A promise that resolves if the active address matches the expected address,
+     * otherwise rejects with an error.
+     */
+    validateActiveWallet(expectedAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.debug('validateActiveWallet - validating wallet', expectedAddress);
+            const canFetchConnectedAccounts = isConnectorMethodSupported(this, 'getConnectedAccounts', 'browserExtension');
+            logger.debug('validateActiveWallet - getting connected accounts', {
+                canFetchConnectedAccounts,
+            });
+            const [activeAddress] = canFetchConnectedAccounts
+                ? yield this.getConnectedAccounts()
+                : [];
+            const isWalletActive = activeAddress &&
+                isSameAddress(activeAddress, expectedAddress, this.connectedChain);
+            if (isWalletActive) {
+                logger.debug('validateActiveWallet - wallet is active');
+                return;
+            }
+            logger.debug('validateActiveWallet - trying to reconnect wallet...');
+            const getReconnectedAddress = () => __awaiter(this, void 0, void 0, function* () {
+                if (this.isWalletConnect || !this.canGetChainAddress()) {
+                    return undefined;
+                }
+                return this.getAddress().catch((err) => {
+                    logger.debug('validateActiveWallet - error getting address', err);
+                    return undefined;
+                });
+            });
+            //  not possible to auto-reconnect walletconnect
+            const reconnectedAddress = yield getReconnectedAddress();
+            if (reconnectedAddress &&
+                isSameAddress(reconnectedAddress, expectedAddress, this.connectedChain)) {
+                logger.debug('validateActiveWallet - wallet reconnected successfuly');
+                return;
+            }
+            return this.handleWalletNotActive({
+                activeAddress,
+                expectedAddress,
+                reconnectedAddress,
+            });
+        });
+    }
 }
 _WalletConnectorBase_registeredExtensions = new WeakMap();
 

package/src/lib/WalletConnectorExtension.d.ts

@@ -1,5 +1,5 @@
-import { WalletConnector } from '.';
+import { InternalWalletConnector } from '.';
 export interface WalletConnectorExtension {
-    extend(connector: WalletConnector): void;
+    extend(connector: InternalWalletConnector): void;
     name: string;
 }

package/src/lib/index.d.ts

@@ -3,7 +3,8 @@ export * from './IEmailWalletConnector';
 export * from './WalletConnector';
 export * from './types';
 export * from './IPasskeyWalletConnector';
-export * from './SmartWalletConnector';
+export * from './ITurnkeyWalletConnector';
+export * from './ITurnkeyWalletConnectorStamper';
 export * from './IAccountAbstractionWalletConnector';
 export * from './IBitcoinWalletConnector';
 export * from './IHardwareWalletConnector';
@@ -13,3 +14,4 @@ export * from './IWalletConnectConnector';
 export * from './ISendBalanceWalletConnector';
 export * from './ISessionKeyCompatibleWalletConnector';
 export * from './ISMSWalletConnector';
+export * from './wallets';

package/src/lib/wallets/Wallet/Wallet.cjs

@@ -0,0 +1,119 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../../../_virtual/_tslib.cjs');
+var types = require('@dynamic-labs/types');
+var logger = require('../../../utils/logger.cjs');
+var normalizeAddress = require('../../../utils/isSameAddress/utils/normalizeAddress/normalizeAddress.cjs');
+require('@dynamic-labs/utils');
+require('@dynamic-labs/wallet-book');
+
+class Wallet extends types.BaseWallet {
+    constructor(_a) {
+        var { connector } = _a, props = _tslib.__rest(_a, ["connector"]);
+        super(props);
+        this._connector = connector;
+    }
+    /**
+     * Gets the wallet connector.
+     */
+    get connector() {
+        return this._connector;
+    }
+    /**
+     * Retrieves the balance of the wallet.
+     * @returns A promise that resolves to the balance of the wallet as a string,
+     * or undefined if the balance cannot be retrieved.
+     */
+    getBalance() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return this._connector.getBalance(this.address);
+        });
+    }
+    /**
+     * Retrieves the name service data associated with the wallet.
+     * @returns A promise that resolves to the name service data of the wallet,
+     * or undefined if the data cannot be retrieved.
+     */
+    getNameService() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return this._connector.getNameService(this.address);
+        });
+    }
+    /**
+     * Retrieves the network that the wallet is connected to.
+     * @returns A promise that resolves to the network value as a string or number,
+     * or undefined if the network cannot be retrieved.
+     */
+    getNetwork() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return this._connector.getNetwork();
+        });
+    }
+    /**
+     * If the wallet is connected.
+     * @returns A promise that resolves to true the wallet is connected or false if it's not connected.
+     */
+    isConnected() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const connectedAccounts = yield this._connector.getConnectedAccounts();
+                return connectedAccounts
+                    .map((address) => normalizeAddress.normalizeAddress(address, this.chain))
+                    .includes(normalizeAddress.normalizeAddress(this.address, this.chain));
+            }
+            catch (error) {
+                logger.logger.error('[Wallet] isConnected - Error detecting if wallet is connected', error);
+                return false;
+            }
+        });
+    }
+    /**
+     * Proves ownership of the wallet by signing a message.
+     * @param messageToSign - The message to sign.
+     * @returns A promise that resolves to the signature of the message as a string,
+     *  or undefined if the message cannot be signed.
+     */
+    proveOwnership(messageToSign) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return this._connector.proveOwnership(this.address, messageToSign);
+        });
+    }
+    /**
+     * Signs a message using the wallet.
+     * @param messageToSign - The message to sign.
+     * @returns A promise that resolves to the signature of the message as a string,
+     * or undefined if the message cannot be signed.
+     */
+    signMessage(messageToSign) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            yield this.sync();
+            return this._connector.signMessage(messageToSign, this.address);
+        });
+    }
+    /**
+     * Switches the network that the wallet is connected to.
+     * @param networkChainId - The chain id of the network to switch to.
+     * @returns A promise that resolves when the network is switched.
+     */
+    switchNetwork(networkChainId) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return this._connector.switchNetwork({
+                networkChainId,
+            });
+        });
+    }
+    /**
+     * Synchronizes the wallet with the connector.
+     * @returns A promise that resolves when the wallet is connected and active.
+     */
+    sync() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            return this._connector.validateActiveWallet(this.address);
+        });
+    }
+}
+
+exports.Wallet = Wallet;

package/src/lib/wallets/Wallet/Wallet.d.ts

@@ -0,0 +1,65 @@
+import type { BaseWalletProps } from '@dynamic-labs/types';
+import { BaseWallet } from '@dynamic-labs/types';
+import { WalletConnector, NameServiceData, InternalWalletConnector } from '../../';
+export type WalletProps<T extends InternalWalletConnector = InternalWalletConnector> = BaseWalletProps & {
+    connector: T;
+};
+export declare class Wallet<T extends InternalWalletConnector = InternalWalletConnector> extends BaseWallet {
+    protected _connector: T;
+    constructor({ connector, ...props }: WalletProps<T>);
+    /**
+     * Gets the wallet connector.
+     */
+    get connector(): WalletConnector;
+    /**
+     * Retrieves the balance of the wallet.
+     * @returns A promise that resolves to the balance of the wallet as a string,
+     * or undefined if the balance cannot be retrieved.
+     */
+    getBalance(): Promise<string | undefined>;
+    /**
+     * Retrieves the name service data associated with the wallet.
+     * @returns A promise that resolves to the name service data of the wallet,
+     * or undefined if the data cannot be retrieved.
+     */
+    getNameService(): Promise<NameServiceData | undefined>;
+    /**
+     * Retrieves the network that the wallet is connected to.
+     * @returns A promise that resolves to the network value as a string or number,
+     * or undefined if the network cannot be retrieved.
+     */
+    getNetwork(): Promise<string | number | undefined>;
+    /**
+     * If the wallet is connected.
+     * @returns A promise that resolves to true the wallet is connected or false if it's not connected.
+     */
+    isConnected(): Promise<boolean>;
+    /**
+     * Proves ownership of the wallet by signing a message.
+     * @param messageToSign - The message to sign.
+     * @returns A promise that resolves to the signature of the message as a string,
+     *  or undefined if the message cannot be signed.
+     */
+    proveOwnership(messageToSign: string): Promise<string | undefined>;
+    /**
+     * Signs a message using the wallet.
+     * @param messageToSign - The message to sign.
+     * @returns A promise that resolves to the signature of the message as a string,
+     * or undefined if the message cannot be signed.
+     */
+    signMessage(messageToSign: string): Promise<string | undefined>;
+    /**
+     * Switches the network that the wallet is connected to.
+     * @param networkChainId - The chain id of the network to switch to.
+     * @returns A promise that resolves when the network is switched.
+     */
+    switchNetwork(networkChainId: number | string): Promise<void>;
+    /**
+     * Synchronizes the wallet with the connector.
+     * @returns A promise that resolves when the wallet is connected and active.
+     */
+    sync(): Promise<void>;
+}
+export interface WalletConstructor<T extends InternalWalletConnector> {
+    new (props: WalletProps<T>): Wallet<T>;
+}