Merge branch 'master' of github.com:bitcoinjs/bitcoinjs-lib

Author: SpiderMan670

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 6.1.7
+__added__
+- skip ecc library verification via DANGER_DO_NOT_VERIFY_ECCLIB flag
+
 # 6.1.6
 __fixed__
 - Fix sighash treatment when signing taproot script sign scripts using Psbt (#2104)

src/cjs/ecc_lib.cjs

@@ -54,14 +54,16 @@ const _ECCLIB_CACHE = {};
  * If `eccLib` is a new instance, it will be verified before setting it as the active library.
  *
  * @param eccLib The instance of the ECC library to initialize.
+ * @param opts Extra initialization options. Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
-function initEccLib(eccLib) {
+function initEccLib(eccLib, opts) {
   if (!eccLib) {
     // allow clearing the library
     _ECCLIB_CACHE.eccLib = eccLib;
   } else if (eccLib !== _ECCLIB_CACHE.eccLib) {
-    // new instance, verify it
-    verifyEcc(eccLib);
+    if (!opts?.DANGER_DO_NOT_VERIFY_ECCLIB)
+      // new instance, verify it
+      verifyEcc(eccLib);
     _ECCLIB_CACHE.eccLib = eccLib;
   }
 }

src/cjs/ecc_lib.d.ts

@@ -5,8 +5,11 @@ import { TinySecp256k1Interface } from './types.js';
  * If `eccLib` is a new instance, it will be verified before setting it as the active library.
  *
  * @param eccLib The instance of the ECC library to initialize.
+ * @param opts Extra initialization options. Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
-export declare function initEccLib(eccLib: TinySecp256k1Interface | undefined): void;
+export declare function initEccLib(eccLib: TinySecp256k1Interface | undefined, opts?: {
+    DANGER_DO_NOT_VERIFY_ECCLIB: boolean;
+}): void;
 /**
  * Retrieves the ECC Library instance.
  * Throws an error if the ECC Library is not provided.

src/cjs/transaction.cjs

@@ -203,6 +203,11 @@ class Transaction {
       return x.witness.length !== 0;
     });
   }
+  stripWitnesses() {
+    this.ins.forEach(input => {
+      input.witness = EMPTY_WITNESS; // Set witness data to an empty array
+    });
+  }
   weight() {
     const base = this.byteLength(false);
     const total = this.byteLength(true);

src/cjs/transaction.d.ts

@@ -34,6 +34,7 @@ export declare class Transaction {
     addInput(hash: Uint8Array, index: number, sequence?: number, scriptSig?: Uint8Array): number;
     addOutput(scriptPubKey: Uint8Array, value: bigint): number;
     hasWitnesses(): boolean;
+    stripWitnesses(): void;
     weight(): number;
     virtualSize(): number;
     byteLength(_ALLOW_WITNESS?: boolean): number;

src/esm/ecc_lib.js

@@ -6,14 +6,16 @@ const _ECCLIB_CACHE = {};
  * If `eccLib` is a new instance, it will be verified before setting it as the active library.
  *
  * @param eccLib The instance of the ECC library to initialize.
+ * @param opts Extra initialization options. Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
-export function initEccLib(eccLib) {
+export function initEccLib(eccLib, opts) {
   if (!eccLib) {
     // allow clearing the library
     _ECCLIB_CACHE.eccLib = eccLib;
   } else if (eccLib !== _ECCLIB_CACHE.eccLib) {
-    // new instance, verify it
-    verifyEcc(eccLib);
+    if (!opts?.DANGER_DO_NOT_VERIFY_ECCLIB)
+      // new instance, verify it
+      verifyEcc(eccLib);
     _ECCLIB_CACHE.eccLib = eccLib;
   }
 }

src/esm/transaction.js

@@ -161,6 +161,11 @@ export class Transaction {
       return x.witness.length !== 0;
     });
   }
+  stripWitnesses() {
+    this.ins.forEach(input => {
+      input.witness = EMPTY_WITNESS; // Set witness data to an empty array
+    });
+  }
   weight() {
     const base = this.byteLength(false);
     const total = this.byteLength(true);

test/ecc_lib.spec.ts

@@ -0,0 +1,22 @@
+import { initEccLib } from 'bitcoinjs-lib';
+import { describe, test } from 'mocha';
+import * as assert from 'assert';
+
+describe(`initEccLib`, () => {
+  beforeEach(() => {
+    initEccLib(undefined);
+  });
+
+  test('initEccLib should fail when invalid', () => {
+    assert.throws(() => {
+      initEccLib({ isXOnlyPoint: () => false } as any);
+    }, 'Error: ecc library invalid');
+  });
+
+  test('initEccLib should not fail when DANGER_DO_NOT_VERIFY_ECCLIB = true', () => {
+    initEccLib({ isXOnlyPoint: () => false } as any, {
+      DANGER_DO_NOT_VERIFY_ECCLIB: true,
+    });
+    assert.ok('it does not fail, verification is excluded');
+  });
+});

test/transaction.spec.ts

@@ -135,6 +135,16 @@ describe('Transaction', () => {
     });
   });
 
+  describe('stripWitnesses', () => {
+    fixtures.valid.forEach(f => {
+      it('removes witness from the transaction if it exists', () => {
+        const T = Transaction.fromHex(f.whex ? f.whex : f.hex);
+        T.stripWitnesses();
+        assert.strictEqual(T.hasWitnesses(), false);
+      });
+    });
+  });
+
   describe('weight/virtualSize', () => {
     it('computes virtual size', () => {
       fixtures.valid.forEach(f => {

ts_src/ecc_lib.ts

@@ -9,14 +9,19 @@ const _ECCLIB_CACHE: { eccLib?: TinySecp256k1Interface } = {};
  * If `eccLib` is a new instance, it will be verified before setting it as the active library.
  *
  * @param eccLib The instance of the ECC library to initialize.
+ * @param opts Extra initialization options. Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
-export function initEccLib(eccLib: TinySecp256k1Interface | undefined): void {
+export function initEccLib(
+  eccLib: TinySecp256k1Interface | undefined,
+  opts?: { DANGER_DO_NOT_VERIFY_ECCLIB: boolean },
+): void {
   if (!eccLib) {
     // allow clearing the library
     _ECCLIB_CACHE.eccLib = eccLib;
   } else if (eccLib !== _ECCLIB_CACHE.eccLib) {
-    // new instance, verify it
-    verifyEcc(eccLib!);
+    if (!opts?.DANGER_DO_NOT_VERIFY_ECCLIB)
+      // new instance, verify it
+      verifyEcc(eccLib!);
     _ECCLIB_CACHE.eccLib = eccLib;
   }
 }