@drift-labs/sdk-browser 2.157.0-beta.8 → 2.158.0-beta.1

package/VERSION

@@ -1 +1 @@
-2.157.0-beta.8
+2.158.0-beta.1

package/lib/browser/driftClient.d.ts

@@ -5,7 +5,7 @@
 import * as anchor from '@coral-xyz/anchor';
 import { AnchorProvider, BN, Program, ProgramAccount } from '@coral-xyz/anchor';
 import { Idl as Idl30, Program as Program30 } from '@coral-xyz/anchor-30';
-import { DriftClientMetricsEvents, HighLeverageModeConfig, IWallet, MakerInfo, MappedRecord, MarketType, ModifyOrderPolicy, OpenbookV2FulfillmentConfigAccount, OptionalOrderParams, OracleSource, Order, OrderParams, OrderTriggerCondition, PerpMarketAccount, PerpMarketExtendedInfo, PhoenixV1FulfillmentConfigAccount, PlaceAndTakeOrderSuccessCondition, PositionDirection, ReferrerInfo, ReferrerNameAccount, SerumV3FulfillmentConfigAccount, SettlePnlMode, SignedTxData, SpotMarketAccount, SpotPosition, StateAccount, SwapReduceOnly, SignedMsgOrderParamsMessage, TxParams, UserAccount, UserStatsAccount, ProtectedMakerModeConfig, SignedMsgOrderParamsDelegateMessage, PostOnlyParams, LPPoolAccount, ConstituentAccount, ConstituentTargetBaseAccount, AmmCache } from './types';
+import { DriftClientMetricsEvents, HighLeverageModeConfig, IWallet, MakerInfo, MappedRecord, MarketType, ModifyOrderPolicy, OpenbookV2FulfillmentConfigAccount, OptionalOrderParams, OracleSource, Order, OrderParams, OrderTriggerCondition, PerpMarketAccount, PerpMarketExtendedInfo, PhoenixV1FulfillmentConfigAccount, PlaceAndTakeOrderSuccessCondition, PositionDirection, ReferrerInfo, ReferrerNameAccount, ScaleOrderParams, SerumV3FulfillmentConfigAccount, SettlePnlMode, SignedTxData, SpotMarketAccount, SpotPosition, StateAccount, SwapReduceOnly, SignedMsgOrderParamsMessage, TxParams, UserAccount, UserStatsAccount, ProtectedMakerModeConfig, SignedMsgOrderParamsDelegateMessage, PostOnlyParams, LPPoolAccount, ConstituentAccount, ConstituentTargetBaseAccount, AmmCache } from './types';
 import { AccountMeta, AddressLookupTableAccount, BlockhashWithExpiryBlockHeight, ConfirmOptions, Connection, Keypair, PublicKey, Signer, Transaction, TransactionInstruction, TransactionSignature, TransactionVersion, VersionedTransaction } from '@solana/web3.js';
 import { TokenFaucet } from './tokenFaucet';
 import { EventEmitter } from 'events';
@@ -578,6 +578,18 @@ export declare class DriftClient {
         authority?: PublicKey;
     }): Promise<TransactionInstruction>;
     getPlaceOrdersAndSetPositionMaxLevIx(params: OptionalOrderParams[], positionMaxLev: number, subAccountId?: number): Promise<TransactionInstruction[]>;
+    /**
+     * Place scale orders: multiple limit orders distributed across a price range
+     * @param params Scale order parameters
+     * @param txParams Optional transaction parameters
+     * @param subAccountId Optional sub account ID
+     * @returns Transaction signature
+     */
+    placeScaleOrders(params: ScaleOrderParams, txParams?: TxParams, subAccountId?: number): Promise<TransactionSignature>;
+    preparePlaceScaleOrdersTx(params: ScaleOrderParams, txParams?: TxParams, subAccountId?: number): Promise<{
+        placeScaleOrdersTx: anchor.web3.Transaction | anchor.web3.VersionedTransaction;
+    }>;
+    getPlaceScaleOrdersIx(params: ScaleOrderParams, subAccountId?: number): Promise<TransactionInstruction>;
     fillPerpOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Pick<Order, 'marketIndex' | 'orderId'>, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, txParams?: TxParams, fillerSubAccountId?: number, fillerAuthority?: PublicKey, hasBuilderFee?: boolean): Promise<TransactionSignature>;
     getFillPerpOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Pick<Order, 'marketIndex' | 'orderId'>, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, fillerSubAccountId?: number, isSignedMsg?: boolean, fillerAuthority?: PublicKey, hasBuilderFee?: boolean): Promise<TransactionInstruction>;
     getRevertFillIx(fillerPublicKey?: PublicKey): Promise<TransactionInstruction>;

package/lib/browser/driftClient.js

@@ -2282,13 +2282,14 @@ class DriftClient {
             const quoteSpotMarketIndex = perpMarketAccount.quoteSpotMarketIndex;
             associatedTokenAccount = await this.getAssociatedTokenAccount(quoteSpotMarketIndex);
         }
-        const withdrawIx = await this.getWithdrawFromIsolatedPerpPositionIx(amountToWithdraw, perpMarketIndex, associatedTokenAccount, subAccountId);
-        const ixs = [withdrawIx];
+        const ixs = [];
         const needsToSettle = amount.gt(tokenAmountDeposited) && isolatedPositionUnrealizedPnl.gt(numericConstants_1.ZERO);
         if (needsToSettle) {
             const settleIx = await this.settleMultiplePNLsIx(userAccountPublicKey, userAccount, [perpMarketIndex], types_1.SettlePnlMode.TRY_SETTLE);
             ixs.push(settleIx);
         }
+        const withdrawIx = await this.getWithdrawFromIsolatedPerpPositionIx(amountToWithdraw, perpMarketIndex, associatedTokenAccount, subAccountId);
+        ixs.push(withdrawIx);
         return ixs;
     }
     async getWithdrawFromIsolatedPerpPositionIx(amount, perpMarketIndex, userTokenAccount, subAccountId) {
@@ -2867,6 +2868,65 @@ class DriftClient {
         const setPositionMaxLevIxs = await this.getUpdateUserPerpPositionCustomMarginRatioIx(readablePerpMarketIndex[0], marginRatio, subAccountId);
         return [placeOrdersIxs, setPositionMaxLevIxs];
     }
+    /**
+     * Place scale orders: multiple limit orders distributed across a price range
+     * @param params Scale order parameters
+     * @param txParams Optional transaction parameters
+     * @param subAccountId Optional sub account ID
+     * @returns Transaction signature
+     */
+    async placeScaleOrders(params, txParams, subAccountId) {
+        const { txSig } = await this.sendTransaction((await this.preparePlaceScaleOrdersTx(params, txParams, subAccountId))
+            .placeScaleOrdersTx, [], this.opts, false);
+        return txSig;
+    }
+    async preparePlaceScaleOrdersTx(params, txParams, subAccountId) {
+        const lookupTableAccounts = await this.fetchAllLookupTableAccounts();
+        const tx = await this.buildTransaction(await this.getPlaceScaleOrdersIx(params, subAccountId), txParams, undefined, lookupTableAccounts);
+        return {
+            placeScaleOrdersTx: tx,
+        };
+    }
+    async getPlaceScaleOrdersIx(params, subAccountId) {
+        const user = await this.getUserAccountPublicKey(subAccountId);
+        const isPerp = (0, types_1.isVariant)(params.marketType, 'perp');
+        const remainingAccounts = this.getRemainingAccounts({
+            userAccounts: [this.getUserAccount(subAccountId)],
+            readablePerpMarketIndex: isPerp ? [params.marketIndex] : [],
+            readableSpotMarketIndexes: isPerp ? [] : [params.marketIndex],
+            useMarketLastSlotCache: true,
+        });
+        if ((0, orderParams_1.isUpdateHighLeverageMode)(params.bitFlags)) {
+            remainingAccounts.push({
+                pubkey: (0, pda_1.getHighLeverageModeConfigPublicKey)(this.program.programId),
+                isWritable: true,
+                isSigner: false,
+            });
+        }
+        const formattedParams = {
+            marketType: params.marketType,
+            direction: params.direction,
+            marketIndex: params.marketIndex,
+            totalBaseAssetAmount: params.totalBaseAssetAmount,
+            startPrice: params.startPrice,
+            endPrice: params.endPrice,
+            orderCount: params.orderCount,
+            sizeDistribution: params.sizeDistribution,
+            reduceOnly: params.reduceOnly,
+            postOnly: params.postOnly,
+            bitFlags: params.bitFlags,
+            maxTs: params.maxTs,
+        };
+        return await this.program.instruction.placeScaleOrders(formattedParams, {
+            accounts: {
+                state: await this.getStatePublicKey(),
+                user,
+                userStats: this.getUserStatsAccountPublicKey(),
+                authority: this.wallet.publicKey,
+            },
+            remainingAccounts,
+        });
+    }
     async fillPerpOrder(userAccountPublicKey, user, order, makerInfo, referrerInfo, txParams, fillerSubAccountId, fillerAuthority, hasBuilderFee) {
         const { txSig } = await this.sendTransaction(await this.buildTransaction(await this.getFillPerpOrderIx(userAccountPublicKey, user, order, makerInfo, referrerInfo, fillerSubAccountId, undefined, fillerAuthority, hasBuilderFee), txParams), [], this.opts);
         return txSig;

package/lib/browser/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.156.0",
+    "version": "2.157.0",
     "name": "drift",
     "instructions": [
         {
@@ -1382,6 +1382,34 @@
                 }
             ]
         },
+        {
+            "name": "placeScaleOrders",
+            "accounts": [
+                {
+                    "name": "state",
+                    "isMut": false,
+                    "isSigner": false
+                },
+                {
+                    "name": "user",
+                    "isMut": true,
+                    "isSigner": false
+                },
+                {
+                    "name": "authority",
+                    "isMut": false,
+                    "isSigner": true
+                }
+            ],
+            "args": [
+                {
+                    "name": "params",
+                    "type": {
+                        "defined": "ScaleOrderParams"
+                    }
+                }
+            ]
+        },
         {
             "name": "beginSwap",
             "accounts": [
@@ -13260,6 +13288,102 @@
                 ]
             }
         },
+        {
+            "name": "ScaleOrderParams",
+            "docs": [
+                "Parameters for placing scale orders - multiple limit orders distributed across a price range"
+            ],
+            "type": {
+                "kind": "struct",
+                "fields": [
+                    {
+                        "name": "marketType",
+                        "type": {
+                            "defined": "MarketType"
+                        }
+                    },
+                    {
+                        "name": "direction",
+                        "type": {
+                            "defined": "PositionDirection"
+                        }
+                    },
+                    {
+                        "name": "marketIndex",
+                        "type": "u16"
+                    },
+                    {
+                        "name": "totalBaseAssetAmount",
+                        "docs": [
+                            "Total base asset amount to distribute across all orders"
+                        ],
+                        "type": "u64"
+                    },
+                    {
+                        "name": "startPrice",
+                        "docs": [
+                            "Starting price for the scale (in PRICE_PRECISION)"
+                        ],
+                        "type": "u64"
+                    },
+                    {
+                        "name": "endPrice",
+                        "docs": [
+                            "Ending price for the scale (in PRICE_PRECISION)"
+                        ],
+                        "type": "u64"
+                    },
+                    {
+                        "name": "orderCount",
+                        "docs": [
+                            "Number of orders to place (min 2, max 32)"
+                        ],
+                        "type": "u8"
+                    },
+                    {
+                        "name": "sizeDistribution",
+                        "docs": [
+                            "How to distribute sizes across orders"
+                        ],
+                        "type": {
+                            "defined": "SizeDistribution"
+                        }
+                    },
+                    {
+                        "name": "reduceOnly",
+                        "docs": [
+                            "Whether orders should be reduce-only"
+                        ],
+                        "type": "bool"
+                    },
+                    {
+                        "name": "postOnly",
+                        "docs": [
+                            "Post-only setting for all orders"
+                        ],
+                        "type": {
+                            "defined": "PostOnlyParam"
+                        }
+                    },
+                    {
+                        "name": "bitFlags",
+                        "docs": [
+                            "Bit flags (e.g., for high leverage mode)"
+                        ],
+                        "type": "u8"
+                    },
+                    {
+                        "name": "maxTs",
+                        "docs": [
+                            "Maximum timestamp for orders to be valid"
+                        ],
+                        "type": {
+                            "option": "i64"
+                        }
+                    }
+                ]
+            }
+        },
         {
             "name": "InsuranceClaim",
             "type": {
@@ -15607,6 +15731,26 @@
                 ]
             }
         },
+        {
+            "name": "SizeDistribution",
+            "docs": [
+                "How to distribute order sizes across scale orders"
+            ],
+            "type": {
+                "kind": "enum",
+                "variants": [
+                    {
+                        "name": "Flat"
+                    },
+                    {
+                        "name": "Ascending"
+                    },
+                    {
+                        "name": "Descending"
+                    }
+                ]
+            }
+        },
         {
             "name": "PerpOperation",
             "type": {
@@ -19824,9 +19968,16 @@
             "code": 6345,
             "name": "InvalidIsolatedPerpMarket",
             "msg": "Invalid Isolated Perp Market"
+        },
+        {
+            "code": 6346,
+            "name": "InvalidOrderScaleOrderCount",
+            "msg": "Invalid scale order count - must be between 2 and 10"
+        },
+        {
+            "code": 6347,
+            "name": "InvalidOrderScalePriceRange",
+            "msg": "Invalid scale order price range"
         }
-    ],
-    "metadata": {
-        "address": "dRiftyHA39MWEi3m9aunc5MzRF1JYuBsbn6VPcn33UH"
-    }
+    ]
 }

package/lib/browser/types.d.ts

@@ -1346,6 +1346,46 @@ export declare class PostOnlyParams {
         slide: {};
     };
 }
+/**
+ * How to distribute order sizes across scale orders
+ */
+export declare class SizeDistribution {
+    static readonly FLAT: {
+        flat: {};
+    };
+    static readonly ASCENDING: {
+        ascending: {};
+    };
+    static readonly DESCENDING: {
+        descending: {};
+    };
+}
+/**
+ * Parameters for placing scale orders - multiple limit orders distributed across a price range
+ */
+export type ScaleOrderParams = {
+    marketType: MarketType;
+    direction: PositionDirection;
+    marketIndex: number;
+    /** Total base asset amount to distribute across all orders */
+    totalBaseAssetAmount: BN;
+    /** Starting price for the scale (in PRICE_PRECISION) */
+    startPrice: BN;
+    /** Ending price for the scale (in PRICE_PRECISION) */
+    endPrice: BN;
+    /** Number of orders to place (min 2, max 32). User cannot exceed 32 total open orders. */
+    orderCount: number;
+    /** How to distribute sizes across orders */
+    sizeDistribution: SizeDistribution;
+    /** Whether orders should be reduce-only */
+    reduceOnly: boolean;
+    /** Post-only setting for all orders */
+    postOnly: PostOnlyParams;
+    /** Bit flags (e.g., for high leverage mode) */
+    bitFlags: number;
+    /** Maximum timestamp for orders to be valid */
+    maxTs: BN | null;
+};
 export declare class OrderParamsBitFlag {
     static readonly ImmediateOrCancel = 1;
     static readonly UpdateHighLeverageMode = 2;

package/lib/browser/types.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OracleValidity = exports.SwapReduceOnly = exports.PlaceAndTakeOrderSuccessCondition = exports.FuelOverflowStatus = exports.ReferrerStatus = exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PositionFlag = exports.OrderParamsBitFlag = exports.PostOnlyParams = exports.LiquidationBitFlag = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.SettlePnlMode = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderBitFlag = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSourceNum = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.TokenProgramFlag = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.MarginMode = exports.UserStatsPausedOperation = exports.UserStatus = exports.InsuranceFundOperation = exports.SpotOperation = exports.PerpOperation = exports.MarketStatus = exports.FeatureBitFlags = exports.ExchangeStatus = void 0;
-exports.ConstituentLpOperation = exports.ConstituentStatus = void 0;
+exports.SwapReduceOnly = exports.PlaceAndTakeOrderSuccessCondition = exports.FuelOverflowStatus = exports.ReferrerStatus = exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PositionFlag = exports.OrderParamsBitFlag = exports.SizeDistribution = exports.PostOnlyParams = exports.LiquidationBitFlag = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.SettlePnlMode = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderBitFlag = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSourceNum = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.TokenProgramFlag = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.MarginMode = exports.UserStatsPausedOperation = exports.UserStatus = exports.InsuranceFundOperation = exports.SpotOperation = exports.PerpOperation = exports.MarketStatus = exports.FeatureBitFlags = exports.ExchangeStatus = void 0;
+exports.ConstituentLpOperation = exports.ConstituentStatus = exports.OracleValidity = void 0;
 const numericConstants_1 = require("./constants/numericConstants");
 // # Utility Types / Enums / Constants
 var ExchangeStatus;
@@ -371,6 +371,15 @@ 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
 PostOnlyParams.SLIDE = { slide: {} }; // Modify price to be post only if can't be post only
+/**
+ * How to distribute order sizes across scale orders
+ */
+class SizeDistribution {
+}
+exports.SizeDistribution = SizeDistribution;
+SizeDistribution.FLAT = { flat: {} }; // Equal size for all orders
+SizeDistribution.ASCENDING = { ascending: {} }; // Smallest at start price, largest at end price
+SizeDistribution.DESCENDING = { descending: {} }; // Largest at start price, smallest at end price
 class OrderParamsBitFlag {
 }
 exports.OrderParamsBitFlag = OrderParamsBitFlag;

package/lib/node/driftClient.d.ts

@@ -5,7 +5,7 @@
 import * as anchor from '@coral-xyz/anchor';
 import { AnchorProvider, BN, Program, ProgramAccount } from '@coral-xyz/anchor';
 import { Idl as Idl30, Program as Program30 } from '@coral-xyz/anchor-30';
-import { DriftClientMetricsEvents, HighLeverageModeConfig, IWallet, MakerInfo, MappedRecord, MarketType, ModifyOrderPolicy, OpenbookV2FulfillmentConfigAccount, OptionalOrderParams, OracleSource, Order, OrderParams, OrderTriggerCondition, PerpMarketAccount, PerpMarketExtendedInfo, PhoenixV1FulfillmentConfigAccount, PlaceAndTakeOrderSuccessCondition, PositionDirection, ReferrerInfo, ReferrerNameAccount, SerumV3FulfillmentConfigAccount, SettlePnlMode, SignedTxData, SpotMarketAccount, SpotPosition, StateAccount, SwapReduceOnly, SignedMsgOrderParamsMessage, TxParams, UserAccount, UserStatsAccount, ProtectedMakerModeConfig, SignedMsgOrderParamsDelegateMessage, PostOnlyParams, LPPoolAccount, ConstituentAccount, ConstituentTargetBaseAccount, AmmCache } from './types';
+import { DriftClientMetricsEvents, HighLeverageModeConfig, IWallet, MakerInfo, MappedRecord, MarketType, ModifyOrderPolicy, OpenbookV2FulfillmentConfigAccount, OptionalOrderParams, OracleSource, Order, OrderParams, OrderTriggerCondition, PerpMarketAccount, PerpMarketExtendedInfo, PhoenixV1FulfillmentConfigAccount, PlaceAndTakeOrderSuccessCondition, PositionDirection, ReferrerInfo, ReferrerNameAccount, ScaleOrderParams, SerumV3FulfillmentConfigAccount, SettlePnlMode, SignedTxData, SpotMarketAccount, SpotPosition, StateAccount, SwapReduceOnly, SignedMsgOrderParamsMessage, TxParams, UserAccount, UserStatsAccount, ProtectedMakerModeConfig, SignedMsgOrderParamsDelegateMessage, PostOnlyParams, LPPoolAccount, ConstituentAccount, ConstituentTargetBaseAccount, AmmCache } from './types';
 import { AccountMeta, AddressLookupTableAccount, BlockhashWithExpiryBlockHeight, ConfirmOptions, Connection, Keypair, PublicKey, Signer, Transaction, TransactionInstruction, TransactionSignature, TransactionVersion, VersionedTransaction } from '@solana/web3.js';
 import { TokenFaucet } from './tokenFaucet';
 import { EventEmitter } from 'events';
@@ -578,6 +578,18 @@ export declare class DriftClient {
         authority?: PublicKey;
     }): Promise<TransactionInstruction>;
     getPlaceOrdersAndSetPositionMaxLevIx(params: OptionalOrderParams[], positionMaxLev: number, subAccountId?: number): Promise<TransactionInstruction[]>;
+    /**
+     * Place scale orders: multiple limit orders distributed across a price range
+     * @param params Scale order parameters
+     * @param txParams Optional transaction parameters
+     * @param subAccountId Optional sub account ID
+     * @returns Transaction signature
+     */
+    placeScaleOrders(params: ScaleOrderParams, txParams?: TxParams, subAccountId?: number): Promise<TransactionSignature>;
+    preparePlaceScaleOrdersTx(params: ScaleOrderParams, txParams?: TxParams, subAccountId?: number): Promise<{
+        placeScaleOrdersTx: anchor.web3.Transaction | anchor.web3.VersionedTransaction;
+    }>;
+    getPlaceScaleOrdersIx(params: ScaleOrderParams, subAccountId?: number): Promise<TransactionInstruction>;
     fillPerpOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Pick<Order, 'marketIndex' | 'orderId'>, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, txParams?: TxParams, fillerSubAccountId?: number, fillerAuthority?: PublicKey, hasBuilderFee?: boolean): Promise<TransactionSignature>;
     getFillPerpOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Pick<Order, 'marketIndex' | 'orderId'>, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, fillerSubAccountId?: number, isSignedMsg?: boolean, fillerAuthority?: PublicKey, hasBuilderFee?: boolean): Promise<TransactionInstruction>;
     getRevertFillIx(fillerPublicKey?: PublicKey): Promise<TransactionInstruction>;