From 53dd7caf9b31acd8712d41a00ca5e7a672bd923c Mon Sep 17 00:00:00 2001 From: fboucquez Date: Mon, 2 Dec 2024 17:08:38 -0300 Subject: [PATCH] feedback fix, added tests --- src/ecc_lib.d.ts | 6 ++++-- src/ecc_lib.js | 4 ++-- test/ecc_lib.spec.ts | 22 ++++++++++++++++++++++ ts_src/ecc_lib.ts | 6 +++--- 4 files changed, 31 insertions(+), 7 deletions(-) create mode 100644 test/ecc_lib.spec.ts diff --git a/src/ecc_lib.d.ts b/src/ecc_lib.d.ts index 382ad4aa0..12b83d1a9 100644 --- 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 index fe1905eec..aae264f05 100644 --- 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 new file mode 100644 index 000000000..e8bd2a41e --- /dev/null +++ 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 index e2423d983..72f43754f 100644 --- 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;