refactor: rename taprootutils to bip341

Author: motorina0

src/payments/taprootutils.d.ts renamed to src/payments/bip341.d.ts

@@ -6,7 +6,7 @@ const networks_1 = require('../networks');
 const bscript = require('../script');
 const types_1 = require('../types');
 const ecc_lib_1 = require('../ecc_lib');
-const taprootutils_1 = require('./taprootutils');
+const bip341_1 = require('./bip341');
 const lazy = require('./lazy');
 const bech32_1 = require('bech32');
 const OPS = bscript.OPS;
@@ -69,7 +69,7 @@ function p2tr(a, opts) {
     return a.witness.slice();
   });
   const _hashTree = lazy.value(() => {
-    if (a.scriptTree) return (0, taprootutils_1.toHashTree)(a.scriptTree);
+    if (a.scriptTree) return (0, bip341_1.toHashTree)(a.scriptTree);
     if (a.hash) return { hash: a.hash };
     return;
   });
@@ -89,11 +89,11 @@ function p2tr(a, opts) {
       const controlBlock = w[w.length - 1];
       const leafVersion = controlBlock[0] & types_1.TAPLEAF_VERSION_MASK;
       const script = w[w.length - 2];
-      const leafHash = (0, taprootutils_1.tapleafHash)({
+      const leafHash = (0, bip341_1.tapleafHash)({
         output: script,
         version: leafVersion,
       });
-      return (0, taprootutils_1.rootHashFromPath)(controlBlock, leafHash);
+      return (0, bip341_1.rootHashFromPath)(controlBlock, leafHash);
     }
     return null;
   });
@@ -110,7 +110,7 @@ function p2tr(a, opts) {
     ) {
       return a.redeem.redeemVersion;
     }
-    return taprootutils_1.LEAF_VERSION_TAPSCRIPT;
+    return bip341_1.LEAF_VERSION_TAPSCRIPT;
   });
   lazy.prop(o, 'redeem', () => {
     const witness = _witness(); // witness without annex
@@ -127,7 +127,7 @@ function p2tr(a, opts) {
     if (a.output) return a.output.slice(2);
     if (a.address) return _address().data;
     if (o.internalPubkey) {
-      const tweakedKey = (0, taprootutils_1.tweakKey)(o.internalPubkey, o.hash);
+      const tweakedKey = (0, bip341_1.tweakKey)(o.internalPubkey, o.hash);
       if (tweakedKey) return tweakedKey.x;
     }
   });
@@ -147,16 +147,13 @@ function p2tr(a, opts) {
     if (a.witness) return a.witness;
     const hashTree = _hashTree();
     if (hashTree && a.redeem && a.redeem.output && a.internalPubkey) {
-      const leafHash = (0, taprootutils_1.tapleafHash)({
+      const leafHash = (0, bip341_1.tapleafHash)({
         output: a.redeem.output,
         version: o.redeemVersion,
       });
-      const path = (0, taprootutils_1.findScriptPath)(hashTree, leafHash);
+      const path = (0, bip341_1.findScriptPath)(hashTree, leafHash);
       if (!path) return;
-      const outputKey = (0, taprootutils_1.tweakKey)(
-        a.internalPubkey,
-        hashTree.hash,
-      );
+      const outputKey = (0, bip341_1.tweakKey)(a.internalPubkey, hashTree.hash);
       if (!outputKey) return;
       const controlBock = buffer_1.Buffer.concat(
         [
@@ -197,7 +194,7 @@ function p2tr(a, opts) {
       else pubkey = a.output.slice(2);
     }
     if (a.internalPubkey) {
-      const tweakedKey = (0, taprootutils_1.tweakKey)(a.internalPubkey, o.hash);
+      const tweakedKey = (0, bip341_1.tweakKey)(a.internalPubkey, o.hash);
       if (pubkey.length > 0 && !pubkey.equals(tweakedKey.x))
         throw new TypeError('Pubkey mismatch');
       else pubkey = tweakedKey.x;
@@ -211,11 +208,11 @@ function p2tr(a, opts) {
       if (!a.hash.equals(hashTree.hash)) throw new TypeError('Hash mismatch');
     }
     if (a.redeem && a.redeem.output && hashTree) {
-      const leafHash = (0, taprootutils_1.tapleafHash)({
+      const leafHash = (0, bip341_1.tapleafHash)({
         output: a.redeem.output,
         version: o.redeemVersion,
       });
-      if (!(0, taprootutils_1.findScriptPath)(hashTree, leafHash))
+      if (!(0, bip341_1.findScriptPath)(hashTree, leafHash))
         throw new TypeError('Redeem script not in tree');
     }
     const witness = _witness();
@@ -270,15 +267,12 @@ function p2tr(a, opts) {
           throw new TypeError('Invalid internalPubkey for p2tr witness');
         const leafVersion = controlBlock[0] & types_1.TAPLEAF_VERSION_MASK;
         const script = witness[witness.length - 2];
-        const leafHash = (0, taprootutils_1.tapleafHash)({
+        const leafHash = (0, bip341_1.tapleafHash)({
           output: script,
           version: leafVersion,
         });
-        const hash = (0, taprootutils_1.rootHashFromPath)(
-          controlBlock,
-          leafHash,
-        );
-        const outputKey = (0, taprootutils_1.tweakKey)(internalPubkey, hash);
+        const hash = (0, bip341_1.rootHashFromPath)(controlBlock, leafHash);
+        const outputKey = (0, bip341_1.tweakKey)(internalPubkey, hash);
         if (!outputKey)
           // todo: needs test data
           throw new TypeError('Invalid outputKey for p2tr witness');

src/payments/taprootutils.js renamed to src/payments/bip341.js

@@ -8,7 +8,7 @@ const address_1 = require('./address');
 const bufferutils_1 = require('./bufferutils');
 const networks_1 = require('./networks');
 const payments = require('./payments');
-const taprootutils_1 = require('./payments/taprootutils');
+const bip341_1 = require('./payments/bip341');
 const bscript = require('./script');
 const transaction_1 = require('./transaction');
 const bip371_1 = require('./psbt/bip371');
@@ -1325,7 +1325,7 @@ function getTaprootHashesForSig(
   const tapLeafHashes = (input.tapLeafScript || [])
     .filter(tapLeaf => (0, psbtutils_1.pubkeyInScript)(pubkey, tapLeaf.script))
     .map(tapLeaf => {
-      const hash = (0, taprootutils_1.tapleafHash)({
+      const hash = (0, bip341_1.tapleafHash)({
         output: tapLeaf.script,
         version: tapLeaf.leafVersion,
       });

src/payments/p2tr.js

@@ -4,7 +4,7 @@ exports.checkTaprootInputForSigs = exports.tapTreeFromList = exports.tapTreeToLi
 const types_1 = require('../types');
 const transaction_1 = require('../transaction');
 const psbtutils_1 = require('./psbtutils');
-const taprootutils_1 = require('../payments/taprootutils');
+const bip341_1 = require('../payments/bip341');
 const payments_1 = require('../payments');
 const psbtutils_2 = require('./psbtutils');
 const toXOnly = pubKey => (pubKey.length === 32 ? pubKey : pubKey.slice(1, 33));
@@ -101,7 +101,7 @@ function tweakInternalPubKey(inputIndex, input) {
   const tapInternalKey = input.tapInternalKey;
   const outputKey =
     tapInternalKey &&
-    (0, taprootutils_1.tweakKey)(tapInternalKey, input.tapMerkleRoot);
+    (0, bip341_1.tweakKey)(tapInternalKey, input.tapMerkleRoot);
   if (!outputKey)
     throw new Error(
       `Cannot tweak tap internal key for input #${inputIndex}. Public key: ${tapInternalKey &&
@@ -175,13 +175,13 @@ function getTapKeySigFromWithness(finalScriptWitness) {
   if (witness.length === 64 || witness.length === 65) return witness;
 }
 function _tapTreeToList(tree, leaves = [], depth = 0) {
-  if (depth > taprootutils_1.MAX_TAPTREE_DEPTH)
+  if (depth > bip341_1.MAX_TAPTREE_DEPTH)
     throw new Error('Max taptree depth exceeded.');
   if (!tree) return [];
   if ((0, types_1.isTapleaf)(tree)) {
     leaves.push({
       depth,
-      leafVersion: tree.version || taprootutils_1.LEAF_VERSION_TAPSCRIPT,
+      leafVersion: tree.version || bip341_1.LEAF_VERSION_TAPSCRIPT,
       script: tree.output,
     });
     return leaves;
@@ -199,7 +199,7 @@ function instertLeavesInTree(leaves) {
   return tree;
 }
 function instertLeafInTree(leaf, tree, depth = 0) {
-  if (depth > taprootutils_1.MAX_TAPTREE_DEPTH)
+  if (depth > bip341_1.MAX_TAPTREE_DEPTH)
     throw new Error('Max taptree depth exceeded.');
   if (leaf.depth === depth) {
     if (!tree)
@@ -275,18 +275,18 @@ function checkIfTapLeafInTree(inputData, newInputData, action) {
 }
 function isTapLeafInTree(tapLeaf, merkleRoot) {
   if (!merkleRoot) return true;
-  const leafHash = (0, taprootutils_1.tapleafHash)({
+  const leafHash = (0, bip341_1.tapleafHash)({
     output: tapLeaf.script,
     version: tapLeaf.leafVersion,
   });
-  const rootHash = (0, taprootutils_1.rootHashFromPath)(
+  const rootHash = (0, bip341_1.rootHashFromPath)(
     tapLeaf.controlBlock,
     leafHash,
   );
   return rootHash.equals(merkleRoot);
 }
 function sortSignatures(input, tapLeaf) {
-  const leafHash = (0, taprootutils_1.tapleafHash)({
+  const leafHash = (0, bip341_1.tapleafHash)({
     output: tapLeaf.script,
     version: tapLeaf.leafVersion,
   });
@@ -327,7 +327,7 @@ function findTapLeafToFinalize(input, inputIndex, leafHashToFinalize) {
   return tapLeaf;
 }
 function canFinalizeLeaf(leaf, tapScriptSig, hash) {
-  const leafHash = (0, taprootutils_1.tapleafHash)({
+  const leafHash = (0, bip341_1.tapleafHash)({
     output: leaf.script,
     version: leaf.leafVersion,
   });

src/psbt.js

@@ -6,7 +6,7 @@ import ECPairFactory from 'ecpair';
 import { describe, it } from 'mocha';
 
 import { convertScriptTree } from './payments.utils';
-import { LEAF_VERSION_TAPSCRIPT } from '../src/payments/taprootutils';
+import { LEAF_VERSION_TAPSCRIPT } from '../src/payments/bip341';
 import { tapTreeToList, tapTreeFromList } from '../src/psbt/bip371';
 import { Taptree } from '../src/types';
 import { initEccLib } from '../src';

src/psbt/bip371.js

@@ -10,7 +10,7 @@ import {
   tapleafHash,
   tweakKey,
   LEAF_VERSION_TAPSCRIPT,
-} from './taprootutils';
+} from './bip341';
 import { Payment, PaymentOpts } from './index';
 import * as lazy from './lazy';
 import { bech32m } from 'bech32';

test/psbt.spec.ts

@@ -19,7 +19,7 @@ import { fromOutputScript, toOutputScript } from './address';
 import { cloneBuffer, reverseBuffer } from './bufferutils';
 import { bitcoin as btcNetwork, Network } from './networks';
 import * as payments from './payments';
-import { tapleafHash } from './payments/taprootutils';
+import { tapleafHash } from './payments/bip341';
 import * as bscript from './script';
 import { Output, Transaction } from './transaction';
 import {

ts_src/payments/taprootutils.ts renamed to ts_src/payments/bip341.ts

@@ -22,7 +22,7 @@ import {
   rootHashFromPath,
   LEAF_VERSION_TAPSCRIPT,
   MAX_TAPTREE_DEPTH,
-} from '../payments/taprootutils';
+} from '../payments/bip341';
 import { p2tr } from '../payments';
 
 import { signatureBlocksAction } from './psbtutils';