@drift-labs/sdk 2.145.0 → 2.146.0-alpha.13

package/src/driftClientConfig.ts

@@ -5,7 +5,7 @@ import {
 	PublicKey,
 	TransactionVersion,
 } from '@solana/web3.js';
-import { IWallet, TxParams } from './types';
+import { IWallet, TxParams, UserAccount } from './types';
 import { OracleInfo } from './oracles/types';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
 import { DriftEnv } from './config';
@@ -22,6 +22,9 @@ import { WebSocketAccountSubscriberV2 } from './accounts/webSocketAccountSubscri
 import { grpcDriftClientAccountSubscriberV2 } from './accounts/grpcDriftClientAccountSubscriberV2';
 import { grpcDriftClientAccountSubscriber } from './accounts/grpcDriftClientAccountSubscriber';
 import { grpcMultiUserAccountSubscriber } from './accounts/grpcMultiUserAccountSubscriber';
+import { WebSocketProgramAccountSubscriber } from './accounts/webSocketProgramAccountSubscriber';
+import { WebSocketDriftClientAccountSubscriber } from './accounts/webSocketDriftClientAccountSubscriber';
+import { WebSocketDriftClientAccountSubscriberV2 } from './accounts/webSocketDriftClientAccountSubscriberV2';
 
 export type DriftClientConfig = {
 	connection: Connection;
@@ -78,6 +81,7 @@ export type DriftClientSubscriptionConfig =
 			resubTimeoutMs?: number;
 			logResubMessages?: boolean;
 			commitment?: Commitment;
+			programUserAccountSubscriber?: WebSocketProgramAccountSubscriber<UserAccount>;
 			perpMarketAccountSubscriber?: new (
 				accountName: string,
 				program: Program,
@@ -86,14 +90,17 @@ export type DriftClientSubscriptionConfig =
 				resubOpts?: ResubOpts,
 				commitment?: Commitment
 			) => WebSocketAccountSubscriberV2<any> | WebSocketAccountSubscriber<any>;
-			oracleAccountSubscriber?: new (
-				accountName: string,
+			/** If you use V2 here, whatever you pass for perpMarketAccountSubscriber will be ignored and it will use v2 under the hood regardless */
+			driftClientAccountSubscriber?: new (
 				program: Program,
-				accountPublicKey: PublicKey,
-				decodeBuffer?: (buffer: Buffer) => any,
-				resubOpts?: ResubOpts,
-				commitment?: Commitment
-			) => WebSocketAccountSubscriberV2<any> | WebSocketAccountSubscriber<any>;
+				perpMarketIndexes: number[],
+				spotMarketIndexes: number[],
+				oracleInfos: OracleInfo[],
+				shouldFindAllMarketsAndOracles: boolean,
+				delistedMarketSetting: DelistedMarketSetting
+			) =>
+				| WebSocketDriftClientAccountSubscriber
+				| WebSocketDriftClientAccountSubscriberV2;
 	  }
 	| {
 			type: 'polling';

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.145.0",
+  "version": "2.145.1",
   "name": "drift",
   "instructions": [
     {
@@ -652,6 +652,163 @@
         }
       ]
     },
+    {
+      "name": "depositIntoIsolatedPerpPosition",
+      "accounts": [
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "userStats",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "spotMarketVault",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "userTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "tokenProgram",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "spotMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "perpMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "amount",
+          "type": "u64"
+        }
+      ]
+    },
+    {
+      "name": "transferIsolatedPerpPositionDeposit",
+      "accounts": [
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "userStats",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "spotMarketVault",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "spotMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "perpMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "amount",
+          "type": "i64"
+        }
+      ]
+    },
+    {
+      "name": "withdrawFromIsolatedPerpPosition",
+      "accounts": [
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "userStats",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "spotMarketVault",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "driftSigner",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "userTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "tokenProgram",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "spotMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "perpMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "amount",
+          "type": "u64"
+        }
+      ]
+    },
     {
       "name": "placePerpOrder",
       "accounts": [
@@ -4453,6 +4610,37 @@
       ],
       "args": []
     },
+    {
+      "name": "resizeAmmCache",
+      "accounts": [
+        {
+          "name": "admin",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "ammCache",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "rent",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "systemProgram",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": []
+    },
     {
       "name": "updateInitialAmmCacheInfo",
       "accounts": [
@@ -14599,13 +14787,13 @@
             "type": "u64"
           },
           {
-            "name": "lastBaseAssetAmountPerLp",
+            "name": "isolatedPositionScaledBalance",
             "docs": [
               "The last base asset amount per lp the amm had",
               "Used to settle the users lp position",
-              "precision: BASE_PRECISION"
+              "precision: SPOT_BALANCE_PRECISION"
             ],
-            "type": "i64"
+            "type": "u64"
           },
           {
             "name": "lastQuoteAssetAmountPerLp",
@@ -14644,8 +14832,8 @@
             "type": "u8"
           },
           {
-            "name": "perLpBase",
-            "type": "i8"
+            "name": "positionFlag",
+            "type": "u8"
           }
         ]
       }
@@ -15118,6 +15306,9 @@
           },
           {
             "name": "SafeMMOracle"
+          },
+          {
+            "name": "Margin"
           }
         ]
       }
@@ -15322,6 +15513,17 @@
         ]
       }
     },
+    {
+      "name": "LiquidationBitFlag",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "IsolatedPosition"
+          }
+        ]
+      }
+    },
     {
       "name": "SettlePnlExplanation",
       "type": {
@@ -15451,13 +15653,7 @@
         "kind": "enum",
         "variants": [
           {
-            "name": "Standard",
-            "fields": [
-              {
-                "name": "trackOpenOrdersFraction",
-                "type": "bool"
-              }
-            ]
+            "name": "Standard"
           },
           {
             "name": "Liquidation",
@@ -16096,6 +16292,23 @@
         ]
       }
     },
+    {
+      "name": "PositionFlag",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "IsolatedPosition"
+          },
+          {
+            "name": "BeingLiquidated"
+          },
+          {
+            "name": "Bankrupt"
+          }
+        ]
+      }
+    },
     {
       "name": "ReferrerStatus",
       "type": {
@@ -17060,6 +17273,11 @@
             "defined": "SpotBankruptcyRecord"
           },
           "index": false
+        },
+        {
+          "name": "bitFlags",
+          "type": "u8",
+          "index": false
         }
       ]
     },
@@ -18496,8 +18714,8 @@
     },
     {
       "code": 6094,
-      "name": "CantUpdatePoolBalanceType",
-      "msg": "CantUpdatePoolBalanceType"
+      "name": "CantUpdateSpotBalanceType",
+      "msg": "CantUpdateSpotBalanceType"
     },
     {
       "code": 6095,
@@ -19611,41 +19829,46 @@
     },
     {
       "code": 6317,
+      "name": "InvalidIsolatedPerpMarket",
+      "msg": "Invalid Isolated Perp Market"
+    },
+    {
+      "code": 6318,
       "name": "InvalidRevenueShareResize",
       "msg": "Invalid RevenueShare resize"
     },
     {
-      "code": 6318,
+      "code": 6319,
       "name": "BuilderRevoked",
       "msg": "Builder has been revoked"
     },
     {
-      "code": 6319,
+      "code": 6320,
       "name": "InvalidBuilderFee",
       "msg": "Builder fee is greater than max fee bps"
     },
     {
-      "code": 6320,
+      "code": 6321,
       "name": "RevenueShareEscrowAuthorityMismatch",
       "msg": "RevenueShareEscrow authority mismatch"
     },
     {
-      "code": 6321,
+      "code": 6322,
       "name": "RevenueShareEscrowOrdersAccountFull",
       "msg": "RevenueShareEscrow has too many active orders"
     },
     {
-      "code": 6322,
+      "code": 6323,
       "name": "InvalidRevenueShareAccount",
       "msg": "Invalid RevenueShareAccount"
     },
     {
-      "code": 6323,
+      "code": 6324,
       "name": "CannotRevokeBuilderWithOpenOrders",
       "msg": "Cannot revoke builder with open orders"
     },
     {
-      "code": 6324,
+      "code": 6325,
       "name": "UnableToLoadRevenueShareAccount",
       "msg": "Unable to load builder account"
     },
@@ -19745,4 +19968,4 @@
       "msg": "Invalid Lp Pool Id for Operation"
     }
   ]
-}
+}

package/src/index.ts

@@ -12,6 +12,10 @@ export * from './accounts/webSocketDriftClientAccountSubscriber';
 export * from './accounts/webSocketInsuranceFundStakeAccountSubscriber';
 export * from './accounts/webSocketHighLeverageModeConfigAccountSubscriber';
 export { WebSocketAccountSubscriberV2 } from './accounts/webSocketAccountSubscriberV2';
+export { WebSocketProgramAccountSubscriber } from './accounts/webSocketProgramAccountSubscriber';
+export { WebSocketProgramUserAccountSubscriber } from './accounts/websocketProgramUserAccountSubscriber';
+export { WebSocketProgramAccountsSubscriberV2 } from './accounts/webSocketProgramAccountsSubscriberV2';
+export { WebSocketDriftClientAccountSubscriberV2 } from './accounts/webSocketDriftClientAccountSubscriberV2';
 export * from './accounts/bulkAccountLoader';
 export * from './accounts/bulkUserSubscription';
 export * from './accounts/bulkUserStatsSubscription';

package/src/margin/README.md

@@ -0,0 +1,143 @@
+## Margin Calculation Snapshot (SDK)
+
+This document describes the single-source-of-truth margin engine in the SDK that mirrors the on-chain `MarginCalculation` and related semantics. The goal is to compute an immutable snapshot in one pass and have existing `User` getters delegate to it, eliminating duplicative work across getters and UI hooks while maintaining parity with the program.
+
+### Alignment with on-chain
+
+- The SDK snapshot shape mirrors `programs/drift/src/state/margin_calculation.rs` field-for-field.
+- The inputs and ordering mirror `calculate_margin_requirement_and_total_collateral_and_liability_info` in `programs/drift/src/math/margin.rs`.
+- Isolated positions are represented as `isolated_margin_calculations` keyed by perp `market_index`, matching program logic.
+
+### Core SDK types (shape parity)
+
+```ts
+// Types reflect on-chain names and numeric signs
+export type MarginRequirementType = 'Initial' | 'Fill' | 'Maintenance';
+export type MarketType = 'Spot' | 'Perp';
+
+export type MarketIdentifier = {
+  marketType: MarketType;
+  marketIndex: number; // u16
+};
+
+export type MarginCalculationMode =
+  | { kind: 'Standard' }
+  | { kind: 'Liquidation'; marketToTrackMarginRequirement?: MarketIdentifier };
+
+export type MarginContext = {
+  marginType: MarginRequirementType;
+  mode: MarginCalculationMode;
+  strict: boolean;
+  ignoreInvalidDepositOracles: boolean;
+  marginBuffer: BN;                  // u128
+  fuelBonusNumerator: number;       // i64
+  fuelBonus: number;                 // u64
+  fuelPerpDelta?: { marketIndex: number; delta: BN };      // (u16, i64)
+  fuelSpotDeltas: Array<{ marketIndex: number; delta: BN }>; // up to 2 entries
+  marginRatioOverride?: number;     // u32
+};
+
+export type IsolatedMarginCalculation = {
+  marginRequirement: BN;             // u128
+  totalCollateral: BN;               // i128
+  totalCollateralBuffer: BN;        // i128
+  marginRequirementPlusBuffer: BN; // u128
+};
+
+export type MarginCalculation = {
+  context: MarginContext;
+
+  totalCollateral: BN;               // i128
+  totalCollateralBuffer: BN;        // i128
+  marginRequirement: BN;             // u128
+  marginRequirementPlusBuffer: BN; // u128
+
+  isolatedMarginCalculations: Map<number, IsolatedMarginCalculation>; // BTreeMap<u16,_>
+
+  numSpotLiabilities: number;       // u8
+  numPerpLiabilities: number;       // u8
+  allDepositOraclesValid: boolean;
+  allLiabilityOraclesValid: boolean;
+  withPerpIsolatedLiability: boolean;
+  withSpotIsolatedLiability: boolean;
+
+  totalSpotAssetValue: BN;         // i128
+  totalSpotLiabilityValue: BN;     // u128
+  totalPerpLiabilityValue: BN;     // u128
+  totalPerpPnl: BN;                 // i128
+
+  trackedMarketMarginRequirement: BN; // u128
+  fuelDeposits: number;              // u32
+  fuelBorrows: number;               // u32
+  fuelPositions: number;             // u32
+};
+```
+
+### Engine API
+
+```ts
+// Pure computation, no I/O; uses data already cached in the client/subscribers
+export function computeMarginCalculation(user: User, context: MarginContext): MarginCalculation;
+
+// Helpers that mirror on-chain semantics
+export function meets_margin_requirement(calc: MarginCalculation): boolean;
+export function meets_margin_requirement_with_buffer(calc: MarginCalculation): boolean;
+export function get_cross_free_collateral(calc: MarginCalculation): BN;
+export function get_isolated_free_collateral(calc: MarginCalculation, marketIndex: number): BN;
+export function cross_margin_shortage(calc: MarginCalculation): BN; // requires buffer mode
+export function isolated_margin_shortage(calc: MarginCalculation, marketIndex: number): BN; // requires buffer mode
+```
+
+### Computation model (on-demand)
+
+- The SDK computes the snapshot on-demand when `getMarginCalculation(...)` is called.
+- No event-driven recomputation by default (oracle prices can change every slot; recomputing every update would be wasteful).
+- Callers (UI/bots) decide polling frequency (e.g., UI can refresh every ~1s on active trade forms).
+
+### User integration
+
+- Add `user.getMarginCalculation(margin_type = 'Initial', overrides?: Partial<MarginContext>)`.
+- Existing getters delegate to the snapshot to avoid duplicate work:
+  - `getTotalCollateral()` → `snapshot.total_collateral`
+  - `getMarginRequirement(mode)` → `snapshot.margin_requirement`
+  - `getFreeCollateral()` → `get_cross_free_collateral(snapshot)`
+  - Per-market isolated FC → `get_isolated_free_collateral(snapshot, marketIndex)`
+
+Suggested `User` API surface (non-breaking):
+
+```ts
+// Primary entrypoint
+getMarginCalculation(
+  marginType: 'Initial' | 'Maintenance' | 'Fill' = 'Initial',
+  contextOverrides?: Partial<MarginContext>
+): MarginCalculation;
+
+// Optional conveniences for consumers
+getIsolatedMarginCalculation(
+  marketIndex: number,
+  marginType: 'Initial' | 'Maintenance' | 'Fill' = 'Initial',
+  contextOverrides?: Partial<MarginContext>
+): IsolatedMarginCalculation | undefined;
+
+// Cross views can continue to use helpers on the snapshot:
+// get_cross_free_collateral(snapshot), meets_margin_requirement(snapshot), etc.
+```
+
+### UI compatibility
+
+- All existing `User` getters remain and delegate to the snapshot, so current UI keeps working without call-site changes.
+- New consumers can call `user.getMarginCalculation()` to access isolated breakdowns.
+
+### Testing and parity
+
+- Golden tests comparing SDK snapshot against program outputs (cross and isolated, edge cases).
+- Keep math/rounding identical to program (ordering, buffers, funding, open-order IM, oracle strictness).
+
+### Migration plan (brief)
+
+1. Implement `types` and `engine` with strict parity; land behind a feature flag.
+2. Add `user.getMarginCalculation()` and delegate legacy getters.
+3. Optionally update UI hooks to read richer fields; not required for compatibility.
+4. Expand parity tests; enable by default after validation.
+
+