⚡️ TON Vitest Utils ⚡️

This package is a fork of test-utils with support for Vitest. It contains all the same functionality as the original package, such as randomAddress. But, a lot faster ⚡️

Features

• ⚡️ Performance: Native Vite & Vitest support
• 🛠️ Lightning Compilation: Extended caching layer on top of blueprint compilation for better performance
• 📦 Small Bundle Size: No jest or chai dependencies, only Vitest
• 🧪 Type Safe: Type definitions for TypeScript
• 🚀 Easy: Simple setup, just follow the usage instructions

Installation

yarn add vitest ton-vitest-utils -D

or

npm i --save-dev vitest ton-vitest-utils

Usage

Import the setup function from ton-vitest-utils (in your tests setup file), then pass Vitest's expect method into that function to init the matchers:

1// tests/vitest.setup.ts
2import { setUpTonTestUtils } from 'ton-vitest-utils';
3import { expect } from 'vitest';
4
5setUpTonTestUtils(expect);

In vitest.config.ts or vite.config.ts, add the setup file to the setupFiles array:

1// vitest.config.ts
2export default defineConfig({
3  test: {
4    // ...
5    environment: 'node',
6    globals: true,
7    setupFiles: ['tests/vitest.setup.ts'],
8  },
9});

Now all the matchers are available to use in your tests:

1test('should pass', () => {
2  expect(1).toHaveTransaction(1);
3  expect(1).toEqualAddress(1);
4});

With TypeScript

If you're using TypeScript, import our type definitions into tsconfig.json to get autocomplete and type checking:

1{
2  "compilerOptions": {
3    "types": ["vitest/globals", "ton-vitest-utils"]
4  }
5}

⚠️ Compile Note

To compile contracts in your tests, use our compile function instead of blueprint's.

Our compile function is a wrapper around blueprint's compile that is make it compatible with vitest and includes some performance enhancements.

1- import { compile } from '@ton/blueprint';
2+ import { compile } from 'ton-vitest-utils';

Transaction matcher notice

The transaction matcher (.toHaveTransaction) can only perform matching on transactions with descriptions of type generic. When matching an array of transactions, all transactions of other types will be filtered out. When matching a single transaction of non-generic type, an exception will be thrown.

Benchmarks

Setup: MacBook Pro (16-inch, M2 Pro, 2023).

Performed on various contracts to compare the performance of @ton/test-utils and ton-vitest-utils.

Contract	@ton/test-utils	ton-vitest-utils
Multisig Contract v2	29.071s	8.36s
Highload Wallet Contract v3	9.83s	5.30s
Tonkeeper Wallet v5 Contract	14.06s	6.55s
Hipo Finance contract	53.808s	34.80s
Ton Raffles - NFT Launchpad contract	44.663s	28.89s

Overall, this package can perform 2-5x faster than the @ton/test-utils package.

License

This package is released under the MIT License.