refactor: add Taptree interface

Author: motorina0

src/payments/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Network } from '../networks';
-import { TinySecp256k1Interface, TaprootLeaf } from '../types';
+import { TinySecp256k1Interface, Taptree } from '../types';
 import { p2data as embed } from './embed';
 import { p2ms } from './p2ms';
 import { p2pk } from './p2pk';
@@ -26,7 +26,7 @@ export interface Payment {
     hash?: Buffer;
     redeem?: Payment;
     redeemVersion?: number;
-    scriptTree?: TaprootLeaf[];
+    scriptTree?: Taptree;
     witness?: Buffer[];
 }
 export declare type PaymentCreator = (a: Payment, opts?: PaymentOpts) => Payment;

src/payments/taprootutils.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { TaprootLeaf } from '../types';
+import { Taptree } from '../types';
 export declare const LEAF_VERSION_TAPSCRIPT = 192;
 export declare function rootHashFromPath(controlBlock: Buffer, tapLeafMsg: Buffer): Buffer;
 export interface HashTree {
@@ -15,11 +15,11 @@ export interface HashTree {
  *  - a pair of two taproot leafs [(output, version), (output, version)], or
  *  - one taproot leaf and a list of elements
  */
-export declare function toHashTree(scriptTree: TaprootLeaf[]): HashTree;
+export declare function toHashTree(scriptTree: Taptree): HashTree;
 /**
- * Check if the tree is a binary tree with leafs of type TaprootLeaf
+ * Check if the tree is a binary tree with leafs of type Tapleaf
  */
-export declare function isTapTree(scriptTree: TaprootLeaf[]): boolean;
+export declare function isTapTree(scriptTree: Taptree): boolean;
 /**
  * Given a MAST tree, it finds the path of a particular hash.
  * @param node - the root of the tree

src/payments/taprootutils.js

@@ -55,7 +55,7 @@ function toHashTree(scriptTree) {
 }
 exports.toHashTree = toHashTree;
 /**
- * Check if the tree is a binary tree with leafs of type TaprootLeaf
+ * Check if the tree is a binary tree with leafs of type Tapleaf
  */
 function isTapTree(scriptTree) {
   if (scriptTree.length > 2) return false;

src/types.d.ts

@@ -14,10 +14,11 @@ export interface XOnlyPointAddTweakResult {
     parity: 1 | 0;
     xOnlyPubkey: Uint8Array;
 }
-export interface TaprootLeaf {
+export interface Tapleaf {
     output: Buffer;
     version?: number;
 }
+export declare type Taptree = Array<[Tapleaf, Tapleaf] | Tapleaf>;
 export interface TinySecp256k1Interface {
     isXOnlyPoint(p: Uint8Array): boolean;
     xOnlyPointAddTweak(p: Uint8Array, tweak: Uint8Array): XOnlyPointAddTweakResult | null;

ts_src/payments/index.ts

@@ -1,5 +1,5 @@
 import { Network } from '../networks';
-import { TinySecp256k1Interface, TaprootLeaf } from '../types';
+import { TinySecp256k1Interface, Taptree } from '../types';
 import { p2data as embed } from './embed';
 import { p2ms } from './p2ms';
 import { p2pk } from './p2pk';
@@ -26,7 +26,7 @@ export interface Payment {
   hash?: Buffer;
   redeem?: Payment;
   redeemVersion?: number;
-  scriptTree?: TaprootLeaf[];
+  scriptTree?: Taptree;
   witness?: Buffer[];
 }
 

ts_src/payments/taprootutils.ts

@@ -2,7 +2,7 @@ import { Buffer as NBuffer } from 'buffer';
 import * as bcrypto from '../crypto';
 
 import { varuint } from '../bufferutils';
-import { TaprootLeaf } from '../types';
+import { Taptree } from '../types';
 
 const TAP_LEAF_TAG = 'TapLeaf';
 const TAP_BRANCH_TAG = 'TapBranch';
@@ -45,7 +45,7 @@ export interface HashTree {
  *  - a pair of two taproot leafs [(output, version), (output, version)], or
  *  - one taproot leaf and a list of elements
  */
-export function toHashTree(scriptTree: TaprootLeaf[]): HashTree {
+export function toHashTree(scriptTree: Taptree): HashTree {
   if (scriptTree.length === 1) {
     const script = scriptTree[0];
     if (Array.isArray(script)) {
@@ -71,9 +71,9 @@ export function toHashTree(scriptTree: TaprootLeaf[]): HashTree {
   };
 }
 /**
- * Check if the tree is a binary tree with leafs of type TaprootLeaf
+ * Check if the tree is a binary tree with leafs of type Tapleaf
  */
-export function isTapTree(scriptTree: TaprootLeaf[]): boolean {
+export function isTapTree(scriptTree: Taptree): boolean {
   if (scriptTree.length > 2) return false;
   if (scriptTree.length === 1) {
     const script = scriptTree[0];

ts_src/types.ts

@@ -72,11 +72,13 @@ export interface XOnlyPointAddTweakResult {
   xOnlyPubkey: Uint8Array;
 }
 
-export interface TaprootLeaf {
+export interface Tapleaf {
   output: Buffer;
   version?: number;
 }
 
+export type Taptree = Array<[Tapleaf, Tapleaf] | Tapleaf>;
+
 export interface TinySecp256k1Interface {
   isXOnlyPoint(p: Uint8Array): boolean;
   xOnlyPointAddTweak(