@drift-labs/sdk 2.31.1-beta.21 → 2.31.1-beta.23

package/VERSION

@@ -1 +1 @@
-2.31.1-beta.21
+2.31.1-beta.23

package/lib/driftClient.d.ts

@@ -273,7 +273,6 @@ export declare class DriftClient {
         signedFillTx: Transaction;
     }>;
     placePerpOrder(orderParams: OptionalOrderParams, txParams?: TxParams): Promise<TransactionSignature>;
-    getOrderParams(optionalOrderParams: OptionalOrderParams, marketType: MarketType): OrderParams;
     getPlacePerpOrderIx(orderParams: OptionalOrderParams): Promise<TransactionInstruction>;
     updateAMMs(marketIndexes: number[], txParams?: TxParams): Promise<TransactionSignature>;
     getUpdateAMMsIx(marketIndexes: number[]): Promise<TransactionInstruction>;

package/lib/driftClient.js

@@ -53,6 +53,7 @@ const fetch_1 = require("./accounts/fetch");
 const spotMarket_1 = require("./math/spotMarket");
 const memcmp_1 = require("./memcmp");
 const marinade_1 = require("./marinade");
+const orderParams_1 = require("./orderParams");
 /**
  * # DriftClient
  * This class is the main way to interact with Drift Protocol. It allows you to subscribe to the various accounts where the Market's state is stored, as well as: opening positions, liquidating, settling funding, depositing & withdrawing, and more.
@@ -1393,13 +1394,8 @@ class DriftClient {
         this.perpMarketLastSlotCache.set(orderParams.marketIndex, slot);
         return txSig;
     }
-    getOrderParams(optionalOrderParams, marketType) {
-        return Object.assign({}, types_1.DefaultOrderParams, optionalOrderParams, {
-            marketType,
-        });
-    }
     async getPlacePerpOrderIx(orderParams) {
-        orderParams = this.getOrderParams(orderParams, types_1.MarketType.PERP);
+        orderParams = (0, orderParams_1.getOrderParams)(orderParams, { marketType: types_1.MarketType.PERP });
         const userAccountPublicKey = await this.getUserAccountPublicKey();
         const remainingAccounts = this.getRemainingAccounts({
             userAccounts: [this.getUserAccount()],
@@ -1589,6 +1585,9 @@ class DriftClient {
         const readablePerpMarketIndex = [];
         const readableSpotMarketIndexes = [];
         for (const param of params) {
+            if (!param.marketType) {
+                throw new Error('must set param.marketType');
+            }
             if ((0, types_1.isVariant)(param.marketType, 'perp')) {
                 readablePerpMarketIndex.push(param.marketIndex);
             }
@@ -1696,7 +1695,7 @@ class DriftClient {
         return txSig;
     }
     async getPlaceSpotOrderIx(orderParams) {
-        orderParams = this.getOrderParams(orderParams, types_1.MarketType.SPOT);
+        orderParams = (0, orderParams_1.getOrderParams)(orderParams, { marketType: types_1.MarketType.SPOT });
         const userAccountPublicKey = await this.getUserAccountPublicKey();
         const remainingAccounts = this.getRemainingAccounts({
             userAccounts: [this.getUserAccount()],
@@ -2209,7 +2208,7 @@ class DriftClient {
         return txSig;
     }
     async getPlaceAndTakePerpOrderIx(orderParams, makerInfo, referrerInfo) {
-        orderParams = this.getOrderParams(orderParams, types_1.MarketType.PERP);
+        orderParams = (0, orderParams_1.getOrderParams)(orderParams, { marketType: types_1.MarketType.PERP });
         const userStatsPublicKey = await this.getUserStatsAccountPublicKey();
         const userAccountPublicKey = await this.getUserAccountPublicKey();
         makerInfo = Array.isArray(makerInfo)
@@ -2270,7 +2269,7 @@ class DriftClient {
         return txSig;
     }
     async getPlaceAndMakePerpOrderIx(orderParams, takerInfo, referrerInfo) {
-        orderParams = this.getOrderParams(orderParams, types_1.MarketType.PERP);
+        orderParams = (0, orderParams_1.getOrderParams)(orderParams, { marketType: types_1.MarketType.PERP });
         const userStatsPublicKey = this.getUserStatsAccountPublicKey();
         const userAccountPublicKey = await this.getUserAccountPublicKey();
         const remainingAccounts = this.getRemainingAccounts({
@@ -2310,7 +2309,7 @@ class DriftClient {
         return txSig;
     }
     async getPlaceAndTakeSpotOrderIx(orderParams, fulfillmentConfig, makerInfo, referrerInfo) {
-        orderParams = this.getOrderParams(orderParams, types_1.MarketType.SPOT);
+        orderParams = (0, orderParams_1.getOrderParams)(orderParams, { marketType: types_1.MarketType.SPOT });
         const userStatsPublicKey = await this.getUserStatsAccountPublicKey();
         const userAccountPublicKey = await this.getUserAccountPublicKey();
         const userAccounts = [this.getUserAccount()];
@@ -2369,7 +2368,7 @@ class DriftClient {
         return txSig;
     }
     async getPlaceAndMakeSpotOrderIx(orderParams, takerInfo, fulfillmentConfig, referrerInfo) {
-        orderParams = this.getOrderParams(orderParams, types_1.MarketType.SPOT);
+        orderParams = (0, orderParams_1.getOrderParams)(orderParams, { marketType: types_1.MarketType.SPOT });
         const userStatsPublicKey = this.getUserStatsAccountPublicKey();
         const userAccountPublicKey = await this.getUserAccountPublicKey();
         const remainingAccounts = this.getRemainingAccounts({

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.31.1-beta.20",
+    "version": "2.31.1-beta.22",
     "name": "drift",
     "instructions": [
         {

package/lib/orderParams.d.ts

@@ -1,15 +1,28 @@
-import { OptionalOrderParams, OrderTriggerCondition } from './types';
+import { OptionalOrderParams, OrderParams, OrderTriggerCondition } from './types';
 import { BN } from '@coral-xyz/anchor';
-export declare function getLimitOrderParams(params: Omit<OptionalOrderParams, 'orderType' | 'marketType'> & {
+export declare function getLimitOrderParams(params: Omit<OptionalOrderParams, 'orderType'> & {
     price: BN;
 }): OptionalOrderParams;
-export declare function getTriggerMarketOrderParams(params: Omit<OptionalOrderParams, 'orderType' | 'marketType'> & {
+export declare function getTriggerMarketOrderParams(params: Omit<OptionalOrderParams, 'orderType'> & {
     triggerCondition: OrderTriggerCondition;
     triggerPrice: BN;
 }): OptionalOrderParams;
-export declare function getTriggerLimitOrderParams(params: Omit<OptionalOrderParams, 'orderType' | 'marketType'> & {
+export declare function getTriggerLimitOrderParams(params: Omit<OptionalOrderParams, 'orderType'> & {
     triggerCondition: OrderTriggerCondition;
     triggerPrice: BN;
     price: BN;
 }): OptionalOrderParams;
-export declare function getMarketOrderParams(params: Omit<OptionalOrderParams, 'orderType' | 'marketType'>): OptionalOrderParams;
+export declare function getMarketOrderParams(params: Omit<OptionalOrderParams, 'orderType'>): OptionalOrderParams;
+/**
+ * Creates an OrderParams object with the given OptionalOrderParams and any params to override.
+ *
+ * example:
+ * ```
+ * const orderParams = getOrderParams(optionalOrderParams, { marketType: MarketType.PERP });
+ * ```
+ *
+ * @param optionalOrderParams
+ * @param overridingParams
+ * @returns
+ */
+export declare function getOrderParams(optionalOrderParams: OptionalOrderParams, overridingParams?: Record<string, any>): OrderParams;

package/lib/orderParams.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMarketOrderParams = exports.getTriggerLimitOrderParams = exports.getTriggerMarketOrderParams = exports.getLimitOrderParams = void 0;
+exports.getOrderParams = exports.getMarketOrderParams = exports.getTriggerLimitOrderParams = exports.getTriggerMarketOrderParams = exports.getLimitOrderParams = void 0;
 const types_1 = require("./types");
 function getLimitOrderParams(params) {
     return Object.assign({}, params, {
@@ -26,3 +26,19 @@ function getMarketOrderParams(params) {
     });
 }
 exports.getMarketOrderParams = getMarketOrderParams;
+/**
+ * Creates an OrderParams object with the given OptionalOrderParams and any params to override.
+ *
+ * example:
+ * ```
+ * const orderParams = getOrderParams(optionalOrderParams, { marketType: MarketType.PERP });
+ * ```
+ *
+ * @param optionalOrderParams
+ * @param overridingParams
+ * @returns
+ */
+function getOrderParams(optionalOrderParams, overridingParams = {}) {
+    return Object.assign({}, types_1.DefaultOrderParams, optionalOrderParams, overridingParams);
+}
+exports.getOrderParams = getOrderParams;

package/package.json

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

package/src/driftClient.ts

@@ -27,7 +27,6 @@ import {
 	MakerInfo,
 	TakerInfo,
 	OptionalOrderParams,
-	DefaultOrderParams,
 	OrderType,
 	ReferrerInfo,
 	MarketType,
@@ -118,6 +117,7 @@ import { JupiterClient, Route, SwapMode } from './jupiter/jupiterClient';
 import { getNonIdleUserFilter } from './memcmp';
 import { UserStatsSubscriptionConfig } from './userStatsConfig';
 import { getMarinadeDepositIx, getMarinadeFinanceProgram } from './marinade';
+import { getOrderParams } from './orderParams';
 
 type RemainingAccountParams = {
 	userAccounts: UserAccount[];
@@ -2522,19 +2522,10 @@ export class DriftClient {
 		return txSig;
 	}
 
-	getOrderParams(
-		optionalOrderParams: OptionalOrderParams,
-		marketType: MarketType
-	): OrderParams {
-		return Object.assign({}, DefaultOrderParams, optionalOrderParams, {
-			marketType,
-		});
-	}
-
 	public async getPlacePerpOrderIx(
 		orderParams: OptionalOrderParams
 	): Promise<TransactionInstruction> {
-		orderParams = this.getOrderParams(orderParams, MarketType.PERP);
+		orderParams = getOrderParams(orderParams, { marketType: MarketType.PERP });
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
 		const remainingAccounts = this.getRemainingAccounts({
@@ -2863,6 +2854,9 @@ export class DriftClient {
 		const readablePerpMarketIndex: number[] = [];
 		const readableSpotMarketIndexes: number[] = [];
 		for (const param of params) {
+			if (!param.marketType) {
+				throw new Error('must set param.marketType');
+			}
 			if (isVariant(param.marketType, 'perp')) {
 				readablePerpMarketIndex.push(param.marketIndex);
 			} else {
@@ -3028,7 +3022,7 @@ export class DriftClient {
 	public async getPlaceSpotOrderIx(
 		orderParams: OptionalOrderParams
 	): Promise<TransactionInstruction> {
-		orderParams = this.getOrderParams(orderParams, MarketType.SPOT);
+		orderParams = getOrderParams(orderParams, { marketType: MarketType.SPOT });
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
 		const remainingAccounts = this.getRemainingAccounts({
@@ -3888,7 +3882,7 @@ export class DriftClient {
 		makerInfo?: MakerInfo | MakerInfo[],
 		referrerInfo?: ReferrerInfo
 	): Promise<TransactionInstruction> {
-		orderParams = this.getOrderParams(orderParams, MarketType.PERP);
+		orderParams = getOrderParams(orderParams, { marketType: MarketType.PERP });
 		const userStatsPublicKey = await this.getUserStatsAccountPublicKey();
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
@@ -3984,7 +3978,7 @@ export class DriftClient {
 		takerInfo: TakerInfo,
 		referrerInfo?: ReferrerInfo
 	): Promise<TransactionInstruction> {
-		orderParams = this.getOrderParams(orderParams, MarketType.PERP);
+		orderParams = getOrderParams(orderParams, { marketType: MarketType.PERP });
 		const userStatsPublicKey = this.getUserStatsAccountPublicKey();
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
@@ -4056,7 +4050,7 @@ export class DriftClient {
 		makerInfo?: MakerInfo,
 		referrerInfo?: ReferrerInfo
 	): Promise<TransactionInstruction> {
-		orderParams = this.getOrderParams(orderParams, MarketType.SPOT);
+		orderParams = getOrderParams(orderParams, { marketType: MarketType.SPOT });
 		const userStatsPublicKey = await this.getUserStatsAccountPublicKey();
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
@@ -4154,7 +4148,7 @@ export class DriftClient {
 		fulfillmentConfig?: SerumV3FulfillmentConfigAccount,
 		referrerInfo?: ReferrerInfo
 	): Promise<TransactionInstruction> {
-		orderParams = this.getOrderParams(orderParams, MarketType.SPOT);
+		orderParams = getOrderParams(orderParams, { marketType: MarketType.SPOT });
 		const userStatsPublicKey = this.getUserStatsAccountPublicKey();
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.31.1-beta.21",
+  "version": "2.31.1-beta.23",
   "name": "drift",
   "instructions": [
     {

package/src/orderParams.ts

@@ -1,8 +1,14 @@
-import { OptionalOrderParams, OrderTriggerCondition, OrderType } from './types';
+import {
+	DefaultOrderParams,
+	OptionalOrderParams,
+	OrderParams,
+	OrderTriggerCondition,
+	OrderType,
+} from './types';
 import { BN } from '@coral-xyz/anchor';
 
 export function getLimitOrderParams(
-	params: Omit<OptionalOrderParams, 'orderType' | 'marketType'> & { price: BN }
+	params: Omit<OptionalOrderParams, 'orderType'> & { price: BN }
 ): OptionalOrderParams {
 	return Object.assign({}, params, {
 		orderType: OrderType.LIMIT,
@@ -10,7 +16,7 @@ export function getLimitOrderParams(
 }
 
 export function getTriggerMarketOrderParams(
-	params: Omit<OptionalOrderParams, 'orderType' | 'marketType'> & {
+	params: Omit<OptionalOrderParams, 'orderType'> & {
 		triggerCondition: OrderTriggerCondition;
 		triggerPrice: BN;
 	}
@@ -21,7 +27,7 @@ export function getTriggerMarketOrderParams(
 }
 
 export function getTriggerLimitOrderParams(
-	params: Omit<OptionalOrderParams, 'orderType' | 'marketType'> & {
+	params: Omit<OptionalOrderParams, 'orderType'> & {
 		triggerCondition: OrderTriggerCondition;
 		triggerPrice: BN;
 		price: BN;
@@ -33,9 +39,33 @@ export function getTriggerLimitOrderParams(
 }
 
 export function getMarketOrderParams(
-	params: Omit<OptionalOrderParams, 'orderType' | 'marketType'>
+	params: Omit<OptionalOrderParams, 'orderType'>
 ): OptionalOrderParams {
 	return Object.assign({}, params, {
 		orderType: OrderType.MARKET,
 	});
 }
+
+/**
+ * Creates an OrderParams object with the given OptionalOrderParams and any params to override.
+ *
+ * example:
+ * ```
+ * const orderParams = getOrderParams(optionalOrderParams, { marketType: MarketType.PERP });
+ * ```
+ *
+ * @param optionalOrderParams
+ * @param overridingParams
+ * @returns
+ */
+export function getOrderParams(
+	optionalOrderParams: OptionalOrderParams,
+	overridingParams: Record<string, any> = {}
+): OrderParams {
+	return Object.assign(
+		{},
+		DefaultOrderParams,
+		optionalOrderParams,
+		overridingParams
+	);
+}