@neutral-trade/sdk 0.1.5 → 0.1.7

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

@@ -5141,15 +5141,8 @@ interface VaultRegistryEntry {
   /** Optional Bundle program ID (only for Bundle vaults with non-default V2 program) */
   bundleProgramId?: string;
 }
-/** Vault config (same as registry entry, program IDs are optional) */
-interface VaultConfig extends VaultRegistryEntry {
-  /** Required for Drift vaults */
-  driftProgramId: string;
-  /** Required for Bundle vaults */
-  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 {
@@ -5179,16 +5172,16 @@ type UserBalanceResult = Record<number, VaultBalanceData | null>;
  * Get Bundle Program ID for a vault config
  * Uses registry value if present, otherwise defaults to V1
  */
-declare function getBundleProgramId(vault: VaultRegistryEntry): BundleProgramId;
+declare function getBundleProgramId(vault: VaultRegistryEntry): BundleProgramId | undefined;
 /**
  * Get Drift Program ID for a vault config as PublicKey
  * Uses registry value if present, otherwise defaults to VAULT_PROGRAM_ID
  */
-declare function getDriftProgramId(vault: VaultRegistryEntry): string;
-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 {
@@ -5204,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();
@@ -5247,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, getDriftProgramId, 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

@@ -8987,6 +8987,7 @@ const VaultRegistryArraySchema = z.array(VaultRegistryEntrySchema).superRefine((
 * Uses registry value if present, otherwise defaults to V1
 */
 function getBundleProgramId(vault) {
+	if (vault.type !== VaultType.Bundle) return;
 	if (vault.bundleProgramId) {
 		if (Object.values(BundleProgramId).includes(vault.bundleProgramId)) return vault.bundleProgramId;
 	}
@@ -8997,6 +8998,7 @@ function getBundleProgramId(vault) {
 * Uses registry value if present, otherwise defaults to VAULT_PROGRAM_ID
 */
 function getDriftProgramId(vault) {
+	if (vault.type !== VaultType.Drift) return;
 	if (vault.driftProgramId) return vault.driftProgramId;
 	return VAULT_PROGRAM_ID.toBase58();
 }
@@ -9290,7 +9292,7 @@ async function getDriftBalances({ vaultIds, userAddress, vaults: vaults$1, drift
 	const vaultAddresses = vaultEntries.map(({ config }) => new PublicKey(config.vaultAddress));
 	const vaultDepositorPDAs = vaultEntries.map(({ config }) => {
 		const vaultPubkey = new PublicKey(config.vaultAddress);
-		return getVaultDepositorAddressSync(new PublicKey(config.driftProgramId), 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++) {

package/package.json

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