Replace @loris-sandbox/litesvm-kit with litesvm v1

.changeset/true-wings-send.md

@@ -0,0 +1,5 @@
+---
+'@solana/kit-plugin-litesvm': minor
+---
+
+Replace the temporary `@loris-sandbox/litesvm-kit` dependency with the official `litesvm` v1 package.

packages/kit-plugin-litesvm/package.json

@@ -49,7 +49,7 @@
         "@solana/kit": "^6.5.0"
     },
     "dependencies": {
-        "@loris-sandbox/litesvm-kit": "^0.5.0"
+        "litesvm": "^1.0.0"
     },
     "devDependencies": {
         "@solana-program/system": "^0.12.0"

packages/kit-plugin-litesvm/src/index.browser.ts

@@ -1,4 +1,4 @@
-export type { FailedTransactionMetadata, TransactionMetadata } from '@loris-sandbox/litesvm-kit';
+export type { FailedTransactionMetadata, TransactionMetadata } from 'litesvm';
 export type { LiteSVM } from './litesvm';
 export type { LiteSvmRpcApi } from './litesvm-to-rpc';
 

packages/kit-plugin-litesvm/src/index.ts

@@ -1,4 +1,4 @@
-export type { FailedTransactionMetadata, TransactionMetadata } from '@loris-sandbox/litesvm-kit';
+export type { FailedTransactionMetadata, TransactionMetadata } from 'litesvm';
 
 export * from './airdrop';
 export * from './get-minimum-balance';

packages/kit-plugin-litesvm/src/litesvm-to-rpc.ts

@@ -1,4 +1,3 @@
-import type { LiteSVM } from '@loris-sandbox/litesvm-kit';
 import {
     AccountInfoBase,
     AccountInfoWithBase64EncodedData,
@@ -25,6 +24,7 @@ import {
     signature as toSignature,
     SolanaRpcResponse,
 } from '@solana/kit';
+import type { LiteSVM } from 'litesvm';
 
 import { getSolanaErrorFromLiteSvmFailure, isFailedTransaction } from './transaction-error';
 
@@ -70,7 +70,7 @@ type Encoding = 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
  *
  * @example
  * ```ts
- * import { LiteSVM } from '@loris-sandbox/litesvm-kit';
+ * import { LiteSVM } from 'litesvm';
  * import { createRpcFromSvm } from '@solana/kit-plugin-litesvm';
  *
  * const svm = new LiteSVM();

packages/kit-plugin-litesvm/src/litesvm.ts

@@ -1,10 +1,10 @@
-import { LiteSVM } from '@loris-sandbox/litesvm-kit';
 import { extendClient } from '@solana/kit';
+import { LiteSVM } from 'litesvm';
 
 import { createRpcFromSvm } from './litesvm-to-rpc';
 
 // Re-export the LiteSVM type to make the `litesvm` plugin type-portable.
-export type { LiteSVM } from '@loris-sandbox/litesvm-kit';
+export type { LiteSVM } from 'litesvm';
 
 /**
  * A Kit plugin that adds LiteSVM functionality to your client.

packages/kit-plugin-litesvm/src/transaction-error.ts

@@ -2,7 +2,7 @@ import { getSolanaErrorFromTransactionError } from '@solana/kit';
 
 /**
  * A duck-typed interface for `FailedTransactionMetadata` from
- * `@loris-sandbox/litesvm-kit`. We avoid importing the class directly
+ * `litesvm`. We avoid importing the class directly
  * because LiteSVM is a Node-only native module and this file must be
  * resolvable in browser builds.
  */
@@ -12,7 +12,7 @@ export type FailedTransactionResult = {
 
 /**
  * The ordered names of the `TransactionErrorFieldless` enum variants
- * from `@loris-sandbox/litesvm-kit`. Each index corresponds to the
+ * from `litesvm`. Each index corresponds to the
  * enum's numeric value and maps to the string name expected by
  * {@link getSolanaErrorFromTransactionError}.
  */
@@ -56,7 +56,7 @@ const TRANSACTION_ERROR_NAMES: readonly string[] = [
 
 /**
  * The ordered names of the `InstructionErrorFieldless` enum variants
- * from `@loris-sandbox/litesvm-kit`. Each index corresponds to the
+ * from `litesvm`. Each index corresponds to the
  * enum's numeric value and maps to the string name expected by
  * {@link getSolanaErrorFromTransactionError}.
  */

packages/kit-plugin-litesvm/src/transaction-plan-executor.ts

@@ -1,11 +1,5 @@
-import type { FailedTransactionMetadata, LiteSVM, TransactionMetadata } from '@loris-sandbox/litesvm-kit';
-import {
-    createTransactionPlanExecutor,
-    extendClient,
-    pipe,
-    setTransactionMessageLifetimeUsingBlockhash,
-    signTransactionMessageWithSigners,
-} from '@solana/kit';
+import { createTransactionPlanExecutor, extendClient, pipe, signTransactionMessageWithSigners } from '@solana/kit';
+import type { FailedTransactionMetadata, LiteSVM, TransactionMetadata } from 'litesvm';
 
 import { getSolanaErrorFromLiteSvmFailure, isFailedTransaction } from './transaction-error';
 
@@ -51,10 +45,9 @@ export function litesvmTransactionPlanExecutor() {
             transactionMetadata: FailedTransactionMetadata | TransactionMetadata;
         }>({
             executeTransactionMessage: async (context, transactionMessage, config) => {
-                const latestBlockhash = client.svm.latestBlockhashLifetime();
                 const signedTransaction = await pipe(
                     transactionMessage,
-                    tx => setTransactionMessageLifetimeUsingBlockhash(latestBlockhash, tx),
+                    tx => client.svm.setTransactionMessageLifetimeUsingLatestBlockhash(tx),
                     tx => (context.message = tx),
                     async tx => await signTransactionMessageWithSigners(tx, config),
                 );

packages/kit-plugin-litesvm/test/index.test.ts

@@ -1,4 +1,3 @@
-import { LiteSVM } from '@loris-sandbox/litesvm-kit';
 import {
     createEmptyClient,
     GetAccountInfoApi,
@@ -11,6 +10,7 @@ import {
     RequestAirdropApi,
     Rpc,
 } from '@solana/kit';
+import { LiteSVM } from 'litesvm';
 import { describe, expect, expectTypeOf, it } from 'vitest';
 
 import { litesvm as nodeLitesvm } from '../src/index';

packages/kit-plugin-litesvm/test/transaction-plan-executor.test.ts

@@ -1,4 +1,3 @@
-import type { FailedTransactionMetadata, LiteSVM, TransactionMetadata } from '@loris-sandbox/litesvm-kit';
 import {
     Address,
     appendTransactionMessageInstruction,
@@ -19,14 +18,12 @@ import {
     SolanaError,
 } from '@solana/kit';
 import { getTransferSolInstruction } from '@solana-program/system';
+import type { FailedTransactionMetadata, LiteSVM, TransactionMetadata } from 'litesvm';
 import { describe, expect, it, vi } from 'vitest';
 
 import { litesvm, litesvmTransactionPlanExecutor, litesvmTransactionPlanner } from '../src';
 
-const MOCK_BLOCKHASH = { blockhash: '11111111111111111111111111111111', lastValidBlockHeight: 0n };
-const MOCK_INSTRUCTION = {
-    programAddress: '11111111111111111111111111111111' as Address,
-};
+const MOCK_INSTRUCTION = { programAddress: '11111111111111111111111111111111' as Address };
 
 describe('litesvmTransactionPlanExecutor', () => {
     describe('with mocks', () => {
@@ -40,10 +37,10 @@ describe('litesvmTransactionPlanExecutor', () => {
 
         it('uses the SVM instance to send transactions', async () => {
             const payer = await generateKeyPairSigner();
-            const latestBlockhashLifetime = vi.fn().mockReturnValueOnce(MOCK_BLOCKHASH);
+            const setTransactionMessageLifetimeUsingLatestBlockhash = vi.fn().mockImplementation(<T>(m: T) => m);
             // Return a success result (no `.err` property).
             const sendTransaction = vi.fn().mockReturnValue({ signature: () => new Uint8Array(64) });
-            const svm = { latestBlockhashLifetime, sendTransaction } as unknown as LiteSVM;
+            const svm = { sendTransaction, setTransactionMessageLifetimeUsingLatestBlockhash } as unknown as LiteSVM;
             const client = createEmptyClient()
                 .use(() => ({ payer, svm }))
                 .use(litesvmTransactionPlanner())
@@ -55,16 +52,16 @@ describe('litesvmTransactionPlanExecutor', () => {
                 transactionPlan,
             )) as SingleTransactionPlanResult;
             expect(transactionPlanResult.kind).toBe('single');
-            expect(latestBlockhashLifetime).toHaveBeenCalledOnce();
+            expect(setTransactionMessageLifetimeUsingLatestBlockhash).toHaveBeenCalledOnce();
             expect(sendTransaction).toHaveBeenCalledOnce();
         });
 
         it('includes transactionMetadata in the result context on success', async () => {
             const payer = await generateKeyPairSigner();
-            const latestBlockhashLifetime = vi.fn().mockReturnValueOnce(MOCK_BLOCKHASH);
+            const setTransactionMessageLifetimeUsingLatestBlockhash = vi.fn().mockImplementation(<T>(m: T) => m);
             const mockMetadata = { logs: () => ['log1'], signature: () => new Uint8Array(64) };
             const sendTransaction = vi.fn().mockReturnValue(mockMetadata);
-            const svm = { latestBlockhashLifetime, sendTransaction } as unknown as LiteSVM;
+            const svm = { sendTransaction, setTransactionMessageLifetimeUsingLatestBlockhash } as unknown as LiteSVM;
             const client = createEmptyClient()
                 .use(() => ({ payer, svm }))
                 .use(litesvmTransactionPlanner())
@@ -78,10 +75,10 @@ describe('litesvmTransactionPlanExecutor', () => {
 
         it('includes transactionMetadata in the result context on failure', async () => {
             const payer = await generateKeyPairSigner();
-            const latestBlockhashLifetime = vi.fn().mockReturnValueOnce(MOCK_BLOCKHASH);
+            const setTransactionMessageLifetimeUsingLatestBlockhash = vi.fn().mockImplementation(<T>(m: T) => m);
             const mockMetadata = { err: () => 2 };
             const sendTransaction = vi.fn().mockReturnValue(mockMetadata);
-            const svm = { latestBlockhashLifetime, sendTransaction } as unknown as LiteSVM;
+            const svm = { sendTransaction, setTransactionMessageLifetimeUsingLatestBlockhash } as unknown as LiteSVM;
             const client = createEmptyClient()
                 .use(() => ({ payer, svm }))
                 .use(litesvmTransactionPlanExecutor());
@@ -98,10 +95,10 @@ describe('litesvmTransactionPlanExecutor', () => {
 
         it('throws a SolanaError when the transaction fails', async () => {
             const payer = await generateKeyPairSigner();
-            const latestBlockhashLifetime = vi.fn().mockReturnValueOnce(MOCK_BLOCKHASH);
+            const setTransactionMessageLifetimeUsingLatestBlockhash = vi.fn().mockImplementation(<T>(m: T) => m);
             // Return a failed result with a fieldless error (AccountNotFound = 2).
             const sendTransaction = vi.fn().mockReturnValue({ err: () => 2 });
-            const svm = { latestBlockhashLifetime, sendTransaction } as unknown as LiteSVM;
+            const svm = { sendTransaction, setTransactionMessageLifetimeUsingLatestBlockhash } as unknown as LiteSVM;
             const client = createEmptyClient()
                 .use(() => ({ payer, svm }))
                 .use(litesvmTransactionPlanExecutor());
@@ -124,15 +121,15 @@ describe('litesvmTransactionPlanExecutor', () => {
 
         it('throws a SolanaError for instruction errors', async () => {
             const payer = await generateKeyPairSigner();
-            const latestBlockhashLifetime = vi.fn().mockReturnValueOnce(MOCK_BLOCKHASH);
+            const setTransactionMessageLifetimeUsingLatestBlockhash = vi.fn().mockImplementation(<T>(m: T) => m);
             // Return a failed result with an instruction error.
             const instructionError = {
                 constructor: { name: 'TransactionErrorInstructionError' },
                 err: () => 2, // InstructionErrorFieldless.InvalidInstructionData
                 index: 0,
             };
             const sendTransaction = vi.fn().mockReturnValue({ err: () => instructionError });
-            const svm = { latestBlockhashLifetime, sendTransaction } as unknown as LiteSVM;
+            const svm = { sendTransaction, setTransactionMessageLifetimeUsingLatestBlockhash } as unknown as LiteSVM;
             const client = createEmptyClient()
                 .use(() => ({ payer, svm }))
                 .use(litesvmTransactionPlanExecutor());
@@ -194,10 +191,10 @@ describe('litesvmTransactionPlanExecutor', () => {
                 .use(client => extendClient(client, { payer }))
                 .use(litesvmTransactionPlanner())
                 .use(litesvmTransactionPlanExecutor());
-            client.svm.airdrop(payer.address, lamports(1_000_000_000n));
+            client.svm.airdrop(payer.address, lamports(1_000_000_000n)); // 1 SOL
 
             const instruction = getTransferSolInstruction({
-                amount: lamports(1_000n),
+                amount: lamports(100_000_000n), // 0.1 SOL
                 destination: destination.address,
                 source: payer,
             });