@ledgerhq/device-signer-kit-bitcoin 0.0.0-signer-eth-20250122093657 → 0.0.0-webhid-20250124103640

package/README.md

@@ -9,16 +9,17 @@ This module provides the implementation of the Ledger Bitcoin signer of the Devi
 
 ## 🔹 Index
 
-1. [How it works](#how-it-works)
-2. [Installation](#installation)
-3. [Initialisation](#initialisation)
-4. [Use Cases](#use-cases)
+1. [How it works](#-how-it-works)
+2. [Installation](#-installation)
+3. [Initialisation](#-initialisation)
+4. [Use Cases](#-use-cases)
    - [Get Extended Public Key](#use-case-1-get-extended-public-key)
    - [Sign Message](#use-case-2-sign-message)
    - [Sign Partially Signed Transaction (PSBT)](#use-case-3-sign-psbt)
    - [Sign Transaction](#use-case-4-sign-transaction)
-5. [Observable Behavior](#observable-behavior)
-6. [Example](#example)
+   - [Get Wallet address](#use-case-5-get-wallet-address)
+5. [Observable Behavior](#-observable-behavior)
+6. [Example](#-example)
 
 ## 🔹 How it works
 
@@ -39,7 +40,7 @@ npm install @ledgerhq/device-signer-kit-bitcoin
 To initialise a Bitcoin signer instance, you need a Ledger Device Management Kit instance and the ID of the session of the connected device. Use the `SignerBtcBuilder` along with the [Context Module](https://github.com/LedgerHQ/device-sdk-ts/tree/develop/packages/signer/context-module) by default developed by Ledger:
 
 ```typescript
-// Initialize a Bitcoin signer instance
+// Initialise a Bitcoin signer instance
 const signerBitcoin = new SignerBtcBuilder({ sdk, sessionId }).build();
 ```
 
@@ -49,7 +50,7 @@ The `SignerBtcBuilder.build()` method will return a `SignerBitcoin` instance tha
 
 ---
 
-### Use Case 1: Get Extended Public Key
+### Use Case 1: Get extended public key
 
 This method allows users to retrieve the Bitcoin extended public key based on a given `derivationPath`.
 
@@ -65,7 +66,7 @@ const { observable, cancel } = signerBitcoin.getExtendedPublicKey(
 - `derivationPath`
 
   - **Required**
-  - **Type:** `string` (e.g. `"84'/0'/0'"` for a Native Segwit wallet)
+  - **Type:** `string` (e.g. `"84'/0'/0'"` for a Native SegWit wallet)
   - The derivation path used for the Bitcoin address. See [here](https://www.ledger.com/blog/understanding-crypto-addresses-and-derivation-paths) for more information.
 
 - `options`
@@ -83,7 +84,7 @@ const { observable, cancel } = signerBitcoin.getExtendedPublicKey(
 
 #### **Returns**
 
-- `observable` Emits DeviceActionState updates, including the following details::
+- `observable` Emits DeviceActionState updates, including the following details:
 
 ```typescript
 type GetAddressCommandResponse = {
@@ -95,7 +96,7 @@ type GetAddressCommandResponse = {
 
 ---
 
-### Use Case 2: Sign Message
+### Use Case 2: Sign message
 
 This method allows users to sign a text string that is displayed on Ledger devices.
 
@@ -111,18 +112,18 @@ const { observable, cancel } = signerBitcoin.signMessage(
 - `derivationPath`
 
   - **Required**
-  - **Type:** `string` (e.g. `"84'/0'/0'"` for a Native Segwit wallet)
+  - **Type:** `string` (e.g. `"84'/0'/0'"` for a Native SegWit wallet)
   - The derivation path used for the Bitcoin address. See [here](https://www.ledger.com/blog/understanding-crypto-addresses-and-derivation-paths) for more information.
 
 - `message`
 
   - **Required**
-  - **Type:**: `string`
+  - **Type:** `string`
   - The message to be signed, which will be displayed on the Ledger device.
 
 #### **Returns**
 
-- `observable` Emits DeviceActionState updates, including the following details::
+- `observable` Emits DeviceActionState updates, including the following details:
 
 ```typescript
 type Signature = {
@@ -159,7 +160,7 @@ const { observable, cancel } = signerBitcoin.signPsbt(
 
   class DefaultWallet {
     constructor(
-      // Derivation path without master key respresentation.
+      // Derivation path without master key representation.
       // Format example: /44'/0'/0'
       public derivationPath: string,
       public template: DefaultDescriptorTemplate,
@@ -178,19 +179,38 @@ const { observable, cancel } = signerBitcoin.signPsbt(
 
 - `psbt`
   - **Required**
-  - **Type:** `string`
-  - The base64 psbt string
+  - **Type:** `string | Psbt`
+  - A base64/hex psbt string or [bitcoin-js Psbt](https://github.com/bitcoinjs/bitcoinjs-lib/blob/151173f05e26a9af7c98d8d1e3f90e97185955f1/ts_src/psbt.ts#L131)
 
 #### **Returns**
 
-- `observable` Emits DeviceActionState updates, including the following details::
+- `observable` Emits DeviceActionState updates, including the following details:
 
 ```typescript
-type Signature = {
-  r: `0x${string}`; // R component of the signature
-  s: `0x${string}`; // S component of the signature
-  v: number; // Recovery parameter
+type PartialSignature = {
+  inputIndex: number;
+  pubkey: Uint8Array;
+  signature: Uint8Array;
+  tapleafHash?: Uint8Array;
 };
+
+type MusigPubNonce = {
+  inputIndex: number;
+  participantPubkey: Uint8Array;
+  aggregatedPubkey: Uint8Array;
+  tapleafHash: Uint8Array;
+  pubnonce: Uint8Array;
+};
+
+type MusigPartialSignature = {
+  inputIndex: number;
+  participantPubkey: Uint8Array;
+  aggregatedPubkey: Uint8Array;
+  tapleafHash: Uint8Array;
+  partialSignature: Uint8Array;
+};
+
+type PsbtSignature = PartialSignature | MusigPartialSignature | MusigPubNonce;
 ```
 
 - `cancel` A function to cancel the action on the Ledger device.
@@ -220,7 +240,7 @@ const { observable, cancel } = signerBitcoin.signTransaction(
 
   class DefaultWallet {
     constructor(
-      // Derivation path without master key respresentation.
+      // Derivation path without master key representation.
       // Format example: /44'/0'/0'
       public derivationPath: string,
       public template: DefaultDescriptorTemplate,
@@ -239,23 +259,71 @@ const { observable, cancel } = signerBitcoin.signTransaction(
 
   - `psbt`
     - **Required**
-    - **Type:** `string`
-    - The base64 psbt string
+    - **Type:** `string | Psbt`
+    - A base64/hex psbt string or [bitcoin-js Psbt](https://github.com/bitcoinjs/bitcoinjs-lib/blob/151173f05e26a9af7c98d8d1e3f90e97185955f1/ts_src/psbt.ts#L131)
 
 #### **Returns**
 
-- `observable` Emits DeviceActionState updates, including the following details::
+- `observable` Emits DeviceActionState updates, including the following details:
 
 ```typescript
-type Signature = {
-  r: `0x${string}`; // R component of the signature
-  s: `0x${string}`; // S component of the signature
-  v: number; // Recovery parameter
+type TransactionHash = `0x${string}`;
+```
+
+- `cancel` A function to cancel the action on the Ledger device.
+
+### Use Case 5: Get wallet address
+
+This method allows users to get the wallet address linked to a Ledger device.
+
+```typescript
+const { observable, cancel } = signerBitcoin.getWalletAddress(
+  derivationPath,
+  addressIndex,
+  options,
+);
+```
+
+#### **Parameters**
+
+- `derivationPath`
+
+  - **Required**
+  - **Type:** `string` (e.g. `"84'/0'/0'"` for a Native SegWit wallet)
+  - The derivation path used for the Bitcoin address. See [here](https://www.ledger.com/blog/understanding-crypto-addresses-and-derivation-paths) for more information.
+
+- `addressIndex`
+
+  - **Required**
+  - **Type:** `number`
+  - The desired address index on the Ledger device.
+
+- `options`
+
+  - Optional
+  - Type: `WalletAddressOptions`
+
+  ```typescript
+  type WalletAddressOptions = {
+    checkOnDevice?: boolean;
+    change?: boolean;
+  };
+  ```
+
+#### **Returns**
+
+- `observable` Emits DeviceActionState updates, including the following details:
+
+```typescript
+type WalletAddress = {
+  address: string;
 };
 ```
 
 - `cancel` A function to cancel the action on the Ledger device.
 
+---
+
 ## 🔹 Observable Behavior
 
 Each method returns an [Observable](https://rxjs.dev/guide/observable) emitting updates structured as [`DeviceActionState`](https://github.com/LedgerHQ/device-sdk-ts/blob/develop/packages/device-management-kit/src/api/device-action/model/DeviceActionState.ts). These updates reflect the operation’s progress and status:
@@ -299,8 +367,8 @@ observable.subscribe({
       }
       case DeviceActionStatus.Error: {
         const { error } = state;
-        // Access the error here if occured
-        console.log("An error occured during the action: ", error);
+        // Access the error here if occurred
+        console.log("An error occurred during the action: ", error);
         break;
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/device-signer-kit-bitcoin",
-  "version": "0.0.0-signer-eth-20250122093657",
+  "version": "0.0.0-webhid-20250124103640",
   "license": "Apache-2.0",
   "main": "lib/cjs/index.js",
   "types": "lib/cjs/index.d.ts",
@@ -33,17 +33,17 @@
     "bitcoinjs-lib": "^6.1.6",
     "rxjs": "^7.8.1",
     "ts-node": "^10.9.2",
-    "@ledgerhq/device-management-kit": "0.0.0-signer-eth-20250122093657",
-    "@ledgerhq/esbuild-tools": "0.0.2",
+    "@ledgerhq/device-management-kit": "0.0.0-webhid-20250124103640",
     "@ledgerhq/eslint-config-dsdk": "0.0.2",
     "@ledgerhq/jest-config-dsdk": "1.0.1",
     "@ledgerhq/prettier-config-dsdk": "0.0.2",
-    "@ledgerhq/signer-utils": "0.0.0-signer-eth-20250122093657",
+    "@ledgerhq/signer-utils": "1.0.2",
+    "@ledgerhq/esbuild-tools": "0.0.2",
     "@ledgerhq/tsconfig-dsdk": "1.0.1"
   },
   "peerDependencies": {
     "bitcoinjs-lib": "^6.1.6",
-    "@ledgerhq/device-management-kit": "0.0.0-signer-eth-20250122093657"
+    "@ledgerhq/device-management-kit": "0.0.0-webhid-20250124103640"
   },
   "scripts": {
     "prebuild": "rimraf lib",