Appearance

Documentation / react-auth / Wallet

Interface: Wallet ​

Object representation of a user's wallet.

Extended by ​

Properties ​

address ​

address: string

The wallet address.

chainId? ​

chainId?: string

Deprecated ​

Use BaseConnectedWallet.chainId instead.

tsx
const {wallets} = useWallets();
// Replace wallets[0] with the wallet you'd like
const chainId = wallets[0].chainId;
console.log(chainId);
// This will be the current chain ID of the wallet,
// e.g. 'eip155:1' if the wallet is on mainnet

Represents the CAIP-2 formatted chain ID of the wallet during the most recent verification during SIWE. May not be up to date with the current chain ID of the wallet.

Embedded wallets do not complete SIWE since the user is already authenticated, and you should not use this field for the embedded wallet.

e.g. eip155:1, eip155:5, eip155:137, etc.

chainType ​

chainType: "solana" | "ethereum"

Chain type of the wallet address.

connectorType? ​

connectorType?: string

The connector type used for this wallet during the most recent verification.

This includes but is not limited to injected, wallet_connect, coinbase_wallet, embedded.

delegated ​

delegated: boolean

Whether the wallet is delegated. Only applies to embedded wallets (walletClientType === 'privy').

imported ​

imported: boolean

Whether the wallet is imported. Only applies to embedded wallets (walletClientType === 'privy').

recoveryMethod? ​

recoveryMethod?: "privy" | UserRecoveryMethod

If this is a 'privy' embedded wallet, stores the recovery method:

1. 'privy': privy escrow of the recovery material
2. 'user-passcode': recovery protected by user-input passcode

walletClient ​

walletClient: "privy" | "unknown"

Deprecated ​

Use walletClientType instead.

walletClientType? ​

walletClientType?: string

The wallet client used for this wallet during the most recent verification.

If the value is privy, then this is a privy embedded wallet.

Other values include but are not limited to metamask, rainbow, coinbase_wallet, etc.

walletIndex ​

walletIndex: null | number

HD index for the wallet. Only applies to embedded wallets (walletClientType === 'privy').