Add withNativeMints in node-litesvm (#252)

* expose create-native-mints in node-litesvm

* remove token-litesvem changes and dependency

* dependency updates after rebase

* try adding extra newline to resolve diff

* run cargo fmt

* bump MACOSX_DEPLOYMENT_TARGET

* bump MACOSX_DEPLOYMENT_TARGET to 14.0

* parameterize lto workflow matrix strategy

* try turning off lto for failing builds

* Revert node-build workflow

---------

Co-authored-by: Aursen <[email protected]>

Author: jshiohaha

crates/node-litesvm/litesvm/index.ts

@@ -182,6 +182,15 @@ export class LiteSVM {
 		return this;
 	}
 
+	/**
+	 * Adds the native mint accounts for SPL Token and Token-2022, if the programs are loaded.
+	 * @returns The modified LiteSVM instance
+	 */
+	withNativeMints(): LiteSVM {
+		this.inner.withNativeMints();
+		return this;
+	}
+
 	/**
 	 * Changes the capacity of the transaction history.
 	 * @param capacity - How many transactions to store in history.

crates/node-litesvm/litesvm/internal.d.ts

@@ -341,6 +341,7 @@ export declare class LiteSvm {
   setSlotHistory(history: SlotHistory): void
   getStakeHistory(): StakeHistory
   setStakeHistory(history: StakeHistory): void
+  withNativeMints(): void
 }
 
 /** Configuration of network rent. */

crates/node-litesvm/src/lib.rs

@@ -40,6 +40,7 @@ use {
 mod account;
 mod compute_budget;
 mod feature_set;
+mod native_mint;
 mod sysvar;
 mod transaction_error;
 mod transaction_metadata;
@@ -393,4 +394,25 @@ impl LiteSvm {
     pub fn set_stake_history(&mut self, history: &StakeHistory) {
         self.0.set_sysvar::<StakeHistoryOriginal>(&history.0)
     }
+
+    #[napi]
+    pub fn with_native_mints(&mut self) {
+        if self
+            .0
+            .accounts_db()
+            .inner
+            .contains_key(&native_mint::inline_spl::SPL_TOKEN_PROGRAM_ID)
+        {
+            native_mint::create_native_mint(&mut self.0);
+        }
+
+        if self
+            .0
+            .accounts_db()
+            .inner
+            .contains_key(&native_mint::inline_spl::SPL_TOKEN_2022_PROGRAM_ID)
+        {
+            native_mint::create_native_mint_2022(&mut self.0);
+        }
+    }
 }

crates/node-litesvm/src/native_mint.rs

@@ -0,0 +1,43 @@
+use {litesvm::LiteSVM, solana_account::Account, solana_address::Address, solana_rent::Rent};
+
+// Avoid importing external dependencies
+pub(crate) mod inline_spl {
+    use super::*;
+
+    pub const SPL_TOKEN_PROGRAM_ID: Address =
+        Address::from_str_const("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
+    pub const SPL_TOKEN_2022_PROGRAM_ID: Address =
+        Address::from_str_const("TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb");
+}
+
+fn create_native_mint_with_program_id(svm: &mut LiteSVM, address: Address, token_program: Address) {
+    let account = Account {
+        lamports: svm.get_sysvar::<Rent>().minimum_balance(82),
+        data: vec![
+            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+        ],
+        owner: token_program,
+        executable: false,
+        rent_epoch: 0,
+    };
+
+    svm.set_account(address, account).unwrap();
+}
+
+pub fn create_native_mint(svm: &mut LiteSVM) {
+    create_native_mint_with_program_id(
+        svm,
+        Address::from_str_const("So11111111111111111111111111111111111111112"),
+        inline_spl::SPL_TOKEN_PROGRAM_ID,
+    );
+}
+
+pub fn create_native_mint_2022(svm: &mut LiteSVM) {
+    create_native_mint_with_program_id(
+        svm,
+        Address::from_str_const("9pan9bMn5HatX4EJdBwg9VgCa7Uz5HL8N1m5D3NdXejP"),
+        inline_spl::SPL_TOKEN_2022_PROGRAM_ID,
+    );
+}

crates/node-litesvm/tests/token.test.ts

@@ -0,0 +1,30 @@
+import { NATIVE_MINT, NATIVE_MINT_2022 } from "@solana/spl-token";
+import { PublicKey } from "@solana/web3.js";
+import { LiteSVM } from "litesvm";
+import assert from "node:assert/strict";
+import { test } from "node:test";
+
+test("create native mints", () => {
+	let svm = LiteSVM.default();
+
+	assert.strictEqual(svm.getAccount(NATIVE_MINT), null, "SPL Token native mint should not exist");
+	assert.strictEqual(svm.getAccount(NATIVE_MINT_2022), null, "Token-2022 native mint should not exist");
+
+	svm = svm.withSysvars()
+		.withDefaultPrograms()
+		.withNativeMints();
+
+	const validateData = (data: Uint8Array, mint: PublicKey) => {
+		assert.ok(data.filter(x => x !== 0).length > 0, `${mint.toBase58()} data should not be empty`);
+	};
+
+	const nativeMint = svm.getAccount(NATIVE_MINT);
+	assert.ok(nativeMint, "SPL Token native mint should exist");
+	validateData(nativeMint.data, NATIVE_MINT);
+	assert.ok(nativeMint.lamports > 0, "SPL Token native mint should have lamports");
+
+	const nativeMint2022 = svm.getAccount(NATIVE_MINT_2022);
+	assert.ok(nativeMint2022, "Token-2022 native mint should exist");
+	validateData(nativeMint2022.data, NATIVE_MINT_2022);
+	assert.ok(nativeMint2022.lamports > 0, "Token-2022 native mint should have lamports");
+});