Continue BCH_2026 development

Author: bitjson

.cspell.json

@@ -69,6 +69,7 @@
     "deserialize",
     "devtools",
     "discoverability",
+    "DIVSHIFT",
     "Dreyzehner",
     "DYNAMICTOP",
     "ecdsa",
@@ -112,6 +113,7 @@
     "MINIMALIF",
     "MITM",
     "monospace",
+    "MULSHIFT",
     "multisig",
     "Nakamoto",
     "NONFUNGIBLE",
@@ -130,6 +132,8 @@
     "OUTPUTTOKENCATEGORY",
     "OUTPUTTOKENCOMMITMENT",
     "OUTPUTVALUE",
+    "PADLEFT",
+    "PADRIGHT",
     "parsimmon",
     "performant",
     "plusplus",

src/lib/message/fixtures/token-prefix-valid.json

@@ -607,6 +607,17 @@
       }
     }
   },
+  {
+    "prefix": "efbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb7280ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccffffffffffffffff7f",
+    "data": {
+      "amount": "9223372036854775807",
+      "category": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+      "nft": {
+        "commitment": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
+        "capability": "minting"
+      }
+    }
+  },
   {
     "prefix": "efbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb62fdfd00cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
     "data": {

src/lib/schema/ajv/validate-bcmr.js

@@ -30,7 +30,7 @@ const schema22 = {
         },
         splitId: {
           description:
-            "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .",
+            'The split ID of this identity\'s chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .\n\nTODO: rename "splitId" to "chainBranchId" (more clearly refers to the immediate descendent of the split block)',
           type: 'string',
         },
         status: {
@@ -123,7 +123,7 @@ const schema22 = {
         },
         splitId: {
           description:
-            "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .",
+            'The split ID of this identity\'s chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .\n\nTODO: rename "splitId" to "chainBranchId" (more clearly refers to the immediate descendent of the split block)',
           type: 'string',
         },
         status: {
@@ -665,7 +665,7 @@ const schema25 = {
     },
     splitId: {
       description:
-        "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .",
+        'The split ID of this identity\'s chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .\n\nTODO: rename "splitId" to "chainBranchId" (more clearly refers to the immediate descendent of the split block)',
       type: 'string',
     },
     status: {
@@ -1440,7 +1440,7 @@ const schema30 = {
     },
     splitId: {
       description:
-        "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .",
+        'The split ID of this identity\'s chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .\n\nTODO: rename "splitId" to "chainBranchId" (more clearly refers to the immediate descendent of the split block)',
       type: 'string',
     },
     status: {

src/lib/schema/bcmr.schema.json

@@ -23,7 +23,7 @@
           "type": "string"
         },
         "splitId": {
-          "description": "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .",
+          "description": "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .\n\nTODO: rename \"splitId\" to \"chainBranchId\" (more clearly refers to the immediate descendent of the split block)",
           "type": "string"
         },
         "status": {
@@ -113,7 +113,7 @@
           "type": "string"
         },
         "splitId": {
-          "description": "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .",
+          "description": "The split ID of this identity's chain of record.\n\nIf undefined, defaults to  {@link  MetadataRegistry.defaultChain } .\n\nTODO: rename \"splitId\" to \"chainBranchId\" (more clearly refers to the immediate descendent of the split block)",
           "type": "string"
         },
         "status": {

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

@@ -419,10 +419,12 @@ export const createInstructionSetBch2023 = <
       return {
         alternateStack: [],
         controlStack: [],
+        functionTable: [],
         ip: 0,
         lastCodeSeparator: -1,
         metrics: {
           arithmeticCost: 0,
+          definedFunctions: 0,
           densityControlLength,
           evaluatedInstructionCount: 0,
           hashDigestIterations: 0,

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

@@ -5,9 +5,11 @@ import { ConsensusBch2025 } from '../2025/bch-2025-consensus.js';
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const ConsensusBch2026Overrides = {
+  maximumFunctionIdentifier: 999,
   maximumStandardLockingBytecodeLength: 201,
   maximumStandardUnlockingBytecodeLength: 10000,
   maximumTokenCommitmentLength: 128,
+  minimumFunctionIdentifier: 0,
 };
 
 /**

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

@@ -5,13 +5,14 @@ import { OpcodeDescriptionsBch2023 } from '../2023/bch-2023-descriptions.js';
  * beyond those present in `BCH_2025_05`.
  */
 export enum OpcodeDescriptionsBch2026Additions {
-  OP_EVAL = 'Pop the top item from the stack as bytecode. Preserve the active bytecode at the top of the control stack, then evaluate the stack-provided bytecode as if it were the active bytecode (without modifying the stack, alternate stack, or other evaluation context). When the evaluation is complete, restore the original bytecode and continue evaluation after the OP_EVAL instruction. If the bytecode is malformed, error.',
   OP_BEGIN = 'Push the current instruction pointer index to the control stack as an integer (to be read by OP_UNTIL).',
   OP_UNTIL = 'Pop the top item from the control stack (if the control value is not an integer, error). Add the difference between the control value and the current instruction pointer index to the repeated bytes counter, if the sum of the repeated bytes counter and the active bytecode length is greater than the maximum bytecode length, error. Pop the top item from the stack, if the value is not truthy, move the instruction pointer to the control value (and re-evaluate the OP_BEGIN).',
+  OP_DEFINE = 'Pop the top item from the stack to interpret as a function identifier (VM number between 0 and 999, inclusive). Pop the next item from the stack (the function body), and save it to the function table at the index equal to the function identifier. If that function index is out of range or already defined, error.',
+  OP_INVOKE = 'Pop the top item from the stack to interpret as a function table index (VM number between 0 and 999, inclusive). If no function is defined at that index, error. Preserve the active bytecode at the top of the control stack, then evaluate the function body at that function table index as if it were the active bytecode (without resetting the stack, alternate stack, or evaluation limits). When the evaluation is complete, restore the original bytecode and continue evaluation after the OP_INVOKE instruction. If the bytecode is malformed, error.',
 }
 
 /**
- * Descriptions for the `BCH_SPEC` instruction set.
+ * Descriptions for the `BCH_2026_05` instruction set.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const OpcodeDescriptionsBch2026 = {

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

@@ -4,7 +4,10 @@ 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.',
-  malformedEval = 'Program attempted to OP_EVAL malformed bytecode.',
+  functionIdentifierInvalid = 'Program attempted to OP_DEFINE an invalid function identifier.',
+  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

@@ -0,0 +1,104 @@
+import { binToHex } from '../../../../format/format.js';
+import type {
+  AuthenticationInstructionMalformed,
+  AuthenticationProgramStateControlStack,
+  AuthenticationProgramStateError,
+  AuthenticationProgramStateFunctionTable,
+  AuthenticationProgramStateMinimum,
+  AuthenticationProgramStateStack,
+} from '../../../../lib.js';
+import {
+  applyError,
+  authenticationInstructionsAreMalformed,
+  decodeAuthenticationInstructions,
+  disassembleAuthenticationInstructionMalformed,
+  pushToControlStack,
+  useOneStackItem,
+  useOneVmNumber,
+} from '../../common/common.js';
+
+import { ConsensusBch2026 } from './bch-2026-consensus.js';
+import { AuthenticationErrorBch2026 } from './bch-2026-errors.js';
+import { OpcodesBch2026 } from './bch-2026-opcodes.js';
+
+export const createOpDefine =
+  ({
+    maximumFunctionIdentifier = ConsensusBch2026.maximumFunctionIdentifier,
+    minimumFunctionIdentifier = ConsensusBch2026.minimumFunctionIdentifier,
+  } = {}) =>
+  <
+    State extends AuthenticationProgramStateError &
+      AuthenticationProgramStateFunctionTable &
+      AuthenticationProgramStateStack,
+  >(
+    state: State,
+  ) =>
+    useOneVmNumber(state, (nextState, [providedInteger]) => {
+      const functionIdentifier = Number(providedInteger);
+      if (
+        functionIdentifier < minimumFunctionIdentifier ||
+        functionIdentifier > maximumFunctionIdentifier
+      ) {
+        return applyError(
+          nextState,
+          AuthenticationErrorBch2026.functionIdentifierInvalid,
+          `Function identifier (${functionIdentifier}) is outside of the valid range: ${minimumFunctionIdentifier} to ${maximumFunctionIdentifier} (inclusive).`,
+        );
+      }
+      if (nextState.functionTable[functionIdentifier] !== undefined) {
+        return applyError(
+          nextState,
+          AuthenticationErrorBch2026.functionIdentifierPreviouslyDefined,
+          `Function identifier: ${functionIdentifier}. Existing contents: ${binToHex(
+            nextState.functionTable[functionIdentifier],
+          )}.`,
+        );
+      }
+      return useOneStackItem(nextState, (finalState, [functionBody]) => {
+        // eslint-disable-next-line functional/no-expression-statements, functional/immutable-data
+        finalState.functionTable[functionIdentifier] = functionBody;
+        return finalState;
+      });
+    });
+
+export const opInvoke = <
+  State extends AuthenticationProgramStateControlStack &
+    AuthenticationProgramStateError &
+    AuthenticationProgramStateFunctionTable &
+    AuthenticationProgramStateMinimum &
+    AuthenticationProgramStateStack,
+>(
+  state: State,
+) =>
+  useOneVmNumber(state, (nextState, [providedInteger]) => {
+    const functionTableIndex = Number(providedInteger);
+    const functionBody = nextState.functionTable[functionTableIndex];
+    if (functionBody === undefined) {
+      return applyError(
+        nextState,
+        AuthenticationErrorBch2026.functionIdentifierUndefined,
+        `Function identifier: ${functionTableIndex}.`,
+      );
+    }
+    const newInstructions = decodeAuthenticationInstructions(functionBody);
+    if (authenticationInstructionsAreMalformed(newInstructions)) {
+      return applyError(
+        nextState,
+        AuthenticationErrorBch2026.malformedFunction,
+        `Malformed instruction: ${disassembleAuthenticationInstructionMalformed(
+          OpcodesBch2026,
+          newInstructions[
+            newInstructions.length - 1
+          ] as AuthenticationInstructionMalformed,
+        )}.`,
+      );
+    }
+    const manuallyAdvance = 1;
+    const finalState = pushToControlStack(nextState, {
+      instructions: nextState.instructions,
+      ip: nextState.ip + manuallyAdvance,
+    });
+    finalState.ip = 0 - manuallyAdvance; // eslint-disable-line functional/no-expression-statements, functional/immutable-data
+    finalState.instructions = newInstructions; // eslint-disable-line functional/no-expression-statements, functional/immutable-data
+    return finalState;
+  });

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

@@ -14,11 +14,12 @@ import type {
   Sha1,
   Sha256,
 } from '../../../../lib.js';
+import { conditionallyEvaluate } from '../../common/common.js';
 import { createInstructionSetBch2025 } from '../2025/bch-2025-instruction-set.js';
 import { opBegin, opUntil } from '../2026/bch-2026-loops.js';
 
 import { ConsensusBch2026 } from './bch-2026-consensus.js';
-import { opEval } from './bch-2026-eval.js';
+import { createOpDefine, opInvoke } from './bch-2026-functions.js';
 import { OpcodesBch2026 } from './bch-2026-opcodes.js';
 import type { AuthenticationProgramStateBch2026 } from './bch-2026-types.js';
 /**
@@ -100,9 +101,12 @@ export const createInstructionSetBch2026 = <
     /* eslint-enable functional/no-loop-statements, functional/immutable-data, functional/no-expression-statements */
     operations: {
       ...instructionSet.operations,
-      [OpcodesBch2026.OP_EVAL]: opEval,
       [OpcodesBch2026.OP_BEGIN]: opBegin,
       [OpcodesBch2026.OP_UNTIL]: opUntil,
+      [OpcodesBch2026.OP_DEFINE]: conditionallyEvaluate(
+        createOpDefine(consensus),
+      ),
+      [OpcodesBch2026.OP_INVOKE]: conditionallyEvaluate(opInvoke),
     },
   };
 };