Appearance
Documentation / react-auth / WalletWithMetadata
Interface: WalletWithMetadata ​
Object representation of a user's wallet, with additional metadata for advanced use cases.
Extends ​
LinkMetadata
.Wallet
Properties ​
address ​
address:
string
The wallet address.
Inherited from ​
chainType ​
chainType:
"solana"
|"ethereum"
Chain type of the wallet address.
Inherited from ​
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
.
Inherited from ​
react-auth.Wallet.connectorType
delegated ​
delegated:
boolean
Whether the wallet is delegated. Only applies to embedded wallets (walletClientType === 'privy'
).
Inherited from ​
firstVerifiedAt ​
firstVerifiedAt:
null
|Date
Datetime when this account was linked to the user.
Inherited from ​
LinkMetadata.firstVerifiedAt
id? ​
id?:
null
|string
The server wallet ID of the wallet. Null if the wallet is not delegated. Only applies to embedded wallets (walletClientType === 'privy'
).
Inherited from ​
imported ​
imported:
boolean
Whether the wallet is imported. Only applies to embedded wallets (walletClientType === 'privy'
).
Inherited from ​
latestVerifiedAt ​
latestVerifiedAt:
null
|Date
Datetime when this account was most recently used as a login/link method by the user.
Inherited from ​
LinkMetadata.latestVerifiedAt
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
Inherited from ​
react-auth.Wallet.recoveryMethod
type ​
type:
"wallet"
Denotes that this is a wallet account.
Overrides ​
LinkMetadata.type
verifiedAt ​
verifiedAt:
Date
Deprecated ​
use firstVerifiedAt
instead. Datetime when this account was linked to the user or created.
Inherited from ​
LinkMetadata.verifiedAt
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.
Inherited from ​
react-auth.Wallet.walletClientType
walletIndex ​
walletIndex:
null
|number
HD index for the wallet. Only applies to embedded wallets (walletClientType === 'privy'
).