Type alias WalletConfig<I>

WalletConfig<I>: {
    category?: "socialLogin" | "walletLogin";
    connectUI?: React.FC<ConnectUIProps<I>>;
    create: ((options) => I);
    id: string;
    isHeadless?: boolean;
    isInstalled?: (() => boolean);
    meta: typeof AbstractClientWallet["meta"];
    personalWallets?: WalletConfig[];
    recommended?: boolean;
    selectUI?: React.FC<SelectUIProps<I>>;
}

Type Parameters

Type declaration

  • Optional category?: "socialLogin" | "walletLogin"
  • Optional connectUI?: React.FC<ConnectUIProps<I>>

    UI for connecting wallet

  • create: ((options) => I)
  • id: string
  • Optional isHeadless?: boolean

    If the wallet can sign transactions without user interaction, set this to true.

    Default Value

    false
    
  • Optional isInstalled?: (() => boolean)
      • (): boolean
      • Returns boolean

  • meta: typeof AbstractClientWallet["meta"]
  • Optional personalWallets?: WalletConfig[]

    An array of WalletConfig that users can use as a personal wallet to connect to your wallet

    This is only required if your wallet requires a personal wallet to be connected such as a Safe Wallet or Smart Wallet

    providing the personalWallets ensures that autoconnect and ConnectWallet modal works properly for your wallet.

    • autoconnect will connect the last connected personal wallet first and then connect your wallet
    • ConnectWallet modal will reopen once the personal wallet is connected so that you can render UI for connecting your wallet as the next step
  • Optional recommended?: boolean

    If true, this wallet will be tagged as "recommended" in ConnectWallet Modal and will be shown at the top of the list

    Default Value

    false
    
  • Optional selectUI?: React.FC<SelectUIProps<I>>

    UI for selecting wallet - this UI is rendered in the wallet selection screen

Generated using TypeDoc