Skip to Content
📢 Breaking change: Applications using LedgerJS for transport implementation should migrate to the Device Management Kit (DMK). Learn more.

Wallet API Simulator

☞ The renaming of “Ledger Live” to “Ledger Wallet” and “wallet” (in the hardware sense) to “signer” is still in progress. This page may contain legacy references that will be updated.

This page explains what the Wallet API Simulator is for: testing a Live App without opening the real Ledger Wallet application. For installation and the TransportProvider setup, see Use Wallet API Simulator to develop a Live App.

The Simulator is a Ledger library (@ledgerhq/wallet-api-simulator) that returns predefined responses for Wallet API actions. You connect to it through a fake transport that acts as a wallet implementing the Wallet API Server, the same role Ledger Wallet plays in production. That lets you develop the Live App in a browser and write end-to-end, integration, or unit tests by mocking accounts, currencies, and other data. You can also simulate errors that are hard to reproduce on a physical signer.

This documentation and the Wallet API library are for developers building Live Apps that will be embedded in a wallet that implements the Wallet API Server, such as Ledger Wallet .

The Simulator ships profiles: predefined sets of responses. We recommend profiles.STANDARD, which includes a set of mock accounts, mock currencies, and method handlers. The Profiles page shows those mocks and how to customize them.

Main takeaways

The Simulator replaces Ledger Wallet during development and automated tests. It does not talk to a real signer. Use it from a browser with getSimulatorTransport and a profile such as profiles.STANDARD.

Further reading

Last updated on
Ledger
Copyright © Ledger SAS. All rights reserved. Ledger, Ledger Stax, Ledger Flex, Ledger Nano, Ledger Nano S, Ledger OS, Ledger Wallet, [LEDGER] (logo), [L] (logo) are trademarks owned by Ledger SAS.