@dynamic-labs/ethereum 2.0.0-alpha.1 → 2.0.0-alpha.10

package/src/walletConnect/walletConnect.d.ts

@@ -1,52 +1,333 @@
-import Client from '@walletconnect/client';
+import type { SessionTypes } from '@walletconnect/types';
 import { Hex, WalletClient } from 'viem';
-import { Chain, FetchPublicAddressOpts, DeepLinkVariant } from '@dynamic-labs/wallet-connector-core';
 import { EvmNetwork } from '@dynamic-labs/types';
+import { Chain, DeepLinkVariant, FetchPublicAddressOpts, IWalletConnectConnector } from '@dynamic-labs/wallet-connector-core';
 import { EthWalletConnector, EthWalletConnectorOpts } from '../EthWalletConnector';
-type ConnectorSession = {
-    connected: boolean;
-    accounts: string[];
-    chainId: number;
-    bridge: string;
-    key: string;
-    clientId: string;
-    clientMeta: any;
-    peerId: string;
-    peerMeta: any;
-    handshakeId: number;
-    handshakeTopic: string;
-};
 export type WalletConnectOpts = EthWalletConnectorOpts & {
-    walletConnectV1Bridge: string;
+    projectId?: string;
     walletName: string;
     deepLinkPreference?: DeepLinkVariant;
+    walletConnectPreferredChains?: `eip155:${number}`[];
 };
-export declare class WalletConnect extends EthWalletConnector {
+export declare class WalletConnect extends EthWalletConnector implements IWalletConnectConnector {
     supportedChains: Chain[];
     connectedChain: Chain;
     name: string;
-    bridge: string;
+    session: SessionTypes.Struct | undefined;
+    activeAccount: Hex | undefined;
+    isInitialized: boolean;
+    initializePromise: Promise<void> | undefined;
     canConnectViaQrCode: boolean;
     isWalletConnect: boolean;
-    switchNetworkOnlyFromWallet: boolean;
+    private static provider;
+    private projectId?;
     private deepLinkPreference;
-    client?: Client;
-    clientOptions?: any;
-    constructor({ walletConnectV1Bridge, walletName, ...props }: WalletConnectOpts);
-    getClient(): Client;
+    private preferredChains;
+    private _currentChainId;
+    private _hasSwitchedNetwork;
+    constructor(opts: WalletConnectOpts);
+    private getMappedChains;
+    private getMappedChainsByPreferredOrder;
+    private initConnection;
+    private createInitProviderPromise;
+    private initProvider;
+    private refreshSession;
+    init(): Promise<void>;
+    get sessionTopicKey(): string;
+    get activeAccountKey(): string;
+    get swicthedNetworkKey(): string;
+    get currentChainKey(): string;
+    private set currentChainId(value);
+    private get currentChainId();
+    private set hasSwitchedNetwork(value);
+    private get hasSwitchedNetwork();
     supportsNetworkSwitching(): boolean;
     setupEventListeners(): void;
     teardownEventListeners(): void;
-    getWalletClient(): WalletClient | undefined;
+    getWalletClient(): {
+        account: undefined;
+        batch?: {
+            multicall?: boolean | {
+                batchSize?: number | undefined;
+                wait?: number | undefined;
+            } | undefined;
+        } | undefined;
+        cacheTime: number;
+        chain: undefined;
+        key: string;
+        name: string;
+        pollingInterval: number;
+        request: import("viem").EIP1193RequestFn<import("viem").WalletRpcSchema>;
+        transport: import("viem").TransportConfig<"custom", import("viem").EIP1193RequestFn>;
+        type: string;
+        uid: string;
+        addChain: (args: import("viem").AddChainParameters) => Promise<void>;
+        deployContract: <const abi extends import("viem").Abi | readonly unknown[], chainOverride extends import("viem").Chain | undefined>(args: import("viem").DeployContractParameters<abi, undefined, undefined, chainOverride>) => Promise<`0x${string}`>;
+        getAddresses: () => Promise<import("viem").GetAddressesReturnType>;
+        getChainId: () => Promise<number>;
+        getPermissions: () => Promise<import("viem").GetPermissionsReturnType>;
+        prepareTransactionRequest: <TParameterType extends import("viem").PrepareTransactionRequestParameterType, TChainOverride extends import("viem").Chain | undefined = undefined, TAccountOverride extends `0x${string}` | import("viem").Account | undefined = undefined>(args: import("viem").PrepareTransactionRequestParameters<undefined, undefined, TChainOverride, TAccountOverride, TParameterType>) => Promise<import("viem").PrepareTransactionRequestReturnType<import("viem").Chain, undefined, TChainOverride, TAccountOverride, TParameterType>>;
+        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").SendRawTransactionParameters) => Promise<`0x${string}`>;
+        sendTransaction: <TChainOverride_1 extends import("viem").Chain | undefined = undefined>(args: import("viem").SendTransactionParameters<undefined, undefined, TChainOverride_1>) => Promise<`0x${string}`>;
+        signMessage: (args: import("viem").SignMessageParameters<undefined>) => Promise<`0x${string}`>;
+        signTransaction: <TChainOverride_2 extends import("viem").Chain | undefined>(args: import("viem").SignTransactionParameters<undefined, undefined, TChainOverride_2>) => Promise<`0x${string}`>;
+        signTypedData: <const TTypedData extends {
+            [x: string]: readonly import("viem").TypedDataParameter[];
+            [x: `string[${string}]`]: undefined;
+            [x: `function[${string}]`]: undefined;
+            [x: `address[${string}]`]: undefined;
+            [x: `bool[${string}]`]: undefined;
+            [x: `bytes[${string}]`]: undefined;
+            [x: `bytes16[${string}]`]: undefined;
+            [x: `bytes1[${string}]`]: undefined;
+            [x: `bytes2[${string}]`]: undefined;
+            [x: `bytes3[${string}]`]: undefined;
+            [x: `bytes4[${string}]`]: undefined;
+            [x: `bytes5[${string}]`]: undefined;
+            [x: `bytes6[${string}]`]: undefined;
+            [x: `bytes7[${string}]`]: undefined;
+            [x: `bytes8[${string}]`]: undefined;
+            [x: `bytes9[${string}]`]: undefined;
+            [x: `bytes10[${string}]`]: undefined;
+            [x: `bytes11[${string}]`]: undefined;
+            [x: `bytes12[${string}]`]: undefined;
+            [x: `bytes13[${string}]`]: undefined;
+            [x: `bytes14[${string}]`]: undefined;
+            [x: `bytes15[${string}]`]: undefined;
+            [x: `bytes17[${string}]`]: undefined;
+            [x: `bytes18[${string}]`]: undefined;
+            [x: `bytes19[${string}]`]: undefined;
+            [x: `bytes20[${string}]`]: undefined;
+            [x: `bytes21[${string}]`]: undefined;
+            [x: `bytes22[${string}]`]: undefined;
+            [x: `bytes23[${string}]`]: undefined;
+            [x: `bytes24[${string}]`]: undefined;
+            [x: `bytes25[${string}]`]: undefined;
+            [x: `bytes26[${string}]`]: undefined;
+            [x: `bytes27[${string}]`]: undefined;
+            [x: `bytes28[${string}]`]: undefined;
+            [x: `bytes29[${string}]`]: undefined;
+            [x: `bytes30[${string}]`]: undefined;
+            [x: `bytes31[${string}]`]: undefined;
+            [x: `bytes32[${string}]`]: undefined;
+            [x: `int[${string}]`]: undefined;
+            [x: `int16[${string}]`]: undefined;
+            [x: `int8[${string}]`]: undefined;
+            [x: `int24[${string}]`]: undefined;
+            [x: `int32[${string}]`]: undefined;
+            [x: `int40[${string}]`]: undefined;
+            [x: `int48[${string}]`]: undefined;
+            [x: `int56[${string}]`]: undefined;
+            [x: `int64[${string}]`]: undefined;
+            [x: `int72[${string}]`]: undefined;
+            [x: `int80[${string}]`]: undefined;
+            [x: `int88[${string}]`]: undefined;
+            [x: `int96[${string}]`]: undefined;
+            [x: `int104[${string}]`]: undefined;
+            [x: `int112[${string}]`]: undefined;
+            [x: `int120[${string}]`]: undefined;
+            [x: `int128[${string}]`]: undefined;
+            [x: `int136[${string}]`]: undefined;
+            [x: `int144[${string}]`]: undefined;
+            [x: `int152[${string}]`]: undefined;
+            [x: `int160[${string}]`]: undefined;
+            [x: `int168[${string}]`]: undefined;
+            [x: `int176[${string}]`]: undefined;
+            [x: `int184[${string}]`]: undefined;
+            [x: `int192[${string}]`]: undefined;
+            [x: `int200[${string}]`]: undefined;
+            [x: `int208[${string}]`]: undefined;
+            [x: `int216[${string}]`]: undefined;
+            [x: `int224[${string}]`]: undefined;
+            [x: `int232[${string}]`]: undefined;
+            [x: `int240[${string}]`]: undefined;
+            [x: `int248[${string}]`]: undefined;
+            [x: `int256[${string}]`]: undefined;
+            [x: `uint[${string}]`]: undefined;
+            [x: `uint16[${string}]`]: undefined;
+            [x: `uint8[${string}]`]: undefined;
+            [x: `uint24[${string}]`]: undefined;
+            [x: `uint32[${string}]`]: undefined;
+            [x: `uint40[${string}]`]: undefined;
+            [x: `uint48[${string}]`]: undefined;
+            [x: `uint56[${string}]`]: undefined;
+            [x: `uint64[${string}]`]: undefined;
+            [x: `uint72[${string}]`]: undefined;
+            [x: `uint80[${string}]`]: undefined;
+            [x: `uint88[${string}]`]: undefined;
+            [x: `uint96[${string}]`]: undefined;
+            [x: `uint104[${string}]`]: undefined;
+            [x: `uint112[${string}]`]: undefined;
+            [x: `uint120[${string}]`]: undefined;
+            [x: `uint128[${string}]`]: undefined;
+            [x: `uint136[${string}]`]: undefined;
+            [x: `uint144[${string}]`]: undefined;
+            [x: `uint152[${string}]`]: undefined;
+            [x: `uint160[${string}]`]: undefined;
+            [x: `uint168[${string}]`]: undefined;
+            [x: `uint176[${string}]`]: undefined;
+            [x: `uint184[${string}]`]: undefined;
+            [x: `uint192[${string}]`]: undefined;
+            [x: `uint200[${string}]`]: undefined;
+            [x: `uint208[${string}]`]: undefined;
+            [x: `uint216[${string}]`]: undefined;
+            [x: `uint224[${string}]`]: undefined;
+            [x: `uint232[${string}]`]: undefined;
+            [x: `uint240[${string}]`]: undefined;
+            [x: `uint248[${string}]`]: undefined;
+            [x: `uint256[${string}]`]: undefined;
+            string?: undefined;
+            address?: undefined;
+            bool?: undefined;
+            bytes?: undefined;
+            bytes16?: undefined;
+            bytes1?: undefined;
+            bytes2?: undefined;
+            bytes3?: undefined;
+            bytes4?: undefined;
+            bytes5?: undefined;
+            bytes6?: undefined;
+            bytes7?: undefined;
+            bytes8?: undefined;
+            bytes9?: undefined;
+            bytes10?: undefined;
+            bytes11?: undefined;
+            bytes12?: undefined;
+            bytes13?: undefined;
+            bytes14?: undefined;
+            bytes15?: undefined;
+            bytes17?: undefined;
+            bytes18?: undefined;
+            bytes19?: undefined;
+            bytes20?: undefined;
+            bytes21?: undefined;
+            bytes22?: undefined;
+            bytes23?: undefined;
+            bytes24?: undefined;
+            bytes25?: undefined;
+            bytes26?: undefined;
+            bytes27?: undefined;
+            bytes28?: undefined;
+            bytes29?: undefined;
+            bytes30?: undefined;
+            bytes31?: undefined;
+            bytes32?: undefined;
+            int16?: undefined;
+            int8?: undefined;
+            int24?: undefined;
+            int32?: undefined;
+            int40?: undefined;
+            int48?: undefined;
+            int56?: undefined;
+            int64?: undefined;
+            int72?: undefined;
+            int80?: undefined;
+            int88?: undefined;
+            int96?: undefined;
+            int104?: undefined;
+            int112?: undefined;
+            int120?: undefined;
+            int128?: undefined;
+            int136?: undefined;
+            int144?: undefined;
+            int152?: undefined;
+            int160?: undefined;
+            int168?: undefined;
+            int176?: undefined;
+            int184?: undefined;
+            int192?: undefined;
+            int200?: undefined;
+            int208?: undefined;
+            int216?: undefined;
+            int224?: undefined;
+            int232?: undefined;
+            int240?: undefined;
+            int248?: undefined;
+            int256?: undefined;
+            uint16?: undefined;
+            uint8?: undefined;
+            uint24?: undefined;
+            uint32?: undefined;
+            uint40?: undefined;
+            uint48?: undefined;
+            uint56?: undefined;
+            uint64?: undefined;
+            uint72?: undefined;
+            uint80?: undefined;
+            uint88?: undefined;
+            uint96?: undefined;
+            uint104?: undefined;
+            uint112?: undefined;
+            uint120?: undefined;
+            uint128?: undefined;
+            uint136?: undefined;
+            uint144?: undefined;
+            uint152?: undefined;
+            uint160?: undefined;
+            uint168?: undefined;
+            uint176?: undefined;
+            uint184?: undefined;
+            uint192?: undefined;
+            uint200?: undefined;
+            uint208?: undefined;
+            uint216?: undefined;
+            uint224?: undefined;
+            uint232?: undefined;
+            uint240?: undefined;
+            uint248?: undefined;
+            uint256?: undefined;
+        } | {
+            [key: string]: unknown;
+        }, TPrimaryType extends string>(args: import("viem").SignTypedDataParameters<TTypedData, TPrimaryType, undefined>) => Promise<`0x${string}`>;
+        switchChain: (args: import("viem").SwitchChainParameters) => Promise<void>;
+        watchAsset: (args: import("viem").WatchAssetParams) => Promise<boolean>;
+        writeContract: <const abi_1 extends import("viem").Abi | readonly unknown[], functionName extends import("viem").ContractFunctionName<abi_1, "nonpayable" | "payable">, args extends import("viem").ContractFunctionArgs<abi_1, "pure" | "view", functionName>, TChainOverride_3 extends import("viem").Chain | undefined = undefined>(args: import("viem").WriteContractParameters<abi_1, functionName, args, undefined, undefined, TChainOverride_3>) => Promise<`0x${string}`>;
+        extend: <const client extends {
+            [x: string]: unknown;
+            account?: undefined;
+            batch?: undefined;
+            cacheTime?: undefined;
+            chain?: undefined;
+            key?: undefined;
+            name?: undefined;
+            pollingInterval?: undefined;
+            request?: undefined;
+            transport?: undefined;
+            type?: undefined;
+            uid?: undefined;
+        } & Partial<Pick<import("viem").PublicActions<import("viem").CustomTransport, undefined, undefined>, "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<undefined, undefined>, "sendTransaction" | "writeContract">>>(fn: (client: import("viem").Client<import("viem").CustomTransport, undefined, undefined, import("viem").WalletRpcSchema, import("viem").WalletActions<undefined, undefined>>) => client) => import("viem").Client<import("viem").CustomTransport, undefined, undefined, import("viem").WalletRpcSchema, { [K in keyof client]: client[K]; } & import("viem").WalletActions<undefined, undefined>>;
+    } | undefined;
     fetchPublicAddress(opts?: FetchPublicAddressOpts): Promise<string | undefined>;
+    /**
+     * 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
+     * chainId to change and then retry the sign message request.
+     *
+     * Otherwise it will just return the result of the sign message request.
+     *
+     * @param signMessageFn - Function to sign message with provider
+     * @param messageToSign - Message to sign
+     * @returns
+     */
+    protected waitForSignMessage(signMessageFn: (messageToSign: string) => Promise<string | undefined>, messageToSign: string): Promise<string | undefined>;
     getDeepLink(): string | undefined;
     signMessage(messageToSign: string): Promise<string | undefined>;
+    private clearActiveAccount;
+    private clearSession;
+    private setActiveAccount;
+    private setSession;
     endSession(): Promise<void>;
+    getNetwork(): Promise<number | undefined>;
     providerSwitchNetwork({ network, provider, }: {
         network: EvmNetwork;
         provider: WalletClient;
     }): Promise<void>;
-    getConnectedAccounts(): Promise<Hex[]>;
-    getSession(): Promise<ConnectorSession | undefined>;
+    getConnectedAccounts(): Promise<string[]>;
+    private isMetaMask;
+    getSupportedNetworks(): Promise<string[]>;
 }
-export {};