SignerManagementOperations

Interface

interface SignerManagementOperations

Functions

Function	Description
`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.
`removeSigner`	Removes a delegated signer from the wallet. Supported types: DelegatedSigner.Email, DelegatedSigner.Phone, DelegatedSigner.ExternalWallet, DelegatedSigner.Locator.
`signerIsRegistered`	Checks if the signer is registered on this wallet.
`signers`	Fetches the live list of signers registered on this wallet from the API.
`useSigner`	Sets the active signer for subsequent wallet operations.

addSigner

abstract suspend fun addSigner(signer: DelegatedSigner, deployImmediately: Boolean): 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(): Result<Unit, WalletError>

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

removeSigner

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

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

signerIsRegistered

abstract fun signerIsRegistered(signer: DelegatedSigner): Boolean

Checks if the signer is registered on this wallet.

abstract fun ~~signerIsRegistered~~(locator: String): Boolean

Returns true if the given locator is registered as a delegated signer 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.

useSigner

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

Sets the active signer for subsequent wallet operations.

Introduction

Quickstarts ⚡️

Concepts

Guides

API Reference

SignerManagementOperations

Functions

addSigner

isSignerApproved

localDeviceSignerLocator

needsRecovery

recover

removeSigner

signerIsRegistered

signers

useSigner

​Functions

​addSigner

​isSignerApproved

​localDeviceSignerLocator

​needsRecovery

​recover

​removeSigner

​signerIsRegistered

​signers

​useSigner

Functions

addSigner

isSignerApproved

localDeviceSignerLocator

needsRecovery

recover

removeSigner

signerIsRegistered

signers

useSigner