@drift-labs/sdk 2.16.0 → 2.17.0-beta.0

package/lib/driftClient.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="bn.js" />
 import { AnchorProvider, BN, Program } from '@project-serum/anchor';
-import { StateAccount, IWallet, PositionDirection, UserAccount, PerpMarketAccount, OrderParams, Order, SpotMarketAccount, SpotPosition, MakerInfo, TakerInfo, OptionalOrderParams, OrderType, ReferrerInfo, MarketType, TxParams, SerumV3FulfillmentConfigAccount } from './types';
+import { StateAccount, IWallet, PositionDirection, UserAccount, PerpMarketAccount, OrderParams, Order, SpotMarketAccount, SpotPosition, MakerInfo, TakerInfo, OptionalOrderParams, OrderType, ReferrerInfo, MarketType, TxParams, SerumV3FulfillmentConfigAccount, OrderTriggerCondition } from './types';
 import * as anchor from '@project-serum/anchor';
 import { Connection, PublicKey, TransactionSignature, ConfirmOptions, Transaction, TransactionInstruction, AccountMeta, Signer, AddressLookupTableAccount } from '@solana/web3.js';
 import { TokenFaucet } from './tokenFaucet';
@@ -222,6 +222,16 @@ export declare class DriftClient {
      * @returns
      */
     modifyPerpOrder(orderId: number, newBaseAmount?: BN, newLimitPrice?: BN, newOraclePriceOffset?: number): Promise<TransactionSignature>;
+    /**
+     * Modifies an open order by closing it and replacing it with a new order.
+     * @deprecated use modifyOrderByUserOrderId instead
+     * @param userOrderId: The open order to modify
+     * @param newBaseAmount: The new base amount for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+     * @param newLimitPice: The new limit price for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+     * @param newOraclePriceOffset: The new oracle price offset for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+     * @returns
+     */
+    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
@@ -231,27 +241,24 @@ export declare class DriftClient {
      * @param newOrderType: Optional - New order type for the order.
      * @param newTriggerPrice: Optional - Thew new trigger price for the order.
      * @param isSpot: Optional - Set to true if the order is a spot 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
      * @returns
      */
-    modifyOrder({ orderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, isSpot, }: {
+    modifyOrder({ orderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, newTriggerCondition, isSpot, auctionDuration, auctionStartPrice, auctionEndPrice, }: {
         orderId: number;
         newBaseAmount?: BN;
         newLimitPrice?: BN;
         newOraclePriceOffset?: number;
         newOrderType?: OrderType;
         newTriggerPrice?: BN;
+        newTriggerCondition?: OrderTriggerCondition;
         isSpot?: boolean;
+        auctionDuration?: number;
+        auctionStartPrice?: BN;
+        auctionEndPrice?: BN;
     }): Promise<TransactionSignature>;
-    /**
-     * Modifies an open order by closing it and replacing it with a new order.
-     * @deprecated use modifyOrderByUserOrderId instead
-     * @param userOrderId: The open order to modify
-     * @param newBaseAmount: The new base amount for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-     * @param newLimitPice: The new limit price for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-     * @param newOraclePriceOffset: The new oracle price offset for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-     * @returns
-     */
-    modifyPerpOrderByUserOrderId(userOrderId: number, newBaseAmount?: BN, newLimitPrice?: BN, newOraclePriceOffset?: number): Promise<TransactionSignature>;
     /**
      * Modifies an open order by closing it and replacing it with a new order.
      * @param userOrderId: The open order to modify
@@ -261,16 +268,23 @@ export declare class DriftClient {
      * @param newOrderType: Optional - New order type for the order.
      * @param newTriggerPrice: Optional - Thew new trigger price for the order.
      * @param isSpot: Set to true if the order is a spot 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
      * @returns
      */
-    modifyOrderByUserOrderId({ userOrderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, isSpot, }: {
+    modifyOrderByUserOrderId({ userOrderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, newTriggerCondition, isSpot, auctionDuration, auctionStartPrice, auctionEndPrice, }: {
         userOrderId: number;
         newBaseAmount?: BN;
         newLimitPrice?: BN;
         newOraclePriceOffset?: number;
         newOrderType?: OrderType;
         newTriggerPrice?: BN;
+        newTriggerCondition?: OrderTriggerCondition;
         isSpot?: boolean;
+        auctionDuration?: number;
+        auctionStartPrice?: BN;
+        auctionEndPrice?: BN;
     }): Promise<TransactionSignature>;
     settlePNLs(users: {
         settleeUserAccountPublicKey: PublicKey;

package/lib/driftClient.js

@@ -1769,44 +1769,29 @@ class DriftClient {
      * @returns
      */
     async modifyPerpOrder(orderId, newBaseAmount, newLimitPrice, newOraclePriceOffset) {
-        if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
-            throw new Error(`Must provide newBaseAmount or newLimitPrice or newOraclePriceOffset to modify order`);
-        }
-        const openOrder = this.getUser().getOrder(orderId);
-        if (!openOrder) {
-            throw new Error(`No open order with id ${orderId.toString()}`);
-        }
-        const cancelOrderIx = await this.getCancelOrderIx(orderId);
-        const newOrderParams = {
-            orderType: openOrder.orderType,
-            marketType: openOrder.marketType,
-            direction: openOrder.direction,
-            baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-            price: newLimitPrice || openOrder.price,
-            marketIndex: openOrder.marketIndex,
-            reduceOnly: openOrder.reduceOnly,
-            postOnly: openOrder.postOnly,
-            immediateOrCancel: openOrder.immediateOrCancel,
-            triggerPrice: openOrder.triggerPrice,
-            triggerCondition: openOrder.triggerCondition,
-            oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-            auctionDuration: openOrder.auctionDuration,
-            maxTs: openOrder.maxTs,
-            auctionStartPrice: openOrder.auctionStartPrice,
-            auctionEndPrice: openOrder.auctionEndPrice,
-            userOrderId: openOrder.userOrderId,
-        };
-        const placeOrderIx = await this.getPlacePerpOrderIx(newOrderParams);
-        const tx = new web3_js_1.Transaction();
-        tx.add(web3_js_1.ComputeBudgetProgram.requestUnits({
-            units: 1000000,
-            additionalFee: 0,
-        }));
-        tx.add(cancelOrderIx);
-        tx.add(placeOrderIx);
-        const { txSig, slot } = await this.sendTransaction(tx, [], this.opts);
-        this.perpMarketLastSlotCache.set(newOrderParams.marketIndex, slot);
-        return txSig;
+        return this.modifyOrder({
+            orderId,
+            newBaseAmount,
+            newLimitPrice,
+            newOraclePriceOffset,
+        });
+    }
+    /**
+     * Modifies an open order by closing it and replacing it with a new order.
+     * @deprecated use modifyOrderByUserOrderId instead
+     * @param userOrderId: The open order to modify
+     * @param newBaseAmount: The new base amount for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+     * @param newLimitPice: The new limit price for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+     * @param newOraclePriceOffset: The new oracle price offset for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+     * @returns
+     */
+    async modifyPerpOrderByUserOrderId(userOrderId, newBaseAmount, newLimitPrice, newOraclePriceOffset) {
+        return this.modifyOrderByUserOrderId({
+            userOrderId,
+            newBaseAmount,
+            newLimitPrice,
+            newOraclePriceOffset,
+        });
     }
     /**
      * Modifies an open order (spot or perp) by closing it and replacing it with a new order.
@@ -1817,9 +1802,12 @@ class DriftClient {
      * @param newOrderType: Optional - New order type for the order.
      * @param newTriggerPrice: Optional - Thew new trigger price for the order.
      * @param isSpot: Optional - Set to true if the order is a spot 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
      * @returns
      */
-    async modifyOrder({ orderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, isSpot, }) {
+    async modifyOrder({ orderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, newTriggerCondition, isSpot, auctionDuration, auctionStartPrice, auctionEndPrice, }) {
         if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
             throw new Error(`Must provide newBaseAmount or newLimitPrice or newOraclePriceOffset to modify order`);
         }
@@ -1828,23 +1816,37 @@ class DriftClient {
             throw new Error(`No open order with id ${orderId.toString()}`);
         }
         const cancelOrderIx = await this.getCancelOrderIx(orderId);
+        const orderTypeHasTrigger = newOrderType
+            ? types_1.isOneOfVariant(newOrderType, ['triggerlimit', 'triggerMarket'])
+            : types_1.isOneOfVariant(openOrder.orderType, ['triggerLimit', 'triggerMarket']);
+        const orderTypeHasLimitPrice = newOrderType
+            ? types_1.isOneOfVariant(newOrderType, ['triggerLimit', 'limit'])
+            : types_1.isOneOfVariant(openOrder.orderType, ['triggerLimit', 'limit']);
         const newOrderParams = {
             orderType: newOrderType || openOrder.orderType,
             marketType: openOrder.marketType,
             direction: openOrder.direction,
             baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-            price: newLimitPrice || openOrder.price,
+            price: orderTypeHasLimitPrice
+                ? newLimitPrice || openOrder.price
+                : undefined,
             marketIndex: openOrder.marketIndex,
             reduceOnly: openOrder.reduceOnly,
-            postOnly: openOrder.postOnly,
+            postOnly: openOrder.postOnly
+                ? types_1.PostOnlyParams.MUST_POST_ONLY
+                : types_1.PostOnlyParams.NONE,
             immediateOrCancel: openOrder.immediateOrCancel,
-            triggerPrice: newTriggerPrice || openOrder.triggerPrice,
-            triggerCondition: openOrder.triggerCondition,
+            triggerPrice: orderTypeHasTrigger
+                ? newTriggerPrice || openOrder.triggerPrice
+                : undefined,
+            triggerCondition: orderTypeHasTrigger
+                ? newTriggerCondition || openOrder.triggerCondition
+                : undefined,
             oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-            auctionDuration: openOrder.auctionDuration,
+            auctionDuration: auctionDuration || openOrder.auctionDuration,
             maxTs: openOrder.maxTs,
-            auctionStartPrice: openOrder.auctionStartPrice,
-            auctionEndPrice: openOrder.auctionEndPrice,
+            auctionStartPrice: auctionStartPrice || openOrder.auctionStartPrice,
+            auctionEndPrice: auctionEndPrice || openOrder.auctionEndPrice,
             userOrderId: openOrder.userOrderId,
         };
         const placeOrderIx = isSpot
@@ -1867,55 +1869,6 @@ class DriftClient {
         }
         return txSig;
     }
-    /**
-     * Modifies an open order by closing it and replacing it with a new order.
-     * @deprecated use modifyOrderByUserOrderId instead
-     * @param userOrderId: The open order to modify
-     * @param newBaseAmount: The new base amount for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-     * @param newLimitPice: The new limit price for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-     * @param newOraclePriceOffset: The new oracle price offset for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-     * @returns
-     */
-    async modifyPerpOrderByUserOrderId(userOrderId, newBaseAmount, newLimitPrice, newOraclePriceOffset) {
-        if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
-            throw new Error(`Must provide newBaseAmount or newLimitPrice or newOraclePriceOffset to modify order`);
-        }
-        const openOrder = this.getUser().getOrderByUserOrderId(userOrderId);
-        if (!openOrder) {
-            throw new Error(`No open order with user order id ${userOrderId.toString()}`);
-        }
-        const cancelOrderIx = await this.getCancelOrderByUserIdIx(userOrderId);
-        const newOrderParams = {
-            orderType: openOrder.orderType,
-            marketType: openOrder.marketType,
-            direction: openOrder.direction,
-            baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-            price: newLimitPrice || openOrder.price,
-            marketIndex: openOrder.marketIndex,
-            reduceOnly: openOrder.reduceOnly,
-            postOnly: openOrder.postOnly,
-            immediateOrCancel: openOrder.immediateOrCancel,
-            triggerPrice: openOrder.triggerPrice,
-            triggerCondition: openOrder.triggerCondition,
-            oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-            auctionDuration: openOrder.auctionDuration,
-            maxTs: openOrder.maxTs,
-            auctionStartPrice: openOrder.auctionStartPrice,
-            auctionEndPrice: openOrder.auctionEndPrice,
-            userOrderId: openOrder.userOrderId,
-        };
-        const placeOrderIx = await this.getPlacePerpOrderIx(newOrderParams);
-        const tx = new web3_js_1.Transaction();
-        tx.add(web3_js_1.ComputeBudgetProgram.requestUnits({
-            units: 1000000,
-            additionalFee: 0,
-        }));
-        tx.add(cancelOrderIx);
-        tx.add(placeOrderIx);
-        const { txSig, slot } = await this.sendTransaction(tx, [], this.opts);
-        this.perpMarketLastSlotCache.set(newOrderParams.marketIndex, slot);
-        return txSig;
-    }
     /**
      * Modifies an open order by closing it and replacing it with a new order.
      * @param userOrderId: The open order to modify
@@ -1925,9 +1878,12 @@ class DriftClient {
      * @param newOrderType: Optional - New order type for the order.
      * @param newTriggerPrice: Optional - Thew new trigger price for the order.
      * @param isSpot: Set to true if the order is a spot 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
      * @returns
      */
-    async modifyOrderByUserOrderId({ userOrderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, isSpot, }) {
+    async modifyOrderByUserOrderId({ userOrderId, newBaseAmount, newLimitPrice, newOraclePriceOffset, newOrderType, newTriggerPrice, newTriggerCondition, isSpot, auctionDuration, auctionStartPrice, auctionEndPrice, }) {
         if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
             throw new Error(`Must provide newBaseAmount or newLimitPrice or newOraclePriceOffset to modify order`);
         }
@@ -1936,23 +1892,37 @@ class DriftClient {
             throw new Error(`No open order with user order id ${userOrderId.toString()}`);
         }
         const cancelOrderIx = await this.getCancelOrderByUserIdIx(userOrderId);
+        const orderTypeHasTrigger = newOrderType
+            ? types_1.isOneOfVariant(newOrderType, ['triggerlimit', 'triggerMarket'])
+            : types_1.isOneOfVariant(openOrder.orderType, ['triggerLimit', 'triggerMarket']);
+        const orderTypeHasLimitPrice = newOrderType
+            ? types_1.isOneOfVariant(newOrderType, ['triggerLimit', 'limit'])
+            : types_1.isOneOfVariant(openOrder.orderType, ['triggerLimit', 'limit']);
         const newOrderParams = {
             orderType: newOrderType || openOrder.orderType,
             marketType: openOrder.marketType,
             direction: openOrder.direction,
             baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-            price: newLimitPrice || openOrder.price,
+            price: orderTypeHasLimitPrice
+                ? newLimitPrice || openOrder.price
+                : undefined,
             marketIndex: openOrder.marketIndex,
             reduceOnly: openOrder.reduceOnly,
-            postOnly: openOrder.postOnly,
+            postOnly: openOrder.postOnly
+                ? types_1.PostOnlyParams.MUST_POST_ONLY
+                : types_1.PostOnlyParams.NONE,
             immediateOrCancel: openOrder.immediateOrCancel,
-            triggerPrice: newTriggerPrice || openOrder.triggerPrice,
-            triggerCondition: openOrder.triggerCondition,
+            triggerPrice: orderTypeHasTrigger
+                ? newTriggerPrice || openOrder.triggerPrice
+                : undefined,
+            triggerCondition: orderTypeHasTrigger
+                ? newTriggerCondition || openOrder.triggerCondition
+                : undefined,
             oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-            auctionDuration: openOrder.auctionDuration,
+            auctionDuration: auctionDuration || openOrder.auctionDuration,
             maxTs: openOrder.maxTs,
-            auctionStartPrice: openOrder.auctionStartPrice,
-            auctionEndPrice: openOrder.auctionEndPrice,
+            auctionStartPrice: auctionStartPrice || openOrder.auctionStartPrice,
+            auctionEndPrice: auctionEndPrice || openOrder.auctionEndPrice,
             userOrderId: openOrder.userOrderId,
         };
         const placeOrderIx = isSpot

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.16.0",
+    "version": "2.17.0-beta.0",
     "name": "drift",
     "instructions": [
         {
@@ -4655,7 +4655,9 @@
                     },
                     {
                         "name": "postOnly",
-                        "type": "bool"
+                        "type": {
+                            "defined": "PostOnlyParam"
+                        }
                     },
                     {
                         "name": "immediateOrCancel",
@@ -5862,6 +5864,23 @@
                 ]
             }
         },
+        {
+            "name": "PostOnlyParam",
+            "type": {
+                "kind": "enum",
+                "variants": [
+                    {
+                        "name": "None"
+                    },
+                    {
+                        "name": "MustPostOnly"
+                    },
+                    {
+                        "name": "TryPostOnly"
+                    }
+                ]
+            }
+        },
         {
             "name": "TwapPeriod",
             "type": {

package/lib/types.d.ts

@@ -886,7 +886,7 @@ export declare type OrderParams = {
     price: BN;
     marketIndex: number;
     reduceOnly: boolean;
-    postOnly: boolean;
+    postOnly: PostOnlyParams;
     immediateOrCancel: boolean;
     triggerPrice: BN | null;
     triggerCondition: OrderTriggerCondition;
@@ -897,6 +897,17 @@ export declare type OrderParams = {
     auctionStartPrice: BN | null;
     auctionEndPrice: BN | null;
 };
+export declare class PostOnlyParams {
+    static readonly NONE: {
+        none: {};
+    };
+    static readonly MUST_POST_ONLY: {
+        mustPostOnly: {};
+    };
+    static readonly TRY_POST_ONLY: {
+        tryPostOnly: {};
+    };
+}
 export declare type NecessaryOrderParams = {
     orderType: OrderType;
     marketIndex: number;

package/lib/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultOrderParams = 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.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;
@@ -232,6 +232,12 @@ LiquidationType.BORROW_BANKRUPTCY = {
 LiquidationType.LIQUIDATE_SPOT = {
     liquidateSpot: {},
 };
+class PostOnlyParams {
+}
+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
 exports.DefaultOrderParams = {
     orderType: OrderType.MARKET,
     marketType: MarketType.PERP,
@@ -241,7 +247,7 @@ exports.DefaultOrderParams = {
     price: _1.ZERO,
     marketIndex: 0,
     reduceOnly: false,
-    postOnly: false,
+    postOnly: PostOnlyParams.NONE,
     immediateOrCancel: false,
     triggerPrice: null,
     triggerCondition: OrderTriggerCondition.ABOVE,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.16.0",
+	"version": "2.17.0-beta.0",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",
@@ -53,10 +53,11 @@
 		"eslint-plugin-prettier": "^3.4.0",
 		"mocha": "^10.0.0",
 		"prettier": "^2.4.1",
-		"ts-node": "^10.8.0"
+		"ts-node": "^10.8.0",
+		"typescript": "^4.9.5"
 	},
 	"description": "SDK for Drift Protocol",
 	"engines": {
 		"node": ">=12"
 	}
-}
+}

package/src/driftClient.ts

@@ -25,6 +25,9 @@ import {
 	TxParams,
 	SerumV3FulfillmentConfigAccount,
 	isVariant,
+	OrderTriggerCondition,
+	isOneOfVariant,
+	PostOnlyParams,
 } from './types';
 import * as anchor from '@project-serum/anchor';
 import driftIDL from './idl/drift.json';
@@ -3049,51 +3052,35 @@ export class DriftClient {
 		newLimitPrice?: BN,
 		newOraclePriceOffset?: number
 	): Promise<TransactionSignature> {
-		if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
-			throw new Error(
-				`Must provide newBaseAmount or newLimitPrice or newOraclePriceOffset to modify order`
-			);
-		}
-
-		const openOrder = this.getUser().getOrder(orderId);
-		if (!openOrder) {
-			throw new Error(`No open order with id ${orderId.toString()}`);
-		}
-		const cancelOrderIx = await this.getCancelOrderIx(orderId);
-
-		const newOrderParams: OptionalOrderParams = {
-			orderType: openOrder.orderType,
-			marketType: openOrder.marketType,
-			direction: openOrder.direction,
-			baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-			price: newLimitPrice || openOrder.price,
-			marketIndex: openOrder.marketIndex,
-			reduceOnly: openOrder.reduceOnly,
-			postOnly: openOrder.postOnly,
-			immediateOrCancel: openOrder.immediateOrCancel,
-			triggerPrice: openOrder.triggerPrice,
-			triggerCondition: openOrder.triggerCondition,
-			oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-			auctionDuration: openOrder.auctionDuration,
-			maxTs: openOrder.maxTs,
-			auctionStartPrice: openOrder.auctionStartPrice,
-			auctionEndPrice: openOrder.auctionEndPrice,
-			userOrderId: openOrder.userOrderId,
-		};
-		const placeOrderIx = await this.getPlacePerpOrderIx(newOrderParams);
+		return this.modifyOrder({
+			orderId,
+			newBaseAmount,
+			newLimitPrice,
+			newOraclePriceOffset,
+		});
+	}
 
-		const tx = new Transaction();
-		tx.add(
-			ComputeBudgetProgram.requestUnits({
-				units: 1_000_000,
-				additionalFee: 0,
-			})
-		);
-		tx.add(cancelOrderIx);
-		tx.add(placeOrderIx);
-		const { txSig, slot } = await this.sendTransaction(tx, [], this.opts);
-		this.perpMarketLastSlotCache.set(newOrderParams.marketIndex, slot);
-		return txSig;
+	/**
+	 * Modifies an open order by closing it and replacing it with a new order.
+	 * @deprecated use modifyOrderByUserOrderId instead
+	 * @param userOrderId: The open order to modify
+	 * @param newBaseAmount: The new base amount for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+	 * @param newLimitPice: The new limit price for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+	 * @param newOraclePriceOffset: The new oracle price offset for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
+	 * @returns
+	 */
+	public async modifyPerpOrderByUserOrderId(
+		userOrderId: number,
+		newBaseAmount?: BN,
+		newLimitPrice?: BN,
+		newOraclePriceOffset?: number
+	): Promise<TransactionSignature> {
+		return this.modifyOrderByUserOrderId({
+			userOrderId,
+			newBaseAmount,
+			newLimitPrice,
+			newOraclePriceOffset,
+		});
 	}
 
 	/**
@@ -3105,6 +3092,9 @@ export class DriftClient {
 	 * @param newOrderType: Optional - New order type for the order.
 	 * @param newTriggerPrice: Optional - Thew new trigger price for the order.
 	 * @param isSpot: Optional - Set to true if the order is a spot 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
 	 * @returns
 	 */
 	public async modifyOrder({
@@ -3114,7 +3104,11 @@ export class DriftClient {
 		newOraclePriceOffset,
 		newOrderType,
 		newTriggerPrice,
+		newTriggerCondition,
 		isSpot,
+		auctionDuration,
+		auctionStartPrice,
+		auctionEndPrice,
 	}: {
 		orderId: number;
 		newBaseAmount?: BN;
@@ -3122,7 +3116,11 @@ export class DriftClient {
 		newOraclePriceOffset?: number;
 		newOrderType?: OrderType;
 		newTriggerPrice?: BN;
+		newTriggerCondition?: OrderTriggerCondition;
 		isSpot?: boolean;
+		auctionDuration?: number;
+		auctionStartPrice?: BN;
+		auctionEndPrice?: BN;
 	}): Promise<TransactionSignature> {
 		if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
 			throw new Error(
@@ -3136,23 +3134,38 @@ export class DriftClient {
 		}
 		const cancelOrderIx = await this.getCancelOrderIx(orderId);
 
+		const orderTypeHasTrigger = newOrderType
+			? isOneOfVariant(newOrderType, ['triggerlimit', 'triggerMarket'])
+			: isOneOfVariant(openOrder.orderType, ['triggerLimit', 'triggerMarket']);
+		const orderTypeHasLimitPrice = newOrderType
+			? isOneOfVariant(newOrderType, ['triggerLimit', 'limit'])
+			: isOneOfVariant(openOrder.orderType, ['triggerLimit', 'limit']);
+
 		const newOrderParams: OptionalOrderParams = {
 			orderType: newOrderType || openOrder.orderType,
 			marketType: openOrder.marketType,
 			direction: openOrder.direction,
 			baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-			price: newLimitPrice || openOrder.price,
+			price: orderTypeHasLimitPrice
+				? newLimitPrice || openOrder.price
+				: undefined,
 			marketIndex: openOrder.marketIndex,
 			reduceOnly: openOrder.reduceOnly,
-			postOnly: openOrder.postOnly,
+			postOnly: openOrder.postOnly
+				? PostOnlyParams.MUST_POST_ONLY
+				: PostOnlyParams.NONE,
 			immediateOrCancel: openOrder.immediateOrCancel,
-			triggerPrice: newTriggerPrice || openOrder.triggerPrice,
-			triggerCondition: openOrder.triggerCondition,
+			triggerPrice: orderTypeHasTrigger
+				? newTriggerPrice || openOrder.triggerPrice
+				: undefined,
+			triggerCondition: orderTypeHasTrigger
+				? newTriggerCondition || openOrder.triggerCondition
+				: undefined,
 			oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-			auctionDuration: openOrder.auctionDuration,
+			auctionDuration: auctionDuration || openOrder.auctionDuration,
 			maxTs: openOrder.maxTs,
-			auctionStartPrice: openOrder.auctionStartPrice,
-			auctionEndPrice: openOrder.auctionEndPrice,
+			auctionStartPrice: auctionStartPrice || openOrder.auctionStartPrice,
+			auctionEndPrice: auctionEndPrice || openOrder.auctionEndPrice,
 			userOrderId: openOrder.userOrderId,
 		};
 		const placeOrderIx = isSpot
@@ -3180,70 +3193,6 @@ export class DriftClient {
 		return txSig;
 	}
 
-	/**
-	 * Modifies an open order by closing it and replacing it with a new order.
-	 * @deprecated use modifyOrderByUserOrderId instead
-	 * @param userOrderId: The open order to modify
-	 * @param newBaseAmount: The new base amount for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-	 * @param newLimitPice: The new limit price for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-	 * @param newOraclePriceOffset: The new oracle price offset for the order. One of [newBaseAmount|newLimitPrice|newOraclePriceOffset] must be provided.
-	 * @returns
-	 */
-	public async modifyPerpOrderByUserOrderId(
-		userOrderId: number,
-		newBaseAmount?: BN,
-		newLimitPrice?: BN,
-		newOraclePriceOffset?: number
-	): Promise<TransactionSignature> {
-		if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
-			throw new Error(
-				`Must provide newBaseAmount or newLimitPrice or newOraclePriceOffset to modify order`
-			);
-		}
-
-		const openOrder = this.getUser().getOrderByUserOrderId(userOrderId);
-		if (!openOrder) {
-			throw new Error(
-				`No open order with user order id ${userOrderId.toString()}`
-			);
-		}
-		const cancelOrderIx = await this.getCancelOrderByUserIdIx(userOrderId);
-
-		const newOrderParams: OptionalOrderParams = {
-			orderType: openOrder.orderType,
-			marketType: openOrder.marketType,
-			direction: openOrder.direction,
-			baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-			price: newLimitPrice || openOrder.price,
-			marketIndex: openOrder.marketIndex,
-			reduceOnly: openOrder.reduceOnly,
-			postOnly: openOrder.postOnly,
-			immediateOrCancel: openOrder.immediateOrCancel,
-			triggerPrice: openOrder.triggerPrice,
-			triggerCondition: openOrder.triggerCondition,
-			oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-			auctionDuration: openOrder.auctionDuration,
-			maxTs: openOrder.maxTs,
-			auctionStartPrice: openOrder.auctionStartPrice,
-			auctionEndPrice: openOrder.auctionEndPrice,
-			userOrderId: openOrder.userOrderId,
-		};
-		const placeOrderIx = await this.getPlacePerpOrderIx(newOrderParams);
-
-		const tx = new Transaction();
-		tx.add(
-			ComputeBudgetProgram.requestUnits({
-				units: 1_000_000,
-				additionalFee: 0,
-			})
-		);
-		tx.add(cancelOrderIx);
-		tx.add(placeOrderIx);
-		const { txSig, slot } = await this.sendTransaction(tx, [], this.opts);
-		this.perpMarketLastSlotCache.set(newOrderParams.marketIndex, slot);
-		return txSig;
-	}
-
 	/**
 	 * Modifies an open order by closing it and replacing it with a new order.
 	 * @param userOrderId: The open order to modify
@@ -3253,6 +3202,9 @@ export class DriftClient {
 	 * @param newOrderType: Optional - New order type for the order.
 	 * @param newTriggerPrice: Optional - Thew new trigger price for the order.
 	 * @param isSpot: Set to true if the order is a spot 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
 	 * @returns
 	 */
 	public async modifyOrderByUserOrderId({
@@ -3262,7 +3214,11 @@ export class DriftClient {
 		newOraclePriceOffset,
 		newOrderType,
 		newTriggerPrice,
+		newTriggerCondition,
 		isSpot,
+		auctionDuration,
+		auctionStartPrice,
+		auctionEndPrice,
 	}: {
 		userOrderId: number;
 		newBaseAmount?: BN;
@@ -3270,7 +3226,11 @@ export class DriftClient {
 		newOraclePriceOffset?: number;
 		newOrderType?: OrderType;
 		newTriggerPrice?: BN;
+		newTriggerCondition?: OrderTriggerCondition;
 		isSpot?: boolean;
+		auctionDuration?: number;
+		auctionStartPrice?: BN;
+		auctionEndPrice?: BN;
 	}): Promise<TransactionSignature> {
 		if (!newBaseAmount && !newLimitPrice && !newOraclePriceOffset) {
 			throw new Error(
@@ -3286,23 +3246,38 @@ export class DriftClient {
 		}
 		const cancelOrderIx = await this.getCancelOrderByUserIdIx(userOrderId);
 
+		const orderTypeHasTrigger = newOrderType
+			? isOneOfVariant(newOrderType, ['triggerlimit', 'triggerMarket'])
+			: isOneOfVariant(openOrder.orderType, ['triggerLimit', 'triggerMarket']);
+		const orderTypeHasLimitPrice = newOrderType
+			? isOneOfVariant(newOrderType, ['triggerLimit', 'limit'])
+			: isOneOfVariant(openOrder.orderType, ['triggerLimit', 'limit']);
+
 		const newOrderParams: OptionalOrderParams = {
 			orderType: newOrderType || openOrder.orderType,
 			marketType: openOrder.marketType,
 			direction: openOrder.direction,
 			baseAssetAmount: newBaseAmount || openOrder.baseAssetAmount,
-			price: newLimitPrice || openOrder.price,
+			price: orderTypeHasLimitPrice
+				? newLimitPrice || openOrder.price
+				: undefined,
 			marketIndex: openOrder.marketIndex,
 			reduceOnly: openOrder.reduceOnly,
-			postOnly: openOrder.postOnly,
+			postOnly: openOrder.postOnly
+				? PostOnlyParams.MUST_POST_ONLY
+				: PostOnlyParams.NONE,
 			immediateOrCancel: openOrder.immediateOrCancel,
-			triggerPrice: newTriggerPrice || openOrder.triggerPrice,
-			triggerCondition: openOrder.triggerCondition,
+			triggerPrice: orderTypeHasTrigger
+				? newTriggerPrice || openOrder.triggerPrice
+				: undefined,
+			triggerCondition: orderTypeHasTrigger
+				? newTriggerCondition || openOrder.triggerCondition
+				: undefined,
 			oraclePriceOffset: newOraclePriceOffset || openOrder.oraclePriceOffset,
-			auctionDuration: openOrder.auctionDuration,
+			auctionDuration: auctionDuration || openOrder.auctionDuration,
 			maxTs: openOrder.maxTs,
-			auctionStartPrice: openOrder.auctionStartPrice,
-			auctionEndPrice: openOrder.auctionEndPrice,
+			auctionStartPrice: auctionStartPrice || openOrder.auctionStartPrice,
+			auctionEndPrice: auctionEndPrice || openOrder.auctionEndPrice,
 			userOrderId: openOrder.userOrderId,
 		};
 		const placeOrderIx = isSpot

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.16.0",
+  "version": "2.17.0-beta.0",
   "name": "drift",
   "instructions": [
     {
@@ -4655,7 +4655,9 @@
           },
           {
             "name": "postOnly",
-            "type": "bool"
+            "type": {
+              "defined": "PostOnlyParam"
+            }
           },
           {
             "name": "immediateOrCancel",
@@ -5862,6 +5864,23 @@
         ]
       }
     },
+    {
+      "name": "PostOnlyParam",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "None"
+          },
+          {
+            "name": "MustPostOnly"
+          },
+          {
+            "name": "TryPostOnly"
+          }
+        ]
+      }
+    },
     {
       "name": "TwapPeriod",
       "type": {

package/src/types.ts

@@ -846,7 +846,7 @@ export type OrderParams = {
 	price: BN;
 	marketIndex: number;
 	reduceOnly: boolean;
-	postOnly: boolean;
+	postOnly: PostOnlyParams;
 	immediateOrCancel: boolean;
 	triggerPrice: BN | null;
 	triggerCondition: OrderTriggerCondition;
@@ -858,6 +858,12 @@ export type OrderParams = {
 	auctionEndPrice: BN | null;
 };
 
+export class PostOnlyParams {
+	static readonly NONE = { none: {} };
+	static readonly MUST_POST_ONLY = { mustPostOnly: {} }; // Tx fails if order can't be post only
+	static readonly TRY_POST_ONLY = { tryPostOnly: {} }; // Tx succeeds and order not placed if can't be post only
+}
+
 export type NecessaryOrderParams = {
 	orderType: OrderType;
 	marketIndex: number;
@@ -878,7 +884,7 @@ export const DefaultOrderParams: OrderParams = {
 	price: ZERO,
 	marketIndex: 0,
 	reduceOnly: false,
-	postOnly: false,
+	postOnly: PostOnlyParams.NONE,
 	immediateOrCancel: false,
 	triggerPrice: null,
 	triggerCondition: OrderTriggerCondition.ABOVE,