@bitcoinerlab/descriptors 2.3.6 → 3.0.0

package/dist/types.d.ts

@@ -1,6 +1,7 @@
 import type { ECPairInterface } from 'ecpair';
 import type { BIP32Interface } from 'bip32';
 import type { Payment, Network } from 'bitcoinjs-lib';
+import type { TapTreeNode, TapTreeInfoNode } from './tapTree';
 /**
  * Preimage
  * See {@link Output}
@@ -24,14 +25,14 @@ export type TimeConstraints = {
     nSequence: number | undefined;
 };
 /**
- * See {@link _Internal_.ParseKeyExpression | ParseKeyExpression}.
+ * See {@link _Internal_.KeyExpressionParser | KeyExpressionParser}.
  */
 export type KeyInfo = {
     keyExpression: string;
-    pubkey?: Buffer;
+    pubkey?: Uint8Array;
     ecpair?: ECPairInterface;
     bip32?: BIP32Interface;
-    masterFingerprint?: Buffer;
+    masterFingerprint?: Uint8Array;
     originPath?: string;
     keyPath?: string;
     path?: string;
@@ -127,14 +128,53 @@ export type Expansion = {
      * expression.
      */
     expandedMiniscript?: string;
+    /**
+     * The taproot tree expression, if any. Only defined for `tr(KEY, TREE)`.
+     * Example: `{pk(02aa...),{pk(03bb...),pk(02cc...)}}`.
+     */
+    tapTreeExpression?: string;
+    /**
+     * The parsed taproot tree, if any. Only defined for `tr(KEY, TREE)`.
+     * Example:
+     * ```
+     * {
+     *   left: { miniscript: 'pk(02aa...)' },
+     *   right: {
+     *     left: { miniscript: 'pk(03bb...)' },
+     *     right: { miniscript: 'pk(02cc...)' }
+     *   }
+     * }
+     * ```
+     */
+    tapTree?: TapTreeNode;
+    /**
+     * The compiled taproot tree metadata, if any. Only defined for `tr(KEY, TREE)`.
+     * Same as tapTree, but each leaf includes the expanded miniscript, key
+     * expansion map, compiled tapscript (`tapScript`), and leaf version.
+     * Note: `@i` placeholders in `expandedMiniscript` are scoped per leaf, since
+     * each leaf is expanded and satisfied independently.
+     *
+     * Example:
+     * ```
+     * {
+     *   left: {
+     *     miniscript: 'pk(02aa...)',
+     *     expandedMiniscript: 'pk(@0)',
+     *     expansionMap: ExpansionMap;
+     *     tapScript: Uint8Array;
+     *     version: number;
+     *   },
+     *   right: ....
+     */
+    tapTreeInfo?: TapTreeInfoNode;
     /**
      * The redeem script for the descriptor, if applicable.
      */
-    redeemScript?: Buffer;
+    redeemScript?: Uint8Array;
     /**
      * The witness script for the descriptor, if applicable.
      */
-    witnessScript?: Buffer;
+    witnessScript?: Uint8Array;
     /**
      * Whether the descriptor is a ranged-descriptor.
      */
@@ -170,7 +210,7 @@ export type Expansion = {
  *
  * See {@link KeyInfo} for the complete list of elements retrieved by this function.
  */
-export interface ParseKeyExpression {
+export interface KeyExpressionParser {
     (params: {
         keyExpression: string;
         /**

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.6",
+  "version": "3.0.0",
   "author": "Jose-Luis Landabaso",
   "license": "MIT",
   "repository": {
@@ -36,43 +36,43 @@
     "build": "npm run build:src && npm run build: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 && echo \"\n\n\" && node test/integration/sortedmulti.js",
-    "test:integration:ledger": "npm run ensureTester && node test/integration/ledger.js",
-    "test:integration:deprecated": "npm run ensureTester && node test/integration/standardOutputs-deprecated.js && echo \"\n\n\" && node test/integration/miniscript-deprecated.js && echo \"\n\n\" && node test/integration/ledger-deprecated.js",
+    "test:integration:soft": "npm run ensureTester && node test/integration/standardOutputs.js && echo \"\n\n\" && node test/integration/miniscript.js && echo \"\n\n\" && node test/integration/sortedmulti.js && echo \"\n\n\" && node test/integration/taproot.js",
+    "test:integration:ledger": "npm run ensureTester && node test/integration/ledgerTaproot.js && echo \"\n\n\" && node test/integration/ledger.js",
     "test:unit": "jest",
     "test": "npm run lint && npm run build && npm run test:unit && npm run test:integration:soft",
     "testledger": "npm run lint && npm run build && npm run test:integration:ledger",
-    "prepublishOnly": "npm run test && echo \"\n\n\" && npm run test:integration:deprecated && npm run test:integration:ledger"
+    "prepublishOnly": "npm run test && echo \"\n\n\" && npm run test:integration:ledger"
   },
   "files": [
     "dist"
   ],
   "peerDependencies": {
-    "ledger-bitcoin": "^0.2.2"
+    "@ledgerhq/ledger-bitcoin": "^0.3.0"
   },
   "peerDependenciesMeta": {
-    "ledger-bitcoin": {
+    "@ledgerhq/ledger-bitcoin": {
       "optional": true
     }
   },
   "devDependencies": {
     "@bitcoinerlab/configs": "^2.0.0",
-    "@ledgerhq/hw-transport-node-hid": "^6.27.12",
+    "@bitcoinerlab/miniscript-policies": "^1.0.0",
+    "@ledgerhq/hw-transport-node-hid": "^6.30.0",
+    "@ledgerhq/ledger-bitcoin": "^0.3.0",
     "@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.1",
     "yargs": "^17.7.2"
   },
   "dependencies": {
-    "@bitcoinerlab/miniscript": "^1.4.3",
+    "@bitcoinerlab/miniscript": "^2.0.0",
     "@bitcoinerlab/secp256k1": "^1.2.0",
     "bip32": "^4.0.0",
-    "bitcoinjs-lib": "^6.1.7",
-    "ecpair": "^2.1.0",
+    "bitcoinjs-lib": "^7.0.1",
+    "ecpair": "^3.0.1",
     "lodash.memoize": "^4.1.2",
-    "varuint-bitcoin": "^1.1.2"
+    "varuint-bitcoin": "^2.0.0"
   }
 }