Merge pull request #31 from LiteSVM/port-to-litesvm

port to litesvm

Author: kevinheavey

CHANGELOG.md

@@ -1,28 +1,3 @@
 # Changelog
 
-## [0.5.0] - 2024-10-18
-
-- Re-export `startAnchor` from `solana-bankrun`
-- Require `solana/web3.js` >1.92.0 and fix SendTransactionError construction
-
-## [0.4.1] - 2024-09-12
-
-- Restrict solana/web3.js to <1.92 to avoid breaking change they introduced
-
-## [0.4.0] - 2024-06-29
-
-- BREAKING: Update to Anchor v0.30 [(#15)](https://github.com/kevinheavey/anchor-bankrun/pull/15)
-
-## [0.3.0] - 2023-12-02
-
-- Make `@solana/web3.js` a peer dependency [(#5)](https://github.com/kevinheavey/anchor-bankrun/pull/5)
-- Correctly handle missing transaction logs [(#10)](https://github.com/kevinheavey/anchor-bankrun/pull/10)
-
-## [0.2.0] - 2023-09-08
-
-- Add better support for Anchor-like errors [(#6)](https://github.com/kevinheavey/anchor-bankrun/pull/6)
-- Expose publicKey and add wallet to provider constructor [(#3)](https://github.com/kevinheavey/anchor-bankrun/pull/3)
-
-## [0.1.0] - 2023-08-13
-
-First release 🚀
+Unreleased

README.md

@@ -1,34 +1,29 @@
-# anchor-bankrun
+# anchor-litesvm
 
-`anchor-bankrun` is a small but powerful extension to [solana-bankrun](https://github.com/kevinheavey/solana-bankrun)
-that enables using both Anchor and Bankrun with only a one-line code change. It does this by exporting a `BankrunProvider` class that can be used as a drop-in replacement for `AnchorProvider` during testing.
+`anchor-litesvm` is a small extension to [LiteSVM](https://github.com/LiteSVM/litesvm)
+that enables using both Anchor and LiteSVM with minimal code changes. It does this by exporting a `LitesvmProvider` class that can be used as a replacement for `AnchorProvider` during testing.
 
-## Anchor version note
+## Async note
 
-Recent versions of `anchor-bankrun` use the Anchor v0.30 IDL, which is not backwards compatible with older Anchor IDLs.
-If you have an older IDL, use `anchor-bankrun` v0.3.0.
+`litesvm` is synchronous because it is entirely compute-bound. However, `anchor-litesvm` uses async because
+it implements interfaces that require async. If you would like to avoid async tests, you can simply
+use regular `litesvm` without `anchor-litesvm`.
 
 ## Usage
 
-Here's an example using `BankrunProvider` to test an Anchor program:
+Here's an example using `LitesvmProvider` to test an Anchor program:
 
 ```typescript
-import { BankrunProvider, startAnchor } from "anchor-bankrun";
+import { fromWorkspace, LiteSVMProvider } from "anchor-litesvm";
 import { Keypair, PublicKey } from "@solana/web3.js";
-import { BN, Program } from "@coral-xyz/anchor";
+import { BN, Program, Wallet } from "@coral-xyz/anchor";
 import { Puppet } from "./anchor-example/puppet";
 const IDL = require("./anchor-example/puppet.json");
 
 test("anchor", async () => {
-	const context = await startAnchor("tests/anchor-example", [], []);
-
-	const provider = new BankrunProvider(context);
-
-	const puppetProgram = new Program<Puppet>(
-		IDL,
-		provider,
-	);
-
+	const client = fromWorkspace("tests/anchor-example");
+	const provider = new LiteSVMProvider(client);
+	const puppetProgram = new Program<Puppet>(IDL, provider);
 	const puppetKeypair = Keypair.generate();
 	await puppetProgram.methods
 		.initialize()
@@ -56,9 +51,5 @@ test("anchor", async () => {
 ## Installation
 
 ```
-yarn add anchor-bankrun
+yarn add anchor-litesvm
 ```
-
-## Why is this a separate package?
-
-I want to keep the Bankrun dependencies light.

package.json

@@ -1,23 +1,22 @@
 {
-	"name": "anchor-bankrun",
-	"version": "0.5.0",
+	"name": "anchor-litesvm",
+	"version": "0.0.1",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
-	"files": [
-		"dist/"
-	],
+	"files": ["dist/"],
 	"license": "MIT",
 	"devDependencies": {
 		"@coral-xyz/anchor": "^0.30.0",
 		"@solana/web3.js": ">1.92.0",
 		"@types/bn.js": "^5.1.1",
 		"@types/bs58": "^4.0.1",
 		"@types/jest": "^29.5.3",
+		"@types/node": "^22.10.7",
 		"@types/node-fetch": "^2.6.4",
 		"bs58": "^4.0.1",
 		"jest": "^29.6.1",
+		"litesvm": "0.0.2",
 		"rome": "^12.0.0",
-		"solana-bankrun": ">=0.2.0 <0.5.0",
 		"ts-jest": "^29.1.1",
 		"ts-node": "^10.9.1",
 		"typescript": "^5.0.4"
@@ -28,7 +27,7 @@
 	"scripts": {
 		"fmt": "rome format --write src/index.ts tests/ jest.config.ts tsconfig.json package.json",
 		"lint": "rome check src/index.ts tests/ jest.config.ts tsconfig.json package.json && tsc",
-		"test": "RUST_LOG= jest --runInBand",
+		"test": "jest",
 		"tsc": "tsc",
 		"bumpPatch": "yarn version --no-git-tag-version --patch",
 		"bumpMinor": "yarn version --no-git-tag-version --minor",
@@ -38,6 +37,9 @@
 	"peerDependencies": {
 		"@coral-xyz/anchor": "^0.30.0",
 		"@solana/web3.js": ">1.92.0",
-		"solana-bankrun": ">=0.2.0 <0.5.0"
+		"litesvm": "0.0.2"
+	},
+	"dependencies": {
+		"@iarna/toml": "^2.2.5"
 	}
 }