fix: rename format utils for consistency, improve vmb_tests, fix issu…

…es in BCH vm

.cspell.json

@@ -14,6 +14,7 @@
     "bcoin",
     "bcrypto",
     "bech",
+    "benchmarkjs",
     "bigint",
     "bindgen",
     "bitauth",
@@ -165,7 +166,8 @@
     "yarn.lock",
     "tsconfig.json",
     "node_modules/**",
-    "src/**/*.base64.ts"
+    "src/**/*.base64.ts",
+    "src/**/script_tests.json"
   ],
   "ignoreRegExpList": ["Base64", "HexValues"]
 }

package.json

@@ -151,6 +151,7 @@
   },
   "files": [
     "build",
+    "!build/.tsbuildinfo",
     "!**/*.spec.*",
     "!**/*.json",
     "CHANGELOG.md",

src/lib/format/numbers.spec.ts

@@ -17,7 +17,6 @@ import {
   binToNumberUint16LE,
   binToNumberUint32LE,
   binToNumberUintLE,
-  decodeVarInt,
   hexToBin,
   numberToBinInt16LE,
   numberToBinInt32LE,
@@ -30,6 +29,7 @@ import {
   numberToBinUint32LEClamped,
   numberToBinUintLE,
   varIntPrefixToSize,
+  varIntToBigInt,
 } from '../lib.js';
 
 test('numberToBinUint16LE', (t) => {
@@ -436,8 +436,8 @@ test('binToBigIntUint64LE', (t) => {
   );
 });
 
-test('decodeVarInt: index is optional', (t) => {
-  t.deepEqual(decodeVarInt(hexToBin('00')), {
+test('varIntToBigInt: index is optional', (t) => {
+  t.deepEqual(varIntToBigInt(hexToBin('00')), {
     nextIndex: 1,
     value: BigInt(0x00),
   });
@@ -446,13 +446,13 @@ test('decodeVarInt: index is optional', (t) => {
 const varIntVector = test.macro<[string, bigint, number, number?, string?]>({
   // eslint-disable-next-line max-params
   exec: (t, hex, value, nextIndex, start = 0, expected = hex) => {
-    t.deepEqual(decodeVarInt(hexToBin(hex), start), {
+    t.deepEqual(varIntToBigInt(hexToBin(hex), start), {
       nextIndex,
       value,
     });
     t.deepEqual(bigIntToVarInt(value), hexToBin(expected));
   },
-  title: (_, string) => `decodeVarInt/bigIntToVarInt: ${string}`,
+  title: (_, string) => `varIntToBigInt/bigIntToVarInt: ${string}`,
 });
 
 /* spell-checker: disable */
@@ -492,13 +492,13 @@ test(varIntVector, 'ff1111111111111111', BigInt('0x1111111111111111'), 9);
 test(varIntVector, 'ff1234567890abcdef', BigInt('0xefcdab9078563412'), 9);
 
 testProp(
-  '[fast-check] bigIntToVarInt <-> decodeVarInt',
+  '[fast-check] bigIntToVarInt <-> varIntToBigInt',
   [fc.bigUintN(64)],
   (t, uint64) => {
     const varInt = bigIntToVarInt(uint64);
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const expectedIndex = varIntPrefixToSize(varInt[0]!);
-    const result = decodeVarInt(varInt);
+    const result = varIntToBigInt(varInt);
     t.deepEqual(result, { nextIndex: expectedIndex, value: uint64 });
   }
 );

src/lib/format/numbers.ts

@@ -466,7 +466,7 @@ export const varIntPrefixToSize = (firstByte: number) => {
  * @param bin - the Uint8Array from which to read the VarInt
  * @param index - the index at which the VarInt begins
  */
-export const decodeVarInt = (bin: Uint8Array, index = 0) => {
+export const varIntToBigInt = (bin: Uint8Array, index = 0) => {
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   const bytes = varIntPrefixToSize(bin[index]!);
   const hasPrefix = bytes !== 1;
@@ -503,3 +503,11 @@ export const bigIntToVarInt = (value: bigint) =>
         ...numberToBinUint32LE(Number(value)),
       ])
     : Uint8Array.from([VarInt.uint64Prefix, ...bigIntToBinUint64LE(value)]);
+
+export const int32SignedToUnsigned = (int32: number) =>
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  Uint32Array.from(Int32Array.of(int32))[0]!;
+
+export const int32UnsignedToSigned = (int32: number) =>
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  Int32Array.from(Uint32Array.of(int32))[0]!;

src/lib/language/language-utils.spec.ts

@@ -1049,7 +1049,7 @@ test.failing('extractEvaluationSamples: documentation example', (t) => {
   });
 });
 
-test('extractEvaluationSamples: error in initial validation', (t) => {
+test.failing('extractEvaluationSamples: error in initial validation', (t) => {
   const result = compiler.generateBytecode({
     data: {},
     debug: true,

src/lib/language/language-utils.ts

@@ -17,9 +17,9 @@ import type {
 import {
   authenticationInstructionIsMalformed,
   decodeAuthenticationInstructions,
-  decodeVmNumber,
   encodeAuthenticationInstructionMalformed,
   OpcodesBCH,
+  vmNumberToBigInt,
 } from '../vm/vm.js';
 
 const pluckStartPosition = (range: Range) => ({
@@ -803,7 +803,7 @@ export const extractUnexecutedRanges = <
  */
 export const summarizeStack = (stack: Uint8Array[]) =>
   stack.map((item) => {
-    const asNumber = decodeVmNumber(item);
+    const asNumber = vmNumberToBigInt(item);
     return `0x${binToHex(item)}${
       typeof asNumber === 'string' ? '' : `(${asNumber.toString()})`
     }`;

src/lib/message/transaction-encoding.ts

@@ -3,9 +3,9 @@ import {
   bigIntToVarInt,
   binToHex,
   binToNumberUint32LE,
-  decodeVarInt,
   flattenBinArray,
   numberToBinUint32LE,
+  varIntToBigInt,
 } from '../format/format.js';
 import type { Input, Output, Sha256, TransactionCommon } from '../lib';
 
@@ -46,7 +46,7 @@ export const decodeTransactionInputUnsafe = (
     bin.subarray(indexAfterTxHash, indexAfterOutpointIndex)
   );
   const { nextIndex: indexAfterBytecodeLength, value: bytecodeLength } =
-    decodeVarInt(bin, indexAfterOutpointIndex);
+    varIntToBigInt(bin, indexAfterOutpointIndex);
   const indexAfterBytecode = indexAfterBytecodeLength + Number(bytecodeLength);
   const unlockingBytecode = bin.slice(
     indexAfterBytecodeLength,
@@ -82,7 +82,7 @@ export const encodeTransactionInputs = (inputs: readonly Input[]) =>
   ]);
 
 /**
- * Decode an array of items following a VarInt (see {@link decodeVarInt}). A
+ * Decode an array of items following a VarInt (see {@link varIntToBigInt}). A
  * VarInt will be read beginning at `index`, and then the encoded number of
  * items will be decoded using `itemDecoder`.
  *
@@ -101,7 +101,7 @@ export const createVarIntItemUnsafeDecoder =
     keyPlural: KeyPlural
   ) =>
   (bin: Uint8Array, index = 0) => {
-    const { nextIndex: indexAfterItemCount, value: itemCount } = decodeVarInt(
+    const { nextIndex: indexAfterItemCount, value: itemCount } = varIntToBigInt(
       bin,
       index
     );
@@ -168,7 +168,7 @@ export const decodeTransactionOutputUnsafe = (
   const uint64Bytes = 8;
   const indexAfterSatoshis = index + uint64Bytes;
   const valueSatoshis = bin.slice(index, indexAfterSatoshis);
-  const { nextIndex: indexAfterScriptLength, value } = decodeVarInt(
+  const { nextIndex: indexAfterScriptLength, value } = varIntToBigInt(
     bin,
     indexAfterSatoshis
   );

src/lib/vm/instruction-sets/bch/2021/bch-2021.script-tests.spec.ts

@@ -10,6 +10,8 @@ import {
   disassembleBytecodeBCH,
   stackItemIsTruthy,
   stringify,
+  stringifyDebugTraceSummary,
+  summarizeDebugTrace,
 } from '../../../../lib.js';
 
 // eslint-disable-next-line import/no-restricted-paths, import/no-internal-modules
@@ -139,7 +141,10 @@ pendingTests.map((expectation) => {
         t.log(`lockingBytecodeText: "${expectation.lockingBytecodeText}"`);
         t.log(`disassembled: "${disassembleBytecodeBCH(lockingBytecode)}"`);
         t.log('result:', stringify(result));
-        t.log('debug:', stringify(vm.debug(program)));
+        t.log(
+          'debug:',
+          stringifyDebugTraceSummary(summarizeDebugTrace(vm.debug(program)))
+        );
         if (expectation.expectedError === false) {
           t.fail('Expected a valid state, but this result is invalid.');
           return;

src/lib/vm/instruction-sets/bch/2021/fixtures/bchn/script-tests-addendum.json

@@ -57,12 +57,12 @@
   ],
   "minimalIf": [1447, 1449, 1460, 1463, 1465, 1477],
   "useStrict": [
-    593, 910, 1079, 1080, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092,
-    1093, 1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104,
-    1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116,
-    1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128,
-    1129, 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140,
-    1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152,
-    1153, 1154, 1155, 1156, 1157, 1158
+    910, 1079, 1080, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093,
+    1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105,
+    1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117,
+    1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 1129,
+    1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141,
+    1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153,
+    1154, 1155, 1156, 1157, 1158
   ]
 }

src/lib/vm/instruction-sets/bch/2022/bch-2022-instruction-set.ts

@@ -223,16 +223,16 @@ export const createInstructionSetBCH2022 = (
           AuthenticationErrorCommon.malformedLockingBytecode
         );
       }
-      if (standard && !isPushOnly(unlockingBytecode)) {
-        return applyError(
-          initialState,
-          AuthenticationErrorCommon.requiresPushOnly
-        );
-      }
       const unlockingResult = stateEvaluate(initialState);
       if (unlockingResult.error !== undefined) {
         return unlockingResult;
       }
+      if (unlockingResult.controlStack.length !== 0) {
+        return applyError(
+          initialState,
+          AuthenticationErrorCommon.nonEmptyControlStack
+        );
+      }
       const lockingResult = stateEvaluate(
         createAuthenticationProgramStateCommon({
           instructions: lockingInstructions,
@@ -243,7 +243,12 @@ export const createInstructionSetBCH2022 = (
       if (!isPayToScriptHash20(lockingBytecode)) {
         return lockingResult;
       }
-
+      if (!isPushOnly(unlockingBytecode)) {
+        return applyError(
+          initialState,
+          AuthenticationErrorCommon.requiresPushOnly
+        );
+      }
       const p2shStack = cloneStack(unlockingResult.stack);
       // eslint-disable-next-line functional/immutable-data
       const p2shScript = p2shStack.pop() ?? Uint8Array.of();

src/lib/vm/instruction-sets/common/combinators.ts

@@ -10,8 +10,8 @@ import { ConsensusCommon } from './consensus.js';
 import { applyError, AuthenticationErrorCommon } from './errors.js';
 import {
   bigIntToVmNumber,
-  decodeVmNumber,
   isVmNumberError,
+  vmNumberToBigInt,
 } from './instruction-sets-utils.js';
 
 export const incrementOperationCount =
@@ -178,7 +178,7 @@ export const useOneVmNumber = <
   }
 ) =>
   useOneStackItem(state, (nextState, [item]) => {
-    const value = decodeVmNumber(item, {
+    const value = vmNumberToBigInt(item, {
       maximumVmNumberByteLength,
       requireMinimalEncoding,
     });

src/lib/vm/instruction-sets/common/errors.ts

@@ -38,7 +38,7 @@ export enum AuthenticationErrorCommon {
   malformedPush = 'Program must be long enough to push the requested number of bytes.',
   malformedUnlockingBytecode = 'The provided unlocking bytecode is malformed.',
   negativeLocktime = 'Program called an OP_CHECKLOCKTIMEVERIFY or OP_CHECKSEQUENCEVERIFY operation with a negative locktime.',
-  nonEmptyControlStack = 'Program completed with a non-empty control stack (missing `OP_ENDIF`).',
+  nonEmptyControlStack = 'The active bytecode completed with a non-empty control stack (missing `OP_ENDIF`).',
   nonMinimalPush = 'Push operations must use the smallest possible encoding.',
   nonNullSignatureFailure = 'Program failed a signature verification with a non-null signature (violating the "NULLFAIL" rule).',
   overflowsVmNumberRange = 'Program attempted an arithmetic operation which exceeds the range of VM Numbers.',

src/lib/vm/instruction-sets/common/inspection.ts

@@ -1,4 +1,7 @@
-import { binToBigIntUint64LE } from '../../../format/format.js';
+import {
+  binToBigIntUint64LE,
+  int32UnsignedToSigned,
+} from '../../../format/format.js';
 import type {
   AuthenticationProgramStateCommon,
   Input,
@@ -32,7 +35,10 @@ export const opActiveBytecode = <
 export const opTxVersion = <State extends AuthenticationProgramStateCommon>(
   state: State
 ) =>
-  pushToStackVmNumberChecked(state, BigInt(state.program.transaction.version));
+  pushToStackVmNumberChecked(
+    state,
+    BigInt(int32UnsignedToSigned(state.program.transaction.version))
+  );
 
 export const opTxInputCount = <State extends AuthenticationProgramStateCommon>(
   state: State

src/lib/vm/instruction-sets/common/instruction-sets-utils.ts

@@ -483,7 +483,7 @@ const typicalMaximumVmNumberByteLength = 8;
  * @param bytes - a Uint8Array from the stack
  */
 // eslint-disable-next-line complexity
-export const decodeVmNumber = (
+export const vmNumberToBigInt = (
   bytes: Uint8Array,
   {
     maximumVmNumberByteLength = typicalMaximumVmNumberByteLength,
@@ -548,7 +548,7 @@ export const decodeVmNumber = (
 };
 
 /**
- * Convert a BigInt into the VM Number format. See {@link decodeVmNumber} for
+ * Convert a BigInt into the VM Number format. See {@link vmNumberToBigInt} for
  * more information.
  *
  * @param integer - the BigInt to encode as a VM Number

src/lib/vm/instruction-sets/common/time.ts

@@ -5,7 +5,7 @@ import type {
 } from '../../../lib';
 
 import { applyError, AuthenticationErrorCommon } from './errors.js';
-import { decodeVmNumber, isVmNumberError } from './instruction-sets-utils.js';
+import { isVmNumberError, vmNumberToBigInt } from './instruction-sets-utils.js';
 
 const enum Bits {
   sequenceLocktimeDisableFlag = 31,
@@ -36,7 +36,7 @@ export const useLocktime = <
   if (item === undefined) {
     return applyError(state, AuthenticationErrorCommon.emptyStack);
   }
-  const decodedLocktime = decodeVmNumber(item, {
+  const decodedLocktime = vmNumberToBigInt(item, {
     maximumVmNumberByteLength: Constants.locktimeVmNumberByteLength,
     requireMinimalEncoding: true,
   });