Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/beginner/ble_flex_stax.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Add BLE and USB support for Flex and Stax"
category: tutorial
---

# Add BLE and USB support for Flex and Stax

## DMK
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/beginner/discover_and_connect.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Connecting to a Device"
category: tutorial
---

# Connecting to a Device

In this guide, you'll learn how to discover and connect to hardware devices using the Device Management Kit (DMK). By the end, you'll be able to scan for nearby devices, establish connections, and monitor their status.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/beginner/exchange_data.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Exchange data with the device"
category: tutorial
---

# Exchange data with the device

In this guide, you'll learn how to send commands to a connected Ledger device and process the responses using the Device Management Kit (DMK). By the end, you'll understand multiple ways to communicate with your hardware device.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/beginner/init_dmk.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Initializing and Configuring the DMK"
category: tutorial
---

# Initializing and Configuring the DMK

In this guide, you'll learn how to initialize and configure the Device Management Kit (DMK) for your application. By the end, you'll have a working DMK instance that's ready to interface with hardware devices.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/beginner/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Setup"
category: tutorial
---

# Setup

## What is the DMK?
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/explanation/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Why choose the Device Management Kit?"
category: explanation
---

# Why choose the Device Management Kit?

The Device Management Kit (DMK) offers a comprehensive suite of tools and libraries tailored for secure and efficient management of Ledger devices. It is specifically crafted for external developers to enhance the experience of interacting with Ledger hardware securely.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/explanation/ledgerjs.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Differences with LedgerJS"
category: explanation
---

# Differences with LedgerJS

The Device Management Kit (DMK) is designed to replace the existing LedgerJS libraries, including the `hw-app-XXX` and `hw-transport-XXX` series.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/explanation/signers.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Understanding Device Signer Kits"
category: explanation
---

# Understanding Device Signer Kits

Device Signer Kits represent a fundamental architectural choice in how developers interact with Ledger hardware devices across different blockchain ecosystems. To understand their importance, it's helpful to first consider the challenges they address and the conceptual model they implement.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Documentation"
category: overview
---

import { Callout } from "nextra/components";

# Documentation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Build a Custom Command"
category: how-to
---

# Build a Custom Command

You can build your own command simply by extending the `Command` class and implementing the `getApdu` and `parseResponse` methods.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/integration/how_to/dmk.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Device Management Kit"
category: how-to
---

import { Callout } from "nextra/components";

# Device Management Kit
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Use a signer"
category: how-to
---

# Use a signer

As ledger devices are able to install applications that will allow to be compatible with different blockchains,
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/integration/how_to/transports.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Transports"
category: how-to
---

# Transports

The Device Management Kit is offering several transports to communicate with a Ledger device.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Migration from 0.5.0 to 0.6.0"
category: how-to
---

# Migration from 0.5.0 to 0.6.0

We made some breaking changes to the Device Management Kit in 0.6 which are detailed below.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Migration from 0.6.1 to 0.6.2"
category: how-to
---

# Migration from 0.6.1 to 0.6.2

This guide walks you through migrating your Device Management Kit integration from version 0.6.1 to 0.6.2.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Migration from 1.1.0 to 1.2.0"
category: how-to
---

# Migration from 1.1.0 to 1.2.0

We made some breaking changes to the Ethereum Signer in 1.2.0 which are detailed below.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Migration from 1.3.3 to 1.4.0"
category: how-to
---

# Migration from 1.3.3 to 1.4.0

This guide walks you through migrating your Ethereum Signer integration from version 1.3.3 to 1.4.0.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Secure Channel"
category: reference
---

# Secure Channel

The secure connection is established between the connected device and Ledger HSM backend service via WebSocket. The following device actions will be executed with the secure connection.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/references/identifiers.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Device and Transport Identifiers"
category: reference
---

# Device and Transport Identifiers

Technical identifiers for Ledger devices when implementing custom USB and Bluetooth integrations outside of DMK or LedgerJS.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/references/signers/btc.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Bitcoin Signer Kit"
category: reference
---

# Bitcoin Signer Kit

This module provides the implementation of the Ledger Bitcoin signer of the Device Management Kit. It enables interaction with the Bitcoin application on a Ledger device including:
Expand Down
7 changes: 6 additions & 1 deletion apps/docs/pages/docs/references/signers/eth.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Ethereum Signer Kit"
category: reference
---

# Ethereum Signer Kit

This module provides the implementation of the Ledger Ethereum signer of the Device Management Kit. It enables interaction with the Ethereum application on a Ledger device including:
Expand Down Expand Up @@ -116,7 +121,7 @@ type GetAddressCommandResponse = {

### Use Case 2: Sign Transaction

This method enables users to securely sign transactions using clear signing on Ledger devices.
This method enables users to securely sign transactions using Clear Signing on Ledger devices.

```typescript
const { observable, cancel } = signerEth.signTransaction(
Expand Down
9 changes: 7 additions & 2 deletions apps/docs/pages/docs/references/signers/solana.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Solana Signer Kit"
category: reference
---

# Solana Signer Kit

This module provides the implementation of the Ledger Solana signer of the Device Management Kit. It enables interaction with the Solana application on a Ledger device including:
Expand Down Expand Up @@ -93,7 +98,7 @@ type GetAddressCommandResponse = {

### Use Case 2: Sign Transaction

Securely sign a Solana or SPL transaction using **clear signing** on Ledger devices.
Securely sign a Solana or SPL transaction using **Clear Signing** on Ledger devices.

```ts
const { observable, cancel } = signerSolana.signTransaction(
Expand Down Expand Up @@ -228,7 +233,7 @@ const subscription = observable.subscribe({

#### **Notes**

- Clear signing only supports simple instructions like a single `transfer` or combos like `createAccound + fundAccount` or `createAccount + transfer`. If you are receiving `6808` error from device, most likely the instructions are not supported and blind signing is required.
- Clear Signing only supports simple instructions like a single `transfer` or combos like `createAccound + fundAccount` or `createAccount + transfer`. If you are receiving `6808` error from device, most likely the instructions are not supported and blind signing is required.

---

Expand Down
5 changes: 5 additions & 0 deletions apps/docs/pages/docs/references/ts-doc.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "TS Doc"
category: reference
---

# TS Doc

Device Management Kits References:
Expand Down