@neutral-trade/sdk - v0.3.11

@neutral-trade/sdk

TypeScript SDK for Neutral Trade Bundle vaults (on-chain reads, balances, registry).

Drift vault balances (legacy)

This package does not depend on @drift-labs/*. The public registry may still list historical Drift vault metadata, but NeutralTrade.getUserBalanceByVaultIds only returns Bundle vaults. Drift depositor balances are outside this package’s scope.

Installation

# npm
npm install @neutral-trade/sdk

# yarn
yarn add @neutral-trade/sdk

# pnpm
pnpm add @neutral-trade/sdk

# bun
bun add @neutral-trade/sdk

Runtime dependencies are declared normally (Anchor, Solana web3, etc.); consumers should not need extra setup for Bundle flows.

Quick Start

import { NeutralTrade, VaultId } from '@neutral-trade/sdk'

// Initialize the SDK
const sdk = await NeutralTrade.create({
  rpcUrl: 'YOUR_RPC_URL_HERE'
})

// Get user balance for Bundle vaults only
const balances = await sdk.getUserBalanceByVaultIds({
  vaultIds: [VaultId.hyperliquid_funding_arb_48, VaultId.alp_delta_neutral_49],
  userAddress: 'YOUR_WALLET_ADDRESS'
})

console.log(balances)

Vault registry

Built-in configs include multiple vault types in metadata (VaultType may still include Drift for historical entries). Balance queries in this package apply only to VaultType.Bundle rows.

import { VaultId } from '@neutral-trade/sdk'

// Examples — Bundle vaults (balances supported here)
VaultId.hyperliquid_funding_arb_48 // Hyperliquid Funding Arb
VaultId.alp_delta_neutral_49 // ALP Delta Neutral

See the documentation for the complete list of vault IDs.

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.

Merge order is:

built-in configs
registry (local array you provide)
registryUrl (remote, highest priority)

Use bundleCluster to select fixed default Bundle program ID by cluster (mainnet or devnet). If a vault entry includes bundleProgramId, that vault-specific program ID is used instead.

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 a local registry array (good for custom/new vaults):

const sdk = await NeutralTrade.create({
  rpcUrl: 'YOUR_RPC_URL_HERE',
  registry: [
    {
      vaultId: 9999,
      name: 'My Custom Vault',
      type: 'Bundle',
      category: 'Market Neutral',
      vaultAddress: 'YOUR_VAULT_ADDRESS',
      depositToken: 'USDC'
    }
  ]
})

Use the registry URL if you don't upgrade the SDK frequently:

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 both local + registry URL (URL overrides local when same vaultId exists):

const sdk = await NeutralTrade.create({
  rpcUrl: 'YOUR_RPC_URL_HERE',
  registry: [
    // Local overrides built-in
  ],
  registryUrl: 'https://cdn.jsdelivr.net/gh/neutral-trade/sdk@main/src/registry/vaults.json'
  // Remote overrides local
})

Use built-in configs if you upgrade the SDK regularly:

const sdk = await NeutralTrade.create({
  rpcUrl: 'YOUR_RPC_URL_HERE'
  // No registryUrl - uses built-in configurations
})

Select devnet default Bundle program ID:

const sdk = await NeutralTrade.create({
  rpcUrl: 'YOUR_RPC_URL_HERE',
  bundleCluster: 'devnet'
})

This is simpler and doesn't require an additional network request at initialization.

Examples

See the examples directory. From the sdk/ package root (clone this repo):

# 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

MIT