@bitcoinerlab/descriptors 1.0.0 → 1.0.2

package/dist/ledger.d.ts

@@ -7,7 +7,7 @@ import type { DescriptorInterface } from './types';
  * @param {unknown} ledgerClient - An optional parameter that, if provided, is checked to see if it's an instance of `AppClient`.
  * @throws {Error} Throws an error if `ledgerClient` is provided but is not an instance of `AppClient`.
  * @throws {Error} Throws an error if the 'ledger-bitcoin' module cannot be imported. This typically indicates that the 'ledger-bitcoin' peer dependency is not installed.
- * @returns {Promise<any>} Returns a promise that resolves with the entire 'ledger-bitcoin' module if it can be successfully imported.
+ * @returns {Promise<unknown>} Returns a promise that resolves with the entire 'ledger-bitcoin' module if it can be successfully imported. We force it to return an unknown type so that the declaration of this function won't break projects that don't use ledger-bitcoin as dependency
  *
  * @example
  *
@@ -18,7 +18,7 @@ import type { DescriptorInterface } from './types';
  *   })
  *   .catch((error) => console.error(error));
  */
-export declare function importAndValidateLedgerBitcoin(ledgerClient?: unknown): Promise<typeof import("ledger-bitcoin")>;
+export declare function importAndValidateLedgerBitcoin(ledgerClient?: unknown): Promise<unknown>;
 export declare function assertLedgerApp({ transport, name, minVersion }: {
     transport: any;
     name: string;

package/dist/ledger.js

@@ -35,7 +35,7 @@ const re_1 = require("./re");
  * @param {unknown} ledgerClient - An optional parameter that, if provided, is checked to see if it's an instance of `AppClient`.
  * @throws {Error} Throws an error if `ledgerClient` is provided but is not an instance of `AppClient`.
  * @throws {Error} Throws an error if the 'ledger-bitcoin' module cannot be imported. This typically indicates that the 'ledger-bitcoin' peer dependency is not installed.
- * @returns {Promise<any>} Returns a promise that resolves with the entire 'ledger-bitcoin' module if it can be successfully imported.
+ * @returns {Promise<unknown>} Returns a promise that resolves with the entire 'ledger-bitcoin' module if it can be successfully imported. We force it to return an unknown type so that the declaration of this function won't break projects that don't use ledger-bitcoin as dependency
  *
  * @example
  *
@@ -115,7 +115,7 @@ function isLedgerStandard({ ledgerTemplate, keyRoots, network = bitcoinjs_lib_1.
     return false;
 }
 async function getLedgerMasterFingerPrint({ ledgerClient, ledgerState }) {
-    const { AppClient } = await importAndValidateLedgerBitcoin(ledgerClient);
+    const { AppClient } = (await importAndValidateLedgerBitcoin(ledgerClient));
     if (!(ledgerClient instanceof AppClient))
         throw new Error(`Error: pass a valid ledgerClient`);
     let masterFingerprint = ledgerState.masterFingerprint;
@@ -127,7 +127,7 @@ async function getLedgerMasterFingerPrint({ ledgerClient, ledgerState }) {
 }
 exports.getLedgerMasterFingerPrint = getLedgerMasterFingerPrint;
 async function getLedgerXpub({ originPath, ledgerClient, ledgerState }) {
-    const { AppClient } = await importAndValidateLedgerBitcoin(ledgerClient);
+    const { AppClient } = (await importAndValidateLedgerBitcoin(ledgerClient));
     if (!(ledgerClient instanceof AppClient))
         throw new Error(`Error: pass a valid ledgerClient`);
     if (!ledgerState.xpubs)
@@ -242,7 +242,7 @@ exports.descriptorToLedgerFormat = descriptorToLedgerFormat;
  *
  **/
 async function registerLedgerWallet({ descriptor, ledgerClient, ledgerState, policyName }) {
-    const { WalletPolicy, AppClient } = await importAndValidateLedgerBitcoin(ledgerClient);
+    const { WalletPolicy, AppClient } = (await importAndValidateLedgerBitcoin(ledgerClient));
     if (!(ledgerClient instanceof AppClient))
         throw new Error(`Error: pass a valid ledgerClient`);
     const result = await descriptorToLedgerFormat({

package/dist/signers.js

@@ -27,7 +27,7 @@ const ledgerSignaturesForInputIndex = (index, ledgerSignatures) => ledgerSignatu
     signature: partialSignature.signature
 }));
 async function signInputLedger({ psbt, index, descriptor, ledgerClient, ledgerState }) {
-    const { PsbtV2, DefaultWalletPolicy, WalletPolicy, AppClient } = await (0, ledger_1.importAndValidateLedgerBitcoin)(ledgerClient);
+    const { PsbtV2, DefaultWalletPolicy, WalletPolicy, AppClient } = (await (0, ledger_1.importAndValidateLedgerBitcoin)(ledgerClient));
     if (!(ledgerClient instanceof AppClient))
         throw new Error(`Error: pass a valid ledgerClient`);
     const result = await (0, ledger_1.descriptorToLedgerFormat)({
@@ -68,7 +68,7 @@ exports.signInputLedger = signInputLedger;
 //it clusters together wallet policy types before signing
 //it throws if it cannot sign any input.
 async function signLedger({ psbt, descriptors, ledgerClient, ledgerState }) {
-    const { PsbtV2, DefaultWalletPolicy, WalletPolicy, AppClient } = await (0, ledger_1.importAndValidateLedgerBitcoin)(ledgerClient);
+    const { PsbtV2, DefaultWalletPolicy, WalletPolicy, AppClient } = (await (0, ledger_1.importAndValidateLedgerBitcoin)(ledgerClient));
     if (!(ledgerClient instanceof AppClient))
         throw new Error(`Error: pass a valid ledgerClient`);
     const ledgerPolicies = [];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bitcoinerlab/descriptors",
   "homepage": "https://github.com/bitcoinerlab/descriptors",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "This library parses and creates Bitcoin Miniscript Descriptors and generates Partially Signed Bitcoin Transactions (PSBTs). It provides PSBT finalizers and signers for single-signature, BIP32 and Hardware Wallets.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -52,13 +52,6 @@
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "@bitcoinerlab/miniscript": "^1.2.1",
-    "@bitcoinerlab/secp256k1": "^1.0.2",
-    "bip32": "^3.1.0",
-    "bitcoinjs-lib": "^6.1.0",
-    "ecpair": "^2.1.0"
-  },
   "peerDependencies": {
     "ledger-bitcoin": "^0.2.2"
   },
@@ -89,5 +82,12 @@
     "regtest-client": "^0.2.0",
     "ts-node-dev": "^2.0.0",
     "typescript": "5.0"
+  },
+  "dependencies": {
+    "@bitcoinerlab/miniscript": "^1.2.1",
+    "@bitcoinerlab/secp256k1": "^1.0.5",
+    "bip32": "^4.0.0",
+    "bitcoinjs-lib": "^6.1.3",
+    "ecpair": "^2.1.0"
   }
 }