Migrate JS tests to a Kit client and LiteSVM (#74)

Author: lorisleiva

Makefile

@@ -77,25 +77,17 @@ build-doc-%:
 test-doc-%:
 	cargo $(nightly) test --doc --all-features --manifest-path $(call make-path,$*)/Cargo.toml $(ARGS)
 
-test-%:
-	SBF_OUT_DIR=$(PWD)/target/deploy cargo $(nightly) test --manifest-path $(call make-path,$*)/Cargo.toml $(ARGS)
-
 format-check-js-%:
 	cd $(call make-path,$*) && pnpm install && pnpm format $(ARGS)
 
 lint-js-%:
 	cd $(call make-path,$*) && pnpm install && pnpm lint $(ARGS)
 
 test-js-%:
-	make restart-test-validator
 	cd $(call make-path,$*) && pnpm install && pnpm build && pnpm test $(ARGS)
-	make stop-test-validator
 
-restart-test-validator:
-	./scripts/restart-test-validator.sh
-
-stop-test-validator:
-	pkill -f solana-test-validator
+test-%:
+	SBF_OUT_DIR=$(PWD)/target/deploy cargo $(nightly) test --manifest-path $(call make-path,$*)/Cargo.toml $(ARGS)
 
 generate-idl-%:
 	pnpm generate:idl $(call make-path,$*) $(ARGS)

clients/js/README.md

@@ -4,24 +4,19 @@ A generated JavaScript library for the Feature Gate program.
 
 ## Getting started
 
-To build and test your JavaScript client from the root of the repository, you may use the following command.
+The JS client tests use [LiteSVM](https://github.com/LiteSVM/litesvm) in-process, so no local validator is needed. To build and test your JavaScript client from the root of the repository, you may use the following command.
 
 ```sh
-pnpm clients:js:test
+make test-js-clients-js
 ```
 
-This will start a new local validator, if one is not already running, and run the tests for your JavaScript client.
+This installs dependencies, builds the client, and runs the test suite.
 
 ## Available client scripts.
 
 Alternatively, you can go into the client directory and run the tests directly.
 
 ```sh
-# Build your programs and start the validator.
-pnpm programs:build
-pnpm validator:restart
-
-# Go into the client directory and run the tests.
 cd clients/js
 pnpm install
 pnpm build

clients/js/package.json

@@ -40,6 +40,8 @@
   "devDependencies": {
     "@solana/eslint-config-solana": "^3.0.3",
     "@solana/kit": "^6.4.0",
+    "@solana/kit-plugin-litesvm": "^0.10.0",
+    "@solana/kit-plugin-signer": "^0.10.0",
     "@solana/webcrypto-ed25519-polyfill": "3.0.3",
     "@types/node": "^24",
     "@typescript-eslint/eslint-plugin": "^7.16.1",

clients/js/pnpm-lock.yaml

@@ -0,0 +1,38 @@
+import path from 'node:path';
+
+import { createClient, lamports } from '@solana/kit';
+import { litesvm } from '@solana/kit-plugin-litesvm';
+import { airdropSigner, generatedSigner } from '@solana/kit-plugin-signer';
+
+import {
+  SOLANA_FEATURE_GATE_PROGRAM_ADDRESS,
+  solanaFeatureGateProgram,
+} from '../src';
+
+const SOLANA_FEATURE_GATE_BINARY_PATH = path.resolve(
+  __dirname,
+  '..',
+  '..',
+  '..',
+  'target',
+  'deploy',
+  'solana_feature_gate_program.so'
+);
+
+export const createTestClient = () => {
+  return createClient()
+    .use(generatedSigner())
+    .use(litesvm())
+    .use(airdropSigner(lamports(1_000_000_000n)))
+    .use((client) => {
+      // Load the feature-gate program into the LiteSVM instance from its
+      // compiled `.so` file. This must run after the `litesvm()` plugin so
+      // that `client.svm` is available.
+      client.svm.addProgramFromFile(
+        SOLANA_FEATURE_GATE_PROGRAM_ADDRESS,
+        SOLANA_FEATURE_GATE_BINARY_PATH
+      );
+      return client;
+    })
+    .use(solanaFeatureGateProgram());
+};

clients/js/test/_setup.ts

@@ -1,5 +1,17 @@
 import { expect, it } from 'vitest';
 
-it('runs an example test', () => {
-  expect(true).toBe(true);
+import { createTestClient } from './_setup';
+
+it('sets up a LiteSVM client with the feature-gate program', async () => {
+  // Given a test client whose payer is funded with SOL.
+  const client = await createTestClient();
+
+  // Then the client exposes the feature-gate program plugin.
+  expect(client.solanaFeatureGate).toBeDefined();
+
+  // And the payer was funded via LiteSVM.
+  const { value: balance } = await client.rpc
+    .getBalance(client.payer.address)
+    .send();
+  expect(balance).toBe(1_000_000_000n);
 });