SDK Reference

npm install @symmetry-hq/sdk @solana/web3.js @coral-xyz/anchor

import {
  SymmetryCore,
  KeeperMonitor,
  RebalanceHandler,

  // Transaction types
  VaultCreationTx,
  TxPayloadBatchSequence,
  VersionedTxs,

  // Core data types
  GlobalConfig,
  Vault,
  VaultFilter,
  Intent,
  IntentFilter,
  RebalanceIntent,
  RebalanceIntentFilter,

  // Formatted types
  FormattedGlobalConfig,
  FormattedVault,
  FormattedAsset,
  FormattedIntent,
  FormattedRebalanceIntent,
  UIRebalanceIntent,

  // Settings input types
  EditCreatorSettings,
  EditManagerSettings,
  EditFeeSettings,
  EditScheduleSettings,
  EditAutomationSettings,
  EditLpSettings,
  EditMetadataSettings,
  EditDepositsSettings,
  EditForceRebalanceSettings,
  EditCustomRebalanceSettings,
  EditAddTokenSettings,
  EditUpdateWeightsSettings,
  EditMakeDirectSwapSettings,
  AddOrEditTokenInput,
  OracleInput,
  UpdateWeightsInput,
  MakeDirectSwapInput,
  Settings,
  TaskContext,
  TaskType,

  // Rebalance data types
  DepositData,
  PriceUpdatesData,
  AuctionData,
  MintData,
  RedeemData,
  ClaimBountyData,

  // Utilities
  getJupTokenLedgerAndSwapInstructions,
  getSwapPairs,
  isRebalanceRequired,
} from "@symmetry-hq/sdk";

const sdk = new SymmetryCore({
  connection: Connection,
  network: "devnet" | "mainnet",
  priorityFee?: number, // micro-lamports, default: 25,000
});

type VaultFilter = {
  type: "creator" | "host" | "manager";
  pubkey: string;
};

params: {
  creator: string,
  start_price: string,        // human USD terms, e.g. "1.0" = $1.00; encoded to program fraction format by the SDK
  name: string,               // max 32 chars
  symbol: string,             // max 10 chars
  metadata_uri: string,       // URL to JSON with name, symbol, description, image, cover
  host_platform_params?: {
    host_pubkey: string,
    host_deposit_fee_bps: number,
    host_withdraw_fee_bps: number,
    host_management_fee_bps: number,    // currently disabled in global config
    host_performance_fee_bps: number,   // currently disabled in global config
  },
}

// Returns:
interface VaultCreationTx extends TxPayloadBatchSequence {
  mint: string;
  vault: string;
}

interface TaskContext {
  vault: string;
  manager: string;
  activation_timestamp?: number;
  expiration_timestamp?: number;
  min_bounty?: number;            // raw amount in bounty token's smallest units
  max_bounty?: number;            // raw amount in bounty token's smallest units
}

type IntentFilter = {
  type: "manager" | "vault";
  pubkey: string;
};

params: { keeper: string, intent: string }

params: {
  keeper: string,
  intent: string,
  jup_token_ledger_ix?: TransactionInstruction,
  jup_swap_ix: TransactionInstruction,
  jup_address_lookup_table_addresses?: PublicKey[],
}

params: { keeper: string, intent: string }

type RebalanceIntentFilter = {
  type: "owner" | "vault";
  pubkey: string;
};

params: {
  buyer: string,
  vault_mint: string,
  contributions: { mint: string, amount: number }[],  // amount in raw smallest units (e.g. lamports)
  rebalance_slippage_bps?: number,       // default: 100
  per_trade_rebalance_slippage_bps?: number,
  execution_start_time?: number,
  min_bounty_amount?: number,            // raw amount in bounty token's smallest units
  max_bounty_amount?: number,            // raw amount in bounty token's smallest units
}

params: {
  buyer: string,
  contributions: { mint: string, amount: number }[],  // amount in raw smallest units (e.g. lamports)
  rebalance_intent?: string,
  rebalance_intent_chain_data?: RebalanceIntent,
}

params: { buyer: string, vault_mint: string }

params: {
  seller: string,
  vault_mint: string,
  withdraw_amount: number,        // raw vault token amount to burn (smallest units)
  keep_tokens: string[],
  rebalance_slippage_bps?: number,
  per_trade_rebalance_slippage_bps?: number,
  execution_start_time?: number,
  min_bounty_amount?: number,     // raw amount in bounty token's smallest units
  max_bounty_amount?: number,     // raw amount in bounty token's smallest units
}

params: {
  keeper: string,
  vault_mint: string,
  rebalance_slippage_bps?: number,
  per_trade_rebalance_slippage_bps?: number,
  execution_start_time?: number,
  min_bounty_amount?: number,
  max_bounty_amount?: number,
}

params: { keeper: string, rebalance_intent: string }

params: { keeper: string, vault: string, rebalance_intent: string }

params: { keeper: string, accounts: string[] }

params: {
  keeper: string,
  vault: string,
  rebalance_intent?: string,
  intent?: string,
  mint_in: string,
  mint_out: string,
  amount_in: number,
  amount_out: number,
  mode?: number,               // 0=exact_in, 1=exact_out, 2=IOC
  jup_token_ledger_ix?: TransactionInstruction,
  jup_swap_ix?: TransactionInstruction,
  jup_address_lookup_table_addresses?: PublicKey[],
}

params: { keeper: string, rebalance_intent: string }

params: { keeper: string, rebalance_intent: string }

params: { keeper: string, vault: string, amount: number }  // amount in raw smallest units (e.g. lamports)

params: { keeper: string, rebalance_intent: string }

params: { claimer: string, vault: string }

params: { claimer: string, withdrawVaultFees: string }

type WithdrawVaultFeesFilter = {
  type: "vault" | "manager" | "creator" | "host" | "symmetry";
  pubkey: string;
};

params: { signer: string, vault_mint: string, additional_accounts: string[] }

params: {
  txPayloadBatchSequence: TxPayloadBatchSequence,
  wallet: Wallet,
  simulateTransactions?: boolean,  // enables preflight-style send path; does NOT perform offline-only simulation
}

params: { versionedTxs: VersionedTxs, wallet: Wallet }

interface Wallet {
  signTransaction<T extends Transaction | VersionedTransaction>(tx: T): Promise<T>;
  signAllTransactions<T extends Transaction | VersionedTransaction>(txs: T[]): Promise<T[]>;
  publicKey: PublicKey;
  payer?: Keypair;
}