feedback fix, added tests

bitcoinjs · Dec 2, 2024 · 53dd7ca · 53dd7ca
1 parent ea07097
commit 53dd7ca
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 7 deletions.
diff --git a/src/ecc_lib.d.ts b/src/ecc_lib.d.ts
@@ -5,9 +5,11 @@ import { TinySecp256k1Interface } from './types';
  * 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 skipVerification If the ecc verification should not be executed.
+ * @param skipVerification Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
-export declare function initEccLib(eccLib: TinySecp256k1Interface | undefined, skipVerification?: boolean): void;
+export declare function initEccLib(eccLib: TinySecp256k1Interface | undefined, skipVerification?: {
+    DANGER_DO_NOT_VERIFY_ECCLIB: boolean;
+}): void;
 /**
  * Retrieves the ECC Library instance.
  * Throws an error if the ECC Library is not provided.

diff --git a/src/ecc_lib.js b/src/ecc_lib.js
@@ -8,14 +8,14 @@ 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 skipVerification If the ecc verification should not be executed.
+ * @param skipVerification Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
 function initEccLib(eccLib, skipVerification) {
   if (!eccLib) {
     // allow clearing the library
     _ECCLIB_CACHE.eccLib = eccLib;
   } else if (eccLib !== _ECCLIB_CACHE.eccLib) {
-    if (!skipVerification)
+    if (!skipVerification?.DANGER_DO_NOT_VERIFY_ECCLIB)
       // new instance, verify it
       verifyEcc(eccLib);
     _ECCLIB_CACHE.eccLib = eccLib;

diff --git a/test/ecc_lib.spec.ts b/test/ecc_lib.spec.ts
@@ -0,0 +1,22 @@
+import { initEccLib } from '../src';
+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');
+  });
+});
diff --git a/ts_src/ecc_lib.ts b/ts_src/ecc_lib.ts
@@ -8,17 +8,17 @@ 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 skipVerification If the ecc verification should not be executed.
+ * @param skipVerification Use {DANGER_DO_NOT_VERIFY_ECCLIB:true} if ecc verification should not be executed. Not recommended!
  */
 export function initEccLib(
   eccLib: TinySecp256k1Interface | undefined,
-  skipVerification?: boolean,
+  skipVerification?: { DANGER_DO_NOT_VERIFY_ECCLIB: boolean },
 ): void {
   if (!eccLib) {
     // allow clearing the library
     _ECCLIB_CACHE.eccLib = eccLib;
   } else if (eccLib !== _ECCLIB_CACHE.eccLib) {
-    if (!skipVerification)
+    if (!skipVerification?.DANGER_DO_NOT_VERIFY_ECCLIB)
       // new instance, verify it
       verifyEcc(eccLib!);
     _ECCLIB_CACHE.eccLib = eccLib;