@d13co/use-wallet 4.5.4 → 4.5.5

package/dist/index.d.ts

@@ -4,11 +4,9 @@ import AVMWebProviderSDK from '@agoralabs-sh/avm-web-provider';
 import { InstanceWithExtensions, SDKBase } from '@magic-sdk/provider';
 import { AlgorandExtension } from '@magic-ext/algorand';
 import { MagicUserMetadata } from 'magic-sdk';
-import * as liquid_accounts_evm from 'liquid-accounts-evm';
-import { LiquidEvmSdk, SignTypedDataParams } from 'liquid-accounts-evm';
 import { AlgorandClient } from '@algorandfoundation/algokit-utils';
-import { SDKProvider } from '@metamask/sdk';
-import { EIP1193Provider } from 'viem';
+import { LiquidEvmSdk, SignTypedDataParams } from 'liquid-accounts-evm';
+import { Config } from '@wagmi/core';
 import { WalletConnectModalConfig } from '@walletconnect/modal';
 import { SignClientTypes } from '@walletconnect/types';
 
@@ -106,6 +104,11 @@ declare abstract class BaseWallet {
     get isConnected(): boolean;
     get isActive(): boolean;
     get activeNetworkConfig(): NetworkConfig;
+    /**
+     * Dynamically update wallet metadata (e.g., after learning the actual
+     * connector name/icon during connect).
+     */
+    protected updateMetadata(updates: Partial<WalletMetadata>): void;
     protected onDisconnect: () => void;
     protected manageWalletConnectSession: (action: "backup" | "restore", targetWalletKey?: WalletKey) => void;
 }
@@ -413,6 +416,59 @@ declare class MagicAuth extends BaseWallet {
     signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
 }
 
+interface MnemonicConstructor {
+    persistToStorage?: boolean;
+    promptForMnemonic: () => Promise<string | null>;
+}
+type MnemonicOptions = Partial<Pick<MnemonicConstructor, 'promptForMnemonic'>> & Omit<MnemonicConstructor, 'promptForMnemonic'>;
+declare const LOCAL_STORAGE_MNEMONIC_KEY = "@txnlab/use-wallet:v4_mnemonic";
+declare class MnemonicWallet extends BaseWallet {
+    private account;
+    private options;
+    protected store: Store<State>;
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.MNEMONIC>);
+    static defaultMetadata: {
+        name: string;
+        icon: string;
+    };
+    private loadMnemonicFromStorage;
+    private saveMnemonicToStorage;
+    private removeMnemonicFromStorage;
+    private checkMainnet;
+    private initializeAccount;
+    connect: () => Promise<WalletAccount[]>;
+    disconnect: () => Promise<void>;
+    resumeSession: () => Promise<void>;
+    private processTxns;
+    private processEncodedTxns;
+    signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
+}
+
+interface PeraWalletConnectOptions {
+    bridge?: string;
+    shouldShowSignTxnToast?: boolean;
+    chainId?: 416001 | 416002 | 416003 | 4160;
+    compactMode?: boolean;
+}
+declare class PeraWallet extends BaseWallet {
+    private client;
+    private options;
+    protected store: Store<State>;
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.PERA>);
+    static defaultMetadata: {
+        name: string;
+        icon: string;
+    };
+    private initializeClient;
+    connect: () => Promise<WalletAccount[]>;
+    disconnect: () => Promise<void>;
+    setActive: () => void;
+    resumeSession: () => Promise<void>;
+    private processTxns;
+    private processEncodedTxns;
+    signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
+}
+
 interface EvmAccount {
     evmAddress: string;
     algorandAddress: string;
@@ -483,15 +539,22 @@ declare abstract class LiquidEvmBaseWallet extends BaseWallet {
      */
     protected initializeEvmSdk(): Promise<LiquidEvmSdk>;
     /**
-     * Derive Algorand accounts from EVM addresses
+     * Derive Algorand accounts from EVM addresses.
+     * @param evmAddresses - EVM addresses to derive Algorand accounts from
+     * @param connectorInfo - Optional connector name/icon to include in account metadata
+     */
+    protected deriveAlgorandAccounts(evmAddresses: string[], connectorInfo?: {
+        name?: string;
+        icon?: string;
+    }): Promise<WalletAccount[]>;
+    /**
+     * Process transaction group to extract transactions that need signing
      */
-    protected deriveAlgorandAccounts(evmAddresses: string[]): Promise<WalletAccount[]>;
+    protected processTxns(txnGroup: algosdk.Transaction[], indexesToSign?: number[]): algosdk.Transaction[];
     /**
-     * Convert bytes to hex string with 0x prefix
+     * Process encoded transaction group to extract transactions that need signing
      */
-    protected bytesToHex(bytes: Uint8Array): string;
-    private processTxns;
-    private processEncodedTxns;
+    protected processEncodedTxns(txnGroup: Uint8Array[], indexesToSign?: number[]): algosdk.Transaction[];
     /**
      * Sign Algorand transactions using EVM wallet signatures
      */
@@ -499,107 +562,90 @@ declare abstract class LiquidEvmBaseWallet extends BaseWallet {
     /**
      * Helper to compare and update accounts if needed during session resume
      */
-    protected resumeWithAccounts(evmAddresses: string[], setAccountsFn: (accounts: WalletAccount[]) => void): Promise<void>;
-    protected notifyConnect(evmAddress: string, algorandAddress: string): void;
-}
-
-interface MetaMaskWalletOptions extends LiquidEvmOptions {
-    dappMetadata?: {
+    protected resumeWithAccounts(evmAddresses: string[], setAccountsFn: (accounts: WalletAccount[]) => void, connectorInfo?: {
         name?: string;
-        url?: string;
-        iconUrl?: string;
-    };
-}
-declare class MetaMaskWallet extends LiquidEvmBaseWallet {
-    private metamaskSdk;
-    private provider;
-    protected options: MetaMaskWalletOptions;
-    constructor(params: WalletConstructor<WalletId.METAMASK>);
-    static defaultMetadata: {
-        name: string;
-        icon: string;
-        isLiquid: "EVM";
-    };
-    protected initializeProvider(): Promise<void>;
-    getEvmProvider(): Promise<SDKProvider>;
-    protected signWithProvider(typedData: liquid_accounts_evm.SignTypedDataParams, evmAddress: string): Promise<string>;
-    connect: () => Promise<WalletAccount[]>;
-    disconnect: () => Promise<void>;
-    resumeSession: () => Promise<void>;
-}
-
-interface MnemonicConstructor {
-    persistToStorage?: boolean;
-    promptForMnemonic: () => Promise<string | null>;
-}
-type MnemonicOptions = Partial<Pick<MnemonicConstructor, 'promptForMnemonic'>> & Omit<MnemonicConstructor, 'promptForMnemonic'>;
-declare const LOCAL_STORAGE_MNEMONIC_KEY = "@txnlab/use-wallet:v4_mnemonic";
-declare class MnemonicWallet extends BaseWallet {
-    private account;
-    private options;
-    protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.MNEMONIC>);
-    static defaultMetadata: {
-        name: string;
-        icon: string;
-    };
-    private loadMnemonicFromStorage;
-    private saveMnemonicToStorage;
-    private removeMnemonicFromStorage;
-    private checkMainnet;
-    private initializeAccount;
-    connect: () => Promise<WalletAccount[]>;
-    disconnect: () => Promise<void>;
-    resumeSession: () => Promise<void>;
-    private processTxns;
-    private processEncodedTxns;
-    signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
-}
-
-interface PeraWalletConnectOptions {
-    bridge?: string;
-    shouldShowSignTxnToast?: boolean;
-    chainId?: 416001 | 416002 | 416003 | 4160;
-    compactMode?: boolean;
-}
-declare class PeraWallet extends BaseWallet {
-    private client;
-    private options;
-    protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.PERA>);
-    static defaultMetadata: {
-        name: string;
-        icon: string;
-    };
-    private initializeClient;
-    connect: () => Promise<WalletAccount[]>;
-    disconnect: () => Promise<void>;
-    setActive: () => void;
-    resumeSession: () => Promise<void>;
-    private processTxns;
-    private processEncodedTxns;
-    signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
+        icon?: string;
+    }): Promise<void>;
+    protected notifyConnect(evmAddress: string, algorandAddress: string): void;
 }
 
-interface RainbowWalletOptions extends LiquidEvmOptions {
-    dappMetadata?: {
-        name?: string;
-        url?: string;
-        iconUrl?: string;
-    };
+interface RainbowKitWalletOptions extends LiquidEvmOptions {
+    /** wagmi Config instance, typically created with RainbowKit's getDefaultConfig() */
+    wagmiConfig: Config;
+    /**
+     * Optional callback to connect an EVM wallet when none is connected.
+     * The app can use this to open RainbowKit's connect modal.
+     * Should resolve once the wallet is connected (wagmi state will be read after).
+     */
+    getEvmAccounts?: () => Promise<string[]>;
 }
-declare class RainbowWallet extends LiquidEvmBaseWallet {
-    private provider;
-    protected options: RainbowWalletOptions;
-    constructor(params: WalletConstructor<WalletId.RAINBOW>);
+declare class RainbowKitWallet extends LiquidEvmBaseWallet {
+    protected options: RainbowKitWalletOptions;
+    private _connecting;
+    constructor(params: WalletConstructor<WalletId.RAINBOWKIT>);
     static defaultMetadata: {
         name: string;
         icon: string;
         isLiquid: "EVM";
     };
+    /** True while connect() is running. Prevents re-entrancy from bridge components. */
+    get isConnecting(): boolean;
+    /**
+     * Set the getEvmAccounts callback after construction.
+     *
+     * RainbowKit's connect modal can only be opened via React hooks (useConnectModal)
+     * rendered inside <RainbowKitProvider>, but WalletManager is constructed before
+     * any React tree renders. This method lets WalletUIProvider create the bridge
+     * callback internally and inject it into the wallet on mount — before any
+     * user-initiated connect() call.
+     */
+    setGetEvmAccounts(fn: () => Promise<string[]>): void;
+    private get wagmiConfig();
+    /**
+     * If the Algorand chain (4160) isn't already in the wagmi config, add it.
+     * This is needed so wagmi's switchChain and signTypedData work without
+     * falling back to raw provider calls.
+     */
+    private ensureChainRegistered;
     protected initializeProvider(): Promise<void>;
-    getEvmProvider(): Promise<EIP1193Provider>;
-    protected signWithProvider(typedData: liquid_accounts_evm.SignTypedDataParams, evmAddress: string): Promise<string>;
+    /**
+     * Get the raw EIP-1193 provider from the active wagmi connector.
+     * Used by the base class's getEvmProvider and ensureAlgorandChain.
+     */
+    private getRawProvider;
+    getEvmProvider(): Promise<any>;
+    /**
+     * Sign EIP-712 typed data using wagmi's signTypedData.
+     *
+     * wagmi's signTypedData does NOT validate the domain's chainId against the
+     * connected chain — it simply forwards the typed data to the wallet via viem.
+     * EIP-712 signing is chain-agnostic (the chain ID is in the typed data domain,
+     * not in the RPC method), so this works regardless of which chain the wallet
+     * reports being on.
+     */
+    protected signWithProvider(typedData: SignTypedDataParams, evmAddress: string): Promise<string>;
+    /**
+     * Build a connectorInfo object from a wagmi account, omitting undefined fields.
+     * Uses `any` for the parameter to avoid exactOptionalPropertyTypes conflicts
+     * with wagmi's discriminated union return types.
+     */
+    private static extractConnectorInfo;
+    /**
+     * Read connected EVM accounts from wagmi state.
+     * If not connected, tries the getEvmAccounts callback, then falls back to
+     * connecting with the first available connector.
+     *
+     * When getEvmAccounts is provided, it is always called (to show the wallet
+     * selection UI). The callback is responsible for any disconnect/reconnect
+     * needed to present a fresh selection.
+     */
+    private getConnectedEvmAddresses;
+    /**
+     * Apply connector info to wallet-level metadata so the UI displays
+     * the actual wallet name/icon (e.g., "MetaMask") instead of the generic
+     * "EVM Wallet".  Falls back to defaults when connector info is unavailable.
+     */
+    private applyConnectorMetadata;
     connect: () => Promise<WalletAccount[]>;
     disconnect: () => Promise<void>;
     resumeSession: () => Promise<void>;
@@ -949,10 +995,9 @@ declare enum WalletId {
     KMD = "kmd",
     LUTE = "lute",
     MAGIC = "magic",
-    METAMASK = "metamask",
     MNEMONIC = "mnemonic",
     PERA = "pera",
-    RAINBOW = "rainbow",
+    RAINBOWKIT = "rainbowkit",
     WALLETCONNECT = "walletconnect",
     WEB3AUTH = "web3auth",
     W3_WALLET = "w3-wallet"
@@ -991,10 +1036,9 @@ type WalletMap = {
     [WalletId.KMD]: typeof KmdWallet;
     [WalletId.LUTE]: typeof LuteWallet;
     [WalletId.MAGIC]: typeof MagicAuth;
-    [WalletId.METAMASK]: typeof MetaMaskWallet;
     [WalletId.MNEMONIC]: typeof MnemonicWallet;
     [WalletId.PERA]: typeof PeraWallet;
-    [WalletId.RAINBOW]: typeof RainbowWallet;
+    [WalletId.RAINBOWKIT]: typeof RainbowKitWallet;
     [WalletId.WALLETCONNECT]: typeof WalletConnect;
     [WalletId.WEB3AUTH]: typeof Web3AuthWallet;
     [WalletId.W3_WALLET]: typeof W3Wallet;
@@ -1009,10 +1053,9 @@ type WalletOptionsMap = {
     [WalletId.KMD]: KmdOptions;
     [WalletId.LUTE]: LuteConnectOptions;
     [WalletId.MAGIC]: MagicAuthOptions;
-    [WalletId.METAMASK]: MetaMaskWalletOptions;
     [WalletId.MNEMONIC]: MnemonicOptions;
     [WalletId.PERA]: PeraWalletConnectOptions;
-    [WalletId.RAINBOW]: RainbowWalletOptions;
+    [WalletId.RAINBOWKIT]: RainbowKitWalletOptions;
     [WalletId.WALLETCONNECT]: WalletConnectOptions;
     [WalletId.WEB3AUTH]: Web3AuthOptions;
     [WalletId.W3_WALLET]: Record<string, never>;
@@ -1403,4 +1446,4 @@ declare function getSkin(skinId: string): WalletConnectSkin | undefined;
  */
 declare function resolveSkin(skinOption: WalletConnectSkinOption): WalletConnectSkin | undefined;
 
-export { type AlgodConfig, BUILTIN_SKINS, BaseWallet, type BaseWalletConstructor, BiatecWallet, type CustomProvider, CustomWallet, type CustomWalletOptions, DEFAULT_NETWORK_CONFIG, DEFAULT_STATE, DEFLY_WEB_PROVIDER_ID, DeflyWallet, type DeflyWalletConnectOptions, DeflyWebWallet, type EnableResult, type Exodus, type ExodusOptions, ExodusWallet, ICON, type JsonRpcRequest, KIBISIS_AVM_WEB_PROVIDER_ID, KibisisWallet, type KmdOptions, KmdWallet, LOCAL_STORAGE_MNEMONIC_KEY, LiquidEvmBaseWallet, type LiquidEvmMetadata, type LiquidEvmOptions, LogLevel, type LuteConnectOptions, LuteWallet, MagicAuth, type MagicAuthClient, type MagicAuthOptions, type ManagerStatus, MetaMaskWallet, type MetaMaskWalletOptions, type MnemonicOptions, MnemonicWallet, type MultisigMetadata, type NetworkConfig, NetworkConfigBuilder, NetworkId, PeraWallet, type PeraWalletConnectOptions, RainbowWallet, type RainbowWalletOptions, ScopeType, SecureKeyContainer, SessionError, type SignData, SignDataError, type SignDataResponse, type SignMetadata, SignTxnsError, type SignTxnsResponse, type SignTxnsResult, type SignerTransaction, type Siwa, type State, StorageAdapter, type SupportedWallet, type SupportedWallets, type UIHooks, W3Wallet, type W3WalletProvider, type WalletAccount, type WalletConfig, type WalletConfigMap, WalletConnect, type WalletConnectOptions, type WalletConnectSkin, type WalletConnectSkinOption, type WalletConstructor, WalletId, type WalletIdConfig, type WalletKey, WalletManager, type WalletManagerConfig, type WalletManagerOptions, type WalletMap, type WalletMetadata, type WalletOptions, type WalletOptionsMap, type WalletState, type WalletTransaction, type Web3AuthCredentials, type Web3AuthCustomAuth, type Web3AuthOptions, Web3AuthWallet, type WindowExtended, getSkin, registerSkin, resolveSkin, webpackFallback, withSecureKey, withSecureKeySync, zeroMemory, zeroString };
+export { type AlgodConfig, BUILTIN_SKINS, BaseWallet, type BaseWalletConstructor, BiatecWallet, type CustomProvider, CustomWallet, type CustomWalletOptions, DEFAULT_NETWORK_CONFIG, DEFAULT_STATE, DEFLY_WEB_PROVIDER_ID, DeflyWallet, type DeflyWalletConnectOptions, DeflyWebWallet, type EnableResult, type Exodus, type ExodusOptions, ExodusWallet, ICON, type JsonRpcRequest, KIBISIS_AVM_WEB_PROVIDER_ID, KibisisWallet, type KmdOptions, KmdWallet, LOCAL_STORAGE_MNEMONIC_KEY, LiquidEvmBaseWallet, type LiquidEvmMetadata, type LiquidEvmOptions, LogLevel, type LuteConnectOptions, LuteWallet, MagicAuth, type MagicAuthClient, type MagicAuthOptions, type ManagerStatus, type MnemonicOptions, MnemonicWallet, type MultisigMetadata, type NetworkConfig, NetworkConfigBuilder, NetworkId, PeraWallet, type PeraWalletConnectOptions, RainbowKitWallet, type RainbowKitWalletOptions, ScopeType, SecureKeyContainer, SessionError, type SignData, SignDataError, type SignDataResponse, type SignMetadata, SignTxnsError, type SignTxnsResponse, type SignTxnsResult, type SignerTransaction, type Siwa, type State, StorageAdapter, type SupportedWallet, type SupportedWallets, type UIHooks, W3Wallet, type W3WalletProvider, type WalletAccount, type WalletConfig, type WalletConfigMap, WalletConnect, type WalletConnectOptions, type WalletConnectSkin, type WalletConnectSkinOption, type WalletConstructor, WalletId, type WalletIdConfig, type WalletKey, WalletManager, type WalletManagerConfig, type WalletManagerOptions, type WalletMap, type WalletMetadata, type WalletOptions, type WalletOptionsMap, type WalletState, type WalletTransaction, type Web3AuthCredentials, type Web3AuthCustomAuth, type Web3AuthOptions, Web3AuthWallet, type WindowExtended, getSkin, registerSkin, resolveSkin, webpackFallback, withSecureKey, withSecureKeySync, zeroMemory, zeroString };