Update BCH_2026 VM and VMB tests

Author: bitjson

.changeset/strange-paws-decide.md

@@ -0,0 +1,5 @@
+---
+'@bitauth/libauth': minor
+---
+
+Update BCH_2026 VM and VMB tests

package.json

@@ -44,6 +44,8 @@
     "bchn:cmake": "cd wasm/bitcoin-cash-node/build && cmake -GNinja .. -DBUILD_BITCOIN_WALLET=OFF -DBUILD_BITCOIN_QT=OFF -DENABLE_NATPMP=OFF -DENABLE_MAN=OFF -DCMAKE_BUILD_TYPE=Release",
     "bchn:build": "cd wasm/bitcoin-cash-node/build && ninja",
     "bchn:setup": "cd wasm/bitcoin-cash-node && mkdir build && yarn bchn:cmake && yarn bchn:build",
+    "bchn:bench": "cd wasm/bitcoin-cash-node/build && ninja && ninja bench_bitcoin && echo 'Running BCHN benchmarks (fast)...' && ./src/bench/bench_bitcoin -libauth -filter=\"^LibAuth_(2025|2026)_.*\"",
+    "bchn:bench:slow": "cd wasm/bitcoin-cash-node/build && ninja && ninja bench_bitcoin && echo 'Running BCHN benchmarks (slow, ~6-24 hrs)...' && src/bench/bench_bitcoin -libauth=all_slow -filter=\"^LibAuth_(2025|2026)_.*\"",
     "bchn:remove-old-vmb-tests": "rm -r wasm/bitcoin-cash-node/src/test/data/vmb_tests/bch_{2023,2025,2026}_{invalid,nonstandard,standard} && echo 'Removed old VMB tests from: wasm/bitcoin-cash-node/src/test/data/vmb_tests'",
     "bchn:add-new-vmb-tests": "cp -r src/lib/vmb-tests/generated/bch_{2023,2025,2026}_{invalid,nonstandard,standard} wasm/bitcoin-cash-node/src/test/data/vmb_tests && echo 'Added new VMB tests.'",
     "bchn:replace-vmb-tests": "yarn bchn:remove-old-vmb-tests && yarn bchn:add-new-vmb-tests",

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

@@ -298,6 +298,10 @@ export const createInstructionSetBch2023 = <
         },
       } as AuthenticationProgramState);
 
+      if (lockingResult.error !== undefined) {
+        return lockingResult;
+      }
+
       if (lockingResult.controlStack.length !== 0) {
         return applyError(
           lockingResult,
@@ -419,7 +423,8 @@ export const createInstructionSetBch2023 = <
       return {
         alternateStack: [],
         controlStack: [],
-        functionTable: [],
+        functionCount: 0,
+        functionTable: {},
         ip: 0,
         lastCodeSeparator: -1,
         metrics: {

src/lib/vm/instruction-sets/bch/2026/bch-2026-bitwise.ts

@@ -76,7 +76,7 @@ export const createOpLShiftNum =
           // eslint-disable-next-line no-bitwise
           numericValue << bitCount,
           {
-            hasEncodingCost: true,
+            hasEncodingCost: false,
             maximumVmNumberByteLength: maximumStackItemLength,
           },
         );
@@ -111,7 +111,7 @@ export const createOpRShiftNum =
           // eslint-disable-next-line no-bitwise
           numericValue >> bitCount,
           {
-            hasEncodingCost: true,
+            hasEncodingCost: false,
             maximumVmNumberByteLength: maximumStackItemLength,
           },
         );

src/lib/vm/instruction-sets/bch/2026/bch-2026-consensus.ts

@@ -6,11 +6,14 @@ import { ConsensusBch2025 } from '../2025/bch-2025-consensus.js';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const ConsensusBch2026Overrides = {
   baseInstructionCost: 100,
-  maximumFunctionIdentifier: 999,
+  maximumFunctionIdentifierLength: 7,
+  /**
+   * A.K.A. `MAX_MEMORY_SLOTS`
+   */
+  maximumMemorySlots: 1000,
   maximumStandardLockingBytecodeLength: 201,
   maximumStandardUnlockingBytecodeLength: 10000,
   maximumTokenCommitmentLength: 128,
-  minimumFunctionIdentifier: 0,
 };
 
 /**

src/lib/vm/instruction-sets/bch/2026/bch-2026-errors.ts

@@ -4,7 +4,8 @@ export enum AuthenticationErrorBch2026Additions {
   unexpectedUntil = 'Encountered an OP_UNTIL that is not preceded by a matching OP_BEGIN.',
   unexpectedUntilMissingEndIf = 'Encountered an OP_UNTIL before the previous OP_IF was closed by an OP_ENDIF.',
   excessiveLooping = 'Program attempted an OP_UNTIL operation that would exceed the limit of repeated bytes.',
-  functionIdentifierInvalid = 'Program attempted to OP_DEFINE an invalid function identifier.',
+  exceededMaximumMemorySlots = 'Program attempted to use an excessive number of memory slots: stack items, alternate stack items, and/or defined functions.',
+  functionIdentifierExcessiveLength = 'Program attempted to OP_DEFINE a function identifier of excessive length.',
   functionIdentifierPreviouslyDefined = 'Program attempted to OP_DEFINE a previously-defined function identifier.',
   functionIdentifierUndefined = 'Program attempted to OP_INVOKE an undefined function identifier.',
   malformedFunction = 'Program attempted to OP_INVOKE malformed bytecode.',

src/lib/vm/instruction-sets/bch/2026/bch-2026-functions.ts

@@ -14,7 +14,6 @@ import {
   disassembleAuthenticationInstructionMalformed,
   pushToControlStack,
   useOneStackItem,
-  useOneVmNumber,
 } from '../../common/common.js';
 
 import { ConsensusBch2026 } from './bch-2026-consensus.js';
@@ -23,8 +22,7 @@ import { OpcodesBch2026 } from './bch-2026-opcodes.js';
 
 export const createOpDefine =
   ({
-    maximumFunctionIdentifier = ConsensusBch2026.maximumFunctionIdentifier,
-    minimumFunctionIdentifier = ConsensusBch2026.minimumFunctionIdentifier,
+    maximumFunctionIdentifierLength = ConsensusBch2026.maximumFunctionIdentifierLength,
   } = {}) =>
   <
     State extends AuthenticationProgramStateError &
@@ -33,30 +31,29 @@ export const createOpDefine =
   >(
     state: State,
   ) =>
-    useOneVmNumber(state, (nextState, [providedInteger]) => {
-      const functionIdentifier = Number(providedInteger);
-      if (
-        functionIdentifier < minimumFunctionIdentifier ||
-        functionIdentifier > maximumFunctionIdentifier
-      ) {
+    useOneStackItem(state, (nextState, [functionIdentifier]) => {
+      const functionTableKey = binToHex(functionIdentifier);
+      if (functionIdentifier.length > maximumFunctionIdentifierLength) {
         return applyError(
           nextState,
-          AuthenticationErrorBch2026.functionIdentifierInvalid,
-          `Function identifier (${functionIdentifier}) is outside of the valid range: ${minimumFunctionIdentifier} to ${maximumFunctionIdentifier} (inclusive).`,
+          AuthenticationErrorBch2026.functionIdentifierExcessiveLength,
+          `Function identifier has excessive length. Maximum length: ${maximumFunctionIdentifierLength}. Provided length: ${functionIdentifier.length}. Provided identifier: 0x${functionTableKey}.`,
         );
       }
-      if (nextState.functionTable[functionIdentifier] !== undefined) {
+      if (nextState.functionTable[functionTableKey] !== undefined) {
         return applyError(
           nextState,
           AuthenticationErrorBch2026.functionIdentifierPreviouslyDefined,
-          `Function identifier: ${functionIdentifier}. Existing contents: ${binToHex(
-            nextState.functionTable[functionIdentifier],
+          `Function identifier: 0x${functionTableKey}. Existing contents: ${binToHex(
+            nextState.functionTable[functionTableKey],
           )}.`,
         );
       }
       return useOneStackItem(nextState, (finalState, [functionBody]) => {
         // eslint-disable-next-line functional/no-expression-statements, functional/immutable-data
-        finalState.functionTable[functionIdentifier] = functionBody;
+        finalState.functionTable[functionTableKey] = functionBody;
+        // eslint-disable-next-line functional/no-expression-statements, functional/immutable-data
+        finalState.functionCount += 1;
         return finalState;
       });
     });
@@ -70,14 +67,14 @@ export const opInvoke = <
 >(
   state: State,
 ) =>
-  useOneVmNumber(state, (nextState, [providedInteger]) => {
-    const functionTableIndex = Number(providedInteger);
-    const functionBody = nextState.functionTable[functionTableIndex];
+  useOneStackItem(state, (nextState, [functionIdentifier]) => {
+    const functionTableKey = binToHex(functionIdentifier);
+    const functionBody = nextState.functionTable[functionTableKey];
     if (functionBody === undefined) {
       return applyError(
         nextState,
         AuthenticationErrorBch2026.functionIdentifierUndefined,
-        `Function identifier: ${functionTableIndex}.`,
+        `Function identifier: 0x${functionTableKey}.`,
       );
     }
     const newInstructions = decodeAuthenticationInstructions(functionBody);

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

@@ -14,7 +14,7 @@ import type {
   Sha1,
   Sha256,
 } from '../../../../lib.js';
-import { conditionallyEvaluate } from '../../common/common.js';
+import { applyError, conditionallyEvaluate } from '../../common/common.js';
 import { createInstructionSetBch2025 } from '../2025/bch-2025-instruction-set.js';
 import { opBegin, opUntil } from '../2026/bch-2026-loops.js';
 
@@ -26,6 +26,7 @@ import {
   opRShiftBin,
 } from './bch-2026-bitwise.js';
 import { ConsensusBch2026 } from './bch-2026-consensus.js';
+import { AuthenticationErrorBch2026 } from './bch-2026-errors.js';
 import { createOpDefine, opInvoke } from './bch-2026-functions.js';
 import { OpcodesBch2026 } from './bch-2026-opcodes.js';
 import type { AuthenticationProgramStateBch2026 } from './bch-2026-types.js';
@@ -105,6 +106,23 @@ export const createInstructionSetBch2026 = <
       }
       return state.ip < state.instructions.length;
     },
+    every: (state) => {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const nextState = instructionSet.every!(state);
+      if (
+        nextState.stack.length +
+          nextState.alternateStack.length +
+          nextState.functionCount >
+        consensus.maximumMemorySlots
+      ) {
+        return applyError(
+          nextState,
+          AuthenticationErrorBch2026.exceededMaximumMemorySlots,
+          `Maximum memory slots: ${consensus.maximumMemorySlots}.`,
+        );
+      }
+      return nextState;
+    },
     /* eslint-enable functional/no-loop-statements, functional/immutable-data, functional/no-expression-statements */
     operations: {
       ...instructionSet.operations,

src/lib/vm/vm-types.ts

@@ -61,7 +61,11 @@ export type AuthenticationProgramStateFunctionTable = {
    * The table of functions (in Forth parlance, "vocabulary of words") defined
    * over the course of the evaluation.
    */
-  functionTable: Uint8Array[];
+  functionTable: { [hex: string]: Uint8Array };
+  /**
+   * The count of defined functions ("words") in the current evaluation.
+   */
+  functionCount: number;
 };
 
 export type AuthenticationProgramStateControlStack<

src/lib/vmb-tests/bch-vmb-test-utils.ts

@@ -169,6 +169,9 @@ const testSetOverrideListBch = [
   ['chip_eval_invalid'],
   ['chip_eval_invalid', 'p2sh_ignore'],
   ['chip_functions'],
+  ['chip_functions', 'p2sh_invalid'],
+  ['chip_functions_invalid'],
+  ['chip_functions_invalid', 'p2sh_ignore'],
   ['chip_loops_invalid'],
   ['chip_loops_invalid', 'p2sh_ignore'],
   ['chip_loops'],
@@ -461,6 +464,60 @@ export const supportedTestSetOverridesBch: {
   'chip_eval_invalid,p2sh_ignore': [
     { mode: 'P2S', sets: ['chip_eval_invalid'] },
   ],
+  chip_functions: [
+    {
+      mode: 'P2S',
+      sets: ['chip_functions_standard', '2025_invalid', '2026_standard'],
+    },
+    {
+      mode: 'P2SH20',
+      sets: ['chip_functions_standard', '2025_invalid', '2026_standard'],
+    },
+    {
+      mode: 'P2SH32',
+      sets: ['chip_functions_standard', '2025_invalid', '2026_standard'],
+    },
+  ],
+  'chip_functions,p2sh_ignore': [
+    {
+      mode: 'P2S',
+      sets: ['chip_functions_standard', '2025_invalid', '2026_standard'],
+    },
+  ],
+  'chip_functions,p2sh_invalid': [
+    {
+      mode: 'P2S',
+      sets: ['chip_functions_standard', '2025_invalid', '2026_standard'],
+    },
+    {
+      mode: 'P2SH20',
+      sets: ['chip_functions_invalid', '2025_invalid', '2026_invalid'],
+    },
+    {
+      mode: 'P2SH32',
+      sets: ['chip_functions_invalid', '2025_invalid', '2026_invalid'],
+    },
+  ],
+  chip_functions_invalid: [
+    {
+      mode: 'P2S',
+      sets: ['chip_functions_invalid', '2025_invalid', '2026_invalid'],
+    },
+    {
+      mode: 'P2SH20',
+      sets: ['chip_functions_invalid', '2025_invalid', '2026_invalid'],
+    },
+    {
+      mode: 'P2SH32',
+      sets: ['chip_functions_invalid', '2025_invalid', '2026_invalid'],
+    },
+  ],
+  'chip_functions_invalid,p2sh_ignore': [
+    {
+      mode: 'P2S',
+      sets: ['chip_functions_invalid', '2025_invalid', '2026_invalid'],
+    },
+  ],
   chip_loops: [
     {
       mode: 'P2S',