Deprecate BCH_2022_05, add BCH_2023_05, BCH_2025_05, and BCH_SPEC, update vmb_tests

Author: bitjson

.changeset/great-ducks-roll.md

@@ -0,0 +1,7 @@
+---
+'@bitauth/libauth': minor
+---
+
+Deprecate `BCH_2022_05` VM, add `BCH_2023_05`, `BCH_2025_05`, and `BCH_SPEC` VMs, update vmb_tests
+
+Additionally, all exports have been renamed to more consistently adhere to the `camelCase` capitalization style, without exceptions for abbreviations. For example `assembleBytecodeBCH` is now `assembleBytecodeBch`. To ensure backwards-compatibility, aliases (marked with `@deprecated` TSdoc tags) are also exported using the old capitalization. These aliases will be removed in a future major version.

.cspell.json

@@ -17,7 +17,6 @@
     "authchain",
     "authchains",
     "authhead",
-    "BCHCHIPs",
     "bchn",
     "bchreg",
     "bchtest",

README.md

@@ -333,26 +333,26 @@ High-level utilities are composed from lower-level utilities which are also expo
 
 #### Built-In VMs
 
-- [`createInstructionSetBCH`](https://libauth.org/functions/createInstructionSetBCH.html)
-- [`createInstructionSetBCH2022`](https://libauth.org/functions/createInstructionSetBCH2022.html)
-- [`createInstructionSetBCH2023`](https://libauth.org/functions/createInstructionSetBCH2023.html)
-- [`createInstructionSetBCHCHIPs`](https://libauth.org/functions/createInstructionSetBCHCHIPs.html)
-- [`createInstructionSetXEC`](https://libauth.org/functions/createInstructionSetXEC.html)
+- [`createInstructionSetBch`](https://libauth.org/functions/createInstructionSetBch.html)
+- [`createInstructionSetBch2023`](https://libauth.org/functions/createInstructionSetBch2023.html)
+- [`createInstructionSetBch2025`](https://libauth.org/functions/createInstructionSetBch2025.html)
+- [`createInstructionSetBchSpec`](https://libauth.org/functions/createInstructionSetBchSpec.html)
+- [`createInstructionSetXec`](https://libauth.org/functions/createInstructionSetXec.html)
 - [`createVirtualMachine`](https://libauth.org/functions/createVirtualMachine.html)
-- [`createVirtualMachineBCH`](https://libauth.org/functions/createVirtualMachineBCH.html)
-- [`createVirtualMachineBCH2022`](https://libauth.org/functions/createVirtualMachineBCH2022.html)
-- [`createVirtualMachineBCH2023`](https://libauth.org/functions/createVirtualMachineBCH2023.html)
-- [`createVirtualMachineBCHCHIPs`](https://libauth.org/functions/createVirtualMachineBCHCHIPs.html)
-- [`createVirtualMachineXEC`](https://libauth.org/functions/createVirtualMachineXEC.html)
+- [`createVirtualMachineBch`](https://libauth.org/functions/createVirtualMachineBch.html)
+- [`createVirtualMachineBch2023`](https://libauth.org/functions/createVirtualMachineBch2023.html)
+- [`createVirtualMachineBch2025`](https://libauth.org/functions/createVirtualMachineBch2025.html)
+- [`createVirtualMachineBchSpec`](https://libauth.org/functions/createVirtualMachineBchSpec.html)
+- [`createVirtualMachineXec`](https://libauth.org/functions/createVirtualMachineXec.html)
 
 #### Debugging
 
 - [`assembleBytecode`](https://libauth.org/functions/assembleBytecode.html)
-- [`assembleBytecodeBCH`](https://libauth.org/functions/assembleBytecodeBCH.html)
-- [`assembleBytecodeBTC`](https://libauth.org/functions/assembleBytecodeBTC.html)
-- [`disassembleBytecode`](https://libauth.org/functions/disassembleBytecodeBCH.html)
-- [`disassembleBytecodeBCH`](https://libauth.org/functions/disassembleBytecodeBCH.html)
-- [`disassembleBytecodeBTC`](https://libauth.org/functions/disassembleBytecodeBTC.html)
+- [`assembleBytecodeBch`](https://libauth.org/functions/assembleBytecodeBch.html)
+- [`assembleBytecodeBtc`](https://libauth.org/functions/assembleBytecodeBtc.html)
+- [`disassembleBytecode`](https://libauth.org/functions/disassembleBytecode.html)
+- [`disassembleBytecodeBch`](https://libauth.org/functions/disassembleBytecodeBch.html)
+- [`disassembleBytecodeBtc`](https://libauth.org/functions/disassembleBytecodeBtc.html)
 - [`generateBytecodeMap`](https://libauth.org/functions/generateBytecodeMap.html)
 - [`summarizeDebugTrace`](https://libauth.org/functions/summarizeDebugTrace.html)
 - [`stringifyDebugTraceSummary`](https://libauth.org/functions/stringifyDebugTraceSummary.html)
@@ -399,7 +399,7 @@ High-level utilities are composed from lower-level utilities which are also expo
 - [`stringifyErrors`](https://libauth.org/functions/stringifyErrors.html)
 - [`verifyCashAssemblyEvaluationState`](https://libauth.org/functions/verifyCashAssemblyEvaluationState.html)
 - [`walletTemplateToCompilerConfiguration`](https://libauth.org/functions/walletTemplateToCompilerConfiguration.html)
-- [`walletTemplateToCompilerBCH`](https://libauth.org/functions/walletTemplateToCompilerBCH.html)
+- [`walletTemplateToCompilerBch`](https://libauth.org/functions/walletTemplateToCompilerBch.html)
 
 #### Multi-Party Compilation
 

docs/verify-transactions.md

@@ -4,17 +4,17 @@ Libauth includes extensive support for verifying transactions and debugging Virt
 
 ## Simple Verification
 
-To verify a transaction using Bitcoin Cash's latest standard VM, use `createVirtualMachineBCH` with the initial `standard` parameter set to `true`. (For details on the difference between standard and non-standard VMs, see [`Standard Vs. Non-Standard VMs`](../src/lib/vmb-tests/readme.md#standard-vs-non-standard-vms).)
+To verify a transaction using Bitcoin Cash's latest standard VM, use `createVirtualMachineBch` with the initial `standard` parameter set to `true`. (For details on the difference between standard and non-standard VMs, see [`Standard Vs. Non-Standard VMs`](../src/lib/vmb-tests/readme.md#standard-vs-non-standard-vms).)
 
 ```ts
 import {
   assertSuccess,
   decodeTransaction,
   decodeTransactionOutputs,
-  createVirtualMachineBCH,
+  createVirtualMachineBch,
 } from '@bitauth/libauth';
 
-const vm = createVirtualMachineBCH(true);
+const vm = createVirtualMachineBch(true);
 /* Example transaction from Virtual Machine Bytecode (VMB) test ID: "dv5k4" */
 const vmbTest = {
   description:
@@ -91,17 +91,17 @@ import type { AuthenticationProgramStateStack } from '@bitauth/libauth';
 import {
   assertSuccess,
   binToHex,
-  createInstructionSetBCH,
+  createInstructionSetBch,
   createVirtualMachine,
-  OpcodesBCH,
+  OpcodesBch,
   pushToStack,
   stringifyDebugTraceSummary,
   summarizeDebugTrace,
   useThreeStackItems,
-  walletTemplateToCompilerBCH,
+  walletTemplateToCompilerBch,
 } from '@bitauth/libauth';
 
-const instructionSet = createInstructionSetBCH(true);
+const instructionSet = createInstructionSetBch(true);
 /**
  * A hypothetical "OP_UNROT" which rotates the top stack items in the
  * direction opposite that of OP_ROT. (The generic `<State extends ...>`
@@ -113,7 +113,7 @@ const opUnRot = <State extends AuthenticationProgramStateStack>(state: State) =>
   );
 
 /* We assign "OP_UNROT" at the index held by "OP_RESERVED1" */
-const opcode = OpcodesBCH.OP_RESERVED1;
+const opcode = OpcodesBch.OP_RESERVED1;
 /* All other features of the BCH instruction set are unmodified: */
 const vm = createVirtualMachine({
   ...instructionSet,
@@ -125,7 +125,7 @@ const vm = createVirtualMachine({
 
 const OP_UNROT = `0x${binToHex(Uint8Array.of(opcode))}`;
 /* A compiler for a simple wallet template to test the new opcode: */
-const compiler = walletTemplateToCompilerBCH({
+const compiler = walletTemplateToCompilerBch({
   entities: {},
   scripts: {
     lock: {
@@ -146,7 +146,7 @@ const { program } = assertSuccess(
 const trace = vm.debug(program);
 const summary = summarizeDebugTrace(trace);
 const formatted = stringifyDebugTraceSummary(summary, {
-  opcodes: { ...OpcodesBCH, [opcode]: 'OP_UNROT' },
+  opcodes: { ...OpcodesBch, [opcode]: 'OP_UNROT' },
 });
 console.log(formatted); /*
 

src/lib/compiler/compiler-bch/compiler-bch-operations.spec.ts

@@ -1,13 +1,13 @@
 import test from 'ava';
 
-import type { CompilationContextBCH } from '../../lib.js';
-import { compilerOperationSigningSerializationFullBCH } from '../../lib.js';
+import type { CompilationContextBch } from '../../lib.js';
+import { compilerOperationSigningSerializationFullBch } from '../../lib.js';
 
-test('compilerOperationSigningSerializationFullBCH: requires an algorithm', (t) => {
+test('compilerOperationSigningSerializationFullBch: requires an algorithm', (t) => {
   t.deepEqual(
-    compilerOperationSigningSerializationFullBCH(
+    compilerOperationSigningSerializationFullBch(
       '',
-      { compilationContext: {} as CompilationContextBCH },
+      { compilationContext: {} as CompilationContextBch },
       {
         scripts: { lock: '' },
         sha256: { hash: () => Uint8Array.of() },
@@ -22,11 +22,11 @@ test('compilerOperationSigningSerializationFullBCH: requires an algorithm', (t)
     },
   );
 });
-test('compilerOperationSigningSerializationFullBCH: error on unknown algorithms', (t) => {
+test('compilerOperationSigningSerializationFullBch: error on unknown algorithms', (t) => {
   t.deepEqual(
-    compilerOperationSigningSerializationFullBCH(
+    compilerOperationSigningSerializationFullBch(
       'signing_serialization.full_unknown_serialization',
-      { compilationContext: {} as CompilationContextBCH },
+      { compilationContext: {} as CompilationContextBch },
       {
         scripts: { lock: '' },
         sha256: { hash: () => Uint8Array.of() },

src/lib/compiler/compiler-bch/compiler-bch.e2e.built-in-variables.spec.ts

@@ -1,20 +1,20 @@
 import test from 'ava';
 
 import type {
-  AuthenticationProgramStateBCH,
+  AuthenticationProgramStateBch,
   BytecodeGenerationResult,
-  CompilerConfigurationBCH,
+  CompilerConfigurationBch,
 } from '../../lib.js';
 import {
-  compilerConfigurationToCompilerBCH,
-  compilerOperationsBCH,
+  compilerConfigurationToCompilerBch,
+  compilerOperationsBch,
   createAuthenticationProgramEvaluationCommon,
   createCompilationContextCommonTesting,
-  createVirtualMachineBCH,
+  createVirtualMachineBch,
   dateToLocktime,
   generateBytecodeMap,
   hexToBin,
-  OpcodesBCH2022,
+  OpcodesBch,
   sha256,
 } from '../../lib.js';
 
@@ -43,7 +43,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test(
@@ -78,7 +78,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test(
@@ -113,7 +113,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
   {},
   { unlockingScriptTimeLockTypes: { test: 'height' } },
 );
@@ -142,7 +142,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
   {},
   { unlockingScriptTimeLockTypes: { test: 'timestamp' } },
 );
@@ -180,7 +180,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
   {},
   { unlockingScriptTimeLockTypes: { test: 'height' } },
 );
@@ -205,7 +205,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test(
@@ -228,7 +228,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 /**
@@ -280,7 +280,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test(
@@ -303,7 +303,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test(
@@ -637,7 +637,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
   {},
   {
     unlockingScripts: {},
@@ -664,7 +664,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
   {},
   {
     unlockingScripts: {
@@ -693,7 +693,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
   {},
   {
     scripts: {
@@ -723,7 +723,7 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test(
@@ -746,19 +746,19 @@ test(
       },
     ],
     success: false,
-  } as BytecodeGenerationResult<AuthenticationProgramStateBCH>,
+  } as BytecodeGenerationResult<AuthenticationProgramStateBch>,
 );
 
 test.failing(
   '[BCH compiler] signing_serialization.corresponding_output and signing_serialization.corresponding_output_hash - returns empty bytecode if no corresponding output',
   (t) => {
-    const compiler = compilerConfigurationToCompilerBCH<
-      CompilerConfigurationBCH,
-      AuthenticationProgramStateBCH
+    const compiler = compilerConfigurationToCompilerBch<
+      CompilerConfigurationBch,
+      AuthenticationProgramStateBch
     >({
       createAuthenticationProgram: createAuthenticationProgramEvaluationCommon,
-      opcodes: generateBytecodeMap(OpcodesBCH2022),
-      operations: compilerOperationsBCH,
+      opcodes: generateBytecodeMap(OpcodesBch),
+      operations: compilerOperationsBch,
       scripts: {
         // eslint-disable-next-line camelcase
         corresponding_output:
@@ -773,7 +773,7 @@ test.failing(
           type: 'Key',
         },
       },
-      vm: createVirtualMachineBCH(),
+      vm: createVirtualMachineBch(),
     });
 
     const data = {