SignerManagementOperations

Interface

interface SignerManagementOperations

Properties

Property	Type	Description
`recoveryMethods`	`List<RecoveryMethod>`	The recovery methods of the wallet, with the changes made by addRecoveryMethod and removeRecoveryMethod.

Functions

Function	Description
`addRecoveryMethod`	Adds a recovery method to the wallet. See Wallet.addRecoveryMethod.
`addSigner`	Registers a new delegated signer on the wallet via the recovery/approval flow. Does not change the active signer.
`isSignerApproved`	Returns true if the given signer is approved on this wallet’s chain.
`localDeviceSignerLocator`	Returns the locator of the device signer that lives on this device. Returns null if this wallet has no device signer on this device.
`needsRecovery`	Returns true when a device signer was configured for this wallet but no matching hardware key exists on the current device.
`recover`	Generates a new hardware key on this device and registers it on the wallet using the admin/recovery signer approval flow.
`removeRecoveryMethod`	Removes a recovery method from the wallet. See Wallet.removeRecoveryMethod.
`removeSigner`	Removes a delegated signer from the wallet. Supported types: DelegatedSigner.Email, DelegatedSigner.Phone, DelegatedSigner.ExternalWallet, DelegatedSigner.Locator, DelegatedSigner.Passkey.
`signerIsRegistered`	Checks if the signer is registered on this wallet.
`signers`	Fetches the live list of signers registered on this wallet from the API.
`useRecoveryMethod`	Selects the recovery method that approves signer changes. See Wallet.useRecoveryMethod.
`useSigner`	Sets the active signer for subsequent wallet operations.

addRecoveryMethod

abstract suspend fun addRecoveryMethod(recoveryMethod: DelegatedSigner): Result<Unit, WalletError>

Adds a recovery method to the wallet. See Wallet.addRecoveryMethod.

addSigner

abstract suspend fun addSigner(signer: DelegatedSigner, deployImmediately: Boolean, approver: DelegatedSigner? = null): Result<Unit, WalletError>

Registers a new delegated signer on the wallet via the recovery/approval flow. Does not change the active signer.

isSignerApproved

abstract suspend fun isSignerApproved(locator: String): Result<Boolean, WalletError>

Returns true if the given signer is approved on this wallet’s chain.

localDeviceSignerLocator

abstract suspend fun localDeviceSignerLocator(): DelegatedSignerData?

Returns the locator of the device signer that lives on this device. Returns null if this wallet has no device signer on this device.

needsRecovery

abstract suspend fun needsRecovery(): Boolean

Returns true when a device signer was configured for this wallet but no matching hardware key exists on the current device.

recover

abstract suspend fun recover(approver: DelegatedSigner? = null): Result<Unit, WalletError>

Generates a new hardware key on this device and registers it on the wallet using the admin/recovery signer approval flow.

removeRecoveryMethod

abstract suspend fun removeRecoveryMethod(recoveryMethod: DelegatedSigner): Result<Unit, WalletError>

Removes a recovery method from the wallet. See Wallet.removeRecoveryMethod.

removeSigner

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

Removes a delegated signer from the wallet. Supported types: DelegatedSigner.Email, DelegatedSigner.Phone, DelegatedSigner.ExternalWallet, DelegatedSigner.Locator, DelegatedSigner.Passkey.

signerIsRegistered

abstract fun signerIsRegistered(signer: DelegatedSigner): Boolean

Checks if the signer is registered on this wallet.

signers

abstract suspend fun signers(): Result<List<DelegatedSignerData>, WalletError>

Fetches the live list of signers registered on this wallet from the API.

useRecoveryMethod

abstract suspend fun useRecoveryMethod(recoveryMethod: DelegatedSigner): Result<Unit, WalletError>

Selects the recovery method that approves signer changes. See Wallet.useRecoveryMethod.

useSigner

abstract suspend fun useSigner(signer: DelegatedSigner): Result<Unit, WalletError>

Sets the active signer for subsequent wallet operations.

Deprecated

signerIsRegistered

Deprecated. Use signerIsRegistered(signer: DelegatedSigner) instead.

abstract fun signerIsRegistered(locator: String): Boolean

Returns true if the given locator is registered as a delegated signer on this wallet.

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

SignerManagementOperations

Properties

Functions

addRecoveryMethod

addSigner

isSignerApproved

localDeviceSignerLocator

needsRecovery

recover

removeRecoveryMethod

removeSigner

signerIsRegistered

signers

useRecoveryMethod

useSigner

Deprecated

signerIsRegistered

​Properties

​Functions

​addRecoveryMethod

​addSigner

​isSignerApproved

​localDeviceSignerLocator

​needsRecovery

​recover

​removeRecoveryMethod

​removeSigner

​signerIsRegistered

​signers

​useRecoveryMethod

​useSigner

​Deprecated

​signerIsRegistered

Properties

Functions

addRecoveryMethod

addSigner

isSignerApproved

localDeviceSignerLocator

needsRecovery

recover

removeRecoveryMethod

removeSigner

signerIsRegistered

signers

useRecoveryMethod

useSigner

Deprecated

signerIsRegistered