fix(parseBytesAsScriptNumber): accept options as an object

bitauth · Mar 31, 2020 · 8a73752 · 8a73752
1 parent 1532785
commit 8a73752
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 17 deletions.
diff --git a/src/lib/auth/instruction-sets/common/combinators.ts b/src/lib/auth/instruction-sets/common/combinators.ts
@@ -166,11 +166,10 @@ export const useOneScriptNumber = <
   }: { requireMinimalEncoding: boolean; maximumScriptNumberByteLength?: number }
 ) =>
   useOneStackItem(state, (nextState, [item]) => {
-    const value = parseBytesAsScriptNumber(
-      item,
+    const value = parseBytesAsScriptNumber(item, {
+      maximumScriptNumberByteLength,
       requireMinimalEncoding,
-      maximumScriptNumberByteLength
-    );
+    });
     if (isScriptNumberError(value)) {
       return applyError<State, Errors>(
         AuthenticationErrorCommon.invalidScriptNumber,

diff --git a/src/lib/auth/instruction-sets/common/time.ts b/src/lib/auth/instruction-sets/common/time.ts
@@ -43,11 +43,10 @@ export const readLocktime = <
       state
     );
   }
-  const parsedLocktime = parseBytesAsScriptNumber(
-    item,
-    flags.requireMinimalEncoding,
-    Constants.LocktimeScriptNumberByteLength
-  );
+  const parsedLocktime = parseBytesAsScriptNumber(item, {
+    maximumScriptNumberByteLength: Constants.LocktimeScriptNumberByteLength,
+    requireMinimalEncoding: flags.requireMinimalEncoding,
+  });
   if (isScriptNumberError(parsedLocktime)) {
     return applyError<State, Errors>(
       AuthenticationErrorCommon.invalidScriptNumber,

diff --git a/src/lib/auth/instruction-sets/common/types.spec.ts b/src/lib/auth/instruction-sets/common/types.spec.ts
@@ -83,35 +83,72 @@ const equivalentScriptNumbers: readonly [string, string][] = [
 ];
 
 test('parseBytesAsScriptNumber', (t) => {
+  minimallyEncodedScriptNumbers.map((pair) => {
+    t.deepEqual(parseBytesAsScriptNumber(hexToBin(pair[0])), pair[1]);
+    t.deepEqual(
+      parseBytesAsScriptNumber(hexToBin(pair[0]), {
+        requireMinimalEncoding: true,
+      }),
+      pair[1]
+    );
+    t.deepEqual(
+      parseBytesAsScriptNumber(hexToBin(pair[0]), {
+        maximumScriptNumberByteLength: 4,
+        requireMinimalEncoding: true,
+      }),
+      pair[1]
+    );
+    return undefined;
+  });
   [...minimallyEncodedScriptNumbers, ...nonMinimallyEncodedScriptNumbers].map(
     (pair) => {
       t.deepEqual(
-        parseBytesAsScriptNumber(hexToBin(pair[0]), false, 5),
+        parseBytesAsScriptNumber(hexToBin(pair[0]), {
+          maximumScriptNumberByteLength: 5,
+          requireMinimalEncoding: false,
+        }),
         pair[1]
       );
       return undefined;
     }
   );
   nonMinimallyEncodedScriptNumbers.map((pair) => {
     t.deepEqual(
-      parseBytesAsScriptNumber(hexToBin(pair[0]), true, 5),
+      parseBytesAsScriptNumber(hexToBin(pair[0]), {
+        maximumScriptNumberByteLength: 5,
+      }),
+      ScriptNumberError.requiresMinimal
+    );
+    t.deepEqual(
+      parseBytesAsScriptNumber(hexToBin(pair[0]), {
+        maximumScriptNumberByteLength: 5,
+        requireMinimalEncoding: true,
+      }),
       ScriptNumberError.requiresMinimal
     );
     return undefined;
   });
   equivalentScriptNumbers.map((pair) => {
     t.deepEqual(
-      parseBytesAsScriptNumber(hexToBin(pair[0]), false, 5),
-      parseBytesAsScriptNumber(hexToBin(pair[1]), true, 5)
+      parseBytesAsScriptNumber(hexToBin(pair[0]), {
+        maximumScriptNumberByteLength: 5,
+        requireMinimalEncoding: false,
+      }),
+      parseBytesAsScriptNumber(hexToBin(pair[1]), {
+        maximumScriptNumberByteLength: 5,
+        requireMinimalEncoding: true,
+      })
     );
     return undefined;
   });
   t.deepEqual(
-    parseBytesAsScriptNumber(hexToBin('abcdef1234'), true, 4),
+    parseBytesAsScriptNumber(hexToBin('abcdef1234')),
     ScriptNumberError.outOfRange
   );
   t.deepEqual(
-    parseBytesAsScriptNumber(hexToBin('abcdef1234'), true, 5),
+    parseBytesAsScriptNumber(hexToBin('abcdef1234'), {
+      maximumScriptNumberByteLength: 5,
+    }),
     BigInt(223656005035)
   );
 });

diff --git a/src/lib/auth/instruction-sets/common/types.ts b/src/lib/auth/instruction-sets/common/types.ts
@@ -54,8 +54,16 @@ const normalMaximumScriptNumberByteLength = 4;
 // eslint-disable-next-line complexity
 export const parseBytesAsScriptNumber = (
   bytes: Uint8Array,
-  requireMinimalEncoding = true,
-  maximumScriptNumberByteLength = normalMaximumScriptNumberByteLength
+  {
+    maximumScriptNumberByteLength = normalMaximumScriptNumberByteLength,
+    requireMinimalEncoding = true,
+  }: {
+    maximumScriptNumberByteLength?: number;
+    requireMinimalEncoding?: boolean;
+  } = {
+    maximumScriptNumberByteLength: normalMaximumScriptNumberByteLength,
+    requireMinimalEncoding: true,
+  }
 ): bigint | ScriptNumberError => {
   if (bytes.length === 0) {
     return BigInt(0);