@neutral-trade/sdk 0.1.4 → 0.1.6

package/README.md

@@ -38,7 +38,7 @@ const sdk = await NeutralTrade.create({
 
 // Get user balance for specific vaults
 const balances = await sdk.getUserBalanceByVaultIds({
-  vaultIds: [VaultId.solnl, VaultId.btcnl],
+  vaultIds: [VaultId.sol_super_staking_1, VaultId.btc_super_staking_3],
   userAddress: 'YOUR_WALLET_ADDRESS'
 })
 
@@ -53,17 +53,50 @@ The SDK supports both **Drift** and **Bundle** vault types. Use the `VaultId` en
 import { VaultId } from '@neutral-trade/sdk'
 
 // Drift Vaults
-VaultId.solnl // SOL Neutral Long
-VaultId.btcnl // BTC Neutral Long
-VaultId.jlpdnv1 // JLP DN V1
+VaultId.sol_super_staking_1 // SOL Super Staking
+VaultId.btc_super_staking_3 // BTC Super Staking
+VaultId.jlp_delta_neutral_vault_1_0 // JLP Delta Neutral (vault-1)
 
 // Bundle Vaults
-VaultId.hlfundingarb // HL Funding Arbitrage
-VaultId.alpdn // ALP DN
+VaultId.hyperliquid_funding_arb_48 // Hyperliquid Funding Arb
+VaultId.alp_delta_neutral_49 // ALP Delta Neutral
 ```
 
 See the [documentation](https://sdk.neutral.trade) for the complete list of available vaults.
 
+## Configuration Registry
+
+The SDK includes built-in vault configurations, but you can also fetch the latest configurations from a remote registry. This is useful if you don't upgrade the SDK package frequently.
+
+### Registry URLs
+
+- **GitHub Raw**: `https://raw.githubusercontent.com/neutral-trade/sdk/main/src/registry/vaults.json`
+- **jsDelivr CDN**: `https://cdn.jsdelivr.net/gh/neutral-trade/sdk@main/src/registry/vaults.json`
+
+### Usage
+
+**Use the registry URL if you don't upgrade the SDK frequently:**
+
+```typescript
+const sdk = await NeutralTrade.create({
+  rpcUrl: 'YOUR_RPC_URL_HERE',
+  registryUrl: 'https://cdn.jsdelivr.net/gh/neutral-trade/sdk@main/src/registry/vaults.json'
+})
+```
+
+This ensures you always have the latest vault configurations without needing to update the SDK package.
+
+**Use built-in configs if you upgrade the SDK regularly:**
+
+```typescript
+const sdk = await NeutralTrade.create({
+  rpcUrl: 'YOUR_RPC_URL_HERE'
+  // No registryUrl - uses built-in configurations
+})
+```
+
+This is simpler and doesn't require an additional network request at initialization.
+
 ## Examples
 
 Check out the [examples](./examples) directory for more usage examples.

package/dist/index.d.mts

@@ -5127,7 +5127,7 @@ declare enum VaultType {
   Hyperliquid = "Hyperliquid",
   Kamino = "Kamino",
 }
-/** Raw vault entry from registry JSON (without program IDs) */
+/** Raw vault entry from registry JSON */
 interface VaultRegistryEntry {
   vaultId: number;
   name: string;
@@ -5136,16 +5136,13 @@ interface VaultRegistryEntry {
   vaultAddress: string;
   depositToken: SupportedToken;
   pfee?: number;
-}
-/** Vault config with required program IDs (transformed from registry entry) */
-interface VaultConfig extends VaultRegistryEntry {
-  /** Required for Drift vaults */
+  /** Optional Drift program ID (only for Drift vaults with non-default program) */
   driftProgramId?: string;
-  /** Required for Bundle vaults */
+  /** Optional Bundle program ID (only for Bundle vaults with non-default V2 program) */
   bundleProgramId?: string;
 }
 /** Vault registry as a record keyed by vaultId */
-type VaultConfigRecord = Record<number, VaultConfig>;
+type VaultRegistry = Record<number, VaultRegistryEntry>;
 //#endregion
 //#region src/types/index.d.ts
 interface VaultBalanceData {
@@ -5172,19 +5169,19 @@ type UserBalanceResult = Record<number, VaultBalanceData | null>;
 //#endregion
 //#region src/constants/vaults.d.ts
 /**
- * Get Bundle Program ID for a vault
- * All bundle vaults use V1 except vaultId 69 and 72 which use V2
+ * Get Bundle Program ID for a vault config
+ * Uses registry value if present, otherwise defaults to V1
  */
-declare function getBundleProgramId(vaultId: number): BundleProgramId;
+declare function getBundleProgramId(vault: VaultRegistryEntry): BundleProgramId | undefined;
 /**
- * Get Drift Program ID for a vault
- * All drift vaults use default program ID except vaultId 0
+ * Get Drift Program ID for a vault config as PublicKey
+ * Uses registry value if present, otherwise defaults to VAULT_PROGRAM_ID
  */
-declare function getDriftProgramPK(vaultId: number): PublicKey;
-declare const vaults: VaultConfigRecord;
+declare function getDriftProgramId(vault: VaultRegistryEntry): string | undefined;
+declare const vaults: VaultRegistry;
 declare function isValidVaultAddress(address: string): boolean;
-declare function getVaultByAddress(address: string): VaultConfig | undefined;
-declare function getVaultById(vaultId: number): VaultConfig | undefined;
+declare function getVaultByAddress(address: string): VaultRegistryEntry | undefined;
+declare function getVaultById(vaultId: number): VaultRegistryEntry | undefined;
 //#endregion
 //#region src/NeutralTrade.d.ts
 interface NeutralTradeConfig {
@@ -5200,7 +5197,7 @@ declare class NeutralTrade {
   readonly bundleProgramV2: Program$1<NtbundleV2>;
   readonly driftVaultClient: VaultClient;
   /** Vault configurations (built-in merged with remote if registryUrl was provided) */
-  readonly vaults: VaultConfigRecord;
+  readonly vaults: VaultRegistry;
   /** Price map for deposit tokens */
   readonly priceMap: Map<SupportedToken, number>;
   private constructor();
@@ -5243,4 +5240,4 @@ declare function deriveUserPDA(userKey: PublicKey, bundlePDA: PublicKey, program
  */
 declare function getVaultDepositorAddressSync(programId: PublicKey, vault: PublicKey, authority: PublicKey): PublicKey;
 //#endregion
-export { type BundleAccount, BundleProgramId, NeutralTrade, type NeutralTradeConfig, type OracleData, SupportedChain, SupportedToken, type Token, type UserBalanceResult, type UserBundleAccount, type VaultBalanceData, type VaultConfig, type VaultConfigRecord, VaultId, VaultType, deriveOraclePDA, deriveUserPDA, getBundleProgramId, getDriftProgramPK, getVaultByAddress, getVaultById, getVaultDepositorAddressSync, isValidVaultAddress, tokens, vaults };
+export { type BundleAccount, BundleProgramId, NeutralTrade, type NeutralTradeConfig, type OracleData, SupportedChain, SupportedToken, type Token, type UserBalanceResult, type UserBundleAccount, type VaultBalanceData, type VaultRegistryEntry as VaultConfig, type VaultRegistry as VaultConfigRecord, VaultId, VaultType, deriveOraclePDA, deriveUserPDA, getBundleProgramId, getDriftProgramId, getVaultByAddress, getVaultById, getVaultDepositorAddressSync, isValidVaultAddress, tokens, vaults };

package/dist/index.mjs

@@ -8246,7 +8246,8 @@ var vaults_default = [
 		"subname": "Atlas Research",
 		"type": "Bundle",
 		"vaultAddress": "Eo3m78EQcHnwMyHtxaiz1vw4nwHa85RuGE8jLsrELhxj",
-		"depositToken": "USDC"
+		"depositToken": "USDC",
+		"bundleProgramId": "BUNDeH5A4c47bcEoAjBhN3sCjLgYnRsmt9ibMztqVkC9"
 	},
 	{
 		"vaultId": 71,
@@ -8268,7 +8269,8 @@ var vaults_default = [
 		"subname": "vault-jupiter",
 		"type": "Bundle",
 		"vaultAddress": "GiNbTRuRqvVGEEQGZKMjmwX84LrsbqfzVVNtWYbcZPCY",
-		"depositToken": "USDC"
+		"depositToken": "USDC",
+		"bundleProgramId": "BUNDeH5A4c47bcEoAjBhN3sCjLgYnRsmt9ibMztqVkC9"
 	},
 	{
 		"vaultId": 68,
@@ -8855,7 +8857,8 @@ var vaults_default = [
 		"type": "Drift",
 		"vaultAddress": "3Nkctq19AW7gs5hkxixUDjS9UVjmCwcNCo7rqPpub87c",
 		"depositToken": "USDC",
-		"pfee": .25
+		"pfee": .25,
+		"driftProgramId": "9Fcn3Fd4d5ocrb12xCUtEvezxcjFEAyHBPfrZDiPt9Qj"
 	}
 ];
 
@@ -8961,7 +8964,9 @@ const VaultRegistryEntrySchema = z.object({
 	type: z.nativeEnum(VaultType),
 	vaultAddress: z.string().min(32).max(44),
 	depositToken: z.nativeEnum(SupportedToken),
-	pfee: z.number().min(0).max(1).optional()
+	pfee: z.number().min(0).max(1).optional(),
+	driftProgramId: z.string().min(32).max(44).optional(),
+	bundleProgramId: z.string().min(32).max(44).optional()
 });
 /** Schema for validating array of registry entries */
 const VaultRegistryArraySchema = z.array(VaultRegistryEntrySchema).superRefine((vaults$1, ctx) => {
@@ -8977,25 +8982,25 @@ const VaultRegistryArraySchema = z.array(VaultRegistryEntrySchema).superRefine((
 
 //#endregion
 //#region src/constants/vaults.ts
-/** Special Drift Program ID for jlpdnv1 (vaultId: 0) */
-const JLPDNV1_DRIFT_PROGRAM_ID = "9Fcn3Fd4d5ocrb12xCUtEvezxcjFEAyHBPfrZDiPt9Qj";
-/** V2 Bundle vault IDs */
-const V2_BUNDLE_VAULT_IDS = [69, 72];
 /**
-* Get Bundle Program ID for a vault
-* All bundle vaults use V1 except vaultId 69 and 72 which use V2
+* Get Bundle Program ID for a vault config
+* Uses registry value if present, otherwise defaults to V1
 */
-function getBundleProgramId(vaultId) {
-	if (V2_BUNDLE_VAULT_IDS.includes(vaultId)) return BundleProgramId.V2;
+function getBundleProgramId(vault) {
+	if (vault.type !== VaultType.Bundle) return;
+	if (vault.bundleProgramId) {
+		if (Object.values(BundleProgramId).includes(vault.bundleProgramId)) return vault.bundleProgramId;
+	}
 	return BundleProgramId.V1;
 }
 /**
-* Get Drift Program ID for a vault
-* All drift vaults use default program ID except vaultId 0
+* Get Drift Program ID for a vault config as PublicKey
+* Uses registry value if present, otherwise defaults to VAULT_PROGRAM_ID
 */
-function getDriftProgramPK(vaultId) {
-	if (vaultId === 0) return new PublicKey(JLPDNV1_DRIFT_PROGRAM_ID);
-	return VAULT_PROGRAM_ID;
+function getDriftProgramId(vault) {
+	if (vault.type !== VaultType.Drift) return;
+	if (vault.driftProgramId) return vault.driftProgramId;
+	return VAULT_PROGRAM_ID.toBase58();
 }
 /**
 * Transform a registry entry to VaultConfig with program IDs
@@ -9005,8 +9010,8 @@ function getDriftProgramPK(vaultId) {
 function toVaultConfig(entry) {
 	return {
 		...entry,
-		driftProgramId: entry.type === VaultType.Drift ? getDriftProgramPK(entry.vaultId).toBase58() : void 0,
-		bundleProgramId: entry.type === VaultType.Bundle ? getBundleProgramId(entry.vaultId) : void 0
+		driftProgramId: getDriftProgramId(entry),
+		bundleProgramId: getBundleProgramId(entry)
 	};
 }
 /**
@@ -9147,7 +9152,7 @@ async function getBundleBalances({ vaultIds, userAddress, vaults: vaults$1, bund
 	for (const vaultId of vaultIds) {
 		const config = vaults$1[vaultId];
 		if (!config) continue;
-		if (getBundleProgramId(vaultId) === BundleProgramId.V2) v2Vaults.push({
+		if (config.bundleProgramId === BundleProgramId.V2) v2Vaults.push({
 			vaultId,
 			config
 		});
@@ -9285,9 +9290,9 @@ async function getDriftBalances({ vaultIds, userAddress, vaults: vaults$1, drift
 	})).filter((entry) => entry.config !== void 0);
 	if (vaultEntries.length === 0) return result;
 	const vaultAddresses = vaultEntries.map(({ config }) => new PublicKey(config.vaultAddress));
-	const vaultDepositorPDAs = vaultEntries.map(({ vaultId, config }) => {
+	const vaultDepositorPDAs = vaultEntries.map(({ config }) => {
 		const vaultPubkey = new PublicKey(config.vaultAddress);
-		return getVaultDepositorAddressSync(getDriftProgramPK(vaultId), vaultPubkey, userPublicKey);
+		return getVaultDepositorAddressSync(config.driftProgramId ? new PublicKey(config.driftProgramId) : VAULT_PROGRAM_ID, vaultPubkey, userPublicKey);
 	});
 	const [vaultsData, vaultDepositors] = await Promise.all([driftVaultClient.program.account.vault.fetchMultiple(vaultAddresses), driftVaultClient.program.account.vaultDepositor.fetchMultiple(vaultDepositorPDAs)]);
 	for (let i = 0; i < vaultEntries.length; i++) {
@@ -9488,4 +9493,4 @@ var NeutralTrade = class NeutralTrade {
 };
 
 //#endregion
-export { BundleProgramId, NeutralTrade, SupportedChain, SupportedToken, VaultId, VaultType, deriveOraclePDA, deriveUserPDA, getBundleProgramId, getDriftProgramPK, getVaultByAddress, getVaultById, getVaultDepositorAddressSync, isValidVaultAddress, tokens, vaults };
+export { BundleProgramId, NeutralTrade, SupportedChain, SupportedToken, VaultId, VaultType, deriveOraclePDA, deriveUserPDA, getBundleProgramId, getDriftProgramId, getVaultByAddress, getVaultById, getVaultDepositorAddressSync, isValidVaultAddress, tokens, vaults };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@neutral-trade/sdk",
   "type": "module",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "SDK for Neutral Trade vaults",
   "license": "MIT",
   "homepage": "https://github.com/neutral-trade/sdk#readme",