Search…
Web3Wallet
The Web3Wallet object describes a User's web3 wallet public address.

Overview

The Web3Wallet object describes a Web3 wallet public address. The public address can be used as a proof of identification for users.
Web3 public addresses must be verified so that we can make sure they can be assigned to their rightful owners. The verification is completed via Web3 wallet browser extensions such as Metamask. The Web3Wallet3 object holds all the necessary state around the verification process.
The verification process always starts with the signUp.prepareWeb3WalletVerification() or signIn.prepareFirstFactor() method, which will send the public wallet to Clerk Frontend API and will receive a nonce that needs to be signed by the Web3 wallet browser extension.
The second and final step involves an attempt to complete the verification by calling signUp.attemptWeb3WalletVerification() or signIn.attemptFirstFactor() method, passing the generated signature as a parameter.

Attributes

Name
Description
id
string
A unique identifier for this web3 wallet.
web3Wallet
string
In Ethereum, the address is made up of 0x + 40 hexadecimal characters
verification
An object holding information on the verification of this phone number.

Methods

toString()

toString() => string
Returns the web3Wallet hexadecimal string.

Interfaces

VerificationResource

Property
Description
status
string | null
The verification status. Possible values are:
  • unverified: The verification process has not been completed.
  • verified: The verification process has completed successfully.
  • failed: The verification process has been completed, but failed.
  • expired: The verification is invalid because it wasn't completed in the allowed time.
strategy
string | null
The verification strategy. Possible strategy values are:
nonce
string | null
A unique nonce that will be signed in the browser.
attempts
number | null
The number of attempts to complete the verification so far. Usually, a verification allows for maximum 3 attempts to be completed.
expireAt
Date | null
The timestamp when the verification will expire and cease to be valid.
error
ClerkAPIError | null
Any error that occurred during the verification process from the Clerk API.
Last modified 1mo ago