CrossmintWallets

Protocol Factory for obtaining and creating Crossmint smart wallets.

protocol CrossmintWallets : Sendable

Overview

Obtain an instance from ClientSDK/crossmintWallets() or CrossmintSDK/crossmintWallets. Prefer the chain-specific overloads (e.g. getWallet(chain:options:)) over the generic ones so you get a typed wallet back without an additional cast.

Example

let wallets = CrossmintSDK.shared.crossmintWallets

// Get or create an EVM wallet with email recovery
if let wallet = try await wallets.getWallet(chain: .baseMainnet) {
    print("Existing wallet:", wallet.address)
} else {
    let wallet = try await wallets.createWallet(
        chain: .baseMainnet,
        recoveryMethods: [.email("user@example.com")]
    )
    print("New wallet:", wallet.address)
}

// Solana and Stellar accept several recovery signers. Each one can authorize on its own.
let solanaWallet = try await wallets.createWallet(
    chain: .solana,
    recoveryMethods: [.email("user@example.com"), .phone("+15551234567")]
)

Instance Methods

createWallet(chain:recovery:options:)

Creates a new smart wallet for the authenticated user on the given chain.

func createWallet(chain: Chain, recovery: any Signer, options: WalletOptions?) async throws(WalletError) -> Wallet

Parameters

Parameter	Description
`chain`	The blockchain to deploy to.
`recovery`	The signer that can authorize recovery operations for this wallet.
`options`	Optional configuration, such as enabling a device signer.

createWallet(chain:recoveryMethods:options:)

Creates a new smart wallet for the authenticated user on the given chain.

func createWallet(chain: Chain, recoveryMethods: [any Signer], options: WalletOptions?) async throws(WalletError) -> Wallet

Discussion

Deploys the wallet contract on-chain. Calling this when a wallet already exists returns the existing wallet rather than creating a duplicate. Each recovery signer can authorize on its own. The wallet stays usable when the user loses one of them. Only Solana and Stellar accept more than one recovery signer. The wallet’s first recovery signer, as the API reports it, is the active signer until useSigner(_:) selects another one.

Throws: WalletError.recoveryConfigRejected(code:message:) in these conditions:

The list is empty.

The list has more than one signer, and the chain accepts only one.

The list has a passkey, and the chain is Solana.

Parameters

Parameter	Description
`chain`	The blockchain to deploy to.
`recoveryMethods`	The signers that can each authorize recovery operations for this wallet. To use an external wallet as a recovery signer, pass an `ExternalWalletSigner`.
`options`	Optional configuration, such as enabling a device signer.

createWallet(chain:recoveryMethods:signers:options:)

Creates a new smart wallet for the authenticated user, with more signers on the wallet.

func createWallet(chain: Chain, recoveryMethods: [any Signer], signers: [SignerConfig], options: WalletOptions?) async throws(WalletError) -> Wallet

Discussion

The SDK adds the signers when it creates the wallet. The recovery method does not approve them.

Throws: WalletError.recoveryConfigRejected(code:message:) if the recovery list is empty. The SDK also throws this error if the list has more than one signer on a chain that accepts one. WalletError.walletCreationCancelled if the user cancels the passkey creation.

Parameters

Parameter	Description
`chain`	The blockchain to deploy to.
`recoveryMethods`	The signers that can each authorize recovery operations for this wallet.
`signers`	The signers to add to the wallet. For `SignerConfig/passkey(name:host:)`, the SDK asks the user to create the passkey first. `SignerConfig.device` has the same effect as `deviceSigner`.
`options`	Optional configuration, such as enabling a device signer.

getWallet(chain:options:)

Returns the wallet of the authenticated user on the given chain. Returns nil if the wallet does not exist.

func getWallet(chain: Chain, options: WalletOptions?) async throws(WalletError) -> Wallet?

Discussion

The SDK selects the signer for transactions:

If signers() has only one signer, the SDK uses that signer. This applies to email, phone, API key, and passkey signers.
If not, the SDK uses the first recovery method of the wallet. To use a different signer, call useSigner(_:). To sign with a passkey, set passkeyHost in options. To sign with an external wallet, call useSigner(_:) before you send a transaction.

Parameters

Parameter	Description
`chain`	The blockchain to look up.
`options`	Optional configuration, such as enabling a device signer.

getWallet(chain:recovery:options:)

Returns the wallet for the authenticated user on the given chain, or nil if none exists yet.

func getWallet(chain: Chain, recovery: any Signer, options: WalletOptions?) async throws(WalletError) -> Wallet?

Parameters

Parameter	Description
`chain`	The blockchain to look up.
`recovery`	The signer that can authorize recovery operations for this wallet.
`options`	Optional configuration, such as enabling a device signer.

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

Overview

Example

Instance Methods

createWallet(chain:recovery:options:)

Parameters

createWallet(chain:recoveryMethods:options:)

Discussion

Parameters

createWallet(chain:recoveryMethods:signers:options:)

Discussion

Parameters

getWallet(chain:options:)

Discussion

Parameters

getWallet(chain:recovery:options:)

Parameters

​Overview

​Example

​Instance Methods

​createWallet(chain:recovery:options:)

​Parameters

​createWallet(chain:recoveryMethods:options:)

​Discussion

​Parameters

​createWallet(chain:recoveryMethods:signers:options:)

​Discussion

​Parameters

​getWallet(chain:options:)

​Discussion

​Parameters

​getWallet(chain:recovery:options:)

​Parameters

Overview

Example

Instance Methods

createWallet(chain:recovery:options:)

Parameters

createWallet(chain:recoveryMethods:options:)

Discussion

Parameters

createWallet(chain:recoveryMethods:signers:options:)

Discussion

Parameters

getWallet(chain:options:)

Discussion

Parameters

getWallet(chain:recovery:options:)

Parameters