API reference

This page describes the public API of Ledger Wallet Provider: initializeLedgerProvider from @ledgerhq/ledger-wallet-provider.

initializeLedgerProvider(options)

See Configuration for the full options reference with defaults and examples.

Signature

function initializeLedgerProvider(
  options: InitializeLedgerProviderOptions
): () => void
 
 
type InitializeLedgerProviderOptions = {
  // Core options
  apiKey: string;                                    // Your Ledger API key
  dAppIdentifier: string;                            // Your dApp identifier
  loggerLevel?: 'fatal' | 'error' | 'warn' | 'info' | 'debug';  // default: 'info'
  blockchainProviderFactories: BlockchainProviderFactoryRegistration[]; // v2+ only: blockchain families to register
 
  // UI options
  target?: HTMLElement;                               // Where to mount the UI (default: document.body)
  hideButton?: boolean;                               // Hide the floating button entirely (default: false)
  floatingButtonPosition?: 'bottom-right' | 'bottom-left' | 'bottom-center' | 'top-right' | 'top-left' | 'top-center' | 'middle-right';  // Position of the floating button (default: 'bottom-right')
  floatingButtonTarget?: HTMLElement | string;        // Element or CSS selector to anchor the floating button to
  walletTransactionFeatures?: Array<'send' | 'receive' | 'swap' | 'buy' | 'earn' | 'sell'>;  // Wallet action CTAs to display
  transactionConfirmationNotification?: 'tooltip' | 'toast';  // How TX confirmation is shown (default: 'tooltip')
};

apiKey, dAppIdentifierandblockchainProviderFactories are shown as required because the provider cannot authenticate or register a chain without them. Note that the TypeScript type still marks all three optional for backward compatibility, so the compiler will not catch a missing one.

Returns a cleanup function. Call it to remove the UI components from the DOM and to unregister any providers that were registered for your partner configuration (for example the EVM eip6963:requestProvider listener and/or the Solana Wallet Standard wallet).

const cleanup = initializeLedgerProvider({ /* options */ })
 
// When unmounting (e.g. route change, app teardown):
cleanup()

Methods

request(args): Promise<unknown>

request({ method, params }: RequestArguments): Promise<unknown>

Makes a JSON-RPC request to the provider. For signing and account-selection methods, the provider queues the request while the Ledger UI is open and executes it when the UI closes. Rejects with a ProviderRpcError on failure.

For the full list of supported methods, see Supported methods.

on(eventName, listener): this

on<TEvent extends keyof ProviderEvent>(
  eventName: TEvent,
  listener: (args: ProviderEvent[TEvent]) => void,
): this

Registers an event listener. Returns this for chaining.

removeListener(eventName, listener): this

removeListener<TEvent extends keyof ProviderEvent>(
  eventName: TEvent,
  listener: (args: ProviderEvent[TEvent]) => void,
): this

Removes a previously registered listener. Returns this for chaining.

isConnected(): boolean

isConnected(): boolean

Returns true if the provider has a connected account.

disconnect(code?, message?, data?): Promise<void>

disconnect(code?: number, message?: string, data?: unknown): Promise<void>

Disconnects the provider, clears the selected account and chain, and fires a disconnect event. The code parameter follows the CloseEvent status code  convention (default: 1000).

Supported methods

Handled locally by the provider

Forwarded to node RPC

Events

Error codes

request() rejects with a ProviderRpcError whose code is one of the following:

See also

• Get started — install and initialize the provider
• EVM — EVM Blockchain Provider
• Solana — Solana Blockchain Provider
• Configuration — full initializeLedgerProvider options reference
• Requirements — browser and platform requirements
• EIP-1193 specification 
• EIP-6963 specification