@drift-labs/sdk 2.28.0 → 2.29.0

package/dlob_read.ts

@@ -0,0 +1,155 @@
+import { Connection, Keypair, PublicKey } from '@solana/web3.js';
+import {
+    BASE_PRECISION,
+    BulkAccountLoader,
+    configs,
+    convertToNumber,
+    DLOBSubscriber,
+    DriftClient,
+    getMarketsAndOraclesForSubscription,
+    MarketType,
+    PRICE_PRECISION,
+    SlotSubscriber,
+    UserMap,
+    Wallet,
+} from './src/index';
+import {
+    DLOBApiClient,
+} from './src/dlob/DLOBApiClient';
+
+async function main() {
+
+    const driftConfig = configs['mainnet-beta'];
+    const connection = new Connection('https://api.mainnet-beta.solana.com');
+
+    const accountLoader = new BulkAccountLoader(
+        connection,
+        'confirmed',
+        10000
+    );
+
+    const { perpMarketIndexes, spotMarketIndexes, oracleInfos } = getMarketsAndOraclesForSubscription('mainnet-beta');
+
+
+    const driftClient = new DriftClient({
+        connection: connection,
+        wallet: new Wallet(new Keypair()),
+        programID: new PublicKey(driftConfig.DRIFT_PROGRAM_ID),
+        accountSubscription: {
+            type: 'polling',
+            accountLoader: accountLoader,
+        },
+        perpMarketIndexes,
+        spotMarketIndexes,
+        oracleInfos,
+        userStats: true,
+        env: 'mainnet-beta',
+    });
+    console.log(`driftClientSubscribed: ${await driftClient.subscribe()}`);
+
+    const slotSubscriber = new SlotSubscriber(connection);
+    await slotSubscriber.subscribe();
+
+
+    // Alternatively, you can also use the UserMap class, which loads the DLOB via RPC calls.
+    // const userMap = new UserMap(driftClient, driftClient.userAccountSubscriptionConfig, false);
+
+    // This loads the DLOB from a server hosted by Drift.
+    const dlobAPI = new DLOBApiClient({
+        url: 'https://dlob.drift.trade/orders/idlWithSlot',
+    });
+
+    const dlobSubscriber = new DLOBSubscriber({
+        dlobSource: dlobAPI,
+        slotSource: slotSubscriber,
+        driftClient: driftClient,
+        updateFrequency: 10000,
+    });
+    await dlobSubscriber.subscribe();
+
+    const l2 = dlobSubscriber.getL2({
+        marketIndex: 0,
+        marketType: MarketType.PERP,
+    });
+    console.log("Level 2 order book:");
+
+    console.log("Asks:");
+    const asks = l2.asks.slice().reverse();
+    for (let i = 0; i < asks.length; i++) {
+        const ask = asks[i];
+        console.log(` [${asks.length - i - 1}] ${convertToNumber(ask.size, BASE_PRECISION)} @ $${convertToNumber(ask.price, PRICE_PRECISION)}`);
+    }
+
+    console.log("Bids:");
+    const bids = l2.bids;
+    for (let i = 0; i < bids.length; i++) {
+        const bid = bids[i];
+        console.log(` [${i}] ${convertToNumber(bid.size, BASE_PRECISION)} @ $${convertToNumber(bid.price, PRICE_PRECISION)}`);
+    }
+    console.log("");
+    console.log("");
+
+    /**
+Level 2 order book:
+Asks:
+ [9] 664.8 @ $21.3248
+ [8] 3.5 @ $21.288301
+ [7] 3.5 @ $21.287237
+ [6] 3.5 @ $21.283129
+ [5] 0.1 @ $21.2825
+ [4] 1937.6 @ $21.2748
+ [3] 1 @ $21.26
+ [2] 2015 @ $21.2589
+ [1] 503.7 @ $21.2483
+ [0] 377.8 @ $21.243
+Bids:
+ [0] 1168.2 @ $21.2464
+ [1] 136.7 @ $21.2461
+ [2] 2570.2 @ $21.2426
+ [3] 0.1 @ $21.2419
+ [4] 47 @ $21.216188
+ [5] 327.8 @ $21.211
+ [6] 437 @ $21.2057
+ [7] 47 @ $21.205592
+ [8] 1748.3 @ $21.1951
+ [9] 187 @ $21.1792
+     */
+
+    const l3 = dlobSubscriber.getL3({
+        marketIndex: 0,
+        marketType: MarketType.PERP,
+    });
+
+    console.log("Level 3 order book:");
+    console.log("Asks:");
+    const l3asks = l3.asks.slice().reverse();
+    for (let i = 0; i < l3asks.length; i++) {
+        const ask = l3asks[i];
+        console.log(` [${l3asks.length - i - 1}] ${ask.maker.toBase58()} ${convertToNumber(ask.size, BASE_PRECISION)} @ $${convertToNumber(ask.price, PRICE_PRECISION)}`);
+    }
+
+    console.log("Bids:");
+    const l3bids = l3.bids;
+    for (let i = 0; i < l3bids.length; i++) {
+        const bid = l3bids[i];
+        console.log(` [${i}] ${bid.maker.toBase58()} ${convertToNumber(bid.size, BASE_PRECISION)} @ $${convertToNumber(bid.price, PRICE_PRECISION)}`);
+    }
+
+    /**
+    Level 3 order book:
+    Asks:
+    ...
+     [3] FrEFAwxdrzHxgc7S4cuFfsfLmcg8pfbxnkCQW83euyCS 1 @ $21.26
+     [2] C13FZykQfLXKuMAMh2iuG7JxhQqd8otujNRAgVETU6id 2015 @ $21.2589
+     [1] C13FZykQfLXKuMAMh2iuG7JxhQqd8otujNRAgVETU6id 503.7 @ $21.2483
+     [0] C13FZykQfLXKuMAMh2iuG7JxhQqd8otujNRAgVETU6id 377.8 @ $21.243
+    Bids:
+     [0] FrEFAwxdrzHxgc7S4cuFfsfLmcg8pfbxnkCQW83euyCS 1168.2 @ $21.2464
+     [1] FrEFAwxdrzHxgc7S4cuFfsfLmcg8pfbxnkCQW83euyCS 2570.2 @ $21.2464
+     [2] FrEFAwxdrzHxgc7S4cuFfsfLmcg8pfbxnkCQW83euyCS 136.7 @ $21.2461
+     [3] FrEFAwxdrzHxgc7S4cuFfsfLmcg8pfbxnkCQW83euyCS 2570.2 @ $21.2426
+    ...
+     */
+}
+
+main().catch(console.error);

package/lib/accounts/pollingDriftClientAccountSubscriber.d.ts

@@ -53,4 +53,5 @@ export declare class PollingDriftClientAccountSubscriber implements DriftClientA
     getSpotMarketAccountAndSlot(marketIndex: number): DataAndSlot<SpotMarketAccount> | undefined;
     getSpotMarketAccountsAndSlots(): DataAndSlot<SpotMarketAccount>[];
     getOraclePriceDataAndSlot(oraclePublicKey: PublicKey): DataAndSlot<OraclePriceData> | undefined;
+    updateAccountLoaderPollingFrequency(pollingFrequency: number): void;
 }

package/lib/accounts/pollingDriftClientAccountSubscriber.js

@@ -274,5 +274,8 @@ class PollingDriftClientAccountSubscriber {
         }
         return this.oracles.get(oraclePublicKey.toString());
     }
+    updateAccountLoaderPollingFrequency(pollingFrequency) {
+        this.accountLoader.updatePollingFrequency(pollingFrequency);
+    }
 }
 exports.PollingDriftClientAccountSubscriber = PollingDriftClientAccountSubscriber;

package/lib/accounts/types.d.ts

@@ -40,6 +40,7 @@ export interface DriftClientAccountSubscriber {
     getSpotMarketAccountAndSlot(marketIndex: number): DataAndSlot<SpotMarketAccount> | undefined;
     getSpotMarketAccountsAndSlots(): DataAndSlot<SpotMarketAccount>[];
     getOraclePriceDataAndSlot(oraclePublicKey: PublicKey): DataAndSlot<OraclePriceData> | undefined;
+    updateAccountLoaderPollingFrequency?: (pollingFrequency: number) => void;
 }
 export interface UserAccountEvents {
     userAccountUpdate: (payload: UserAccount) => void;

package/lib/driftClient.d.ts

@@ -314,22 +314,23 @@ export declare class DriftClient {
     modifyPerpOrderByUserOrderId(userOrderId: number, newBaseAmount?: BN, newLimitPrice?: BN, newOraclePriceOffset?: number): Promise<TransactionSignature>;
     /**
      * Modifies an open order (spot or perp) by closing it and replacing it with a new order.
-     * @param orderId: The open order to modify
-     * @param newDirection: The new direction for the order
-     * @param newBaseAmount: The new base amount for the order
-     * @param newLimitPice: The new limit price for the order
-     * @param newOraclePriceOffset: The new oracle price offset for the order
-     * @param newTriggerPrice: Optional - Thew new trigger price for the order.
-     * @param auctionDuration:
-     * @param auctionStartPrice:
-     * @param auctionEndPrice:
-     * @param reduceOnly:
-     * @param postOnly:
-     * @param immediateOrCancel:
-     * @param maxTs:
+     * @param orderParams.orderId: The open order to modify
+     * @param orderParams.newDirection: The new direction for the order
+     * @param orderParams.newBaseAmount: The new base amount for the order
+     * @param orderParams.newLimitPice: The new limit price for the order
+     * @param orderParams.newOraclePriceOffset: The new oracle price offset for the order
+     * @param orderParams.newTriggerPrice: Optional - Thew new trigger price for the order.
+     * @param orderParams.auctionDuration:
+     * @param orderParams.auctionStartPrice:
+     * @param orderParams.auctionEndPrice:
+     * @param orderParams.reduceOnly:
+     * @param orderParams.postOnly:
+     * @param orderParams.immediateOrCancel:
+     * @param orderParams.policy:
+     * @param orderParams.maxTs:
      * @returns
      */
-    modifyOrder({ orderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, txParams, }: {
+    modifyOrder(orderParams: {
         orderId: number;
         newDirection?: PositionDirection;
         newBaseAmount?: BN;
@@ -344,27 +345,61 @@ export declare class DriftClient {
         postOnly?: boolean;
         immediateOrCancel?: boolean;
         maxTs?: BN;
-        txParams?: TxParams;
-    }): Promise<TransactionSignature>;
-    getModifyOrderIx(orderId: number, orderParams: ModifyOrderParams): Promise<TransactionInstruction>;
+        policy?: ModifyOrderParams;
+    }, txParams?: TxParams): Promise<TransactionSignature>;
+    getModifyOrderIx({ orderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, policy, }: {
+        orderId: number;
+        newDirection?: PositionDirection;
+        newBaseAmount?: BN;
+        newLimitPrice?: BN;
+        newOraclePriceOffset?: number;
+        newTriggerPrice?: BN;
+        newTriggerCondition?: OrderTriggerCondition;
+        auctionDuration?: number;
+        auctionStartPrice?: BN;
+        auctionEndPrice?: BN;
+        reduceOnly?: boolean;
+        postOnly?: boolean;
+        immediateOrCancel?: boolean;
+        maxTs?: BN;
+        policy?: ModifyOrderParams;
+    }): Promise<TransactionInstruction>;
     /**
      * Modifies an open order by closing it and replacing it with a new order.
-     * @param userOrderId: The open order to modify
-     * @param newDirection: The new direction for the order
-     * @param newBaseAmount: The new base amount for the order
-     * @param newLimitPice: The new limit price for the order
-     * @param newOraclePriceOffset: The new oracle price offset for the order
-     * @param newTriggerPrice: Optional - Thew new trigger price for the order.
-     * @param auctionDuration: Only required if order type changed to market from something else
-     * @param auctionStartPrice: Only required if order type changed to market from something else
-     * @param auctionEndPrice: Only required if order type changed to market from something else
-     * @param reduceOnly:
-     * @param postOnly:
-     * @param immediateOrCancel:
-     * @param maxTs:
+     * @param orderParams.userOrderId: The open order to modify
+     * @param orderParams.newDirection: The new direction for the order
+     * @param orderParams.newBaseAmount: The new base amount for the order
+     * @param orderParams.newLimitPice: The new limit price for the order
+     * @param orderParams.newOraclePriceOffset: The new oracle price offset for the order
+     * @param orderParams.newTriggerPrice: Optional - Thew new trigger price for the order.
+     * @param orderParams.auctionDuration: Only required if order type changed to market from something else
+     * @param orderParams.auctionStartPrice: Only required if order type changed to market from something else
+     * @param orderParams.auctionEndPrice: Only required if order type changed to market from something else
+     * @param orderParams.reduceOnly:
+     * @param orderParams.postOnly:
+     * @param orderParams.immediateOrCancel:
+     * @param orderParams.policy:
+     * @param orderParams.maxTs:
      * @returns
      */
-    modifyOrderByUserOrderId({ userOrderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, txParams, }: {
+    modifyOrderByUserOrderId(orderParams: {
+        userOrderId: number;
+        newDirection?: PositionDirection;
+        newBaseAmount?: BN;
+        newLimitPrice?: BN;
+        newOraclePriceOffset?: number;
+        newTriggerPrice?: BN;
+        newTriggerCondition?: OrderTriggerCondition;
+        auctionDuration?: number;
+        auctionStartPrice?: BN;
+        auctionEndPrice?: BN;
+        reduceOnly?: boolean;
+        postOnly?: boolean;
+        immediateOrCancel?: boolean;
+        policy?: ModifyOrderParams;
+        maxTs?: BN;
+    }, txParams?: TxParams): Promise<TransactionSignature>;
+    getModifyOrderByUserIdIx({ userOrderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, policy, }: {
         userOrderId: number;
         newDirection?: PositionDirection;
         newBaseAmount?: BN;
@@ -378,10 +413,10 @@ export declare class DriftClient {
         reduceOnly?: boolean;
         postOnly?: boolean;
         immediateOrCancel?: boolean;
+        policy?: ModifyOrderParams;
         maxTs?: BN;
         txParams?: TxParams;
-    }): Promise<TransactionSignature>;
-    getModifyOrderByUserIdIx(userOrderId: number, orderParams: ModifyOrderParams): Promise<TransactionInstruction>;
+    }): Promise<TransactionInstruction>;
     settlePNLs(users: {
         settleeUserAccountPublicKey: PublicKey;
         settleeUserAccount: UserAccount;

package/lib/driftClient.js

@@ -2273,22 +2273,32 @@ class DriftClient {
     }
     /**
      * Modifies an open order (spot or perp) by closing it and replacing it with a new order.
-     * @param orderId: The open order to modify
-     * @param newDirection: The new direction for the order
-     * @param newBaseAmount: The new base amount for the order
-     * @param newLimitPice: The new limit price for the order
-     * @param newOraclePriceOffset: The new oracle price offset for the order
-     * @param newTriggerPrice: Optional - Thew new trigger price for the order.
-     * @param auctionDuration:
-     * @param auctionStartPrice:
-     * @param auctionEndPrice:
-     * @param reduceOnly:
-     * @param postOnly:
-     * @param immediateOrCancel:
-     * @param maxTs:
+     * @param orderParams.orderId: The open order to modify
+     * @param orderParams.newDirection: The new direction for the order
+     * @param orderParams.newBaseAmount: The new base amount for the order
+     * @param orderParams.newLimitPice: The new limit price for the order
+     * @param orderParams.newOraclePriceOffset: The new oracle price offset for the order
+     * @param orderParams.newTriggerPrice: Optional - Thew new trigger price for the order.
+     * @param orderParams.auctionDuration:
+     * @param orderParams.auctionStartPrice:
+     * @param orderParams.auctionEndPrice:
+     * @param orderParams.reduceOnly:
+     * @param orderParams.postOnly:
+     * @param orderParams.immediateOrCancel:
+     * @param orderParams.policy:
+     * @param orderParams.maxTs:
      * @returns
      */
-    async modifyOrder({ orderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, txParams, }) {
+    async modifyOrder(orderParams, txParams) {
+        const { txSig } = await this.sendTransaction(await this.buildTransaction(await this.getModifyOrderIx(orderParams), txParams), [], this.opts);
+        return txSig;
+    }
+    async getModifyOrderIx({ orderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, policy, }) {
+        const userAccountPublicKey = await this.getUserAccountPublicKey();
+        const remainingAccounts = this.getRemainingAccounts({
+            userAccounts: [this.getUserAccount()],
+            useMarketLastSlotCache: true,
+        });
         const orderParams = {
             baseAssetAmount: newBaseAmount || null,
             direction: newDirection || null,
@@ -2302,17 +2312,9 @@ class DriftClient {
             reduceOnly: reduceOnly || null,
             postOnly: postOnly || null,
             immediateOrCancel: immediateOrCancel || null,
+            policy: policy || null,
             maxTs: maxTs || null,
         };
-        const { txSig } = await this.sendTransaction(await this.buildTransaction(await this.getModifyOrderIx(orderId, orderParams), txParams), [], this.opts);
-        return txSig;
-    }
-    async getModifyOrderIx(orderId, orderParams) {
-        const userAccountPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccounts({
-            userAccounts: [this.getUserAccount()],
-            useMarketLastSlotCache: true,
-        });
         return await this.program.instruction.modifyOrder(orderId, orderParams, {
             accounts: {
                 state: await this.getStatePublicKey(),
@@ -2325,22 +2327,32 @@ class DriftClient {
     }
     /**
      * Modifies an open order by closing it and replacing it with a new order.
-     * @param userOrderId: The open order to modify
-     * @param newDirection: The new direction for the order
-     * @param newBaseAmount: The new base amount for the order
-     * @param newLimitPice: The new limit price for the order
-     * @param newOraclePriceOffset: The new oracle price offset for the order
-     * @param newTriggerPrice: Optional - Thew new trigger price for the order.
-     * @param auctionDuration: Only required if order type changed to market from something else
-     * @param auctionStartPrice: Only required if order type changed to market from something else
-     * @param auctionEndPrice: Only required if order type changed to market from something else
-     * @param reduceOnly:
-     * @param postOnly:
-     * @param immediateOrCancel:
-     * @param maxTs:
+     * @param orderParams.userOrderId: The open order to modify
+     * @param orderParams.newDirection: The new direction for the order
+     * @param orderParams.newBaseAmount: The new base amount for the order
+     * @param orderParams.newLimitPice: The new limit price for the order
+     * @param orderParams.newOraclePriceOffset: The new oracle price offset for the order
+     * @param orderParams.newTriggerPrice: Optional - Thew new trigger price for the order.
+     * @param orderParams.auctionDuration: Only required if order type changed to market from something else
+     * @param orderParams.auctionStartPrice: Only required if order type changed to market from something else
+     * @param orderParams.auctionEndPrice: Only required if order type changed to market from something else
+     * @param orderParams.reduceOnly:
+     * @param orderParams.postOnly:
+     * @param orderParams.immediateOrCancel:
+     * @param orderParams.policy:
+     * @param orderParams.maxTs:
      * @returns
      */
-    async modifyOrderByUserOrderId({ userOrderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, txParams, }) {
+    async modifyOrderByUserOrderId(orderParams, txParams) {
+        const { txSig } = await this.sendTransaction(await this.buildTransaction(await this.getModifyOrderByUserIdIx(orderParams), txParams), [], this.opts);
+        return txSig;
+    }
+    async getModifyOrderByUserIdIx({ userOrderId, newDirection, newBaseAmount, newLimitPrice, newOraclePriceOffset, newTriggerPrice, newTriggerCondition, auctionDuration, auctionStartPrice, auctionEndPrice, reduceOnly, postOnly, immediateOrCancel, maxTs, policy, }) {
+        const userAccountPublicKey = await this.getUserAccountPublicKey();
+        const remainingAccounts = this.getRemainingAccounts({
+            userAccounts: [this.getUserAccount()],
+            useMarketLastSlotCache: true,
+        });
         const orderParams = {
             baseAssetAmount: newBaseAmount || null,
             direction: newDirection || null,
@@ -2354,17 +2366,9 @@ class DriftClient {
             reduceOnly: reduceOnly || null,
             postOnly: postOnly || null,
             immediateOrCancel: immediateOrCancel || null,
+            policy: policy || null,
             maxTs: maxTs || null,
         };
-        const { txSig } = await this.sendTransaction(await this.buildTransaction(await this.getModifyOrderByUserIdIx(userOrderId, orderParams), txParams), [], this.opts);
-        return txSig;
-    }
-    async getModifyOrderByUserIdIx(userOrderId, orderParams) {
-        const userAccountPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccounts({
-            userAccounts: [this.getUserAccount()],
-            useMarketLastSlotCache: true,
-        });
         return await this.program.instruction.modifyOrderByUserId(userOrderId, orderParams, {
             accounts: {
                 state: await this.getStatePublicKey(),

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.28.0",
+    "version": "2.29.0",
     "name": "drift",
     "instructions": [
         {
@@ -4736,7 +4736,7 @@
                         "name": "orderTickSize",
                         "docs": [
                             "Spot orders must be a multiple of the tick size",
-                            "precision: QUOTE_PRECISION"
+                            "precision: PRICE_PRECISION"
                         ],
                         "type": "u64"
                     },
@@ -5565,6 +5565,14 @@
                         "type": {
                             "option": "i64"
                         }
+                    },
+                    {
+                        "name": "policy",
+                        "type": {
+                            "option": {
+                                "defined": "ModifyOrderPolicy"
+                            }
+                        }
                     }
                 ]
             }
@@ -7237,6 +7245,20 @@
                 ]
             }
         },
+        {
+            "name": "ModifyOrderPolicy",
+            "type": {
+                "kind": "enum",
+                "variants": [
+                    {
+                        "name": "TryModify"
+                    },
+                    {
+                        "name": "MustModify"
+                    }
+                ]
+            }
+        },
         {
             "name": "TwapPeriod",
             "type": {

package/lib/types.d.ts

@@ -480,8 +480,8 @@ export declare class LiquidationType {
     static readonly PERP_BANKRUPTCY: {
         perpBankruptcy: {};
     };
-    static readonly BORROW_BANKRUPTCY: {
-        borrowBankruptcy: {};
+    static readonly SPOT_BANKRUPTCY: {
+        spotBankruptcy: {};
     };
     static readonly LIQUIDATE_SPOT: {
         liquidateSpot: {};
@@ -932,7 +932,17 @@ export type OptionalOrderParams = {
 } & NecessaryOrderParams;
 export type ModifyOrderParams = {
     [Property in keyof OrderParams]?: OrderParams[Property] | null;
+} & {
+    policy?: ModifyOrderPolicy;
 };
+export declare class ModifyOrderPolicy {
+    static readonly MUST_MODIFY: {
+        mustModify: {};
+    };
+    static readonly TRY_MODIFY: {
+        tryModify: {};
+    };
+}
 export declare const DefaultOrderParams: OrderParams;
 export type MakerInfo = {
     maker: PublicKey;

package/lib/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultOrderParams = exports.PostOnlyParams = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.UserStatus = exports.MarketStatus = exports.ExchangeStatus = void 0;
+exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PostOnlyParams = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.UserStatus = exports.MarketStatus = exports.ExchangeStatus = void 0;
 const _1 = require(".");
 // # Utility Types / Enums / Constants
 var ExchangeStatus;
@@ -230,8 +230,8 @@ LiquidationType.LIQUIDATE_PERP_PNL_FOR_DEPOSIT = {
 LiquidationType.PERP_BANKRUPTCY = {
     perpBankruptcy: {},
 };
-LiquidationType.BORROW_BANKRUPTCY = {
-    borrowBankruptcy: {},
+LiquidationType.SPOT_BANKRUPTCY = {
+    spotBankruptcy: {},
 };
 LiquidationType.LIQUIDATE_SPOT = {
     liquidateSpot: {},
@@ -242,6 +242,11 @@ exports.PostOnlyParams = PostOnlyParams;
 PostOnlyParams.NONE = { none: {} };
 PostOnlyParams.MUST_POST_ONLY = { mustPostOnly: {} }; // Tx fails if order can't be post only
 PostOnlyParams.TRY_POST_ONLY = { tryPostOnly: {} }; // Tx succeeds and order not placed if can't be post only
+class ModifyOrderPolicy {
+}
+exports.ModifyOrderPolicy = ModifyOrderPolicy;
+ModifyOrderPolicy.MUST_MODIFY = { mustModify: {} };
+ModifyOrderPolicy.TRY_MODIFY = { tryModify: {} };
 exports.DefaultOrderParams = {
     orderType: OrderType.MARKET,
     marketType: MarketType.PERP,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.28.0",
+	"version": "2.29.0",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",

package/src/accounts/pollingDriftClientAccountSubscriber.ts

@@ -435,4 +435,8 @@ export class PollingDriftClientAccountSubscriber
 
 		return this.oracles.get(oraclePublicKey.toString());
 	}
+
+	public updateAccountLoaderPollingFrequency(pollingFrequency: number): void {
+		this.accountLoader.updatePollingFrequency(pollingFrequency);
+	}
 }

package/src/accounts/types.ts

@@ -59,6 +59,8 @@ export interface DriftClientAccountSubscriber {
 	getOraclePriceDataAndSlot(
 		oraclePublicKey: PublicKey
 	): DataAndSlot<OraclePriceData> | undefined;
+
+	updateAccountLoaderPollingFrequency?: (pollingFrequency: number) => void;
 }
 
 export interface UserAccountEvents {

package/src/driftClient.ts

@@ -3807,22 +3807,54 @@ export class DriftClient {
 
 	/**
 	 * Modifies an open order (spot or perp) by closing it and replacing it with a new order.
-	 * @param orderId: The open order to modify
-	 * @param newDirection: The new direction for the order
-	 * @param newBaseAmount: The new base amount for the order
-	 * @param newLimitPice: The new limit price for the order
-	 * @param newOraclePriceOffset: The new oracle price offset for the order
-	 * @param newTriggerPrice: Optional - Thew new trigger price for the order.
-	 * @param auctionDuration:
-	 * @param auctionStartPrice:
-	 * @param auctionEndPrice:
-	 * @param reduceOnly:
-	 * @param postOnly:
-	 * @param immediateOrCancel:
-	 * @param maxTs:
+	 * @param orderParams.orderId: The open order to modify
+	 * @param orderParams.newDirection: The new direction for the order
+	 * @param orderParams.newBaseAmount: The new base amount for the order
+	 * @param orderParams.newLimitPice: The new limit price for the order
+	 * @param orderParams.newOraclePriceOffset: The new oracle price offset for the order
+	 * @param orderParams.newTriggerPrice: Optional - Thew new trigger price for the order.
+	 * @param orderParams.auctionDuration:
+	 * @param orderParams.auctionStartPrice:
+	 * @param orderParams.auctionEndPrice:
+	 * @param orderParams.reduceOnly:
+	 * @param orderParams.postOnly:
+	 * @param orderParams.immediateOrCancel:
+	 * @param orderParams.policy:
+	 * @param orderParams.maxTs:
 	 * @returns
 	 */
-	public async modifyOrder({
+	public async modifyOrder(
+		orderParams: {
+			orderId: number;
+			newDirection?: PositionDirection;
+			newBaseAmount?: BN;
+			newLimitPrice?: BN;
+			newOraclePriceOffset?: number;
+			newTriggerPrice?: BN;
+			newTriggerCondition?: OrderTriggerCondition;
+			auctionDuration?: number;
+			auctionStartPrice?: BN;
+			auctionEndPrice?: BN;
+			reduceOnly?: boolean;
+			postOnly?: boolean;
+			immediateOrCancel?: boolean;
+			maxTs?: BN;
+			policy?: ModifyOrderParams;
+		},
+		txParams?: TxParams
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.sendTransaction(
+			await this.buildTransaction(
+				await this.getModifyOrderIx(orderParams),
+				txParams
+			),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async getModifyOrderIx({
 		orderId,
 		newDirection,
 		newBaseAmount,
@@ -3837,7 +3869,7 @@ export class DriftClient {
 		postOnly,
 		immediateOrCancel,
 		maxTs,
-		txParams,
+		policy,
 	}: {
 		orderId: number;
 		newDirection?: PositionDirection;
@@ -3853,8 +3885,15 @@ export class DriftClient {
 		postOnly?: boolean;
 		immediateOrCancel?: boolean;
 		maxTs?: BN;
-		txParams?: TxParams;
-	}): Promise<TransactionSignature> {
+		policy?: ModifyOrderParams;
+	}): Promise<TransactionInstruction> {
+		const userAccountPublicKey = await this.getUserAccountPublicKey();
+
+		const remainingAccounts = this.getRemainingAccounts({
+			userAccounts: [this.getUserAccount()],
+			useMarketLastSlotCache: true,
+		});
+
 		const orderParams: ModifyOrderParams = {
 			baseAssetAmount: newBaseAmount || null,
 			direction: newDirection || null,
@@ -3868,31 +3907,10 @@ export class DriftClient {
 			reduceOnly: reduceOnly || null,
 			postOnly: postOnly || null,
 			immediateOrCancel: immediateOrCancel || null,
+			policy: policy || null,
 			maxTs: maxTs || null,
 		};
 
-		const { txSig } = await this.sendTransaction(
-			await this.buildTransaction(
-				await this.getModifyOrderIx(orderId, orderParams),
-				txParams
-			),
-			[],
-			this.opts
-		);
-		return txSig;
-	}
-
-	public async getModifyOrderIx(
-		orderId: number,
-		orderParams: ModifyOrderParams
-	): Promise<TransactionInstruction> {
-		const userAccountPublicKey = await this.getUserAccountPublicKey();
-
-		const remainingAccounts = this.getRemainingAccounts({
-			userAccounts: [this.getUserAccount()],
-			useMarketLastSlotCache: true,
-		});
-
 		return await this.program.instruction.modifyOrder(orderId, orderParams, {
 			accounts: {
 				state: await this.getStatePublicKey(),
@@ -3906,22 +3924,54 @@ export class DriftClient {
 
 	/**
 	 * Modifies an open order by closing it and replacing it with a new order.
-	 * @param userOrderId: The open order to modify
-	 * @param newDirection: The new direction for the order
-	 * @param newBaseAmount: The new base amount for the order
-	 * @param newLimitPice: The new limit price for the order
-	 * @param newOraclePriceOffset: The new oracle price offset for the order
-	 * @param newTriggerPrice: Optional - Thew new trigger price for the order.
-	 * @param auctionDuration: Only required if order type changed to market from something else
-	 * @param auctionStartPrice: Only required if order type changed to market from something else
-	 * @param auctionEndPrice: Only required if order type changed to market from something else
-	 * @param reduceOnly:
-	 * @param postOnly:
-	 * @param immediateOrCancel:
-	 * @param maxTs:
+	 * @param orderParams.userOrderId: The open order to modify
+	 * @param orderParams.newDirection: The new direction for the order
+	 * @param orderParams.newBaseAmount: The new base amount for the order
+	 * @param orderParams.newLimitPice: The new limit price for the order
+	 * @param orderParams.newOraclePriceOffset: The new oracle price offset for the order
+	 * @param orderParams.newTriggerPrice: Optional - Thew new trigger price for the order.
+	 * @param orderParams.auctionDuration: Only required if order type changed to market from something else
+	 * @param orderParams.auctionStartPrice: Only required if order type changed to market from something else
+	 * @param orderParams.auctionEndPrice: Only required if order type changed to market from something else
+	 * @param orderParams.reduceOnly:
+	 * @param orderParams.postOnly:
+	 * @param orderParams.immediateOrCancel:
+	 * @param orderParams.policy:
+	 * @param orderParams.maxTs:
 	 * @returns
 	 */
-	public async modifyOrderByUserOrderId({
+	public async modifyOrderByUserOrderId(
+		orderParams: {
+			userOrderId: number;
+			newDirection?: PositionDirection;
+			newBaseAmount?: BN;
+			newLimitPrice?: BN;
+			newOraclePriceOffset?: number;
+			newTriggerPrice?: BN;
+			newTriggerCondition?: OrderTriggerCondition;
+			auctionDuration?: number;
+			auctionStartPrice?: BN;
+			auctionEndPrice?: BN;
+			reduceOnly?: boolean;
+			postOnly?: boolean;
+			immediateOrCancel?: boolean;
+			policy?: ModifyOrderParams;
+			maxTs?: BN;
+		},
+		txParams?: TxParams
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.sendTransaction(
+			await this.buildTransaction(
+				await this.getModifyOrderByUserIdIx(orderParams),
+				txParams
+			),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async getModifyOrderByUserIdIx({
 		userOrderId,
 		newDirection,
 		newBaseAmount,
@@ -3936,7 +3986,7 @@ export class DriftClient {
 		postOnly,
 		immediateOrCancel,
 		maxTs,
-		txParams,
+		policy,
 	}: {
 		userOrderId: number;
 		newDirection?: PositionDirection;
@@ -3951,9 +4001,17 @@ export class DriftClient {
 		reduceOnly?: boolean;
 		postOnly?: boolean;
 		immediateOrCancel?: boolean;
+		policy?: ModifyOrderParams;
 		maxTs?: BN;
 		txParams?: TxParams;
-	}): Promise<TransactionSignature> {
+	}): Promise<TransactionInstruction> {
+		const userAccountPublicKey = await this.getUserAccountPublicKey();
+
+		const remainingAccounts = this.getRemainingAccounts({
+			userAccounts: [this.getUserAccount()],
+			useMarketLastSlotCache: true,
+		});
+
 		const orderParams: ModifyOrderParams = {
 			baseAssetAmount: newBaseAmount || null,
 			direction: newDirection || null,
@@ -3967,31 +4025,10 @@ export class DriftClient {
 			reduceOnly: reduceOnly || null,
 			postOnly: postOnly || null,
 			immediateOrCancel: immediateOrCancel || null,
+			policy: policy || null,
 			maxTs: maxTs || null,
 		};
 
-		const { txSig } = await this.sendTransaction(
-			await this.buildTransaction(
-				await this.getModifyOrderByUserIdIx(userOrderId, orderParams),
-				txParams
-			),
-			[],
-			this.opts
-		);
-		return txSig;
-	}
-
-	public async getModifyOrderByUserIdIx(
-		userOrderId: number,
-		orderParams: ModifyOrderParams
-	): Promise<TransactionInstruction> {
-		const userAccountPublicKey = await this.getUserAccountPublicKey();
-
-		const remainingAccounts = this.getRemainingAccounts({
-			userAccounts: [this.getUserAccount()],
-			useMarketLastSlotCache: true,
-		});
-
 		return await this.program.instruction.modifyOrderByUserId(
 			userOrderId,
 			orderParams,

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.28.0",
+  "version": "2.29.0",
   "name": "drift",
   "instructions": [
     {
@@ -4736,7 +4736,7 @@
             "name": "orderTickSize",
             "docs": [
               "Spot orders must be a multiple of the tick size",
-              "precision: QUOTE_PRECISION"
+              "precision: PRICE_PRECISION"
             ],
             "type": "u64"
           },
@@ -5565,6 +5565,14 @@
             "type": {
               "option": "i64"
             }
+          },
+          {
+            "name": "policy",
+            "type": {
+              "option": {
+                "defined": "ModifyOrderPolicy"
+              }
+            }
           }
         ]
       }
@@ -7237,6 +7245,20 @@
         ]
       }
     },
+    {
+      "name": "ModifyOrderPolicy",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "TryModify"
+          },
+          {
+            "name": "MustModify"
+          }
+        ]
+      }
+    },
     {
       "name": "TwapPeriod",
       "type": {
@@ -10067,4 +10089,4 @@
       "msg": "InvalidPhoenixMarket"
     }
   ]
-}
+}

package/src/types.ts

@@ -391,8 +391,8 @@ export class LiquidationType {
 	static readonly PERP_BANKRUPTCY = {
 		perpBankruptcy: {},
 	};
-	static readonly BORROW_BANKRUPTCY = {
-		borrowBankruptcy: {},
+	static readonly SPOT_BANKRUPTCY = {
+		spotBankruptcy: {},
 	};
 	static readonly LIQUIDATE_SPOT = {
 		liquidateSpot: {},
@@ -883,7 +883,12 @@ export type OptionalOrderParams = {
 
 export type ModifyOrderParams = {
 	[Property in keyof OrderParams]?: OrderParams[Property] | null;
-};
+} & { policy?: ModifyOrderPolicy };
+
+export class ModifyOrderPolicy {
+	static readonly MUST_MODIFY = { mustModify: {} };
+	static readonly TRY_MODIFY = { tryModify: {} };
+}
 
 export const DefaultOrderParams: OrderParams = {
 	orderType: OrderType.MARKET,

package/src/assert/assert.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assert = void 0;
-function assert(condition, error) {
-    if (!condition) {
-        throw new Error(error || 'Unspecified AssertionError');
-    }
-}
-exports.assert = assert;

package/src/token/index.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseTokenAccount = void 0;
-const spl_token_1 = require("@solana/spl-token");
-const web3_js_1 = require("@solana/web3.js");
-function parseTokenAccount(data) {
-    const accountInfo = spl_token_1.AccountLayout.decode(data);
-    accountInfo.mint = new web3_js_1.PublicKey(accountInfo.mint);
-    accountInfo.owner = new web3_js_1.PublicKey(accountInfo.owner);
-    accountInfo.amount = spl_token_1.u64.fromBuffer(accountInfo.amount);
-    if (accountInfo.delegateOption === 0) {
-        accountInfo.delegate = null;
-        // eslint-disable-next-line new-cap
-        accountInfo.delegatedAmount = new spl_token_1.u64(0);
-    }
-    else {
-        accountInfo.delegate = new web3_js_1.PublicKey(accountInfo.delegate);
-        accountInfo.delegatedAmount = spl_token_1.u64.fromBuffer(accountInfo.delegatedAmount);
-    }
-    accountInfo.isInitialized = accountInfo.state !== 0;
-    accountInfo.isFrozen = accountInfo.state === 2;
-    if (accountInfo.isNativeOption === 1) {
-        accountInfo.rentExemptReserve = spl_token_1.u64.fromBuffer(accountInfo.isNative);
-        accountInfo.isNative = true;
-    }
-    else {
-        accountInfo.rentExemptReserve = null;
-        accountInfo.isNative = false;
-    }
-    if (accountInfo.closeAuthorityOption === 0) {
-        accountInfo.closeAuthority = null;
-    }
-    else {
-        accountInfo.closeAuthority = new web3_js_1.PublicKey(accountInfo.closeAuthority);
-    }
-    return accountInfo;
-}
-exports.parseTokenAccount = parseTokenAccount;

package/src/util/computeUnits.js

@@ -1,27 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findComputeUnitConsumption = void 0;
-function findComputeUnitConsumption(programId, connection, txSignature, commitment = 'confirmed') {
-    return __awaiter(this, void 0, void 0, function* () {
-        const tx = yield connection.getTransaction(txSignature, { commitment });
-        const computeUnits = [];
-        const regex = new RegExp(`Program ${programId.toString()} consumed ([0-9]{0,6}) of ([0-9]{0,7}) compute units`);
-        tx.meta.logMessages.forEach((logMessage) => {
-            const match = logMessage.match(regex);
-            if (match && match[1]) {
-                computeUnits.push(match[1]);
-            }
-        });
-        return computeUnits;
-    });
-}
-exports.findComputeUnitConsumption = findComputeUnitConsumption;

package/src/util/getTokenAddress.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTokenAddress = void 0;
-const spl_token_1 = require("@solana/spl-token");
-const web3_js_1 = require("@solana/web3.js");
-const getTokenAddress = (mintAddress, userPubKey) => {
-    return spl_token_1.Token.getAssociatedTokenAddress(spl_token_1.ASSOCIATED_TOKEN_PROGRAM_ID, spl_token_1.TOKEN_PROGRAM_ID, new web3_js_1.PublicKey(mintAddress), new web3_js_1.PublicKey(userPubKey));
-};
-exports.getTokenAddress = getTokenAddress;

package/src/util/promiseTimeout.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.promiseTimeout = void 0;
-function promiseTimeout(promise, timeoutMs) {
-    let timeoutId;
-    const timeoutPromise = new Promise((resolve) => {
-        timeoutId = setTimeout(() => resolve(null), timeoutMs);
-    });
-    return Promise.race([promise, timeoutPromise]).then((result) => {
-        clearTimeout(timeoutId);
-        return result;
-    });
-}
-exports.promiseTimeout = promiseTimeout;

package/src/util/tps.js

@@ -1,27 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.estimateTps = void 0;
-function estimateTps(programId, connection, failed) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let signatures = yield connection.getSignaturesForAddress(programId, undefined, 'finalized');
-        if (failed) {
-            signatures = signatures.filter((signature) => signature.err);
-        }
-        const numberOfSignatures = signatures.length;
-        if (numberOfSignatures === 0) {
-            return 0;
-        }
-        return (numberOfSignatures /
-            (signatures[0].blockTime - signatures[numberOfSignatures - 1].blockTime));
-    });
-}
-exports.estimateTps = estimateTps;