CrossmintWallets - Crossmint Docs

Interface

interface CrossmintWallets

Functions

Function	Description
`addSigner`	Adds a delegated signer to the current wallet on the given chain. Supported types: Email, Phone, ExternalWallet, Locator.
`createWallet`	Creates a new wallet on the specified chain with the given signer.
`getDeviceSignerSecurityLevel`	Returns the hardware security level of the device signer key for the given wallet address. Possible values: “StrongBox”, “TEE”, “Hardware-backed”, “Software”, or null if not available.
`getWallet`	Fetches the wallet for the current user on the given chain.
`removeSigner`	Removes a delegated signer from the current wallet on the given chain. Supported types: Email, Phone, ExternalWallet, Locator.

addSigner

abstract suspend fun addSigner(signer: DelegatedSigner, chain: Chain): Result<Unit, WalletError>

Adds a delegated signer to the current wallet on the given chain. Supported types: Email, Phone, ExternalWallet, Locator.

createWallet

open suspend fun createWallet(chain: Chain, recovery: SignerType, signers: List<DelegatedSigner> = emptyList(), owner: String? = null, alias: String? = null, deviceSigner: Boolean = false): Result<Wallet, WalletError>

Creates a new wallet on the specified chain with the given signer.

abstract suspend fun createWallet(chain: EVMChain, recovery: SignerType, signers: List<DelegatedSigner> = emptyList(), owner: String? = null, alias: String? = null, deviceSigner: Boolean = false): Result<EVMWallet, WalletError>

Creates a new EVM wallet on the specified chain with the given signer.

abstract suspend fun createWallet(chain: SolanaChain, recovery: SignerType, signers: List<DelegatedSigner> = emptyList(), owner: String? = null, alias: String? = null, deviceSigner: Boolean = false): Result<SolanaWallet, WalletError>

Creates a new Solana wallet with the given signer.

abstract suspend fun createWallet(chain: StellarChain, recovery: SignerType, signers: List<DelegatedSigner> = emptyList(), owner: String? = null, alias: String? = null, deviceSigner: Boolean = false): Result<StellarWallet, WalletError>

Creates a new Stellar wallet with the given signer.

getDeviceSignerSecurityLevel

abstract suspend fun getDeviceSignerSecurityLevel(walletAddress: String): String?

Returns the hardware security level of the device signer key for the given wallet address. Possible values: “StrongBox”, “TEE”, “Hardware-backed”, “Software”, or null if not available.

getWallet

open suspend fun getWallet(chain: Chain): Result<Wallet, WalletError>

Fetches the wallet for the current user on the given chain.

abstract suspend fun getWallet(chain: EVMChain): Result<EVMWallet, WalletError>

Fetches the EVM wallet for the current user on the given chain.

abstract suspend fun getWallet(chain: SolanaChain): Result<SolanaWallet, WalletError>

Fetches the Solana wallet for the current user.

abstract suspend fun getWallet(chain: StellarChain): Result<StellarWallet, WalletError>

Fetches the Stellar wallet for the current user.

removeSigner

abstract suspend fun removeSigner(signer: DelegatedSigner, chain: Chain): Result<Unit, WalletError>

Removes a delegated signer from the current wallet on the given chain. Supported types: Email, Phone, ExternalWallet, Locator.

​Functions

​addSigner

​createWallet

​getDeviceSignerSecurityLevel

​getWallet

​removeSigner