feat: migrate packages/cashscript jest to vitest

- replace jest with vitest
- remove jest references no longer used
- add vitest configuration file in package
- refactor extend functions so that they work
with vitest
- rename jest extensions file as `VitestExtensions.ts`
- add vitest types

Author: hereje

packages/cashscript/jest.config.js

@@ -42,7 +42,7 @@
     "prepare": "yarn build",
     "prepublishOnly": "yarn test && yarn lint",
     "pretest": "yarn build:test",
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
+    "test": "vitest run"
   },
   "dependencies": {
     "@bitauth/libauth": "^3.1.0-next.2",
@@ -56,13 +56,12 @@
     "semver": "^7.7.2"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
     "@psf/bch-js": "^6.8.0",
     "@types/pako": "^2.0.3",
     "@types/semver": "^7.5.8",
     "eslint": "^8.54.0",
-    "jest": "^29.7.0",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
   },
   "gitHead": "bf02a4b641d5d03c035d052247a545109c17b708"
 }

packages/cashscript/jest.setup.js

@@ -0,0 +1,131 @@
+import { DebugResults } from '../debugging.js';
+import { vi, expect } from 'vitest';
+
+interface Debuggable {
+  debug(): DebugResults | Promise<DebugResults>;
+}
+
+interface ExpectationResult {
+  pass: boolean
+  message: () => string
+  // If you pass these, they will automatically appear inside a diff when
+  // the matcher does not pass, so you don't need to print the diff yourself
+  actual?: unknown
+  expected?: unknown
+}
+
+export function toLog(
+  // FIXME: improve type definition
+  this: any,
+  transaction: Debuggable,
+  match?: RegExp | string,
+): ExpectationResult {
+  const loggerSpy = vi.spyOn(console, 'log');
+  const { utils, isNot } = this;
+
+  // Clear any previous calls (if spy reused accidentally)
+  loggerSpy.mockClear();
+
+  // silence actual stdout output
+  loggerSpy.mockImplementation(() => { });
+
+  try {
+    executeDebug(transaction);
+  } catch (error) {
+    if (error instanceof OldTransactionBuilderError) throw error;
+  }
+
+  // We concatenate all the logs into a single string - if no logs are present, we set received to undefined
+  const receivedBase = loggerSpy.mock.calls.reduce((acc, [log]) => `${acc}\n${log}`, '').trim();
+  const received = receivedBase === '' ? undefined : receivedBase;
+
+  const matcherHint = utils.matcherHint('toLog', 'received', 'expected', { isNot: isNot });
+  const expectedText = `Expected: ${isNot ? 'not ' : ''}${utils.printExpected(match)}`;
+  const receivedText = `Received: ${utils.printReceived(received)}`;
+  const message = (): string => `${matcherHint}\n\n${expectedText}\n${receivedText}`;
+
+  try {
+    // We first check if the expected string is present in any of the individual console.log calls
+    expect(loggerSpy).toHaveBeenCalledWith(match ? expect.stringMatching(match) : expect.anything());
+  } catch {
+    try {
+      // We add this extra check to allow expect().toLog() to check multiple console.log calls in a single test
+      // (e.g. for log ordering), which would fail the first check because that compares the individual console.log calls
+      expect(receivedBase).toMatch(match ? match : expect.anything());
+    } catch {
+      return { message, pass: false };
+    }
+  } finally {
+    // Restore the original console.log implementation
+    loggerSpy.mockRestore();
+  }
+
+  return { message, pass: true };
+}
+
+export function toFailRequireWith(
+  this: any,
+  transaction: Debuggable,
+  match: RegExp | string,
+): ExpectationResult {
+  const { utils, isNot } = this;
+  try {
+    executeDebug(transaction);
+
+    const matcherHint = utils.matcherHint('.toFailRequireWith', undefined, match.toString(), { isNot: isNot });
+    const message = (): string => `${matcherHint}\n\nContract function did not fail a require statement.`;
+    return { message, pass: false };
+  } catch (transactionError: any) {
+    if (transactionError instanceof OldTransactionBuilderError) throw transactionError;
+
+    const matcherHint = utils.matcherHint('toFailRequireWith', 'received', 'expected', { isNot: isNot });
+    const expectedText = `Expected pattern: ${isNot ? 'not ' : ''}${utils.printExpected(match)}`;
+    const receivedText = `Received string: ${utils.printReceived(transactionError?.message ?? '')}`;
+    const message = (): string => `${matcherHint}\n\n${expectedText}\n${receivedText}`;
+
+    try {
+      expect(transactionError?.message ?? '').toMatch(match);
+      return { message, pass: true };
+    } catch {
+      return { message, pass: false };
+    }
+  }
+}
+
+
+export function toFailRequire(
+  this: any,
+  transaction: Debuggable,
+): ExpectationResult {
+  const { utils } = this;
+  try {
+    executeDebug(transaction);
+    const message = (): string => 'Contract function did not fail a require statement.';
+    return { message, pass: false };
+  } catch (transactionError: any) {
+    if (transactionError instanceof OldTransactionBuilderError) throw transactionError;
+
+    const receivedText = `Received string: ${utils.printReceived(transactionError?.message ?? '')}`;
+    const message = (): string => `Contract function failed a require statement.\n${receivedText}`;
+    return { message, pass: true };
+  }
+}
+
+
+// Wrapper function with custom error in case people use it with the old transaction builder
+// This is a temporary solution until we fully remove the old transaction builder from the SDK
+const executeDebug = (transaction: Debuggable): void => {
+  const debugResults = transaction.debug();
+
+  if (debugResults instanceof Promise) {
+    debugResults.catch(() => { });
+    throw new OldTransactionBuilderError();
+  }
+};
+
+class OldTransactionBuilderError extends Error {
+  constructor() {
+    super('The CashScript VitestExtensions do not support the old transaction builder since v0.11.0. Please use the new TransactionBuilder class.');
+    this.name = 'OldTransactionBuilderError';
+  }
+}

packages/cashscript/jest/package.json

@@ -17,6 +17,7 @@ import hodlVaultArtifact from './fixture/hodl_vault.artifact.js';
 import mecenasArtifact from './fixture/mecenas.artifact.js';
 import deprecatedMecenasArtifact from './fixture/deprecated/mecenas-v0.6.0.json' with { type: 'json' };
 import boundedBytesArtifact from './fixture/bounded_bytes.artifact.js';
+import { describe, expect, it, beforeEach } from 'vitest';
 
 describe('Contract', () => {
   describe('new', () => {

packages/cashscript/package.json

@@ -19,6 +19,7 @@ import twtArtifact from './fixture/transfer_with_timeout.artifact.js';
 import { TransactionBuilder } from '../src/TransactionBuilder.js';
 import { gatherUtxos, getTxOutputs } from './test-util.js';
 import { generateWcTransactionObjectFixture } from './fixture/walletconnect/fixtures.js';
+import { describe, expect, it, beforeAll } from 'vitest';
 
 describe('Transaction Builder', () => {
   const provider = process.env.TESTS_USE_CHIPNET

packages/cashscript/src/test/JestExtensions.ts

@@ -1,5 +1,6 @@
 import { Contract, MockNetworkProvider, randomUtxo, SignatureTemplate, TransactionBuilder } from '../src/index.js';
 import { alicePkh, alicePriv, alicePub, bobPriv } from './fixture/vars.js';
+import { describe, expect, it } from 'vitest';
 
 const artifact = {
   contractName: 'P2PKH',