CrossmintWallets

Kotlin Interface

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 wallet with one recovery signer on the given chain.
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	Returns the wallet of 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, deployImmediately: Boolean = true, approver: DelegatedSigner? = null): 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 wallet with one recovery signer on the given chain.

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

Creates a wallet with more than one recovery signer on the given chain.

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

Creates a wallet with one recovery signer.

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

Creates a wallet with more than one recovery 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>

abstract suspend fun <W : Wallet> getWallet(chain: SupportedChain<W>): Result<W, WalletError>

Returns the wallet of the current user on the given chain.

removeSigner

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

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