@bitcoinerlab/descriptors 2.3.3 → 2.3.4

package/dist/descriptors.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Network, Payment, Psbt } from 'bitcoinjs-lib';
 import type { PartialSig } from 'bip174/src/lib/interfaces';
 import { BIP32API } from 'bip32';
@@ -31,7 +29,7 @@ import type { TinySecp256k1Interface, Preimage, TimeConstraints, Expansion, Expa
  * [@bitcoinerlab/secp256k1](https://github.com/bitcoinerlab/secp256k1).
  */
 export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
-    /** @deprecated */ Descriptor: {
+    /** @deprecated @hidden */ Descriptor: {
         new ({ expression, ...rest }: {
             expression: string;
             index?: number;
@@ -41,18 +39,18 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
             preimages?: Preimage[];
             signersPubKeys?: Buffer[];
         }): {
-            readonly "__#1@#payment": Payment;
-            readonly "__#1@#preimages": Preimage[];
-            readonly "__#1@#signersPubKeys": Buffer[];
-            readonly "__#1@#miniscript"?: string;
-            readonly "__#1@#witnessScript"?: Buffer;
-            readonly "__#1@#redeemScript"?: Buffer;
-            readonly "__#1@#isSegwit"?: boolean;
-            readonly "__#1@#isTaproot"?: boolean;
-            readonly "__#1@#expandedExpression"?: string;
-            readonly "__#1@#expandedMiniscript"?: string;
-            readonly "__#1@#expansionMap"?: ExpansionMap;
-            readonly "__#1@#network": Network;
+            readonly "__#private@#payment": Payment;
+            readonly "__#private@#preimages": Preimage[];
+            readonly "__#private@#signersPubKeys": Buffer[];
+            readonly "__#private@#miniscript"?: string;
+            readonly "__#private@#witnessScript"?: Buffer;
+            readonly "__#private@#redeemScript"?: Buffer;
+            readonly "__#private@#isSegwit"?: boolean;
+            readonly "__#private@#isTaproot"?: boolean;
+            readonly "__#private@#expandedExpression"?: string;
+            readonly "__#private@#expandedMiniscript"?: string;
+            readonly "__#private@#expansionMap"?: ExpansionMap;
+            readonly "__#private@#network": Network;
             /**
              * Gets the TimeConstraints (nSequence and nLockTime) of the miniscript
              * descriptor as passed in the constructor, just using the expression,
@@ -67,7 +65,7 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * When running getScriptSatisfaction, using the final signatures,
              * satisfyMiniscript verifies that the time constraints did not change.
              */
-            "__#1@#getTimeConstraints"(): TimeConstraints | undefined;
+            "__#private@#getTimeConstraints"(): TimeConstraints | undefined;
             /**
              * Creates and returns an instance of bitcoinjs-lib
              * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
@@ -92,7 +90,7 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * Important: As mentioned above, note that this function only applies to
              * miniscript descriptors.
              */
-            getScriptSatisfaction(signatures: PartialSig[] | 'DANGEROUSLY_USE_FAKE_SIGNATURES'): Buffer;
+            getScriptSatisfaction(signatures: PartialSig[] | "DANGEROUSLY_USE_FAKE_SIGNATURES"): Buffer;
             /**
              * Gets the nSequence required to fulfill this `Output`.
              */
@@ -165,7 +163,7 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * Note however that tr(MINISCRIPT) is not yet supported for non-single-key
              * expressions.
              */
-            inputWeight(isSegwitTx: boolean, signatures: PartialSig[] | 'DANGEROUSLY_USE_FAKE_SIGNATURES'): number;
+            inputWeight(isSegwitTx: boolean, signatures: PartialSig[] | "DANGEROUSLY_USE_FAKE_SIGNATURES"): number;
             /**
              * Computes the Weight Unit contributions of this Output as if it were the
              * output in a tx.
@@ -232,15 +230,15 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
             /**
              * Adds this output as an output of the provided `psbt` with the given
              * value.
-             *
-             * @param psbt - The Partially Signed Bitcoin Transaction.
-             * @param value - The value for the output in satoshis.
+             * @param params - The parameters for the method.
+             * @param params.psbt - The Partially Signed Bitcoin Transaction.
+             * @param params.value - The value for the output in satoshis.
              */
             updatePsbtAsOutput({ psbt, value }: {
                 psbt: Psbt;
                 value: number;
             }): void;
-            "__#1@#assertPsbtInput"({ psbt, index }: {
+            "__#private@#assertPsbtInput"({ psbt, index }: {
                 psbt: Psbt;
                 index: number;
             }): void;
@@ -354,18 +352,18 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              */
             signersPubKeys?: Buffer[];
         }): {
-            readonly "__#1@#payment": Payment;
-            readonly "__#1@#preimages": Preimage[];
-            readonly "__#1@#signersPubKeys": Buffer[];
-            readonly "__#1@#miniscript"?: string;
-            readonly "__#1@#witnessScript"?: Buffer;
-            readonly "__#1@#redeemScript"?: Buffer;
-            readonly "__#1@#isSegwit"?: boolean;
-            readonly "__#1@#isTaproot"?: boolean;
-            readonly "__#1@#expandedExpression"?: string;
-            readonly "__#1@#expandedMiniscript"?: string;
-            readonly "__#1@#expansionMap"?: ExpansionMap;
-            readonly "__#1@#network": Network;
+            readonly "__#private@#payment": Payment;
+            readonly "__#private@#preimages": Preimage[];
+            readonly "__#private@#signersPubKeys": Buffer[];
+            readonly "__#private@#miniscript"?: string;
+            readonly "__#private@#witnessScript"?: Buffer;
+            readonly "__#private@#redeemScript"?: Buffer;
+            readonly "__#private@#isSegwit"?: boolean;
+            readonly "__#private@#isTaproot"?: boolean;
+            readonly "__#private@#expandedExpression"?: string;
+            readonly "__#private@#expandedMiniscript"?: string;
+            readonly "__#private@#expansionMap"?: ExpansionMap;
+            readonly "__#private@#network": Network;
             /**
              * Gets the TimeConstraints (nSequence and nLockTime) of the miniscript
              * descriptor as passed in the constructor, just using the expression,
@@ -380,7 +378,7 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * When running getScriptSatisfaction, using the final signatures,
              * satisfyMiniscript verifies that the time constraints did not change.
              */
-            "__#1@#getTimeConstraints"(): TimeConstraints | undefined;
+            "__#private@#getTimeConstraints"(): TimeConstraints | undefined;
             /**
              * Creates and returns an instance of bitcoinjs-lib
              * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
@@ -405,7 +403,7 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * Important: As mentioned above, note that this function only applies to
              * miniscript descriptors.
              */
-            getScriptSatisfaction(signatures: PartialSig[] | 'DANGEROUSLY_USE_FAKE_SIGNATURES'): Buffer;
+            getScriptSatisfaction(signatures: PartialSig[] | "DANGEROUSLY_USE_FAKE_SIGNATURES"): Buffer;
             /**
              * Gets the nSequence required to fulfill this `Output`.
              */
@@ -478,7 +476,7 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * Note however that tr(MINISCRIPT) is not yet supported for non-single-key
              * expressions.
              */
-            inputWeight(isSegwitTx: boolean, signatures: PartialSig[] | 'DANGEROUSLY_USE_FAKE_SIGNATURES'): number;
+            inputWeight(isSegwitTx: boolean, signatures: PartialSig[] | "DANGEROUSLY_USE_FAKE_SIGNATURES"): number;
             /**
              * Computes the Weight Unit contributions of this Output as if it were the
              * output in a tx.
@@ -545,15 +543,15 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
             /**
              * Adds this output as an output of the provided `psbt` with the given
              * value.
-             *
-             * @param psbt - The Partially Signed Bitcoin Transaction.
-             * @param value - The value for the output in satoshis.
+             * @param params - The parameters for the method.
+             * @param params.psbt - The Partially Signed Bitcoin Transaction.
+             * @param params.value - The value for the output in satoshis.
              */
             updatePsbtAsOutput({ psbt, value }: {
                 psbt: Psbt;
                 value: number;
             }): void;
-            "__#1@#assertPsbtInput"({ psbt, index }: {
+            "__#private@#assertPsbtInput"({ psbt, index }: {
                 psbt: Psbt;
                 index: number;
             }): void;

package/dist/descriptors.js

@@ -17,13 +17,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -39,7 +49,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DescriptorsFactory = void 0;
+exports.DescriptorsFactory = DescriptorsFactory;
 const lodash_memoize_1 = __importDefault(require("lodash.memoize"));
 const bitcoinjs_lib_1 = require("bitcoinjs-lib");
 const varuint_bitcoin_1 = require("varuint-bitcoin");
@@ -178,7 +188,7 @@ function DescriptorsFactory(ecc) {
         });
     };
     /**
-     * @hidden
+     * @overload
      * To be removed in v3.0 and replaced by the version with the signature that
      * does not accept descriptors
      */
@@ -1090,9 +1100,9 @@ expansion=${expansion}, isPKH=${isPKH}, isWPKH=${isWPKH}, isSH=${isSH}, isTR=${i
         /**
          * Adds this output as an output of the provided `psbt` with the given
          * value.
-         *
-         * @param psbt - The Partially Signed Bitcoin Transaction.
-         * @param value - The value for the output in satoshis.
+         * @param params - The parameters for the method.
+         * @param params.psbt - The Partially Signed Bitcoin Transaction.
+         * @param params.value - The value for the output in satoshis.
          */
         updatePsbtAsOutput({ psbt, value }) {
             psbt.addOutput({ script: this.getScriptPubKey(), value });
@@ -1251,7 +1261,7 @@ expansion=${expansion}, isPKH=${isPKH}, isWPKH=${isWPKH}, isSH=${isSH}, isTR=${i
     }
     return {
         // deprecated TAG must also be below so it is exported to descriptors.d.ts
-        /** @deprecated */ Descriptor,
+        /** @deprecated @hidden */ Descriptor,
         Output,
         parseKeyExpression,
         expand,
@@ -1259,4 +1269,3 @@ expansion=${expansion}, isPKH=${isPKH}, isWPKH=${isWPKH}, isSH=${isSH}, isTR=${i
         BIP32
     };
 }
-exports.DescriptorsFactory = DescriptorsFactory;

package/dist/index.d.ts

@@ -34,10 +34,15 @@ export { keyExpressionBIP32, keyExpressionLedger } from './keyExpressions';
 import * as scriptExpressions from './scriptExpressions';
 export { scriptExpressions };
 import { LedgerState, getLedgerMasterFingerPrint, getLedgerXpub, registerLedgerWallet, assertLedgerApp, LedgerManager } from './ledger';
+/** @namespace */
 export declare const ledger: {
+    /** @function */
     getLedgerMasterFingerPrint: typeof getLedgerMasterFingerPrint;
+    /** @function */
     getLedgerXpub: typeof getLedgerXpub;
+    /** @function */
     registerLedgerWallet: typeof registerLedgerWallet;
+    /** @function */
     assertLedgerApp: typeof assertLedgerApp;
 };
 export type { LedgerState, LedgerManager };

package/dist/index.js

@@ -17,15 +17,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ledger = exports.scriptExpressions = exports.keyExpressionLedger = exports.keyExpressionBIP32 = exports.finalizePsbt = exports.signers = exports.checksum = exports.DescriptorsFactory = void 0;
+exports.ledger = exports.scriptExpressions = exports.keyExpressionLedger = exports.keyExpressionBIP32 = exports.signers = exports.checksum = exports.DescriptorsFactory = void 0;
+exports.finalizePsbt = finalizePsbt;
 // Some dependencies (like hash-base) assume process.version exists.
 // In React Native / Hermes, process is defined but version is not.
 // Note: we only polyfill if process already exists but is incomplete.
@@ -69,16 +80,20 @@ function finalizePsbt({ psbt, outputs, descriptors, validate = true }) {
         throw new Error(`outputs not provided`);
     outputs.forEach((output, inputIndex) => output.finalizePsbtInput({ index: inputIndex, psbt, validate }));
 }
-exports.finalizePsbt = finalizePsbt;
 var keyExpressions_1 = require("./keyExpressions");
 Object.defineProperty(exports, "keyExpressionBIP32", { enumerable: true, get: function () { return keyExpressions_1.keyExpressionBIP32; } });
 Object.defineProperty(exports, "keyExpressionLedger", { enumerable: true, get: function () { return keyExpressions_1.keyExpressionLedger; } });
 const scriptExpressions = __importStar(require("./scriptExpressions"));
 exports.scriptExpressions = scriptExpressions;
 const ledger_1 = require("./ledger");
+/** @namespace */
 exports.ledger = {
+    /** @function */
     getLedgerMasterFingerPrint: ledger_1.getLedgerMasterFingerPrint,
+    /** @function */
     getLedgerXpub: ledger_1.getLedgerXpub,
+    /** @function */
     registerLedgerWallet: ledger_1.registerLedgerWallet,
+    /** @function */
     assertLedgerApp: ledger_1.assertLedgerApp
 };

package/dist/keyExpressions.d.ts

@@ -61,7 +61,7 @@ export declare function keyExpressionLedger({ ledgerManager, originPath, keyPath
     index?: number | undefined | '*';
     keyPath?: string | undefined;
 }): Promise<string>;
-/** @deprecated @hidden */
+/** @hidden */
 export declare function keyExpressionLedger({ ledgerClient, ledgerState, originPath, keyPath, change, index }: {
     ledgerClient: unknown;
     ledgerState: LedgerState;

package/dist/keyExpressions.js

@@ -17,15 +17,27 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.keyExpressionBIP32 = exports.keyExpressionLedger = exports.parseKeyExpression = void 0;
+exports.parseKeyExpression = parseKeyExpression;
+exports.keyExpressionLedger = keyExpressionLedger;
+exports.keyExpressionBIP32 = keyExpressionBIP32;
 const bitcoinjs_lib_1 = require("bitcoinjs-lib");
 const ledger_1 = require("./ledger");
 const RE = __importStar(require("./re"));
@@ -188,7 +200,6 @@ function parseKeyExpression({ keyExpression, isSegwit, isTaproot, ECPair, BIP32,
         ...(path !== undefined ? { path } : {})
     };
 }
-exports.parseKeyExpression = parseKeyExpression;
 function assertChangeIndexKeyPath({ change, index, keyPath }) {
     if (!((change === undefined && index === undefined) ||
         (change !== undefined && index !== undefined)))
@@ -196,7 +207,7 @@ function assertChangeIndexKeyPath({ change, index, keyPath }) {
     if ((change !== undefined) === (keyPath !== undefined))
         throw new Error(`Error: Pass either change and index or a keyPath`);
 }
-/** @hidden */
+/** @overload */
 async function keyExpressionLedger({ ledgerClient, ledgerState, ledgerManager, originPath, keyPath, change, index }) {
     if (ledgerManager && (ledgerClient || ledgerState))
         throw new Error(`ledgerClient and ledgerState have been deprecated`);
@@ -217,7 +228,6 @@ async function keyExpressionLedger({ ledgerClient, ledgerState, ledgerManager, o
     else
         return `${keyRoot}/${change}/${index}`;
 }
-exports.keyExpressionLedger = keyExpressionLedger;
 /**
  * Constructs a key expression string from its constituent components.
  *
@@ -239,4 +249,3 @@ function keyExpressionBIP32({ masterNode, originPath, keyPath, change, index, is
     else
         return `${keyRoot}/${change}/${index}`;
 }
-exports.keyExpressionBIP32 = keyExpressionBIP32;

package/dist/ledger.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { DescriptorInstance, OutputInstance } from './descriptors';
 import { Network, Psbt } from 'bitcoinjs-lib';
 import type { TinySecp256k1Interface } from './types';
@@ -71,16 +69,20 @@ export type LedgerManager = {
     ecc: TinySecp256k1Interface;
     network: Network;
 };
-/** Retrieves the masterFingerPrint of a Ledger device */
+/**
+ * Retrieves the masterFingerPrint of a Ledger device
+ */
 export declare function getLedgerMasterFingerPrint({ ledgerManager }: {
     ledgerManager: LedgerManager;
 }): Promise<Buffer>;
-/** @deprecated @hidden */
+/** @hidden */
 export declare function getLedgerMasterFingerPrint({ ledgerClient, ledgerState }: {
     ledgerClient: unknown;
     ledgerState: LedgerState;
 }): Promise<Buffer>;
-/** Retrieves the xpub of a certain originPath of a Ledger device */
+/**
+ * Retrieves the xpub of a certain originPath of a Ledger device
+ */
 export declare function getLedgerXpub({ originPath, ledgerManager }: {
     originPath: string;
     ledgerManager: LedgerManager;
@@ -153,7 +155,6 @@ export declare function ledgerPolicyFromOutput({ output, ledgerClient, ledgerSta
  *   all addresses (both external and internal).
  * - This means that the registered Ledger Policy is a generalized version of the descriptor,
  *   not assuming specific values for the keyPath.
- *
  */
 export declare function registerLedgerWallet({ descriptor, ledgerManager, policyName }: {
     descriptor: string;
@@ -162,7 +163,6 @@ export declare function registerLedgerWallet({ descriptor, ledgerManager, policy
     policyName: string;
 }): Promise<void>;
 /**
- * @deprecated
  * @hidden
  */
 export declare function registerLedgerWallet({ descriptor, ledgerClient, ledgerState, policyName }: {

package/dist/ledger.js

@@ -2,7 +2,16 @@
 // Copyright (c) 2023 Jose-Luis Landabaso - https://bitcoinerlab.com
 // Distributed under the MIT software license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ledgerPolicyFromState = exports.comparePolicies = exports.ledgerPolicyFromStandard = exports.registerLedgerWallet = exports.ledgerPolicyFromOutput = exports.ledgerPolicyFromPsbtInput = exports.getLedgerXpub = exports.getLedgerMasterFingerPrint = exports.assertLedgerApp = exports.importAndValidateLedgerBitcoin = void 0;
+exports.importAndValidateLedgerBitcoin = importAndValidateLedgerBitcoin;
+exports.assertLedgerApp = assertLedgerApp;
+exports.getLedgerMasterFingerPrint = getLedgerMasterFingerPrint;
+exports.getLedgerXpub = getLedgerXpub;
+exports.ledgerPolicyFromPsbtInput = ledgerPolicyFromPsbtInput;
+exports.ledgerPolicyFromOutput = ledgerPolicyFromOutput;
+exports.registerLedgerWallet = registerLedgerWallet;
+exports.ledgerPolicyFromStandard = ledgerPolicyFromStandard;
+exports.comparePolicies = comparePolicies;
+exports.ledgerPolicyFromState = ledgerPolicyFromState;
 /*
  * Notes on Ledger implementation:
  *
@@ -73,7 +82,6 @@ async function importAndValidateLedgerBitcoin(ledgerClient) {
     }
     return ledgerBitcoinModule;
 }
-exports.importAndValidateLedgerBitcoin = importAndValidateLedgerBitcoin;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 async function ledgerAppInfo(transport) {
     const r = await transport.send(0xb0, 0x01, 0x00, 0x00);
@@ -115,7 +123,6 @@ async function assertLedgerApp({ transport, name, minVersion }) {
             throw new Error(`Error: please upgrade ${name} to version ${minVersion}`);
     }
 }
-exports.assertLedgerApp = assertLedgerApp;
 function isLedgerStandard({ ledgerTemplate, keyRoots, network = bitcoinjs_lib_1.networks.bitcoin }) {
     if (keyRoots.length !== 1)
         return false;
@@ -136,7 +143,7 @@ function isLedgerStandard({ ledgerTemplate, keyRoots, network = bitcoinjs_lib_1.
         return true;
     return false;
 }
-/** @hidden */
+/** @overload */
 async function getLedgerMasterFingerPrint({ ledgerClient, ledgerState, ledgerManager }) {
     if (ledgerManager && (ledgerClient || ledgerState))
         throw new Error(`ledgerClient and ledgerState have been deprecated`);
@@ -154,7 +161,6 @@ async function getLedgerMasterFingerPrint({ ledgerClient, ledgerState, ledgerMan
     }
     return masterFingerprint;
 }
-exports.getLedgerMasterFingerPrint = getLedgerMasterFingerPrint;
 /** @hidden */
 async function getLedgerXpub({ originPath, ledgerClient, ledgerState, ledgerManager }) {
     if (ledgerManager && (ledgerClient || ledgerState))
@@ -184,7 +190,6 @@ async function getLedgerXpub({ originPath, ledgerClient, ledgerState, ledgerMana
     }
     return xpub;
 }
-exports.getLedgerXpub = getLedgerXpub;
 /**
  * Checks whether there is a policy in ledgerState that the ledger
  * could use to sign this psbt input.
@@ -326,7 +331,6 @@ async function ledgerPolicyFromPsbtInput({ ledgerManager, psbt, index }) {
     }
     return;
 }
-exports.ledgerPolicyFromPsbtInput = ledgerPolicyFromPsbtInput;
 /**
  * Given an output, it extracts its descriptor and converts it to a Ledger
  * Wallet Policy, that is, its keyRoots and template.
@@ -414,11 +418,10 @@ async function ledgerPolicyFromOutput({ output, ledgerClient, ledgerState }) {
     });
     return { ledgerTemplate, keyRoots };
 }
-exports.ledgerPolicyFromOutput = ledgerPolicyFromOutput;
 /**
  * To be removed in v3.0 and replaced by a version that does not accept
  * descriptors
- * @hidden
+ * @overload
  **/
 async function registerLedgerWallet({ descriptor, ledgerClient, ledgerState, ledgerManager, policyName }) {
     if (typeof descriptor !== 'string' && ledgerManager)
@@ -487,7 +490,6 @@ async function registerLedgerWallet({ descriptor, ledgerClient, ledgerState, led
         ledgerState.policies.push(policy);
     }
 }
-exports.registerLedgerWallet = registerLedgerWallet;
 /**
  * Retrieve a standard ledger policy or null if it does correspond.
  **/
@@ -508,7 +510,6 @@ async function ledgerPolicyFromStandard({ output, ledgerClient, ledgerState }) {
         return { ledgerTemplate, keyRoots };
     return null;
 }
-exports.ledgerPolicyFromStandard = ledgerPolicyFromStandard;
 function compareKeyRoots(arr1, arr2) {
     if (arr1.length !== arr2.length) {
         return false;
@@ -524,7 +525,6 @@ function comparePolicies(policyA, policyB) {
     return (compareKeyRoots(policyA.keyRoots, policyB.keyRoots) &&
         policyA.ledgerTemplate === policyB.ledgerTemplate);
 }
-exports.comparePolicies = comparePolicies;
 /**
  * Retrieve a ledger policy from ledgerState or null if it does not exist yet.
  **/
@@ -550,4 +550,3 @@ async function ledgerPolicyFromState({ output, ledgerClient, ledgerState }) {
         return null;
     }
 }
-exports.ledgerPolicyFromState = ledgerPolicyFromState;

package/dist/miniscript.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Network } from 'bitcoinjs-lib';
 import type { ECPairAPI } from 'ecpair';
 import type { BIP32API } from 'bip32';

package/dist/miniscript.js

@@ -17,15 +17,28 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.numberEncodeAsm = exports.satisfyMiniscript = exports.miniscript2Script = exports.expandMiniscript = void 0;
+exports.expandMiniscript = expandMiniscript;
+exports.miniscript2Script = miniscript2Script;
+exports.satisfyMiniscript = satisfyMiniscript;
+exports.numberEncodeAsm = numberEncodeAsm;
 const bitcoinjs_lib_1 = require("bitcoinjs-lib");
 const keyExpressions_1 = require("./keyExpressions");
 const RE = __importStar(require("./re"));
@@ -72,7 +85,6 @@ function expandMiniscript({ miniscript, isSegwit, isTaproot, network = bitcoinjs
     }
     return { expandedMiniscript, expansionMap };
 }
-exports.expandMiniscript = expandMiniscript;
 /**
  * Particularize an expanded ASM expression using the variables in
  * expansionMap.
@@ -114,7 +126,6 @@ function miniscript2Script({ expandedMiniscript, expansionMap }) {
     }
     return bitcoinjs_lib_1.script.fromASM(substituteAsm({ expandedAsm: compiled.asm, expansionMap }));
 }
-exports.miniscript2Script = miniscript2Script;
 /**
  * Assumptions:
  * The attacker does not have access to any of the private keys of public keys
@@ -181,7 +192,6 @@ function satisfyMiniscript({ expandedMiniscript, expansionMap, signatures = [],
         nSequence: sat.nSequence
     };
 }
-exports.satisfyMiniscript = satisfyMiniscript;
 /**
  *
  * Use this function instead of bitcoinjs-lib's equivalent `script.number.encode`
@@ -246,4 +256,3 @@ function numberEncodeAsm(number) {
     else
         return bitcoinjs_lib_1.script.number.encode(number).toString('hex');
 }
-exports.numberEncodeAsm = numberEncodeAsm;

package/dist/psbt.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { PsbtInput } from 'bip174/src/lib/interfaces';
 import type { KeyInfo } from './types';
 import { Network, Psbt } from 'bitcoinjs-lib';

package/dist/psbt.js

@@ -2,7 +2,8 @@
 // Copyright (c) 2025 Jose-Luis Landabaso - https://bitcoinerlab.com
 // Distributed under the MIT software license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatePsbt = exports.finalScriptsFuncFactory = void 0;
+exports.finalScriptsFuncFactory = finalScriptsFuncFactory;
+exports.updatePsbt = updatePsbt;
 const bitcoinjs_lib_1 = require("bitcoinjs-lib");
 const varuint_bitcoin_1 = require("varuint-bitcoin");
 function reverseBuffer(buffer) {
@@ -82,7 +83,6 @@ function finalScriptsFuncFactory(scriptSatisfaction, network) {
     };
     return finalScriptsFunc;
 }
-exports.finalScriptsFuncFactory = finalScriptsFuncFactory;
 /**
  * Important: Read comments on descriptor.updatePsbt regarding not passing txHex
  */
@@ -207,4 +207,3 @@ function updatePsbt({ psbt, vout, txHex, txId, value, sequence, locktime, keysIn
     psbt.addInput(input);
     return psbt.data.inputs.length - 1;
 }
-exports.updatePsbt = updatePsbt;

package/dist/scriptExpressions.d.ts

@@ -1,13 +1,14 @@
 import { Network } from 'bitcoinjs-lib';
 import type { LedgerState, LedgerManager } from './ledger';
 import type { BIP32Interface } from 'bip32';
+/** @function */
 export declare const pkhBIP32: ({ masterNode, network, keyPath, account, change, index, isPublic }: {
     masterNode: BIP32Interface;
     /** @default networks.bitcoin */
     network?: Network;
     account: number;
     change?: number | undefined;
-    index?: number | undefined | '*';
+    index?: number | undefined | "*";
     keyPath?: string;
     /**
      * Compute an xpub or xprv
@@ -15,13 +16,14 @@ export declare const pkhBIP32: ({ masterNode, network, keyPath, account, change,
      */
     isPublic?: boolean;
 }) => string;
+/** @function */
 export declare const shWpkhBIP32: ({ masterNode, network, keyPath, account, change, index, isPublic }: {
     masterNode: BIP32Interface;
     /** @default networks.bitcoin */
     network?: Network;
     account: number;
     change?: number | undefined;
-    index?: number | undefined | '*';
+    index?: number | undefined | "*";
     keyPath?: string;
     /**
      * Compute an xpub or xprv
@@ -29,13 +31,14 @@ export declare const shWpkhBIP32: ({ masterNode, network, keyPath, account, chan
      */
     isPublic?: boolean;
 }) => string;
+/** @function */
 export declare const wpkhBIP32: ({ masterNode, network, keyPath, account, change, index, isPublic }: {
     masterNode: BIP32Interface;
     /** @default networks.bitcoin */
     network?: Network;
     account: number;
     change?: number | undefined;
-    index?: number | undefined | '*';
+    index?: number | undefined | "*";
     keyPath?: string;
     /**
      * Compute an xpub or xprv
@@ -43,13 +46,14 @@ export declare const wpkhBIP32: ({ masterNode, network, keyPath, account, change
      */
     isPublic?: boolean;
 }) => string;
+/** @function */
 export declare const trBIP32: ({ masterNode, network, keyPath, account, change, index, isPublic }: {
     masterNode: BIP32Interface;
     /** @default networks.bitcoin */
     network?: Network;
     account: number;
     change?: number | undefined;
-    index?: number | undefined | '*';
+    index?: number | undefined | "*";
     keyPath?: string;
     /**
      * Compute an xpub or xprv
@@ -57,13 +61,14 @@ export declare const trBIP32: ({ masterNode, network, keyPath, account, change,
      */
     isPublic?: boolean;
 }) => string;
+/** @function */
 export declare const pkhLedger: {
     ({ ledgerManager, account, keyPath, change, index }: {
         ledgerManager: LedgerManager;
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
     ({ ledgerClient, ledgerState, network, account, keyPath, change, index }: {
         ledgerClient: unknown;
@@ -73,16 +78,17 @@ export declare const pkhLedger: {
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
 };
+/** @function */
 export declare const shWpkhLedger: {
     ({ ledgerManager, account, keyPath, change, index }: {
         ledgerManager: LedgerManager;
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
     ({ ledgerClient, ledgerState, network, account, keyPath, change, index }: {
         ledgerClient: unknown;
@@ -92,16 +98,17 @@ export declare const shWpkhLedger: {
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
 };
+/** @function */
 export declare const wpkhLedger: {
     ({ ledgerManager, account, keyPath, change, index }: {
         ledgerManager: LedgerManager;
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
     ({ ledgerClient, ledgerState, network, account, keyPath, change, index }: {
         ledgerClient: unknown;
@@ -111,16 +118,17 @@ export declare const wpkhLedger: {
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
 };
+/** @function */
 export declare const trLedger: {
     ({ ledgerManager, account, keyPath, change, index }: {
         ledgerManager: LedgerManager;
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
     ({ ledgerClient, ledgerState, network, account, keyPath, change, index }: {
         ledgerClient: unknown;
@@ -130,6 +138,6 @@ export declare const trLedger: {
         account: number;
         keyPath?: string;
         change?: number | undefined;
-        index?: number | undefined | '*';
+        index?: number | undefined | "*";
     }): Promise<string>;
 };

package/dist/scriptExpressions.js

@@ -40,12 +40,16 @@ function standardExpressionsBIP32Maker(purpose, scriptTemplate) {
     }
     return standardScriptExpressionBIP32;
 }
+/** @function */
 exports.pkhBIP32 = standardExpressionsBIP32Maker(44, 'pkh(KEYEXPRESSION)');
+/** @function */
 exports.shWpkhBIP32 = standardExpressionsBIP32Maker(49, 'sh(wpkh(KEYEXPRESSION))');
+/** @function */
 exports.wpkhBIP32 = standardExpressionsBIP32Maker(84, 'wpkh(KEYEXPRESSION)');
+/** @function */
 exports.trBIP32 = standardExpressionsBIP32Maker(86, 'tr(KEYEXPRESSION)');
 function standardExpressionsLedgerMaker(purpose, scriptTemplate) {
-    /** @hidden */
+    /** @overload */
     async function standardScriptExpressionLedger({ ledgerClient, ledgerState, ledgerManager, network, account, keyPath, change, index }) {
         if (ledgerManager && (ledgerClient || ledgerState))
             throw new Error(`ledgerClient and ledgerState have been deprecated`);
@@ -72,7 +76,11 @@ function standardExpressionsLedgerMaker(purpose, scriptTemplate) {
     }
     return standardScriptExpressionLedger;
 }
+/** @function */
 exports.pkhLedger = standardExpressionsLedgerMaker(44, 'pkh(KEYEXPRESSION)');
+/** @function */
 exports.shWpkhLedger = standardExpressionsLedgerMaker(49, 'sh(wpkh(KEYEXPRESSION))');
+/** @function */
 exports.wpkhLedger = standardExpressionsLedgerMaker(84, 'wpkh(KEYEXPRESSION)');
+/** @function */
 exports.trLedger = standardExpressionsLedgerMaker(86, 'tr(KEYEXPRESSION)');

package/dist/signers.d.ts

@@ -70,7 +70,6 @@ export declare function signInputLedger({ psbt, index, ledgerManager }: {
     ledgerManager: LedgerManager;
 }): Promise<void>;
 /**
- * @deprecated
  * @hidden
  */
 export declare function signInputLedger({ psbt, index, descriptor, ledgerClient, ledgerState }: {
@@ -95,7 +94,6 @@ export declare function signLedger({ psbt, ledgerManager }: {
     ledgerManager: LedgerManager;
 }): Promise<void>;
 /**
- * @deprecated
  * @hidden
  */
 export declare function signLedger({ psbt, descriptors, ledgerClient, ledgerState }: {

package/dist/signers.js

@@ -2,7 +2,12 @@
 // Copyright (c) 2025 Jose-Luis Landabaso - https://bitcoinerlab.com
 // Distributed under the MIT software license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.signLedger = exports.signInputLedger = exports.signBIP32 = exports.signInputBIP32 = exports.signECPair = exports.signInputECPair = void 0;
+exports.signInputECPair = signInputECPair;
+exports.signECPair = signECPair;
+exports.signInputBIP32 = signInputBIP32;
+exports.signBIP32 = signBIP32;
+exports.signInputLedger = signInputLedger;
+exports.signLedger = signLedger;
 const bip371_1 = require("bitcoinjs-lib/src/psbt/bip371");
 const bip341_1 = require("bitcoinjs-lib/src/payments/bip341");
 const ledger_1 = require("./ledger");
@@ -42,7 +47,6 @@ function signInputECPair({ psbt, index, ecpair }) {
     else
         psbt.signInput(index, ecpair);
 }
-exports.signInputECPair = signInputECPair;
 /**
  * Signs all inputs of a PSBT with an ECPair.
  *
@@ -82,17 +86,14 @@ function signECPair({ psbt, ecpair }) {
         throw new Error('No inputs were signed');
     }
 }
-exports.signECPair = signECPair;
 function signInputBIP32({ psbt, index, node }) {
     (0, applyPR2137_1.applyPR2137)(psbt);
     psbt.signInputHD(index, node);
 }
-exports.signInputBIP32 = signInputBIP32;
 function signBIP32({ psbt, masterNode }) {
     (0, applyPR2137_1.applyPR2137)(psbt);
     psbt.signAllInputsHD(masterNode);
 }
-exports.signBIP32 = signBIP32;
 const ledgerSignaturesForInputIndex = (index, ledgerSignatures) => ledgerSignatures
     .filter(([i]) => i === index)
     .map(([_i, partialSignature]) => ({
@@ -102,7 +103,7 @@ const ledgerSignaturesForInputIndex = (index, ledgerSignatures) => ledgerSignatu
 /**
  * To be removed in v3.0 and replaced by a version that does not accept
  * descriptor
- * @hidden
+ * @overload
  */
 async function signInputLedger({ psbt, index, descriptor, ledgerClient, ledgerState, ledgerManager }) {
     if (!descriptor && !ledgerManager)
@@ -178,11 +179,10 @@ async function signInputLedger({ psbt, index, descriptor, ledgerClient, ledgerSt
         partialSig: ledgerSignaturesForInputIndex(index, ledgerSignatures)
     });
 }
-exports.signInputLedger = signInputLedger;
 /**
  * To be removed in v3.0 and replaced by a version that does not accept
  * descriptors
- * @hidden
+ * @overload
  */
 async function signLedger({ psbt, descriptors, ledgerClient, ledgerState, ledgerManager }) {
     if (!descriptors && !ledgerManager)
@@ -252,4 +252,3 @@ async function signLedger({ psbt, descriptors, ledgerClient, ledgerState, ledger
         }
     }
 }
-exports.signLedger = signLedger;

package/dist/types.d.ts

@@ -1,12 +1,9 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { ECPairInterface } from 'ecpair';
 import type { BIP32Interface } from 'bip32';
 import type { Payment, Network } from 'bitcoinjs-lib';
 /**
  * Preimage
- * @alias Preimage
- * @memberof Descriptor
+ * See {@link Output}
  */
 export type Preimage = {
     /**

package/package.json

@@ -2,7 +2,7 @@
   "name": "@bitcoinerlab/descriptors",
   "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.",
   "homepage": "https://github.com/bitcoinerlab/descriptors",
-  "version": "2.3.3",
+  "version": "2.3.4",
   "author": "Jose-Luis Landabaso",
   "license": "MIT",
   "repository": {
@@ -34,7 +34,7 @@
     "build:fixtures": "node test/tools/generateBitcoinCoreFixtures.js -i test/fixtures/descriptor_tests.cpp | npx prettier --parser typescript > test/fixtures/bitcoinCore.ts",
     "build:test": "npm run build:fixtures && tsc --project ./node_modules/@bitcoinerlab/configs/tsconfig.test.json --resolveJsonModule",
     "build": "npm run build:src && npm run build:test",
-    "lint": "if [ \"$ESLINT_USE_FLAT_CONFIG\" != false ]; then echo '\n⚠️  WARNING: ESLINT_USE_FLAT_CONFIG is not set to \"false\".\n   Editors may show different results than the CLI linter.\n   To fix permanently, add this to your ~/.bashrc or ~/.zshrc:\n\n   export ESLINT_USE_FLAT_CONFIG=false\n'; fi; ESLINT_USE_FLAT_CONFIG=false eslint --ignore-path .gitignore --ext .ts src/ test/",
+    "lint": "./node_modules/@bitcoinerlab/configs/scripts/lint.sh",
     "ensureTester": "./node_modules/@bitcoinerlab/configs/scripts/ensureTester.sh",
     "test:integration:soft": "npm run ensureTester && node test/integration/standardOutputs.js && echo \"\\n\\n\" && node test/integration/miniscript.js",
     "test:integration:ledger": "npm run ensureTester && node test/integration/ledger.js",
@@ -56,21 +56,21 @@
     }
   },
   "devDependencies": {
+    "@bitcoinerlab/configs": "^2.0.0",
     "@ledgerhq/hw-transport-node-hid": "^6.27.12",
     "@types/lodash.memoize": "^4.1.9",
     "bip39": "^3.0.4",
     "bip65": "^1.0.3",
     "bip68": "^1.0.4",
     "ledger-bitcoin": "^0.2.2",
-    "regtest-client": "^0.2.0",
+    "regtest-client": "^0.2.1",
     "yargs": "^17.7.2"
   },
   "dependencies": {
-    "@bitcoinerlab/configs": "^1.3.0",
-    "@bitcoinerlab/miniscript": "^1.4.0",
+    "@bitcoinerlab/miniscript": "^1.4.3",
     "@bitcoinerlab/secp256k1": "^1.2.0",
     "bip32": "^4.0.0",
-    "bitcoinjs-lib": "^6.1.3",
+    "bitcoinjs-lib": "^6.1.7",
     "ecpair": "^2.1.0",
     "lodash.memoize": "^4.1.2",
     "varuint-bitcoin": "^1.1.2"