@bitcoinerlab/descriptors - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

dist/descriptors.d.ts

@@ -70,19 +70,2 @@ /// <reference types="node" />
             /**
-             * Retrieves the byte length of the script satisfaction for a Miniscript-based
-             * descriptor, using only the expression, signers' public keys, and preimages
-             * provided in the constructor.
-             *
-             * Useful in scenarios like coin selection algorithms for transaction creation,
-             * where signatures are not yet available. Since signatures are still to be
-             * computed, the function assigns a standard length of 72 bytes for each
-             * signature. However, note that this may not always be completely accurate,
-             * as approximately 50% of signatures are 71 bytes in length
-             * (source: https://transactionfee.info/charts/bitcoin-script-ecdsa-length/).
-             * The function returns the byte length for a worst-case scenario.
-             *
-             * @returns The byte length of the compiled script satisfaction, or `undefined`
-             *          if this was not a miniscript-based descriptor.
-             */
-            getScriptSatisfactionSize(): number | undefined;
-            /**
              * Creates and returns an instance of bitcoinjs-lib
@@ -111,3 +94,3 @@ * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
              */
-            getScriptSatisfaction(signatures: PartialSig[]): Buffer;
+            getScriptSatisfaction(signatures: PartialSig[] | 'DANGEROUSLY_USE_FAKE_SIGNATURES'): Buffer;
             /**
@@ -279,3 +262,11 @@ * Gets the nSequence required to fulfill this `Output`.
             /**
-             * An array of preimages. This info is necessary to finalize Psbts.
+             * An array of preimages if the miniscript-based descriptor uses them.
+             *
+             * This info is necessary to finalize Psbts. Leave it `undefined` if your
+             * miniscript-based descriptor does not use preimages or you don't know
+             * or don't wanto use them.
+             *
+             * You can also leave it `undefined` if only need to generate the
+             * `scriptPubKey` or `address` for a descriptor.
+             *
              * @defaultValue `[]`
@@ -286,12 +277,16 @@ */
              * An array of the public keys used for signing the transaction when
-             * spending the output associated with this descriptor. This parameter is
-             * only used if the descriptor object is being used to finalize a
-             * transaction. It is necessary to specify the spending path when working
-             * with miniscript-based expressions that have multiple spending paths.
-             * Set this parameter to an array containing the public keys involved in
-             * the desired spending path. Leave it `undefined` if you only need to
-             * generate the `scriptPubKey` or `address` for a descriptor, or if all
-             * the public keys involved in the descriptor will sign the transaction.
-             * In the latter case, the satisfier will automatically choose the most
-             * optimal spending path (if more than one is available).
+             * spending the previous output associated with this descriptor.
+             *
+             * This parameter is only used if the descriptor object is being used to
+             * finalize a transaction. It is necessary to specify the spending path
+             * when working with miniscript-based expressions that have multiple
+             * spending paths.
+             *
+             * Set this parameter to an array containing the public
+             * keys involved in the desired spending path. Leave it `undefined` if you
+             * only need to generate the `scriptPubKey` or `address` for a descriptor,
+             * or if all the public keys involved in the descriptor will sign the
+             * transaction. In the latter case, the satisfier will automatically
+             * choose the most optimal spending path (if more than one is available).
+             *
              * For more details on using this parameter, refer to [this Stack Exchange
@@ -329,19 +324,2 @@ * answer](https://bitcoin.stackexchange.com/a/118036/89665).
             /**
-             * Retrieves the byte length of the script satisfaction for a Miniscript-based
-             * descriptor, using only the expression, signers' public keys, and preimages
-             * provided in the constructor.
-             *
-             * Useful in scenarios like coin selection algorithms for transaction creation,
-             * where signatures are not yet available. Since signatures are still to be
-             * computed, the function assigns a standard length of 72 bytes for each
-             * signature. However, note that this may not always be completely accurate,
-             * as approximately 50% of signatures are 71 bytes in length
-             * (source: https://transactionfee.info/charts/bitcoin-script-ecdsa-length/).
-             * The function returns the byte length for a worst-case scenario.
-             *
-             * @returns The byte length of the compiled script satisfaction, or `undefined`
-             *          if this was not a miniscript-based descriptor.
-             */
-            getScriptSatisfactionSize(): number | undefined;
-            /**
              * Creates and returns an instance of bitcoinjs-lib
@@ -370,3 +348,3 @@ * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
              */
-            getScriptSatisfaction(signatures: PartialSig[]): Buffer;
+            getScriptSatisfaction(signatures: PartialSig[] | 'DANGEROUSLY_USE_FAKE_SIGNATURES'): Buffer;
             /**
@@ -373,0 +351,0 @@ * Gets the nSequence required to fulfill this `Output`.

dist/descriptors.js

@@ -485,45 +485,2 @@ "use strict";
         /**
-         * Retrieves the byte length of the script satisfaction for a Miniscript-based
-         * descriptor, using only the expression, signers' public keys, and preimages
-         * provided in the constructor.
-         *
-         * Useful in scenarios like coin selection algorithms for transaction creation,
-         * where signatures are not yet available. Since signatures are still to be
-         * computed, the function assigns a standard length of 72 bytes for each
-         * signature. However, note that this may not always be completely accurate,
-         * as approximately 50% of signatures are 71 bytes in length
-         * (source: https://transactionfee.info/charts/bitcoin-script-ecdsa-length/).
-         * The function returns the byte length for a worst-case scenario.
-         *
-         * @returns The byte length of the compiled script satisfaction, or `undefined`
-         *          if this was not a miniscript-based descriptor.
-         */
-        getScriptSatisfactionSize() {
-            const miniscript = __classPrivateFieldGet(this, _Output_miniscript, "f");
-            const preimages = __classPrivateFieldGet(this, _Output_preimages, "f");
-            const expandedMiniscript = __classPrivateFieldGet(this, _Output_expandedMiniscript, "f");
-            const expansionMap = __classPrivateFieldGet(this, _Output_expansionMap, "f");
-            const signersPubKeys = __classPrivateFieldGet(this, _Output_signersPubKeys, "f");
-            //Create a method. solvePreimages to solve them.
-            if (miniscript) {
-                if (expandedMiniscript === undefined || expansionMap === undefined)
-                    throw new Error(`Error: cannot get script satisfactions from not expanded miniscript ${miniscript}`);
-                //We create some fakeSignatures since we may not have them yet.
-                const fakeSignatures = signersPubKeys.map(pubkey => ({
-                    pubkey,
-                    // https://transactionfee.info/charts/bitcoin-script-ecdsa-length/
-                    signature: Buffer.alloc(72, 0)
-                }));
-                const { scriptSatisfaction } = (0, miniscript_1.satisfyMiniscript)({
-                    expandedMiniscript,
-                    expansionMap,
-                    signatures: fakeSignatures,
-                    preimages
-                });
-                return scriptSatisfaction.length;
-            }
-            else
-                return undefined;
-        }
-        /**
          * Creates and returns an instance of bitcoinjs-lib
@@ -569,4 +526,24 @@ * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
          * `interface PartialSig { pubkey: Buffer; signature: Buffer; }`
+         *
+         *  * Alternatively, if you do not have the signatures, you can use the option
+         * `'DANGEROUSLY_USE_FAKE_SIGNATURES'`. This will generate script satisfactions
+         * using 72-byte zero-padded signatures. While this can be useful in
+         * modules like coinselector that require estimating transaction size before
+         * signing, it is critical to understand the risks:
+         * - Using this option generales invalid unlocking scripts.
+         * - It should NEVER be used with real transactions.
+         * - Its primary use is for testing and size estimation purposes only.
+         *
+         * ⚠️ Warning: Misuse of 'DANGEROUSLY_USE_FAKE_SIGNATURES' can lead to security
+         * vulnerabilities, including but not limited to invalid transaction generation.
+         * Ensure you fully understand the implications before use.
+         *
          */
         signatures) {
+            if (signatures === 'DANGEROUSLY_USE_FAKE_SIGNATURES')
+                signatures = __classPrivateFieldGet(this, _Output_signersPubKeys, "f").map(pubkey => ({
+                    pubkey,
+                    // https://transactionfee.info/charts/bitcoin-script-ecdsa-length/
+                    signature: Buffer.alloc(72, 0)
+                }));
             const miniscript = __classPrivateFieldGet(this, _Output_miniscript, "f");
@@ -573,0 +550,0 @@ const expandedMiniscript = __classPrivateFieldGet(this, _Output_expandedMiniscript, "f");

dist/types.d.ts

@@ -12,4 +12,6 @@ /// <reference types="node" />
     /**
-     * Use same expressions as in miniscript. For example: "sha256(cdabb7f2dce7bfbd8a0b9570c6fd1e712e5d64045e9d6b517b3d5072251dc204)" or "ripemd160(095ff41131e5946f3c85f79e44adbcf8e27e080e)"
+     * Use same string expressions as in miniscript. For example: "sha256(cdabb7f2dce7bfbd8a0b9570c6fd1e712e5d64045e9d6b517b3d5072251dc204)" or "ripemd160(095ff41131e5946f3c85f79e44adbcf8e27e080e)"
+     *
      * Accepted functions: sha256, hash256, ripemd160, hash160
+     *
      * Digests must be: 64-character HEX for sha256, hash160 or 30-character HEX for ripemd160 or hash160.
@@ -19,3 +21,3 @@ */
     /**
-     * Hex encoded preimate. Preimages are always 32 bytes (so, 64 character in hex).
+     * Hex encoded preimage. Preimages are always 32 bytes (so, 64 character in hex).
      */
@@ -22,0 +24,0 @@ preimage: string;

package.json

@@ -5,3 +5,3 @@ {
   "homepage": "https://github.com/bitcoinerlab/descriptors",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "author": "Jose-Luis Landabaso",
@@ -8,0 +8,0 @@ "license": "MIT",

README.md

@@ -76,7 +76,7 @@ # Bitcoin Descriptors Library
 
-Refer to [the API](https://bitcoinerlab.com/modules/descriptors/api/classes/_Internal_.Output.html#constructor) for the complete list of parameters in the constructor.
+For miniscript-based descriptors, the `signersPubKeys` parameter in the constuctor becomes particularly important. It specifies the spending path of a previous output with multiple spending paths. Detailed information about the constructor parameters, including `signersPubKeys`, can be found in [the API documentation](https://bitcoinerlab.com/modules/descriptors/api/classes/_Internal_.Output.html#constructor) and in [this Stack Exchange answer](https://bitcoin.stackexchange.com/a/118036/89665).
 
 The `Output` class [offers various helpful methods](https://bitcoinerlab.com/modules/descriptors/api/classes/_Internal_.Output.html), including `getAddress()`, which returns the address associated with the descriptor, `getScriptPubKey()`, which returns the `scriptPubKey` for the descriptor, `expand()`, which decomposes a descriptor into its elemental parts, `updatePsbtAsInput()` and `updatePsbtAsOutput()`.
 
-The `updatePsbtAsInput()` method is an essential part of the library, responsible for adding an input to the PSBT corresponding to the UTXO  described by the descriptor. Additionally, when the descriptor expresses an absolute time-spending condition, such as "This UTXO can only be spent after block N," `updatePsbtAsInput()` adds timelock information to the PSBT.
+The `updatePsbtAsInput()` method is an essential part of the library, responsible for adding an input to the PSBT corresponding to the UTXO  described by the descriptor. Additionally, when the descriptor expresses an absolute time-spending condition, such as "This UTXO can only be spent after block N", `updatePsbtAsInput()` adds timelock information to the PSBT.
 
@@ -83,0 +83,0 @@ To call `updatePsbtAsInput()`, use the following syntax:

No alert changes

Worsened metrics

Total package byte prevSize

204536

decreased by-1.24%

Lines of code

3884

decreased by-1.09%

No dependency changes