Merge branch 'doc' of https://github.com/jasonandjay/bitcoinjs-lib into doc

jasonandjay · jasonandjay · commit c6cb2f843bb0 · 2024-03-01T01:54:14.000+08:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,8 +14,8 @@ We are always accepting of pull requests, but we do adhere to specific standards
 GitHub is the preferred method of communication between members.
 
 Otherwise, in order of preference:
-* bitcoinjs.slack.com
-* #bitcoinjs-dev on Freenode IRC
+* #bitcoinjs-dev:matrix.org on Matrix (A part of the #bitcoinjs-space:matrix.org "Space")
+* #bitcoinjs on libera.chat IRC
 
 
 ## Workflow
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/payments/embed.js b/src/payments/embed.js
@@ -6,12 +6,6 @@ const bscript = require('../script');
 const types_1 = require('../types');
 const lazy = require('./lazy');
 const OPS = bscript.OPS;
-function stacksEqual(a, b) {
-  if (a.length !== b.length) return false;
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
 // output: OP_RETURN ...
 /**
  * Embeds data in a Bitcoin payment.
@@ -50,7 +44,7 @@ function p2data(a, opts) {
       if (chunks[0] !== OPS.OP_RETURN) throw new TypeError('Output is invalid');
       if (!chunks.slice(1).every(types_1.typeforce.Buffer))
         throw new TypeError('Output is invalid');
-      if (a.data && !stacksEqual(a.data, o.data))
+      if (a.data && !(0, types_1.stacksEqual)(a.data, o.data))
         throw new TypeError('Data mismatch');
     }
   }
diff --git a/src/payments/p2ms.js b/src/payments/p2ms.js
@@ -7,12 +7,6 @@ const types_1 = require('../types');
 const lazy = require('./lazy');
 const OPS = bscript.OPS;
 const OP_INT_BASE = OPS.OP_RESERVED; // OP_1 - 1
-function stacksEqual(a, b) {
-  if (a.length !== b.length) return false;
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
 // input: OP_0 [signatures ...]
 // output: m [pubKeys ...] n OP_CHECKMULTISIG
 /**
@@ -124,7 +118,7 @@ function p2ms(a, opts) {
         throw new TypeError('Output is invalid');
       if (a.m !== undefined && a.m !== o.m) throw new TypeError('m mismatch');
       if (a.n !== undefined && a.n !== o.n) throw new TypeError('n mismatch');
-      if (a.pubkeys && !stacksEqual(a.pubkeys, o.pubkeys))
+      if (a.pubkeys && !(0, types_1.stacksEqual)(a.pubkeys, o.pubkeys))
         throw new TypeError('Pubkeys mismatch');
     }
     if (a.pubkeys) {
@@ -146,7 +140,7 @@ function p2ms(a, opts) {
         !o.signatures.every(isAcceptableSignature)
       )
         throw new TypeError('Input has invalid signature(s)');
-      if (a.signatures && !stacksEqual(a.signatures, o.signatures))
+      if (a.signatures && !(0, types_1.stacksEqual)(a.signatures, o.signatures))
         throw new TypeError('Signature mismatch');
       if (a.m !== undefined && a.m !== a.signatures.length)
         throw new TypeError('Signature count mismatch');
diff --git a/src/payments/p2sh.js b/src/payments/p2sh.js
@@ -8,12 +8,6 @@ const types_1 = require('../types');
 const lazy = require('./lazy');
 const bs58check = require('bs58check');
 const OPS = bscript.OPS;
-function stacksEqual(a, b) {
-  if (a.length !== b.length) return false;
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
 // input: [redeemScriptSig ...] {redeemScript}
 // witness: <?>
 // output: OP_HASH160 {hash160(redeemScript)} OP_EQUAL
@@ -196,7 +190,7 @@ function p2sh(a, opts) {
       if (
         a.redeem &&
         a.redeem.witness &&
-        !stacksEqual(a.redeem.witness, a.witness)
+        !(0, types_1.stacksEqual)(a.redeem.witness, a.witness)
       )
         throw new TypeError('Witness and redeem.witness mismatch');
     }
diff --git a/src/payments/p2tr.js b/src/payments/p2tr.js
@@ -9,6 +9,7 @@ const ecc_lib_1 = require('../ecc_lib');
 const bip341_1 = require('./bip341');
 const lazy = require('./lazy');
 const bech32_1 = require('bech32');
+const address_1 = require('../address');
 const OPS = bscript.OPS;
 const TAPROOT_WITNESS_VERSION = 0x01;
 const ANNEX_PREFIX = 0x50;
@@ -61,14 +62,7 @@ function p2tr(a, opts) {
     a,
   );
   const _address = lazy.value(() => {
-    const result = bech32_1.bech32m.decode(a.address);
-    const version = result.words.shift();
-    const data = bech32_1.bech32m.fromWords(result.words);
-    return {
-      version,
-      prefix: result.prefix,
-      data: buffer_1.Buffer.from(data),
-    };
+    return (0, address_1.fromBech32)(a.address);
   });
   // remove annex if present, ignored by taproot
   const _witness = lazy.value(() => {
@@ -245,7 +239,7 @@ function p2tr(a, opts) {
       if (a.redeem.witness) {
         if (
           o.redeem.witness &&
-          !stacksEqual(a.redeem.witness, o.redeem.witness)
+          !(0, types_1.stacksEqual)(a.redeem.witness, o.redeem.witness)
         )
           throw new TypeError('Redeem.witness and witness mismatch');
       }
@@ -297,9 +291,3 @@ function p2tr(a, opts) {
   return Object.assign(o, a);
 }
 exports.p2tr = p2tr;
-function stacksEqual(a, b) {
-  if (a.length !== b.length) return false;
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
diff --git a/src/payments/p2wsh.js b/src/payments/p2wsh.js
@@ -9,12 +9,6 @@ const lazy = require('./lazy');
 const bech32_1 = require('bech32');
 const OPS = bscript.OPS;
 const EMPTY_BUFFER = Buffer.alloc(0);
-function stacksEqual(a, b) {
-  if (a.length !== b.length) return false;
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
 function chunkHasUncompressedPubkey(chunk) {
   if (
     Buffer.isBuffer(chunk) &&
@@ -198,7 +192,7 @@ function p2wsh(a, opts) {
       if (
         a.witness &&
         a.redeem.witness &&
-        !stacksEqual(a.witness, a.redeem.witness)
+        !(0, types_1.stacksEqual)(a.witness, a.redeem.witness)
       )
         throw new TypeError('Witness and redeem.witness mismatch');
       if (
diff --git a/src/script_signature.js b/src/script_signature.js
@@ -2,6 +2,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.encode = exports.decode = void 0;
 const bip66 = require('./bip66');
+const script_1 = require('./script');
 const types = require('./types');
 const { typeforce } = types;
 const ZERO = Buffer.alloc(1, 0);
@@ -41,9 +42,9 @@ function fromDER(x) {
  */
 function decode(buffer) {
   const hashType = buffer.readUInt8(buffer.length - 1);
-  const hashTypeMod = hashType & ~0x80;
-  if (hashTypeMod <= 0 || hashTypeMod >= 4)
+  if (!(0, script_1.isDefinedHashType)(hashType)) {
     throw new Error('Invalid hashType ' + hashType);
+  }
   const decoded = bip66.decode(buffer.slice(0, -1));
   const r = fromDER(decoded.r);
   const s = fromDER(decoded.s);
@@ -66,9 +67,9 @@ function encode(signature, hashType) {
     },
     { signature, hashType },
   );
-  const hashTypeMod = hashType & ~0x80;
-  if (hashTypeMod <= 0 || hashTypeMod >= 4)
+  if (!(0, script_1.isDefinedHashType)(hashType)) {
     throw new Error('Invalid hashType ' + hashType);
+  }
   const hashTypeBuffer = Buffer.allocUnsafe(1);
   hashTypeBuffer.writeUInt8(hashType, 0);
   const r = toDER(signature.slice(0, 32));
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,5 +1,12 @@
 /// <reference types="node" />
 export declare const typeforce: any;
+/**
+ * Checks if two arrays of Buffers are equal.
+ * @param a - The first array of Buffers.
+ * @param b - The second array of Buffers.
+ * @returns True if the arrays are equal, false otherwise.
+ */
+export declare function stacksEqual(a: Buffer[], b: Buffer[]): boolean;
 /**
  * Checks if the given value is a valid elliptic curve point.
  * @param p - The value to check.
diff --git a/src/types.js b/src/types.js
@@ -27,6 +27,7 @@ exports.oneOf =
   exports.BIP32Path =
   exports.UInt31 =
   exports.isPoint =
+  exports.stacksEqual =
   exports.typeforce =
     void 0;
 const buffer_1 = require('buffer');
@@ -36,6 +37,19 @@ const EC_P = buffer_1.Buffer.from(
   'fffffffffffffffffffffffffffffffffffffffffffffffffffffffefffffc2f',
   'hex',
 );
+/**
+ * Checks if two arrays of Buffers are equal.
+ * @param a - The first array of Buffers.
+ * @param b - The second array of Buffers.
+ * @returns True if the arrays are equal, false otherwise.
+ */
+function stacksEqual(a, b) {
+  if (a.length !== b.length) return false;
+  return a.every((x, i) => {
+    return x.equals(b[i]);
+  });
+}
+exports.stacksEqual = stacksEqual;
 /**
  * Checks if the given value is a valid elliptic curve point.
  * @param p - The value to check.
diff --git a/ts_src/payments/embed.ts b/ts_src/payments/embed.ts
@@ -1,19 +1,11 @@
 import { bitcoin as BITCOIN_NETWORK } from '../networks';
 import * as bscript from '../script';
-import { typeforce as typef } from '../types';
+import { typeforce as typef, stacksEqual } from '../types';
 import { Payment, PaymentOpts, Stack } from './index';
 import * as lazy from './lazy';
 
 const OPS = bscript.OPS;
 
-function stacksEqual(a: Buffer[], b: Buffer[]): boolean {
-  if (a.length !== b.length) return false;
-
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
-
 // output: OP_RETURN ...
 /**
  * Embeds data in a Bitcoin payment.
diff --git a/ts_src/payments/p2ms.ts b/ts_src/payments/p2ms.ts
@@ -1,20 +1,12 @@
 import { bitcoin as BITCOIN_NETWORK } from '../networks';
 import * as bscript from '../script';
-import { isPoint, typeforce as typef } from '../types';
+import { isPoint, typeforce as typef, stacksEqual } from '../types';
 import { Payment, PaymentOpts, Stack } from './index';
 import * as lazy from './lazy';
 const OPS = bscript.OPS;
 
 const OP_INT_BASE = OPS.OP_RESERVED; // OP_1 - 1
 
-function stacksEqual(a: Buffer[], b: Buffer[]): boolean {
-  if (a.length !== b.length) return false;
-
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
-
 // input: OP_0 [signatures ...]
 // output: m [pubKeys ...] n OP_CHECKMULTISIG
 /**
diff --git a/ts_src/payments/p2sh.ts b/ts_src/payments/p2sh.ts
@@ -1,7 +1,7 @@
 import * as bcrypto from '../crypto';
 import { bitcoin as BITCOIN_NETWORK } from '../networks';
 import * as bscript from '../script';
-import { typeforce as typef } from '../types';
+import { typeforce as typef, stacksEqual } from '../types';
 import {
   Payment,
   PaymentFunction,
@@ -13,14 +13,6 @@ import * as lazy from './lazy';
 import * as bs58check from 'bs58check';
 const OPS = bscript.OPS;
 
-function stacksEqual(a: Buffer[], b: Buffer[]): boolean {
-  if (a.length !== b.length) return false;
-
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
-
 // input: [redeemScriptSig ...] {redeemScript}
 // witness: <?>
 // output: OP_HASH160 {hash160(redeemScript)} OP_EQUAL
diff --git a/ts_src/payments/p2tr.ts b/ts_src/payments/p2tr.ts
@@ -1,7 +1,12 @@
 import { Buffer as NBuffer } from 'buffer';
 import { bitcoin as BITCOIN_NETWORK } from '../networks';
 import * as bscript from '../script';
-import { typeforce as typef, isTaptree, TAPLEAF_VERSION_MASK } from '../types';
+import {
+  typeforce as typef,
+  isTaptree,
+  TAPLEAF_VERSION_MASK,
+  stacksEqual,
+} from '../types';
 import { getEccLib } from '../ecc_lib';
 import {
   toHashTree,
@@ -14,6 +19,7 @@ import {
 import { Payment, PaymentOpts } from './index';
 import * as lazy from './lazy';
 import { bech32m } from 'bech32';
+import { fromBech32 } from '../address';
 
 const OPS = bscript.OPS;
 const TAPROOT_WITNESS_VERSION = 0x01;
@@ -62,14 +68,7 @@ export function p2tr(a: Payment, opts?: PaymentOpts): Payment {
   );
 
   const _address = lazy.value(() => {
-    const result = bech32m.decode(a.address!);
-    const version = result.words.shift();
-    const data = bech32m.fromWords(result.words);
-    return {
-      version,
-      prefix: result.prefix,
-      data: NBuffer.from(data),
-    };
+    return fromBech32(a.address!);
   });
 
   // remove annex if present, ignored by taproot
@@ -322,11 +321,3 @@ export function p2tr(a: Payment, opts?: PaymentOpts): Payment {
 
   return Object.assign(o, a);
 }
-
-function stacksEqual(a: Buffer[], b: Buffer[]): boolean {
-  if (a.length !== b.length) return false;
-
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
diff --git a/ts_src/payments/p2wsh.ts b/ts_src/payments/p2wsh.ts
@@ -1,22 +1,14 @@
 import * as bcrypto from '../crypto';
 import { bitcoin as BITCOIN_NETWORK } from '../networks';
 import * as bscript from '../script';
-import { isPoint, typeforce as typef } from '../types';
+import { isPoint, typeforce as typef, stacksEqual } from '../types';
 import { Payment, PaymentOpts, StackElement, StackFunction } from './index';
 import * as lazy from './lazy';
 import { bech32 } from 'bech32';
 const OPS = bscript.OPS;
 
 const EMPTY_BUFFER = Buffer.alloc(0);
 
-function stacksEqual(a: Buffer[], b: Buffer[]): boolean {
-  if (a.length !== b.length) return false;
-
-  return a.every((x, i) => {
-    return x.equals(b[i]);
-  });
-}
-
 function chunkHasUncompressedPubkey(chunk: StackElement): boolean {
   if (
     Buffer.isBuffer(chunk) &&
diff --git a/ts_src/script_signature.ts b/ts_src/script_signature.ts
@@ -1,4 +1,5 @@
 import * as bip66 from './bip66';
+import { isDefinedHashType } from './script';
 import * as types from './types';
 const { typeforce } = types;
 
@@ -46,9 +47,9 @@ interface ScriptSignature {
  */
 export function decode(buffer: Buffer): ScriptSignature {
   const hashType = buffer.readUInt8(buffer.length - 1);
-  const hashTypeMod = hashType & ~0x80;
-  if (hashTypeMod <= 0 || hashTypeMod >= 4)
+  if (!isDefinedHashType(hashType)) {
     throw new Error('Invalid hashType ' + hashType);
+  }
 
   const decoded = bip66.decode(buffer.slice(0, -1));
   const r = fromDER(decoded.r);
@@ -74,9 +75,9 @@ export function encode(signature: Buffer, hashType: number): Buffer {
     { signature, hashType },
   );
 
-  const hashTypeMod = hashType & ~0x80;
-  if (hashTypeMod <= 0 || hashTypeMod >= 4)
+  if (!isDefinedHashType(hashType)) {
     throw new Error('Invalid hashType ' + hashType);
+  }
 
   const hashTypeBuffer = Buffer.allocUnsafe(1);
   hashTypeBuffer.writeUInt8(hashType, 0);
diff --git a/ts_src/types.ts b/ts_src/types.ts
