@neutral-trade/sdk 0.2.12 → 0.3.1

package/README.md

@@ -147,7 +147,16 @@ This is simpler and doesn't require an additional network request at initializat
 
 ## Examples
 
-Check out the [examples](./examples) directory for more usage examples.
+See the [examples](./examples) directory. From the `sdk/` package root (clone this repo):
+
+```bash
+# Local validator default RPC: http://127.0.0.1:8899 — override with SOLANA_RPC_URL
+export SOLANA_KEYPAIR_PATH="$HOME/.config/solana/id.json"
+pnpm example:devnet:deposit
+pnpm example:devnet:withdraw
+```
+
+Uses the built-in devnet registry (`src/registry/vaults.devnet.json`, e.g. vault `100000001`). Your RPC must serve that vault on-chain; override vault id with `DEVNET_BUNDLE_VAULT_ID` if you use `NeutralTrade.create({ registry: [...] })` patterns in a forked script.
 
 ## License
 

package/dist/index.d.mts

@@ -3377,18 +3377,17 @@ declare class NeutralTrade {
     userAddress: string;
   }): Promise<UserBalanceResult>;
   /**
-   * Build deposit instructions (optional init + requestDeposit). Fetches vault state on-chain.
+   * Build deposit instructions (`initializeBundleDepositor` when needed, then `requestDeposit`).
+   * Fetches bundle and user bundle accounts on-chain.
    */
   buildDepositInstructions({
     vaultId,
     userAddress,
-    amount,
-    needsInit
+    amount
   }: {
     vaultId: number;
     userAddress: string;
     amount: number;
-    needsInit?: boolean;
   }): Promise<TransactionInstruction[]>;
   /**
    * Build request-withdraw instruction. Fetches vault, oracle, and depositor accounts on-chain.
@@ -3412,7 +3411,6 @@ interface BuildBundleDepositInstructionsParams {
   user: PublicKey;
   /** UI token amount (multiplied by 10**on-chain decimals inside). */
   amount: number;
-  needsInit?: boolean;
 }
 interface BuildBundleRequestWithdrawInstructionParams {
   bundleProgram: Program<Ntbundle>;
@@ -3422,15 +3420,14 @@ interface BuildBundleRequestWithdrawInstructionParams {
   amount: number;
 }
 /**
- * Optional `initializeBundleDepositor` + `requestDeposit`. Fetches bundle account internally.
+ * `initializeBundleDepositor` (when missing) + `requestDeposit`. Fetches bundle + user bundle internally.
  */
 declare function buildBundleDepositInstructions({
   bundleProgram,
   bundleCluster,
   vault,
   user,
-  amount,
-  needsInit
+  amount
 }: BuildBundleDepositInstructionsParams): Promise<TransactionInstruction[]>;
 /**
  * `requestWithdrawal` only. Fetches bundle, oracle, and user bundle internally.

package/dist/index.mjs

@@ -12847,25 +12847,26 @@ function getDriftProgramId(vault) {
 /**
 * Transform a registry entry to VaultConfig with program IDs
 * - Drift vaults get driftProgramId
-* - Bundle vaults get bundleProgramId
+* - Bundle vaults get bundleProgramId (registry value or cluster default via {@link getBundleProgramId})
 */
-function toVaultConfig(entry) {
+function toVaultConfig(entry, cluster = "mainnet") {
 	return {
 		...entry,
 		driftProgramId: getDriftProgramId(entry),
-		bundleProgramId: entry.bundleProgramId
+		bundleProgramId: getBundleProgramId(entry, cluster)
 	};
 }
 /**
 * Transform an array of registry entries to VaultRegistry
+* @param cluster - Used to resolve default bundle program id when `bundleProgramId` is omitted in JSON
 */
-function toVaultRegistry(entries) {
-	return Object.fromEntries(entries.map((entry) => [entry.vaultId, toVaultConfig(entry)]));
+function toVaultRegistry(entries, cluster = "mainnet") {
+	return Object.fromEntries(entries.map((entry) => [entry.vaultId, toVaultConfig(entry, cluster)]));
 }
 const parsedVaultsMainnet = VaultRegistryArraySchema.parse(vaults_default);
 const parsedVaultsDevnet = VaultRegistryArraySchema.parse(vaults_devnet_default);
-const vaultsMainnetRegistry = toVaultRegistry(parsedVaultsMainnet);
-const vaultsDevnetRegistry = toVaultRegistry(parsedVaultsDevnet);
+const vaultsMainnetRegistry = toVaultRegistry(parsedVaultsMainnet, "mainnet");
+const vaultsDevnetRegistry = toVaultRegistry(parsedVaultsDevnet, "devnet");
 /** Mainnet registry (default; backward compatible). */
 const vaults = vaultsMainnetRegistry;
 /** Devnet-only vault registry (fixtures / local testing). */
@@ -13102,18 +13103,21 @@ function bundleProgramIdForVault(vault, bundleCluster = "mainnet") {
 	return id;
 }
 /**
-* Optional `initializeBundleDepositor` + `requestDeposit`. Fetches bundle account internally.
+* `initializeBundleDepositor` (when missing) + `requestDeposit`. Fetches bundle + user bundle internally.
 */
-async function buildBundleDepositInstructions({ bundleProgram, bundleCluster = "mainnet", vault, user, amount, needsInit = false }) {
+async function buildBundleDepositInstructions({ bundleProgram, bundleCluster = "mainnet", vault, user, amount }) {
 	assertBundleVault(vault);
 	const bundlePDA = new PublicKey(vault.vaultAddress);
 	const programId = bundleProgramIdForVault(vault, bundleCluster);
 	if (programId !== bundleProgram.programId.toBase58()) throw new Error(`Vault ${vault.vaultId} program id mismatch: vault=${programId}, client=${bundleProgram.programId.toBase58()}`);
-	const bundleInfo = await bundleProgram.account.bundle.fetch(bundlePDA);
-	const depositAmountBN = new BN(Math.floor(amount * 10 ** bundleInfo.assetDecimals));
 	const programPk = bundleProgram.programId;
-	const oraclePDA = deriveOraclePDA(bundlePDA, programPk);
 	const userPDA = deriveUserPDA(user, bundlePDA, programPk);
+	const [bundleAcc, userBundleAcc] = await bundleProgram.provider.connection.getMultipleAccountsInfo([bundlePDA, userPDA]);
+	if (!bundleAcc?.data?.length) throw new Error(`Bundle account not found for vault ${vault.vaultId}`);
+	const bundleInfo = bundleProgram.coder.accounts.decode("bundle", bundleAcc.data);
+	const needsInit = (userBundleAcc?.data?.length ? bundleProgram.coder.accounts.decode("userBundleAccount", userBundleAcc.data) : null) === null;
+	const depositAmountBN = new BN(Math.floor(amount * 10 ** bundleInfo.assetDecimals));
+	const oraclePDA = deriveOraclePDA(bundlePDA, programPk);
 	const tempDataPDA = deriveTempDataPDA(bundlePDA, programPk);
 	const pendingAuthPDA = derivePendingAuthPDA(bundlePDA, programPk);
 	const userTokenAcct = getAssociatedTokenAddressSync(bundleInfo.assetAddress, user, true);
@@ -13282,14 +13286,14 @@ var NeutralTrade = class NeutralTrade {
 		const cluster = config.bundleCluster ?? "mainnet";
 		let vaults$1 = config.includeBuiltInVaults !== false ? { ...getVaultRegistry(cluster) } : {};
 		if (config.registry) {
-			const localVaults = NeutralTrade.parseVaultRegistryEntries(config.registry, "registry");
+			const localVaults = NeutralTrade.parseVaultRegistryEntries(config.registry, "registry", cluster);
 			vaults$1 = {
 				...vaults$1,
 				...localVaults
 			};
 		}
 		if (config.registryUrl) {
-			const remoteVaults = await NeutralTrade.fetchVaultsFromRegistry(config.registryUrl);
+			const remoteVaults = await NeutralTrade.fetchVaultsFromRegistry(config.registryUrl, cluster);
 			vaults$1 = {
 				...vaults$1,
 				...remoteVaults
@@ -13321,21 +13325,21 @@ var NeutralTrade = class NeutralTrade {
 		if (!bundleProgram) throw new Error(`Bundle program client not initialized for vault ${vault.vaultId}: ${programId}. Please add it to bundlePrograms config or registry.`);
 		return bundleProgram;
 	}
-	static parseVaultRegistryEntries(entries, sourceLabel) {
+	static parseVaultRegistryEntries(entries, sourceLabel, cluster) {
 		const parseResult = VaultRegistryArraySchema.safeParse(entries);
 		if (!parseResult.success) throw new Error(`Invalid ${sourceLabel} data: ${parseResult.error.message}`);
-		return toVaultRegistry(parseResult.data);
+		return toVaultRegistry(parseResult.data, cluster);
 	}
 	/**
 	* Fetch vault configurations from a remote registry URL
 	* Expects JSON array format and transforms to Record<number, VaultConfig>
 	* @throws Error if fetch fails or validation fails
 	*/
-	static async fetchVaultsFromRegistry(registryUrl) {
+	static async fetchVaultsFromRegistry(registryUrl, cluster) {
 		const response = await fetch(registryUrl);
 		if (!response.ok) throw new Error(`Failed to fetch vaults from registry: ${response.status} ${response.statusText}`);
 		const data = await response.json();
-		return NeutralTrade.parseVaultRegistryEntries(data, "vault registry");
+		return NeutralTrade.parseVaultRegistryEntries(data, "vault registry", cluster);
 	}
 	/**
 	* Get user balance for Bundle vaults only.
@@ -13357,9 +13361,10 @@ var NeutralTrade = class NeutralTrade {
 		});
 	}
 	/**
-	* Build deposit instructions (optional init + requestDeposit). Fetches vault state on-chain.
+	* Build deposit instructions (`initializeBundleDepositor` when needed, then `requestDeposit`).
+	* Fetches bundle and user bundle accounts on-chain.
 	*/
-	async buildDepositInstructions({ vaultId, userAddress, amount, needsInit = false }) {
+	async buildDepositInstructions({ vaultId, userAddress, amount }) {
 		const vault = this.vaults[vaultId];
 		if (!vault) throw new Error(`Vault config not found for vaultId ${vaultId}`);
 		return buildBundleDepositInstructions({
@@ -13367,8 +13372,7 @@ var NeutralTrade = class NeutralTrade {
 			bundleCluster: this.bundleCluster,
 			vault,
 			user: new PublicKey(userAddress),
-			amount,
-			needsInit
+			amount
 		});
 	}
 	/**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@neutral-trade/sdk",
   "type": "module",
-  "version": "0.2.12",
+  "version": "0.3.1",
   "description": "SDK for Neutral Trade vaults",
   "license": "MIT",
   "homepage": "https://github.com/neutral-trade/sdk#readme",
@@ -69,6 +69,10 @@
     "lint": "eslint",
     "release": "bumpp",
     "start": "tsx src/index.ts",
+    "example:devnet:deposit": "tsx examples/devnet-deposit.ts",
+    "example:devnet:withdraw": "tsx examples/devnet-withdraw.ts",
+    "diagnose:balances": "tsx diagnose/vault-balance-fetch.ts",
+    "diagnose:deposit-conservation": "tsx diagnose/deposit-conservation.ts",
     "test": "vitest",
     "typecheck": "tsc",
     "docs:build": "typedoc",