@bitcoinerlab/descriptors 0.2.1 → 0.3.0

package/dist/keyExpressions.js

@@ -44,17 +44,17 @@ const derivePath = (node, path) => {
     return node.derivePath(parsedPath);
 };
 /*
- * Takes a key expression (xpub, xprv, pubkey or wif) and returns a pubkey in
- * binary format
+ * Parses a key expression (xpub, xprv, pubkey or wif) into KeyInfo
  */
 function parseKeyExpression({ keyExpression, isSegwit, ECPair, BIP32, network = bitcoinjs_lib_1.networks.bitcoin }) {
-    let pubkey;
+    let pubkey; //won't be computed for ranged keyExpressions
     let ecpair;
     let bip32;
     let masterFingerprint;
     let originPath;
     let keyPath;
     let path;
+    const isRanged = keyExpression.indexOf('*') !== -1;
     //Validate the keyExpression:
     const keyExpressions = keyExpression.match(RE.reKeyExp);
     if (keyExpressions === null || keyExpressions[0] !== keyExpression) {
@@ -115,7 +115,8 @@ function parseKeyExpression({ keyExpression, isSegwit, ECPair, BIP32, network =
             if (!keyPath)
                 throw new Error(`Error: could not extract a path`);
             //fromBase58 and derivePath will throw if xPub or path are not valid
-            pubkey = derivePath(bip32, keyPath).publicKey;
+            if (!isRanged)
+                pubkey = derivePath(bip32, keyPath).publicKey;
         }
         else {
             pubkey = bip32.publicKey;
@@ -134,7 +135,8 @@ function parseKeyExpression({ keyExpression, isSegwit, ECPair, BIP32, network =
             if (!keyPath)
                 throw new Error(`Error: could not extract a path`);
             //fromBase58 and derivePath will throw if xPrv or path are not valid
-            pubkey = derivePath(bip32, keyPath).publicKey;
+            if (!isRanged)
+                pubkey = derivePath(bip32, keyPath).publicKey;
         }
         else {
             pubkey = bip32.publicKey;
@@ -143,12 +145,12 @@ function parseKeyExpression({ keyExpression, isSegwit, ECPair, BIP32, network =
     else {
         throw new Error(`Error: could not get pubkey for keyExpression ${keyExpression}`);
     }
-    if (masterFingerprint && (originPath || keyPath)) {
-        path = 'm' + originPath + keyPath;
+    if (originPath || keyPath) {
+        path = `m${originPath ?? ''}${keyPath ?? ''}`;
     }
     return {
-        pubkey,
         keyExpression,
+        ...(pubkey !== undefined ? { pubkey } : {}),
         ...(ecpair !== undefined ? { ecpair } : {}),
         ...(bip32 !== undefined ? { bip32 } : {}),
         ...(masterFingerprint !== undefined ? { masterFingerprint } : {}),
@@ -161,7 +163,7 @@ exports.parseKeyExpression = parseKeyExpression;
 function assertChangeIndexKeyPath({ change, index, keyPath }) {
     if (!((change === undefined && index === undefined) ||
         (change !== undefined && index !== undefined)))
-        throw new Error(`Error: Pass change, index and network or neither`);
+        throw new Error(`Error: Pass change and index or neither`);
     if ((change !== undefined) === (keyPath !== undefined))
         throw new Error(`Error: Pass either change and index or a keyPath`);
 }

package/dist/ledger.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { DescriptorInterface } from './types';
-import { AppClient } from '@bitcoinerlab/ledger';
+import { AppClient } from 'ledger-bitcoin';
 export declare function assertLedgerApp({ transport, name, minVersion }: {
     transport: any;
     name: string;

package/dist/ledger.js

@@ -3,7 +3,7 @@
 // Distributed under the MIT software license
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ledgerPolicyFromState = exports.comparePolicies = exports.ledgerPolicyFromStandard = exports.registerLedgerWallet = exports.descriptorToLedgerFormat = exports.getLedgerXpub = exports.getLedgerMasterFingerPrint = exports.assertLedgerApp = void 0;
-const ledger_1 = require("@bitcoinerlab/ledger");
+const ledger_bitcoin_1 = require("ledger-bitcoin");
 const bitcoinjs_lib_1 = require("bitcoinjs-lib");
 const re_1 = require("./re");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -204,7 +204,7 @@ async function registerLedgerWallet({ descriptor, ledgerClient, ledgerState, pol
         //It already existed. No need to register it again.
     }
     else {
-        walletPolicy = new ledger_1.WalletPolicy(policyName, ledgerTemplate, keyRoots);
+        walletPolicy = new ledger_bitcoin_1.WalletPolicy(policyName, ledgerTemplate, keyRoots);
         let policyId;
         [policyId, policyHmac] = await ledgerClient.registerWallet(walletPolicy);
         const policy = {

package/dist/miniscript.js

@@ -51,8 +51,11 @@ function expandMiniscript({ miniscript, isSegwit, network = bitcoinjs_lib_1.netw
         return key;
     });
     //Do some assertions. Miniscript must not have duplicate keys, also all
-    //keyExpressions must produce a valid pubkey
-    const pubkeysHex = Object.values(expansionMap).map(keyInfo => {
+    //keyExpressions must produce a valid pubkey (unless it's ranged and we want
+    //to expand a generalized form, then we don't check)
+    const pubkeysHex = Object.values(expansionMap)
+        .filter(keyInfo => keyInfo.keyExpression.indexOf('*') === -1)
+        .map(keyInfo => {
         if (!keyInfo.pubkey)
             throw new Error(`Error: keyExpression ${keyInfo.keyExpression} does not have a pubkey`);
         return keyInfo.pubkey.toString('hex');
@@ -91,7 +94,7 @@ function substituteAsm({ expandedAsm, expansionMap }) {
         //enclosed in <>, since <> represents hex code already encoded.
         //The regex below will match one or more digits within a string,
         //except if the sequence is surrounded by "<" and ">"
-        .replace(/(?<![<])\b\d+\b(?![>])/g, (num) => numberEncodeAsm(Number(num)))
+        .replace(/(<\d+>)|\b\d+\b/g, match => match.startsWith('<') ? match : numberEncodeAsm(Number(match)))
         //we don't have numbers anymore, now it's safe to remove < and > since we
         //know that every remaining is either an op_code or a hex encoded number
         .replace(/[<>]/g, '');
@@ -133,7 +136,7 @@ function satisfyMiniscript({ expandedMiniscript, expansionMap, signatures = [],
     const expandedSignatureMap = {};
     signatures.forEach(signature => {
         const pubkeyHex = signature.pubkey.toString('hex');
-        const keyExpression = Object.keys(expansionMap).find(k => expansionMap[k]?.pubkey.toString('hex') === pubkeyHex);
+        const keyExpression = Object.keys(expansionMap).find(k => expansionMap[k]?.pubkey?.toString('hex') === pubkeyHex);
         expandedSignatureMap['<sig(' + keyExpression + ')>'] =
             '<' + signature.signature.toString('hex') + '>';
     });

package/dist/psbt.js

@@ -144,26 +144,20 @@ function updatePsbt({ psbt, vout, txHex, txId, value, sequence, locktime, keysIn
     }
     if (txId === undefined || !value)
         throw new Error(`Error: txHex+vout required. Alternatively, but ONLY for Segwit inputs, txId+value can also be passed.`);
-    if (locktime !== undefined) {
-        if (psbt.locktime !== 0 && psbt.locktime !== undefined)
-            throw new Error(`Error: transaction locktime has already been set: ${psbt.locktime}`);
-        psbt.setLocktime(locktime);
-    }
-    let inputSequence;
-    if (locktime !== undefined) {
+    if (locktime) {
+        if (psbt.locktime && psbt.locktime !== locktime)
+            throw new Error(`Error: transaction locktime was already set with a different value: ${locktime} != ${psbt.locktime}`);
+        // nLockTime only works if at least one of the transaction inputs has an
+        // nSequence value that is below 0xffffffff. Let's make sure that at least
+        // this input's sequence < 0xffffffff
         if (sequence === undefined) {
-            // for CTV nSequence MUST be <= 0xfffffffe otherwise OP_CHECKLOCKTIMEVERIFY will fail.
-            inputSequence = 0xfffffffe;
+            //NOTE: if sequence is undefined, bitcoinjs-lib uses 0xffffffff as default
+            sequence = 0xfffffffe;
         }
         else if (sequence > 0xfffffffe) {
-            throw new Error(`Error: incompatible sequence: ${inputSequence} and locktime: ${locktime}`);
-        }
-        else {
-            inputSequence = sequence;
+            throw new Error(`Error: incompatible sequence: ${sequence} and locktime: ${locktime}`);
         }
-    }
-    else {
-        inputSequence = sequence;
+        psbt.setLocktime(locktime);
     }
     const input = {
         hash: reverseBuffer(Buffer.from(txId, 'hex')),
@@ -174,19 +168,24 @@ function updatePsbt({ psbt, vout, txHex, txId, value, sequence, locktime, keysIn
     }
     const bip32Derivation = keysInfo
         .filter((keyInfo) => keyInfo.pubkey && keyInfo.masterFingerprint && keyInfo.path)
-        .map((keyInfo) => ({
-        masterFingerprint: keyInfo.masterFingerprint,
-        pubkey: keyInfo.pubkey,
-        path: keyInfo.path
-    }));
+        .map((keyInfo) => {
+        const pubkey = keyInfo.pubkey;
+        if (!pubkey)
+            throw new Error(`key ${keyInfo.keyExpression} missing pubkey`);
+        return {
+            masterFingerprint: keyInfo.masterFingerprint,
+            pubkey,
+            path: keyInfo.path
+        };
+    });
     if (bip32Derivation.length)
         input.bip32Derivation = bip32Derivation;
     if (isSegwit && txHex !== undefined) {
         //There's no need to put both witnessUtxo and nonWitnessUtxo
         input.witnessUtxo = { script: scriptPubKey, value };
     }
-    if (inputSequence !== undefined)
-        input.sequence = inputSequence;
+    if (sequence !== undefined)
+        input.sequence = sequence;
     if (witnessScript)
         input.witnessScript = witnessScript;
     if (redeemScript)

package/dist/scriptExpressions.d.ts

@@ -1,4 +1,4 @@
-import type { AppClient } from '@bitcoinerlab/ledger';
+import type { AppClient } from 'ledger-bitcoin';
 import { Network } from 'bitcoinjs-lib';
 import type { LedgerState } from './ledger';
 import type { BIP32Interface } from 'bip32';

package/dist/signers.d.ts

@@ -1,7 +1,7 @@
 import type { Psbt } from 'bitcoinjs-lib';
 import type { ECPairInterface } from 'ecpair';
 import type { BIP32Interface } from 'bip32';
-import { AppClient } from '@bitcoinerlab/ledger';
+import { AppClient } from 'ledger-bitcoin';
 import type { DescriptorInterface } from './types';
 import { LedgerState } from './ledger';
 export declare function signInputECPair({ psbt, index, ecpair }: {

package/dist/signers.js

@@ -3,8 +3,8 @@
 // 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;
-const ledger_1 = require("@bitcoinerlab/ledger");
-const ledger_2 = require("./ledger");
+const ledger_bitcoin_1 = require("ledger-bitcoin");
+const ledger_1 = require("./ledger");
 function signInputECPair({ psbt, index, ecpair }) {
     psbt.signInput(index, ecpair);
 }
@@ -23,12 +23,12 @@ function signBIP32({ psbt, masterNode }) {
 exports.signBIP32 = signBIP32;
 const ledgerSignaturesForInputIndex = (index, ledgerSignatures) => ledgerSignatures
     .filter(([i]) => i === index)
-    .map(([_i, pubkey, signature]) => ({
-    pubkey,
-    signature
+    .map(([_i, partialSignature]) => ({
+    pubkey: partialSignature.pubkey,
+    signature: partialSignature.signature
 }));
 async function signInputLedger({ psbt, index, descriptor, ledgerClient, ledgerState }) {
-    const result = await (0, ledger_2.descriptorToLedgerFormat)({
+    const result = await (0, ledger_1.descriptorToLedgerFormat)({
         descriptor,
         ledgerClient,
         ledgerState
@@ -37,24 +37,24 @@ async function signInputLedger({ psbt, index, descriptor, ledgerClient, ledgerSt
         throw new Error(`Error: descriptor does not have a ledger input`);
     const { ledgerTemplate, keyRoots } = result;
     let ledgerSignatures;
-    const standardPolicy = await (0, ledger_2.ledgerPolicyFromStandard)({
+    const standardPolicy = await (0, ledger_1.ledgerPolicyFromStandard)({
         descriptor,
         ledgerClient,
         ledgerState
     });
     if (standardPolicy) {
-        ledgerSignatures = await ledgerClient.signPsbt(new ledger_1.PsbtV2().fromBitcoinJS(psbt), new ledger_1.DefaultWalletPolicy(ledgerTemplate, keyRoots[0]), null);
+        ledgerSignatures = await ledgerClient.signPsbt(new ledger_bitcoin_1.PsbtV2().fromBitcoinJS(psbt), new ledger_bitcoin_1.DefaultWalletPolicy(ledgerTemplate, keyRoots[0]), null);
     }
     else {
-        const policy = await (0, ledger_2.ledgerPolicyFromState)({
+        const policy = await (0, ledger_1.ledgerPolicyFromState)({
             descriptor,
             ledgerClient,
             ledgerState
         });
         if (!policy || !policy.policyName || !policy.policyHmac)
             throw new Error(`Error: the descriptor's policy is not registered`);
-        const walletPolicy = new ledger_1.WalletPolicy(policy.policyName, ledgerTemplate, keyRoots);
-        ledgerSignatures = await ledgerClient.signPsbt(new ledger_1.PsbtV2().fromBitcoinJS(psbt), walletPolicy, policy.policyHmac);
+        const walletPolicy = new ledger_bitcoin_1.WalletPolicy(policy.policyName, ledgerTemplate, keyRoots);
+        ledgerSignatures = await ledgerClient.signPsbt(new ledger_bitcoin_1.PsbtV2().fromBitcoinJS(psbt), walletPolicy, policy.policyHmac);
     }
     //Add the signatures to the Psbt object using PartialSig format:
     psbt.updateInput(index, {
@@ -68,12 +68,12 @@ exports.signInputLedger = signInputLedger;
 async function signLedger({ psbt, descriptors, ledgerClient, ledgerState }) {
     const ledgerPolicies = [];
     for (const descriptor of descriptors) {
-        const policy = (await (0, ledger_2.ledgerPolicyFromState)({
+        const policy = (await (0, ledger_1.ledgerPolicyFromState)({
             descriptor,
             ledgerClient,
             ledgerState
         })) ||
-            (await (0, ledger_2.ledgerPolicyFromStandard)({
+            (await (0, ledger_1.ledgerPolicyFromStandard)({
                 descriptor,
                 ledgerClient,
                 ledgerState
@@ -86,7 +86,7 @@ async function signLedger({ psbt, descriptors, ledgerClient, ledgerState }) {
     //cluster unique LedgerPolicies
     const uniquePolicies = [];
     for (const policy of ledgerPolicies) {
-        if (!uniquePolicies.find((uniquePolicy) => (0, ledger_2.comparePolicies)(uniquePolicy, policy)))
+        if (!uniquePolicies.find((uniquePolicy) => (0, ledger_1.comparePolicies)(uniquePolicy, policy)))
             uniquePolicies.push(policy);
     }
     for (const uniquePolicy of uniquePolicies) {
@@ -95,12 +95,12 @@ async function signLedger({ psbt, descriptors, ledgerClient, ledgerState }) {
             uniquePolicy.policyHmac &&
             uniquePolicy.policyId) {
             //non-standard policy
-            const walletPolicy = new ledger_1.WalletPolicy(uniquePolicy.policyName, uniquePolicy.ledgerTemplate, uniquePolicy.keyRoots);
-            ledgerSignatures = await ledgerClient.signPsbt(new ledger_1.PsbtV2().fromBitcoinJS(psbt), walletPolicy, uniquePolicy.policyHmac);
+            const walletPolicy = new ledger_bitcoin_1.WalletPolicy(uniquePolicy.policyName, uniquePolicy.ledgerTemplate, uniquePolicy.keyRoots);
+            ledgerSignatures = await ledgerClient.signPsbt(new ledger_bitcoin_1.PsbtV2().fromBitcoinJS(psbt), walletPolicy, uniquePolicy.policyHmac);
         }
         else {
             //standard policy
-            ledgerSignatures = await ledgerClient.signPsbt(new ledger_1.PsbtV2().fromBitcoinJS(psbt), new ledger_1.DefaultWalletPolicy(uniquePolicy.ledgerTemplate, uniquePolicy.keyRoots[0]), null);
+            ledgerSignatures = await ledgerClient.signPsbt(new ledger_bitcoin_1.PsbtV2().fromBitcoinJS(psbt), new ledger_bitcoin_1.DefaultWalletPolicy(uniquePolicy.ledgerTemplate, uniquePolicy.keyRoots[0]), null);
         }
         for (const [index, ,] of ledgerSignatures) {
             psbt.updateInput(index, {

package/dist/types.d.ts

@@ -3,17 +3,30 @@ import type { ECPairInterface } from 'ecpair';
 import type { BIP32Interface } from 'bip32';
 import type { Network, Payment, Psbt } from 'bitcoinjs-lib';
 import type { PartialSig } from 'bip174/src/lib/interfaces';
-export interface Preimage {
+/**
+ * Preimage
+ * @alias Preimage
+ * @memberof Descriptor
+ */
+export type Preimage = {
+    /**
+     * Use same 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.
+     */
     digest: string;
+    /**
+     * Hex encoded preimate. Preimages are always 32 bytes (so, 64 character in hex).
+     */
     preimage: string;
-}
+};
 export type TimeConstraints = {
     nLockTime: number | undefined;
     nSequence: number | undefined;
 };
 export type KeyInfo = {
     keyExpression: string;
-    pubkey: Buffer;
+    pubkey?: Buffer;
     ecpair?: ECPairInterface;
     bip32?: BIP32Interface;
     masterFingerprint?: Buffer;
@@ -31,6 +44,23 @@ export interface ParseKeyExpression {
         network?: Network;
     }): KeyInfo;
 }
+export interface Expand {
+    (params: {
+        expression: string;
+        loggedExpression?: string;
+        network?: Network;
+        allowMiniscriptInP2SH?: boolean;
+    }): {
+        payment?: Payment;
+        expandedExpression?: string;
+        miniscript?: string;
+        expansionMap?: ExpansionMap;
+        isSegwit?: boolean;
+        expandedMiniscript?: string;
+        redeemScript?: Buffer;
+        witnessScript?: Buffer;
+    };
+}
 interface XOnlyPointAddTweakResult {
     parity: 1 | 0;
     xOnlyPubkey: Uint8Array;
@@ -49,6 +79,12 @@ export interface TinySecp256k1Interface {
     xOnlyPointAddTweak(p: Uint8Array, tweak: Uint8Array): XOnlyPointAddTweakResult | null;
     privateNegate(d: Uint8Array): Uint8Array;
 }
+/**
+ * DescriptorInfo
+ * What defines a Descriptor. This is the type needed in the constructor.
+ * @alias DescriptorInfo
+ * @memberof Descriptor
+ */
 export type DescriptorInfo = {
     expression: string;
     index?: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bitcoinerlab/descriptors",
   "homepage": "https://github.com/bitcoinerlab/descriptors",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "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",
@@ -9,7 +9,7 @@
     "build": "npx tsc",
     "prepublishOnly": "npm run build && npm test && echo \"\\n\\n\" && npm run test:integration:ledger",
     "docs": "jsdoc -c jsdoc.json",
-    "regtest-docker": "docker ps | grep bitcoinjs-regtest-server > /dev/null || (docker pull junderw/bitcoinjs-regtest-server && docker run -d -p 8080:8080 junderw/bitcoinjs-regtest-server && sleep 5)",
+    "regtest-docker": "docker ps | grep bitcoinerlab/tester > /dev/null || (docker pull bitcoinerlab/tester && docker run -d -p 8080:8080 -p 60401:60401 -p 3002:3002 bitcoinerlab/tester && sleep 5)",
     "test:integration:soft": "npm run regtest-docker && npx ts-node test/integration/standardOutputs.ts && echo \"\\n\\n\" && npx ts-node test/integration/miniscript.ts",
     "test:integration:ledger": "npm run regtest-docker && npx ts-node test/integration/ledger.ts",
     "test:unit": "npm run build && node test/tools/generateBitcoinCoreFixtures.js && jest",
@@ -52,13 +52,14 @@
   "files": [
     "dist"
   ],
+  "COMMENT wrt ledger-bitcoin below": "ledger-bitcoin is installed using an alias. This package can be replaced with the official `ledger-bitcoin` npm package once [this PR](https://github.com/LedgerHQ/app-bitcoin-new/pull/147) is published to npm (likely in version > 0.2.1)",
   "dependencies": {
-    "@bitcoinerlab/ledger": "^0.1.7",
     "@bitcoinerlab/miniscript": "^1.2.1",
     "@bitcoinerlab/secp256k1": "^1.0.2",
     "bip32": "^3.1.0",
     "bitcoinjs-lib": "^6.1.0",
-    "ecpair": "^2.1.0"
+    "ecpair": "^2.1.0",
+    "ledger-bitcoin": "npm:@bitcoinerlab/ledger@^0.2.0"
   },
   "devDependencies": {
     "@babel/plugin-transform-modules-commonjs": "^7.20.11",
@@ -66,6 +67,7 @@
     "@typescript-eslint/eslint-plugin": "^5.53.0",
     "@typescript-eslint/parser": "^5.53.0",
     "babel-plugin-transform-import-meta": "^2.2.0",
+    "better-docs": "^2.7.2",
     "bip39": "^3.0.4",
     "bip65": "^1.0.3",
     "bip68": "^1.0.4",
@@ -74,9 +76,9 @@
     "eslint-plugin-prettier": "^4.2.1",
     "fs": "^0.0.1-security",
     "jest": "^29.4.3",
-    "jsdoc": "^4.0.0",
+    "jsdoc": "^3.6.11",
     "path": "^0.12.7",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.8",
     "regtest-client": "^0.2.0",
     "ts-node-dev": "^2.0.0"
   }