generated from shuding/nextra-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add new changes from device management kit to portal
- Loading branch information
1 parent
7f71d1c
commit e677f26
Showing
64 changed files
with
1,430 additions
and
6,117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,8 @@ | ||
export default { | ||
'---': { | ||
title: 'Device Interaction', | ||
type: 'separator' | ||
}, | ||
'getting-started': "Getting started", | ||
beginner: "Beginner's guides", | ||
integration: "Integration walkthroughs", | ||
references: "References", | ||
explanation: "Explanation", | ||
ledgerjs: "LedgerJS: Soon deprecated" | ||
} | ||
docs: "Ledger Device Management Kits", | ||
explanations: "Explanations", | ||
beginners: "Beginner's guide", | ||
integration_walkthroughs: "Integration Walkthrough", | ||
migrations: "Migrations", | ||
references: "References (TSDoc)", | ||
}; |
This file was deleted.
Oops, something went wrong.
3 changes: 2 additions & 1 deletion
3
...docs/device-interaction/beginner/_meta.js → ...ocs/device-interaction/beginners/_meta.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
export default { | ||
setup: "Setup", | ||
init_dmk: "Initialize Device Management Kit", | ||
discover_and_connect: "Discover and connect", | ||
exchange_data: "Exchange data with the device" | ||
exchange_data: "Exchange data with the device", | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Setting up the DMK | ||
|
||
The core package exposes a builder `DeviceManagementKitBuilder` which will be used to initialise the DMK with your configuration. | ||
|
||
For now it allows you to add one or more custom loggers and transports. | ||
|
||
In the following example, we add a console logger (`.addLogger(new ConsoleLogger())`), then the WebHID transport (`.addTransport(webHidTransportFactory)`). | ||
Then we build the DMK with `.build()`. | ||
|
||
**The returned object will be the entrypoint for all your interactions with the DMK. You should keep it as a <u>SINGLETON</u>.** | ||
|
||
The DMK should be built only once in your application runtime so keep a reference of this object somewhere. | ||
|
||
```ts | ||
import { | ||
ConsoleLogger, | ||
DeviceManagementKitBuilder, | ||
} from "@ledgerhq/device-management-kit"; | ||
import { webHidTransportFactory } from "@ledgerhq/device-transport-kit-web-hid"; | ||
|
||
export const dmk = new DeviceManagementKitBuilder() | ||
.addLogger(new ConsoleLogger()) | ||
.addTransport(webHidTransportFactory) | ||
.build(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Setup | ||
|
||
## Description | ||
|
||
This package contains the core of the Device Management Kit. It provides a simple interface to handle Ledger devices and features the Device Management Kit's entry points, classes, types, structures, and models. | ||
|
||
## Installation | ||
|
||
To install the dmk package, run the following command: | ||
|
||
```sh | ||
npm install @ledgerhq/device-management-kit | ||
``` | ||
|
||
## Usage | ||
|
||
### Compatibility | ||
|
||
This library works in [any browser supporting the WebHID API](https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API#browser_compatibility). | ||
|
||
### Pre-requisites | ||
|
||
Some of the APIs exposed return objects of type `Observable` from RxJS. Ensure you are familiar with the basics of the Observer pattern and RxJS before using the DMK. You can refer to [RxJS documentation](https://rxjs.dev/guide/overview) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import { Callout } from "nextra/components"; | ||
|
||
# Documentation | ||
|
||
Here you will find the all the documention related to the device management kit and all the signer coming along with it. | ||
|
||
<Callout type="warning" emoji="⚠️"> | ||
This project is still in early development so we allow ourselves to make | ||
breaking changes regarding the usage of the Libraries. | ||
|
||
That's why any feedback is relevant for us in order to be able to make it stable as soon as | ||
possible. Get in touch with us on the [Ledger Discord | ||
server](https://developers.ledger.com/discord/) to provide your feedbacks. | ||
|
||
You can follow the migration guidelines [here](./migrations/) | ||
|
||
</Callout> | ||
|
||
## Glossary | ||
|
||
Throughout all the documentation we will use several acronyms that you can find the following description : | ||
|
||
- DMK: Device Management Kit | ||
- DSK: Device Signer Kit | ||
|
||
## Libraries | ||
|
||
Here you can found a summary of all the libraries that are composing the DMK | ||
|
||
| Library | NPM | Version | | ||
| ---------------------- | -------------------------------------------------------------------------------------------------------------- | ------- | | ||
| Device Management Kit | [@LedgerHQ/device-mangement-kit](https://www.npmjs.com/package/@ledgerhq/device-management-kit) | 0.6.0 | | ||
| Device Signer Ethereum | [@LedgerHQ/device-signer-kit-ethereum](https://www.npmjs.com/package/@ledgerhq/device-signer-kit-ethereum) | 1.2.0 | | ||
| WebHidTransport | [@ledgerhq/device-transport-kit-web-hid](https://www.npmjs.com/package/@ledgerhq/device-transport-kit-web-hid) | 1.0.0 | | ||
| WebBleTransport | [@ledgerhq/device-transport-kit-web-ble](https://www.npmjs.com/package/@ledgerhq/device-transport-kit-web-ble) | 1.0.0 | |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
export default { | ||
introduction: "Why the Device Management Kit?", | ||
ledgerjs: "Differences with LedgerJS", | ||
dmk: "Device Management Kit", | ||
signers: "Signer kits", | ||
transports: "Transports", | ||
}; |
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 6 additions & 3 deletions
9
...evice-interaction/explanation/signers.mdx → ...vice-interaction/explanations/signers.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,14 @@ | ||
# What are Device Signer Kits? | ||
# Signer Kits | ||
|
||
As ledger devices are able to install applications that will allow to be compatible with different blockchains, we have created Device Signer Kits. | ||
As ledger devices are able to install applications that will allow to be compatible with different blockchains, | ||
we have created these kits. | ||
|
||
Each **signer kit** is coming along with a Ledger Embedded App (ex: _signer-kit-eth_ is coming with _ledger app ethereum_ ). | ||
|
||
The main goal of each signer is to ease interaction with the app in the most seamless way possible. | ||
|
||
## Available Signers | ||
|
||
- [Signer Ethereum](../references/signers/eth) | ||
- [Signer Bitcoin](./signers/btc) | ||
- [Signer Ethereum](./signers/eth) | ||
- [Signer Solana](./signers/solana) |
File renamed without changes.
Oops, something went wrong.