Documentation
Introduction

Welcome to the Ledger Wallet API Client documentation

This library is exclusively designed to facilitate the seamless integration of decentralized applications (DApps), termed as Live Apps, within Ledger Live. It provides a streamlined way for Live Apps to communicate with Ledger hardware wallets via the Wallet API.

Whether you are developing a crypto asset management app, a decentralized exchange, or any other blockchain project, this library is equipped with a set of React hooks and utilities to ensure a secure and efficient user experience.

This library serves as a cornerstone for integrating applications within Ledger Live, dubbed as Live Apps, in a framework-agnostic manner. By leveraging the Wallet API Client, your Live App can interact with Ledger hardware wallets through Ledger Live.

💡

Migration from Platform SDK: If you are migrating from Platform SDK, please refer to this section that will guide you through the process.

Target Audience

The Wallet API Client is tailored for developers seeking to build Live Apps for embedding within Ledger Live. It ensures smooth communication between the Live App and the user’s Ledger hardware wallet through Ledger Live (opens in a new tab).

We expect to widen the scope of the library in the future to support other use cases as well such as web apps connected to Ledger wallets though the Ledger Extension (opens in a new tab), but this is not yet supported.

Overview

This library is exclusively designed to facilitate the seamless integration of decentralized applications (dApps), termed as Live Apps, within Ledger Live. It provides a streamlined way for Live Apps to communicate with Ledger hardware wallets via the Wallet API.

Whether you are developing a crypto asset management app, a decentralized exchange, or any other blockchain project, this library is equipped with a set of React hooks and utilities to ensure a secure and efficient user experience.

Navigating the Documentation

This documentation is structured to provide you with a clear understanding of the various features and utilities available in the Ledger Wallet API Client library.

  • Getting Started: If you'e new to this library, the Getting Started section (for Core or React) is the perfect launchpad. It navigates you through the installation and initial setup.

  • Configuration: The Configuration (for Core or React section contains information on how to integrate your application into Ledger Live.

  • Modules/Hooks and Utilities: Acquaint yourself with various modules/hooks and utilities for account management, message signing, transaction handling, and more in dedicated sections. Each section elucidates explanations, parameters, and practical applications.

  • Migration Guide: If you are migrating from the Platform SDK (version 1 of this library) to the Wallet API (version 2 and current), refer to the Migration Guide for a guided transition.

  • Families: For a comprehensive list of supported blockchains, visit the Families section. Each blockchain is detailed with its features and capabilities within the library.

We're thrilled to have you on board and excited to see the innovative Live Apps you build.

Ledger
Copyright © Ledger SAS. All rights reserved. Ledger, Ledger Nano S, Ledger Vault, Bolos are registered trademarks of Ledger SAS