Interface SignerProvider

Interface that all signer providers must implement.

Providers are responsible for discovering accounts and creating signers from a specific source (Host API, browser extensions, dev accounts).

interface SignerProvider {
    type: ProviderType;
    connect(
        signal?: AbortSignal,
    ): Promise<Result<SignerAccount[], SignerError>>;
    disconnect(): void;
    onAccountsChange(
        callback: (accounts: SignerAccount[]) => void,
    ): Unsubscribe;
    onStatusChange(callback: (status: ConnectionStatus) => void): Unsubscribe;
}

Implemented by

Index

Properties

Methods

connect disconnect onAccountsChange onStatusChange

Properties

`Readonly`type

type: ProviderType

Unique identifier for this provider type.

Methods

connect

connect(signal?: AbortSignal): Promise<Result<SignerAccount[], SignerError>>
Attempt to connect and discover accounts.
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the connection attempt.
Returns Promise<Result<SignerAccount[], SignerError>>
Accounts on success, typed error on failure.
- Defined in packages/signer/src/providers/types.ts:23

disconnect

disconnect(): void
Disconnect and clean up resources. Safe to call multiple times.

Returns void
- Defined in packages/signer/src/providers/types.ts:29

onAccountsChange

onAccountsChange(callback: (accounts: SignerAccount[]) => void): Unsubscribe
Subscribe to account list changes.

Emitted when the set of available accounts changes (e.g., user connects/disconnects in the host wallet).
Parameters
- callback: (accounts: SignerAccount[]) => void
Returns Unsubscribe
Unsubscribe function.
- Defined in packages/signer/src/providers/types.ts:49

onStatusChange

onStatusChange(callback: (status: ConnectionStatus) => void): Unsubscribe
Subscribe to connection status changes.

Not all providers emit status changes — for example, dev accounts are always "connected" and never emit.
Parameters
- callback: (status: ConnectionStatus) => void
Returns Unsubscribe
Unsubscribe function.
- Defined in packages/signer/src/providers/types.ts:39