Merge pull request LedgerHQ#147 from bitcoinerlab/new-synced-branch

javascript: Improve usability for 3rd parties: update README, expose types, and remove unused dependency
bitcoinerlab · Apr 20, 2023 · 0981826 · 0981826
2 parents 1271309 + 22298b8
commit 0981826
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/bitcoin_client_js/README.md b/bitcoin_client_js/README.md
@@ -6,11 +6,17 @@ TypeScript client for Ledger Bitcoin application. Supports versions 2.1.0 and ab
 
 Main repository and documentation: https://github.com/LedgerHQ/app-bitcoin-new
 
-<!--
 ## Install
 
-TODO: fill this once the module is published
--->
+```bash
+$ yarn add ledger-bitcoin
+```
+
+Or if you prefer using npm:
+
+```bash
+$ npm install ledger-bitcoin
+```
 
 ## Building
 

diff --git a/bitcoin_client_js/package.json b/bitcoin_client_js/package.json
@@ -31,8 +31,7 @@
   "dependencies": {
     "@ledgerhq/hw-transport": "^6.20.0",
     "bip32-path": "^0.4.2",
-    "bitcoinjs-lib": "^6.0.1",
-    "tiny-secp256k1": "^2.1.2"
+    "bitcoinjs-lib": "^6.0.1"
   },
   "devDependencies": {
     "@ledgerhq/hw-transport-node-speculos-http": "^6.24.1",
@@ -71,4 +70,4 @@
   "prettier": {
     "singleQuote": true
   }
-}
+}
diff --git a/bitcoin_client_js/src/index.ts b/bitcoin_client_js/src/index.ts
@@ -1,4 +1,4 @@
-import AppClient from './lib/appClient';
+import AppClient, { PartialSignature } from './lib/appClient';
 import {
   DefaultDescriptorTemplate,
   DefaultWalletPolicy,
@@ -11,6 +11,7 @@ export {
   PsbtV2,
   DefaultDescriptorTemplate,
   DefaultWalletPolicy,
+  PartialSignature,
   WalletPolicy
 };