Skip to main content

Interface: WalletWithMetadata

Object representation of a user's wallet, with additional metadata for advanced use cases.

Hierarchy

  • LinkMetadata

  • Wallet

    WalletWithMetadata

Properties

address

address: string

The wallet address.

Inherited from

Wallet.address


chainId

Optional chainId: string

CAIP-2 formatted chain ID during the most recent verification.

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

Inherited from

Wallet.chainId


chainType

chainType: "ethereum" | "solana"

Deprecated

Use chainId instead.

Chain type of the wallet address.

Inherited from

Wallet.chainType


connectorType

Optional 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.

Inherited from

Wallet.connectorType


recoveryMethod

Optional recoveryMethod: "privy" | "user-passcode"

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

Inherited from

Wallet.recoveryMethod


type

type: "wallet"

Denotes that this is a wallet account.

Overrides

LinkMetadata.type


verifiedAt

verifiedAt: Date

Datetime when this account was linked to the user.

Inherited from

LinkMetadata.verifiedAt


walletClient

walletClient: "privy" | "unknown"

Deprecated

Use walletClientType instead.

Inherited from

Wallet.walletClient


walletClientType

Optional 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.

Inherited from

Wallet.walletClientType