@bitcoinerlab/descriptors 2.0.1 → 2.0.2

package/dist/descriptors.d.ts

@@ -66,6 +66,23 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * satisfyMiniscript verifies that the time constraints did not change.
              */
             "__#1@#getTimeConstraints"(): TimeConstraints | undefined;
+            /**
+             * 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
              * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
@@ -304,6 +321,23 @@ export declare function DescriptorsFactory(ecc: TinySecp256k1Interface): {
              * satisfyMiniscript verifies that the time constraints did not change.
              */
             "__#1@#getTimeConstraints"(): TimeConstraints | undefined;
+            /**
+             * 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
              * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.

package/dist/descriptors.js

@@ -481,6 +481,49 @@ function DescriptorsFactory(ecc) {
                 }
             }
         }
+        /**
+         * 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
          * [`Payment`](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/ts_src/payments/index.ts)'s interface with the `scriptPubKey` of this `Output`.
@@ -750,7 +793,8 @@ function DescriptorsFactory(ecc) {
             //signatures don't matter
             const fakeSignatures = signersPubKeys.map(pubkey => ({
                 pubkey,
-                signature: Buffer.alloc(64, 0)
+                // https://transactionfee.info/charts/bitcoin-script-ecdsa-length/
+                signature: Buffer.alloc(72, 0)
             }));
             const { nLockTime, nSequence } = (0, miniscript_1.satisfyMiniscript)({
                 expandedMiniscript,

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.0.1",
+  "version": "2.0.2",
   "author": "Jose-Luis Landabaso",
   "license": "MIT",
   "repository": {