Add support for BCH_2025_05

- Update libauth to latest @next release and adapt to changes
- Remove opcount checks & update bytesize checks to new limit
- Update VM used for debugging to BCH_2025_05
- Update bigint tests to check that ints bigger than 64 bits no longer
  fail

Author: rkalis

examples/package.json

@@ -11,7 +11,7 @@
     "lint": "eslint . --ext .ts --ignore-path ../.eslintignore"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.0.0",
+    "@bitauth/libauth": "^3.1.0-next.2",
     "@types/node": "^12.7.8",
     "cashc": "^0.10.5",
     "cashscript": "^0.10.5",

examples/testing-suite/package.json

@@ -25,6 +25,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
+    "@bitauth/libauth": "^3.1.0-next.2",
     "cashc": "^0.10.5",
     "cashscript": "^0.10.5",
     "url-join": "^5.0.0"

packages/cashc/package.json

@@ -49,7 +49,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.0.0",
+    "@bitauth/libauth": "^3.1.0-next.2",
     "@cashscript/utils": "^0.10.5",
     "antlr4": "^4.13.1-patch-1",
     "commander": "^7.1.0",

packages/cashc/src/cashc-cli.ts

@@ -13,6 +13,7 @@ import { program, Option } from 'commander';
 import fs from 'fs';
 import path from 'path';
 import { compileFile, version } from './index.js';
+import { MAX_INPUT_BYTESIZE } from './constants.js';
 
 program
   .storeOptionsAsProperties(false)
@@ -54,11 +55,8 @@ function run(): void {
     const opcount = countOpcodes(script);
     const bytesize = calculateBytesize(script);
 
-    if (opcount > 201) {
-      console.warn('Warning: Your contract\'s opcount is over the limit of 201 and will not be accepted by the BCH network');
-    }
-    if (bytesize > 520) {
-      console.warn('Warning: Your contract\'s bytesize is over the limit of 520 and will not be accepted by the BCH network');
+    if (bytesize > MAX_INPUT_BYTESIZE) {
+      console.warn(`Warning: Your contract is ${bytesize} bytes, which is over the limit of ${MAX_INPUT_BYTESIZE} bytes and will not be accepted by the BCH network`);
     }
 
     if (opts.asm) {

packages/cashc/src/constants.ts

@@ -0,0 +1 @@
+export const MAX_INPUT_BYTESIZE = 1650;

packages/cashscript/package.json

@@ -43,7 +43,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.0.0",
+    "@bitauth/libauth": "^3.1.0-next.2",
     "@cashscript/utils": "^0.10.5",
     "@mr-zwets/bchn-api-wrapper": "^1.0.1",
     "delay": "^5.0.0",

packages/cashscript/src/debugging.ts

@@ -1,4 +1,4 @@
-import { AuthenticationErrorCommon, AuthenticationInstruction, AuthenticationProgramCommon, AuthenticationProgramStateBCH, AuthenticationProgramStateCommon, AuthenticationVirtualMachine, ResolvedTransactionCommon, WalletTemplate, binToHex, createCompiler, createVirtualMachineBCH2023, encodeAuthenticationInstruction, walletTemplateToCompilerConfiguration } from '@bitauth/libauth';
+import { AuthenticationErrorCommon, AuthenticationInstruction, AuthenticationProgramCommon, AuthenticationProgramStateCommon, AuthenticationVirtualMachine, ResolvedTransactionCommon, WalletTemplate, binToHex, createCompiler, createVirtualMachineBch2025, encodeAuthenticationInstruction, walletTemplateToCompilerConfiguration } from '@bitauth/libauth';
 import { Artifact, LogEntry, Op, PrimitiveType, StackItem, bytecodeToAsm, decodeBool, decodeInt, decodeString } from '@cashscript/utils';
 import { findLastIndex, toRegExp } from './utils.js';
 import { FailedRequireError, FailedTransactionError, FailedTransactionEvaluationError } from './Errors.js';
@@ -53,7 +53,7 @@ export const debugTemplate = (template: WalletTemplate, artifact: Artifact): Deb
     // preceding OP_CHECKSIG opcode. The error message is registered in the next instruction, so we need to increment
     // the instruction pointer to get the correct error message from the require messages in the artifact.
     // Note that we do NOT use this adjusted IP when passing the failing IP into the FailedRequireError
-    const isNullFail = lastExecutedDebugStep.error === AuthenticationErrorCommon.nonNullSignatureFailure;
+    const isNullFail = lastExecutedDebugStep.error.includes(AuthenticationErrorCommon.nonNullSignatureFailure);
     const requireStatementIp = failingIp + (isNullFail ? 1 : 0);
 
     const requireStatement = (artifact.debug?.requires ?? [])
@@ -110,15 +110,15 @@ export const debugTemplate = (template: WalletTemplate, artifact: Artifact): Deb
 type VM = AuthenticationVirtualMachine<
 ResolvedTransactionCommon,
 AuthenticationProgramCommon,
-AuthenticationProgramStateBCH
+AuthenticationProgramStateCommon
 >;
 type Program = AuthenticationProgramCommon;
 type CreateProgramResult = { vm: VM, program: Program };
 
 // internal util. instantiates the virtual machine and compiles the template into a program
 const createProgram = (template: WalletTemplate): CreateProgramResult => {
   const configuration = walletTemplateToCompilerConfiguration(template);
-  const vm = createVirtualMachineBCH2023();
+  const vm = createVirtualMachineBch2025();
   const compiler = createCompiler(configuration);
 
   const scenarioGeneration = compiler.generateScenario({
@@ -176,8 +176,9 @@ const failedFinalVerify = (evaluationResult: string | true): evaluationResult is
   // If any of the following errors occurred, then the final verify failed - any other messages
   // indicate other kinds of failures
   return toRegExp([
-    AuthenticationErrorCommon.requiresCleanStack,
-    AuthenticationErrorCommon.nonEmptyControlStack,
+    // TODO: Ask Jason to put these back into an enum and replace with the enum value
+    'The CashAssembly internal evaluation completed with an unexpected number of items on the stack (must be exactly 1).', // AuthenticationErrorCommon.requiresCleanStack,
+    'The CashAssembly internal evaluation completed with a non-empty control stack.', // AuthenticationErrorCommon.nonEmptyControlStack,
     AuthenticationErrorCommon.unsuccessfulEvaluation,
   ]).test(evaluationResult);
 };

packages/cashscript/test/e2e/BigInt.test.ts

@@ -1,9 +1,7 @@
-import { AuthenticationErrorCommon } from '@bitauth/libauth';
 import {
   Contract,
   MockNetworkProvider,
   FailedRequireError,
-  FailedTransactionError,
   ElectrumNetworkProvider,
   Network,
 } from '../../src/index.js';
@@ -26,7 +24,7 @@ describe('BigInt', () => {
   });
 
   describe('proofOfBigInt', () => {
-    it('should fail when providing a number that fits within 32 bits', async () => {
+    it('should fail require statement when providing a number that fits within 32 bits', async () => {
       // given
       const to = bigintContract.address;
       const amount = 1000n;
@@ -43,7 +41,7 @@ describe('BigInt', () => {
       await expect(txPromise).rejects.toThrow('Failing statement: require(x >= maxInt32PlusOne)');
     });
 
-    it('should fail when providing numbers that overflow 64 bits when multiplied', async () => {
+    it('should succeed when providing numbers that are larger than 64 bits when multiplied', async () => {
       // given
       const to = bigintContract.address;
       const amount = 1000n;
@@ -55,11 +53,10 @@ describe('BigInt', () => {
         .send();
 
       // then
-      await expect(txPromise).rejects.toThrow(FailedTransactionError);
-      await expect(txPromise).rejects.toThrow(AuthenticationErrorCommon.overflowsVmNumberRange);
+      await expect(txPromise).resolves.not.toThrow();
     });
 
-    it('should fail when providing a number that does not fit within 64 bits', async () => {
+    it('should succeed when providing a number that does not fit within 64 bits', async () => {
       // given
       const to = bigintContract.address;
       const amount = 1000n;
@@ -71,8 +68,7 @@ describe('BigInt', () => {
         .send();
 
       // then
-      await expect(txPromise).rejects.toThrow(FailedTransactionError);
-      await expect(txPromise).rejects.toThrow(AuthenticationErrorCommon.invalidVmNumber);
+      await expect(txPromise).resolves.not.toThrow();
     });
 
     it('should succeed when providing a number within 32b < x < 64b', async () => {

packages/utils/package.json

@@ -40,7 +40,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.0.0"
+    "@bitauth/libauth": "^3.1.0-next.2"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",

packages/utils/src/script.ts

@@ -1,16 +1,16 @@
 import {
-  OpcodesBCH,
+  OpcodesBch2023,
   encodeDataPush,
   hexToBin,
-  disassembleBytecodeBCH,
+  disassembleBytecodeBch,
   flattenBinArray,
   encodeAuthenticationInstructions,
   decodeAuthenticationInstructions,
 } from '@bitauth/libauth';
 import { decodeInt, encodeInt } from './data.js';
 import OptimisationsEquivFile from './cashproof-optimisations.js';
 
-export const Op = OpcodesBCH;
+export const Op = OpcodesBch2023;
 export type Op = number;
 export type OpOrData = Op | Uint8Array;
 export type Script = OpOrData[];
@@ -79,7 +79,7 @@ export function asmToBytecode(asm: string): Uint8Array {
 
 export function bytecodeToAsm(bytecode: Uint8Array): string {
   // Convert the bytecode to libauth's ASM format
-  let asm = disassembleBytecodeBCH(bytecode);
+  let asm = disassembleBytecodeBch(bytecode);
 
   // COnvert libauth's ASM format to BITBOX's
   asm = asm.replace(/OP_PUSHBYTES_[^\s]+/g, '');
@@ -95,7 +95,7 @@ export function bytecodeToAsm(bytecode: Uint8Array): string {
 // TODO: If we decide to change the ASM / artifact format, we can remove this function and merge it with bytecodeToAsm
 export function bytecodeToBitAuthAsm(bytecode: Uint8Array): string {
   // Convert the bytecode to libauth's ASM format
-  let asm = disassembleBytecodeBCH(bytecode);
+  let asm = disassembleBytecodeBch(bytecode);
 
   // COnvert libauth's ASM format to BitAuth Script ASM
   asm = asm.replace(/OP_PUSHBYTES_[^\s]+/g, '');