🚚 (core) [DSDK-570]: Rename Sdk and Keyring (#460)

LedgerHQ · Oct 31, 2024 · 7140b4f · 7140b4f
2 parents 56e3f00 + c3e8066
commit 7140b4f
Show file tree

Hide file tree

Showing 553 changed files with 680 additions and 657 deletions.
diff --git a/.changeset/calm-months-live.md b/.changeset/calm-months-live.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": minor
+"@ledgerhq/device-signer-kit-btc": minor
 ---
 
 Implement MerkleTree and MerkleMap services
diff --git a/.changeset/clever-badgers-pull.md b/.changeset/clever-badgers-pull.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/device-sdk-sample": minor
+"@ledgerhq/device-management-kit-sample": minor
 ---
 
 Add GetAddress Solana Signer use case
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -12,5 +12,5 @@
   "access": "public",
   "baseBranch": "develop",
   "updateInternalDependencies": "patch",
-  "ignore": ["@ledgerhq/keyring-btc"]
+  "ignore": ["@ledgerhq/device-signer-kit-btc"]
 }
diff --git a/.changeset/cool-dancers-join.md b/.changeset/cool-dancers-join.md
@@ -5,7 +5,7 @@
 "@ledgerhq/device-signer-kit-ethereum": patch
 "@ledgerhq/tsconfig-dsdk": patch
 "@ledgerhq/prettier-config-dsdk": patch
-"@ledgerhq/device-sdk-transport-mock": patch
+"@ledgerhq/device-transport-kit-mock-client": patch
 "@ledgerhq/eslint-config-dsdk": patch
 "@ledgerhq/device-sdk-trusted-apps": patch
 "@ledgerhq/jest-config-dsdk": patch

diff --git a/.changeset/cuddly-ducks-confess.md b/.changeset/cuddly-ducks-confess.md
@@ -0,0 +1,7 @@
+---
+"@ledgerhq/device-signer-kit-solana": patch
+"@ledgerhq/device-signer-kit-ethereum": patch
+"@ledgerhq/device-management-kit-sample": patch
+---
+
+Rename keyring to signer
diff --git a/.changeset/cuddly-impalas-sing.md b/.changeset/cuddly-impalas-sing.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": minor
+"@ledgerhq/device-signer-kit-btc": minor
 ---
 
 Implement GetExtendedPublicKeyCommand
diff --git a/.changeset/lemon-suits-notice.md b/.changeset/lemon-suits-notice.md
@@ -0,0 +1,10 @@
+---
+"@ledgerhq/device-management-kit-flipper-plugin-client": patch
+"@ledgerhq/device-signer-kit-solana": patch
+"@ledgerhq/device-signer-kit-ethereum": patch
+"@ledgerhq/device-transport-kit-mock-client": patch
+"@ledgerhq/device-management-kit": patch
+"@ledgerhq/device-management-kit-sample": patch
+---
+
+Rename SDK to DMK
diff --git a/.changeset/lucky-keys-explode.md b/.changeset/lucky-keys-explode.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": minor
+"@ledgerhq/device-signer-kit-btc": minor
 ---
 
 Implement GetMasterFingerprintCommand
diff --git a/.changeset/mighty-vans-kiss.md b/.changeset/mighty-vans-kiss.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": patch
+"@ledgerhq/device-signer-kit-btc": patch
 ---
 
 Implement wallet policy service
diff --git a/.changeset/nine-tools-bow.md b/.changeset/nine-tools-bow.md
@@ -1,7 +1,7 @@
 ---
 "@ledgerhq/device-management-kit-flipper-plugin-client": patch
 "@ledgerhq/device-management-kit": patch
-"@ledgerhq/device-sdk-sample": patch
+"@ledgerhq/device-management-kit-sample": patch
 ---
 
 Implement basic Flipper client for the Ledger Device Management Kit
diff --git a/.changeset/perfect-deers-sneeze.md b/.changeset/perfect-deers-sneeze.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": patch
+"@ledgerhq/device-signer-kit-btc": patch
 ---
 
 Rename packages
diff --git a/.changeset/smart-games-brush.md b/.changeset/smart-games-brush.md
@@ -1,7 +1,7 @@
 ---
-"@ledgerhq/device-sdk-transport-mock": patch
+"@ledgerhq/device-transport-kit-mock-client": patch
 "@ledgerhq/device-management-kit": patch
-"@ledgerhq/device-sdk-sample": patch
+"@ledgerhq/device-management-kit-sample": patch
 ---
 
 Add mockserver integration with transport
diff --git a/.changeset/tall-hairs-cheer.md b/.changeset/tall-hairs-cheer.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": minor
+"@ledgerhq/device-signer-kit-btc": minor
 ---
 
-Create keyring-btc package
+Create device-signer-kit-btc package
diff --git a/.changeset/tasty-falcons-doubt.md b/.changeset/tasty-falcons-doubt.md
@@ -3,7 +3,7 @@
 "@ledgerhq/signer-utils": patch
 "@ledgerhq/device-signer-kit-ethereum": patch
 "@ledgerhq/device-management-kit": patch
-"@ledgerhq/device-sdk-sample": patch
+"@ledgerhq/device-management-kit-sample": patch
 ---
 
 Use type keyword when importing type
diff --git a/.changeset/tiny-hornets-grin.md b/.changeset/tiny-hornets-grin.md
@@ -1,6 +1,6 @@
 ---
 "@ledgerhq/device-management-kit": patch
-"@ledgerhq/device-sdk-sample": patch
+"@ledgerhq/device-management-kit-sample": patch
 ---
 
 Add unlock timeout input in open app device action
diff --git a/.changeset/tiny-otters-draw.md b/.changeset/tiny-otters-draw.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/device-sdk-sample": minor
+"@ledgerhq/device-management-kit-sample": minor
 ---
 
 Add keyring eth provider
diff --git a/.changeset/twelve-snakes-agree.md b/.changeset/twelve-snakes-agree.md
@@ -1,6 +1,6 @@
 ---
 "@ledgerhq/device-management-kit": patch
-"@ledgerhq/device-sdk-sample": patch
+"@ledgerhq/device-management-kit-sample": patch
 ---
 
 New use case listenToKnownDevices
diff --git a/.changeset/weak-ads-chew.md b/.changeset/weak-ads-chew.md
@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/keyring-btc": patch
+"@ledgerhq/device-signer-kit-btc": patch
 ---
 
 Implement PSBT parser and mapper services
diff --git a/README.md b/README.md
@@ -4,9 +4,6 @@
   <p align="center">
   <!-- Update with each individual package version -->
     <!-- Enable and display when CI set up -->
-    <!-- <a href="https://github.com/LedgerHQ/platform-sdk/actions">
-      <img alt="Tests Passing" src="https://github.com/LedgerHQ/platform-sdk/workflows/CI/badge.svg" />
-    </a> -->
     <a href="https://www.typescriptlang.org/">
       <img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white" />
     </a>
@@ -29,6 +26,10 @@
     <a href="https://www.npmjs.com/">
       <img alt="NPM" src="https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white" />
     </a>
+<br />
+    <a href="https://github.com/LedgerHQ/device-sdk-ts/actions/workflows/pull_request.yml">
+      <img alt="Pull request Tests Passing" src="https://github.com/LedgerHQ/device-sdk-ts/actions/workflows/pull_request.yml/badge.svg" />
+    </a>
   </p>
 
   <p align="center">
@@ -61,7 +62,7 @@ The Device Management Kit features an interface for applications to handle any L
 
 ```mermaid
   flowchart LR;
-      application(Application) <--API--> DSDK(DeviceSDK) <--USB/BLE--> device(Device);
+      application(Application) <--API--> LDMK(LedgerDeviceManagementKit) <--USB/BLE--> device(Device);
 ```
 
 The Device Management Kit is available in 3 different environments (web, Android & iOS).
@@ -72,24 +73,24 @@ This repository is dedicated to **web environment** and is written in TypeScript
 
 ### Repository
 
-The Device Management Kit is structured as a monorepository whose prupose is to centralise all the TypeScript code related to the SDK in one place.
+The Device Management Kit is structured as a monorepository whose prupose is to centralise all the TypeScript code related to the Device Management Kit in one place.
 
 This project uses [turbo monorepo](https://turbo.build/repo/docs) to build and release different packages on NPM registry and a sample demo application on Vercel.
 
 ### Modules
 
 A brief description of this project packages:
 
-| Name                              | Path                       | Description                                                                                                                              |
-| --------------------------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| @ledgerhq/device-sdk-sample       | apps/sample                | React Next web app used to test & demonstrate the Web Device Management Kit                                                              |
-| @ledgerhq/eslint-config-dsdk      | packages/config/eslint     | internal package which contains eslint shared config. Used by `extends: ["@ledgerhq/dsdk"]` in `.eslintrc`.                              |
-| @ledgerhq/jest-config-dsdk        | packages/config/jest       | internal package which contains jest shared config. Used by `preset: "@ledgerhq/jest-config-dsdk"` in `jest.config.ts`                   |
-| @ledgerhq/tsconfig-dsdk           | packages/config/typescript | internal package which contains typescript shared config. Used by `"extends": "@ledgerhq/tsconfig-dsdk/tsconfig.sdk"` in `tsconfig.json` |
-| @ledgerhq/device-management-kit   | packages/core              | external package that contains the core of the Web SDK                                                                                   |
-| @ledgerhq/device-sdk-signer       | packages/signer            | external package that contains device coin application dedicated handlers                                                                |
-| @ledgerhq/device-sdk-trusted-apps | packages/trusted-apps      | external package that contains device trusted application dedicated handlers                                                             |
-| @ledgerhq/device-sdk-ui           | packages/ui                | external package                                                                                                                         |
+| Name                                   | Path                           | Description                                                                                                                              |
+|----------------------------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| @ledgerhq/device-management-kit-sample | apps/sample                    | React Next web app used to test & demonstrate the Web Device Management Kit                                                              |
+| @ledgerhq/eslint-config-dsdk           | packages/config/eslint         | internal package which contains eslint shared config. Used by `extends: ["@ledgerhq/dsdk"]` in `.eslintrc`.                              |
+| @ledgerhq/jest-config-dsdk             | packages/config/jest           | internal package which contains jest shared config. Used by `preset: "@ledgerhq/jest-config-dsdk"` in `jest.config.ts`                   |
+| @ledgerhq/tsconfig-dsdk                | packages/config/typescript     | internal package which contains typescript shared config. Used by `"extends": "@ledgerhq/tsconfig-dsdk/tsconfig.sdk"` in `tsconfig.json` |
+| @ledgerhq/device-management-kit        | packages/device-management-kit | external package that contains the core of the Web Device Management Kit                                                                 |
+| @ledgerhq/device-signer-kit-ethereum   | packages/signer/signer-eth     | external package that contains device ethereum coin application dedicated handlers                                                       |
+| @ledgerhq/device-signer-kit-solana     | packages/signer/signer-solana  | external package that contains device solana coin application dedicated handlers                                                         |
+| @ledgerhq/device-management-kit-flipper-plugin-client     | packages/flipper-plugin-client | external package that contains [flipper](https://github.com/facebook/flipper) logger for Device Management Kit                                                              |
 
 # Getting started
 
@@ -182,7 +183,7 @@ Each package is built using the following command (at the root of the monorepo).
 Device Management Kit main module.
 
 ```bash
-pnpm core build
+pnpm dmk build
 ```
 
 ### Signer
@@ -258,7 +259,7 @@ Finally, we should add a script in the correct `package.json` as a shortcut to t
 eg:
 
 ```
-pnpm core module:create
+pnpm dmk module:create
 ```
 
 Under the hood, the script looks like this:

diff --git a/apps/sample/next.config.js b/apps/sample/next.config.js
@@ -23,7 +23,7 @@ const sentryWebpackPluginOptions = {
 
   silent: true,
   org: "ledger",
-  project: "device-sdk-sample",
+  project: "device-management-kit-sample",
 
   // Additional Sentry options
   widenClientFileUpload: true, // Upload a larger set of source maps for prettier stack traces (increases build time)

diff --git a/apps/sample/package.json b/apps/sample/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@ledgerhq/device-sdk-sample",
+  "name": "@ledgerhq/device-management-kit-sample",
   "version": "0.1.3",
   "private": true,
   "scripts": {
@@ -20,7 +20,7 @@
     "@ledgerhq/device-management-kit-flipper-plugin-client": "workspace:*",
     "@ledgerhq/device-signer-kit-ethereum": "workspace:*",
     "@ledgerhq/device-signer-kit-solana": "workspace:*",
-    "@ledgerhq/device-sdk-transport-mock": "workspace:*",
+    "@ledgerhq/device-transport-kit-mock-client": "workspace:*",
     "@ledgerhq/react-ui": "^0.16.2",
     "@sentry/nextjs": "^8.32.0",
     "@playwright/test": "^1.47.0",

diff --git a/apps/sample/playwright/cases/eth_get-address_happy-paths.spec.ts b/apps/sample/playwright/cases/eth_get-address_happy-paths.spec.ts
@@ -40,7 +40,7 @@ test.describe("ETH Signer: get address, happy paths", () => {
     });
 
     await test.step("When execute ETH: get address", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 
@@ -75,7 +75,7 @@ test.describe("ETH Signer: get address, happy paths", () => {
     });
 
     await test.step("When execute ETH: get address with checkOnDevice on", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 
@@ -125,7 +125,7 @@ test.describe("ETH Signer: get address, happy paths", () => {
     });
 
     await test.step("Then execute ETH: get address", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 

diff --git a/apps/sample/playwright/cases/eth_get-address_unhappy-paths.spec.ts b/apps/sample/playwright/cases/eth_get-address_unhappy-paths.spec.ts
@@ -36,7 +36,7 @@ test.describe("ETH Signer: get address, unhappy paths", () => {
     });
 
     await test.step("Then execute ETH: get address with malformed derivation paths", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
       await whenClicking(page, "CTA_command-Ethereum");
 
       const malformedDerivationPaths = [

diff --git a/apps/sample/playwright/cases/eth_sign-message_happy-paths.spec.ts b/apps/sample/playwright/cases/eth_sign-message_happy-paths.spec.ts
@@ -37,7 +37,7 @@ test.describe("ETH Signer: sign message, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign message", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
       await whenClicking(page, "CTA_command-Ethereum");
 
       await whenExecuteDeviceAction(page, "Sign message", [
@@ -75,7 +75,7 @@ test.describe("ETH Signer: sign message, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign message", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 
@@ -137,7 +137,7 @@ test.describe("ETH Signer: sign message, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign message", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 

diff --git a/apps/sample/playwright/cases/eth_sign-message_unhappy-paths.spec.ts b/apps/sample/playwright/cases/eth_sign-message_unhappy-paths.spec.ts
@@ -37,7 +37,7 @@ test.describe("ETH Signer: sign message, unhappy paths", () => {
     });
 
     await test.step("When execute ETH: sign message with malformed derivation paths", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
       await whenClicking(page, "CTA_command-Ethereum");
 
       const malformedDerivationPaths = [

diff --git a/apps/sample/playwright/cases/eth_sign-transaction_happy-paths.spec.ts b/apps/sample/playwright/cases/eth_sign-transaction_happy-paths.spec.ts
@@ -40,7 +40,7 @@ test.describe("ETH Signer: sign transaction, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign transaction", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 
@@ -79,7 +79,7 @@ test.describe("ETH Signer: sign transaction, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign transaction", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 

diff --git a/apps/sample/playwright/cases/eth_sign-transaction_unhappy-paths.spec.ts b/apps/sample/playwright/cases/eth_sign-transaction_unhappy-paths.spec.ts
@@ -37,7 +37,7 @@ test.describe("ETH Signer: sign transaction, unhappy paths", () => {
     });
 
     await test.step("When execute ETH: sign transaction with malformed derivation paths", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
       await whenClicking(page, "CTA_command-Ethereum");
 
       const malformedDerivationPaths = [

diff --git a/apps/sample/playwright/cases/eth_sign-typed-message-happy-paths.spec.ts b/apps/sample/playwright/cases/eth_sign-typed-message-happy-paths.spec.ts
@@ -37,7 +37,7 @@ test.describe("ETH Signer: sign EIP712 message, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign EIP712 message", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
       await whenClicking(page, "CTA_command-Ethereum");
 
       await whenExecuteDeviceAction(page, "Sign typed message", [
@@ -76,7 +76,7 @@ test.describe("ETH Signer: sign EIP712 message, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign EIP712 message", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
       await whenClicking(page, "CTA_command-Ethereum");
 
       await whenExecuteDeviceAction(page, "Sign typed message", [
@@ -139,7 +139,7 @@ test.describe("ETH Signer: sign EIP712 message, happy paths", () => {
     });
 
     await test.step("When execute ETH: sign EIP712 message", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");
 

diff --git a/apps/sample/playwright/cases/eth_sign-typed-message-unhappy-paths.spec.ts b/apps/sample/playwright/cases/eth_sign-typed-message-unhappy-paths.spec.ts
@@ -37,7 +37,7 @@ test.describe("ETH Signer: sign EIP712 message, unhappy paths", () => {
     });
 
     await test.step("When execute ETH: sign typed message with malformed derivation paths", async () => {
-      await whenNavigateTo(page, "/keyring");
+      await whenNavigateTo(page, "/signer");
 
       await whenClicking(page, "CTA_command-Ethereum");