@drift-labs/common 1.0.0

package/lib/drift/base/actions/trade/openPerpOrder/openSwiftOrder/index.d.ts

@@ -0,0 +1,166 @@
+import { SignedMsgOrderParamsDelegateMessage, SignedMsgOrderParamsMessage } from '@drift-labs/sdk';
+import { BN, DriftClient, OptionalOrderParams, PublicKey } from '@drift-labs/sdk';
+import { SwiftOrderEvent } from '../../../../../../clients/swiftClient';
+import { MarketId } from '../../../../../../types';
+import { Observable } from 'rxjs';
+export interface SwiftOrderOptions {
+    wallet: {
+        signMessage: (message: Uint8Array) => Promise<Uint8Array>;
+        publicKey: PublicKey;
+    };
+    swiftServerUrl: string;
+    signedMessageOrderSlotBuffer?: number;
+    confirmDuration?: number;
+    isDelegate?: boolean;
+}
+export type SwiftOrderResult = {
+    swiftOrderObservable: Observable<SwiftOrderEvent>;
+    swiftOrderUuid: Uint8Array;
+};
+export interface OptionalTriggerOrderParams extends OptionalOrderParams {
+    /** The trigger price for the order */
+    triggerPrice: BN;
+}
+interface PrepSwiftOrderParams {
+    /** The Drift client instance */
+    driftClient: DriftClient;
+    /** The taker user account information */
+    takerUserAccount: {
+        /** Public key of the user account */
+        pubKey: PublicKey;
+        /** User account ID */
+        subAccountId: number;
+    };
+    /** Current blockchain slot number */
+    currentSlot: number;
+    /** Whether this is a delegate order */
+    isDelegate: boolean;
+    /** Order parameters including main order and optional stop loss/take profit */
+    orderParams: {
+        /** Main order parameters */
+        main: OptionalOrderParams;
+        /** Optional stop loss order parameters */
+        stopLoss?: OptionalTriggerOrderParams;
+        /** Optional take profit order parameters */
+        takeProfit?: OptionalTriggerOrderParams;
+    };
+    /** Buffer slots to account for signing time (default: 2 slots ~1 second). If a user is required to manually sign the message, this should be a higher number. */
+    slotBuffer?: number;
+}
+/**
+ * Prepares a swift order by encoding the order parameters into a message format
+ * suitable for signing and sending to the Swift server.
+ *
+ * @param driftClient - The Drift client instance
+ * @param takerUserAccount - The taker user account information
+ * @param currentSlot - Current blockchain slot number
+ * @param isDelegate - Whether this is a delegate order
+ * @param orderParams - Order parameters including main order and optional stop loss/take profit
+ * @param slotBuffer - Buffer slots to account for signing time (default: 2 slots ~1 second).  If a user is required to manually sign the message, this should be a higher number.
+ *
+ * @returns An object containing:
+ *   - `hexEncodedSwiftOrderMessage`: The encoded order message in both Uint8Array and string formats. The Uint8Array format is for a wallet to sign, while the string format is used to send to the SWIFT server.
+ *   - `signedMsgOrderParamsMessage`: The signed message order parameters
+ *   - `slotForSignedMsg`: The slot number for the signed message
+ *   - `signedMsgOrderUuid`: Unique identifier for the signed message order
+ */
+export declare const prepSwiftOrder: ({ driftClient, takerUserAccount, currentSlot, isDelegate, orderParams, slotBuffer, }: PrepSwiftOrderParams) => {
+    hexEncodedSwiftOrderMessage: {
+        uInt8Array: Uint8Array;
+        string: string;
+    };
+    signedMsgOrderParamsMessage: SignedMsgOrderParamsMessage | SignedMsgOrderParamsDelegateMessage;
+    slotForSignedMsg: BN;
+    signedMsgOrderUuid: Uint8Array;
+};
+/**
+ * Error thrown when an auction slot has expired
+ */
+export declare class AuctionSlotExpiredError extends Error {
+    name: string;
+    /**
+     * Creates an instance of AuctionSlotExpiredError
+     * @param message - Error message (default: 'Auction slot expired')
+     */
+    constructor(message?: string);
+}
+interface SignOrderMsgParams {
+    /** Wallet instance with message signing capability */
+    wallet: {
+        /** Function to sign a message */
+        signMessage: (message: Uint8Array) => Promise<Uint8Array>;
+    };
+    /** Hex-encoded swift order message to sign */
+    hexEncodedSwiftOrderMessage: Uint8Array;
+    /** Slot number when the auction expires */
+    auctionExpirationSlot: BN;
+    /** Function to get the current blockchain slot */
+    getCurrentSlot: () => number;
+    /** Callback function called when the auction expires */
+    onExpired: () => void;
+}
+/**
+ * Signs a swift order message with slot expiration monitoring.
+ * Continuously monitors the current slot and rejects with AuctionSlotExpiredError
+ * if the auction slot expires before signing is complete.
+ *
+ * @param wallet - Wallet instance with message signing capability
+ * @param hexEncodedSwiftOrderMessage - Hex-encoded swift order message to sign
+ * @param auctionExpirationSlot - Slot number when the auction expires
+ * @param getCurrentSlot - Function to get the current blockchain slot
+ * @param onExpired - Callback function called when the auction expires
+ *
+ * @returns Promise resolving to the signed message as Uint8Array
+ * @throws {AuctionSlotExpiredError} When the auction slot expires before signing completes
+ */
+export declare const signSwiftOrderMsg: ({ wallet, hexEncodedSwiftOrderMessage, auctionExpirationSlot, getCurrentSlot, onExpired, }: SignOrderMsgParams) => Promise<Uint8Array>;
+/**
+ * Parameters for sending a swift order to the Swift server
+ * @interface SendSwiftOrderParams
+ */
+interface SendSwiftOrderParams {
+    /** The Drift client instance */
+    driftClient: DriftClient;
+    /** Market identifier for the order */
+    marketId: MarketId;
+    /** Hex-encoded swift order message as string */
+    hexEncodedSwiftOrderMessageString: string;
+    /** The signed message from the wallet */
+    signedMessage: Uint8Array;
+    /** Unique identifier for the signed message order */
+    signedMsgOrderUuid: Uint8Array;
+    /** Public key of the taker authority */
+    takerAuthority: PublicKey;
+    /** Public key of the signing authority */
+    signingAuthority: PublicKey;
+    /** Duration of the auction in slots (optional) */
+    auctionDurationSlot?: number;
+    /**
+     * This is a slot buffer to account for the time it takes for the swift server to confirm the order.
+     * If there is an auction duration component, it will be added to the final confirmation delay.
+     * @default 15
+     */
+    swiftConfirmationSlotBuffer?: number;
+}
+/**
+ * Sends a swift order to the Swift server and handles the response.
+ * Monitors the order status and calls appropriate callback functions based on the response type.
+ *
+ * @param driftClient - The Drift client instance
+ * @param marketId - Market identifier for the order
+ * @param hexEncodedSwiftOrderMessageString - Hex-encoded swift order message as string
+ * @param signedMessage - The signed message from the wallet
+ * @param signedMsgOrderUuid - Unique identifier for the signed message order
+ * @param takerAuthority - Public key of the taker authority
+ * @param signingAuthority - Public key of the signing authority
+ * @param auctionDurationSlot - Duration of the auction in slots (optional)
+ * @param swiftConfirmationSlotBuffer - Slot buffer for swift server confirmation time (default: 15)
+ * @param onExpired - Callback function called when the order expires
+ * @param onErrored - Callback function called when the order encounters an error
+ * @param onConfirmed - Callback function called when the order is confirmed
+ *
+ * @returns Promise that resolves when the order processing is complete
+ *
+ */
+export declare const sendSwiftOrder: ({ driftClient, marketId, hexEncodedSwiftOrderMessageString: hexEncodedSwiftOrderMessage, signedMessage, signedMsgOrderUuid, takerAuthority, signingAuthority, auctionDurationSlot, swiftConfirmationSlotBuffer, }: SendSwiftOrderParams) => SwiftOrderResult;
+export {};

package/lib/drift/base/actions/trade/openPerpOrder/openSwiftOrder/index.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendSwiftOrder = exports.signSwiftOrderMsg = exports.AuctionSlotExpiredError = exports.prepSwiftOrder = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const sdk_2 = require("@drift-labs/sdk");
+const swiftClient_1 = require("../../../../../../clients/swiftClient");
+/**
+ * Prepares a swift order by encoding the order parameters into a message format
+ * suitable for signing and sending to the Swift server.
+ *
+ * @param driftClient - The Drift client instance
+ * @param takerUserAccount - The taker user account information
+ * @param currentSlot - Current blockchain slot number
+ * @param isDelegate - Whether this is a delegate order
+ * @param orderParams - Order parameters including main order and optional stop loss/take profit
+ * @param slotBuffer - Buffer slots to account for signing time (default: 2 slots ~1 second).  If a user is required to manually sign the message, this should be a higher number.
+ *
+ * @returns An object containing:
+ *   - `hexEncodedSwiftOrderMessage`: The encoded order message in both Uint8Array and string formats. The Uint8Array format is for a wallet to sign, while the string format is used to send to the SWIFT server.
+ *   - `signedMsgOrderParamsMessage`: The signed message order parameters
+ *   - `slotForSignedMsg`: The slot number for the signed message
+ *   - `signedMsgOrderUuid`: Unique identifier for the signed message order
+ */
+const prepSwiftOrder = ({ driftClient, takerUserAccount, currentSlot, isDelegate, orderParams, slotBuffer = 2, // ~1 second
+ }) => {
+    const mainOrderParams = (0, sdk_2.getOrderParams)({
+        ...orderParams.main,
+        auctionDuration: orderParams.main.auctionDuration || null, // swift server expects auctionDuration to be null if not set, won't handle 0
+    });
+    // buffer for time the user takes to sign a message and send to the swift server
+    const slotForSignedMsg = new sdk_2.BN(currentSlot + slotBuffer);
+    const signedMsgOrderUuid = (0, sdk_2.generateSignedMsgUuid)();
+    const baseSignedMsgOrderParamsMessage = {
+        signedMsgOrderParams: mainOrderParams,
+        uuid: signedMsgOrderUuid,
+        slot: slotForSignedMsg,
+        stopLossOrderParams: orderParams.stopLoss
+            ? {
+                baseAssetAmount: orderParams.stopLoss.baseAssetAmount,
+                triggerPrice: orderParams.stopLoss.triggerPrice,
+            }
+            : null,
+        takeProfitOrderParams: orderParams.takeProfit
+            ? {
+                baseAssetAmount: orderParams.takeProfit.baseAssetAmount,
+                triggerPrice: orderParams.takeProfit.triggerPrice,
+            }
+            : null,
+    };
+    const signedMsgOrderParamsMessage = isDelegate
+        ? {
+            ...baseSignedMsgOrderParamsMessage,
+            takerPubkey: takerUserAccount.pubKey,
+        }
+        : {
+            ...baseSignedMsgOrderParamsMessage,
+            subAccountId: takerUserAccount.subAccountId,
+        };
+    const encodedOrderMessage = driftClient.encodeSignedMsgOrderParamsMessage(signedMsgOrderParamsMessage, isDelegate);
+    const hexEncodedSwiftOrderMessage = Buffer.from(encodedOrderMessage.toString('hex'));
+    return {
+        hexEncodedSwiftOrderMessage: {
+            uInt8Array: new Uint8Array(hexEncodedSwiftOrderMessage),
+            string: hexEncodedSwiftOrderMessage.toString(),
+        },
+        signedMsgOrderParamsMessage,
+        slotForSignedMsg,
+        signedMsgOrderUuid,
+    };
+};
+exports.prepSwiftOrder = prepSwiftOrder;
+/**
+ * Error thrown when an auction slot has expired
+ */
+class AuctionSlotExpiredError extends Error {
+    /**
+     * Creates an instance of AuctionSlotExpiredError
+     * @param message - Error message (default: 'Auction slot expired')
+     */
+    constructor(message = 'Auction slot expired') {
+        super(message);
+        this.name = 'AuctionSlotExpiredError';
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, AuctionSlotExpiredError);
+        }
+    }
+}
+exports.AuctionSlotExpiredError = AuctionSlotExpiredError;
+// TODO: Signing the swift order should be part of the Drift wrapper, not here
+/**
+ * Signs a swift order message with slot expiration monitoring.
+ * Continuously monitors the current slot and rejects with AuctionSlotExpiredError
+ * if the auction slot expires before signing is complete.
+ *
+ * @param wallet - Wallet instance with message signing capability
+ * @param hexEncodedSwiftOrderMessage - Hex-encoded swift order message to sign
+ * @param auctionExpirationSlot - Slot number when the auction expires
+ * @param getCurrentSlot - Function to get the current blockchain slot
+ * @param onExpired - Callback function called when the auction expires
+ *
+ * @returns Promise resolving to the signed message as Uint8Array
+ * @throws {AuctionSlotExpiredError} When the auction slot expires before signing completes
+ */
+const signSwiftOrderMsg = async ({ wallet, hexEncodedSwiftOrderMessage, auctionExpirationSlot, getCurrentSlot, onExpired, }) => {
+    return new Promise((resolve, reject) => {
+        const interval = setInterval(() => {
+            const currentSlot = getCurrentSlot();
+            if (currentSlot >= auctionExpirationSlot.toNumber()) {
+                onExpired();
+                clearInterval(interval);
+                reject(new AuctionSlotExpiredError());
+            }
+        }, sdk_1.SLOT_TIME_ESTIMATE_MS);
+        wallet
+            .signMessage(hexEncodedSwiftOrderMessage)
+            .then((signedMessage) => {
+            resolve(signedMessage);
+        })
+            .catch((error) => {
+            reject(error);
+        })
+            .finally(() => {
+            clearInterval(interval);
+        });
+    });
+};
+exports.signSwiftOrderMsg = signSwiftOrderMsg;
+// TODO: Sending the swift order should be part of the Drift wrapper, not here
+/**
+ * Sends a swift order to the Swift server and handles the response.
+ * Monitors the order status and calls appropriate callback functions based on the response type.
+ *
+ * @param driftClient - The Drift client instance
+ * @param marketId - Market identifier for the order
+ * @param hexEncodedSwiftOrderMessageString - Hex-encoded swift order message as string
+ * @param signedMessage - The signed message from the wallet
+ * @param signedMsgOrderUuid - Unique identifier for the signed message order
+ * @param takerAuthority - Public key of the taker authority
+ * @param signingAuthority - Public key of the signing authority
+ * @param auctionDurationSlot - Duration of the auction in slots (optional)
+ * @param swiftConfirmationSlotBuffer - Slot buffer for swift server confirmation time (default: 15)
+ * @param onExpired - Callback function called when the order expires
+ * @param onErrored - Callback function called when the order encounters an error
+ * @param onConfirmed - Callback function called when the order is confirmed
+ *
+ * @returns Promise that resolves when the order processing is complete
+ *
+ */
+const sendSwiftOrder = ({ driftClient, marketId, hexEncodedSwiftOrderMessageString: hexEncodedSwiftOrderMessage, signedMessage, signedMsgOrderUuid, takerAuthority, signingAuthority, auctionDurationSlot, swiftConfirmationSlotBuffer = 15, }) => {
+    const signedMsgUserOrdersAccountPubkey = (0, sdk_1.getSignedMsgUserAccountPublicKey)(driftClient.program.programId, takerAuthority);
+    const swiftOrderObservable = swiftClient_1.SwiftClient.sendAndConfirmSwiftOrderWS(driftClient.connection, driftClient, marketId.marketIndex, marketId.marketType, hexEncodedSwiftOrderMessage.toString(), Buffer.from(signedMessage), takerAuthority, signedMsgUserOrdersAccountPubkey, signedMsgOrderUuid, ((auctionDurationSlot !== null && auctionDurationSlot !== void 0 ? auctionDurationSlot : 0) + swiftConfirmationSlotBuffer) *
+        sdk_1.SLOT_TIME_ESTIMATE_MS, signingAuthority);
+    return { swiftOrderObservable, swiftOrderUuid: signedMsgOrderUuid };
+};
+exports.sendSwiftOrder = sendSwiftOrder;
+//# sourceMappingURL=index.js.map

package/lib/drift/base/actions/trade/openPerpOrder/openSwiftOrder/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../src/drift/base/actions/trade/openPerpOrder/openSwiftOrder/index.ts"],"names":[],"mappings":";;;AAAA,yCAKyB;AACzB,yCAOyB;AACzB,uEAG+C;AAoD/C;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,cAAc,GAAG,CAAC,EAC9B,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,WAAW,EACX,UAAU,GAAG,CAAC,EAAE,YAAY;EACN,EAUrB,EAAE;IACH,MAAM,eAAe,GAAG,IAAA,oBAAc,EAAC;QACtC,GAAG,WAAW,CAAC,IAAI;QACnB,eAAe,EAAE,WAAW,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI,EAAE,6EAA6E;KACxI,CAAC,CAAC;IAEH,gFAAgF;IAChF,MAAM,gBAAgB,GAAG,IAAI,QAAE,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC;IAE1D,MAAM,kBAAkB,GAAG,IAAA,2BAAqB,GAAE,CAAC;IAEnD,MAAM,+BAA+B,GAAG;QACvC,oBAAoB,EAAE,eAAe;QACrC,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,gBAAgB;QACtB,mBAAmB,EAAE,WAAW,CAAC,QAAQ;YACxC,CAAC,CAAC;gBACA,eAAe,EAAE,WAAW,CAAC,QAAQ,CAAC,eAAe;gBACrD,YAAY,EAAE,WAAW,CAAC,QAAQ,CAAC,YAAY;aAC9C;YACH,CAAC,CAAC,IAAI;QACP,qBAAqB,EAAE,WAAW,CAAC,UAAU;YAC5C,CAAC,CAAC;gBACA,eAAe,EAAE,WAAW,CAAC,UAAU,CAAC,eAAe;gBACvD,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY;aAChD;YACH,CAAC,CAAC,IAAI;KACP,CAAC;IAEF,MAAM,2BAA2B,GAEQ,UAAU;QAClD,CAAC,CAAC;YACA,GAAG,+BAA+B;YAClC,WAAW,EAAE,gBAAgB,CAAC,MAAM;SACnC;QACH,CAAC,CAAC;YACA,GAAG,+BAA+B;YAClC,YAAY,EAAE,gBAAgB,CAAC,YAAY;SAC1C,CAAC;IAEL,MAAM,mBAAmB,GAAG,WAAW,CAAC,iCAAiC,CACxE,2BAA2B,EAC3B,UAAU,CACV,CAAC;IACF,MAAM,2BAA2B,GAAG,MAAM,CAAC,IAAI,CAC9C,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CACnC,CAAC;IAEF,OAAO;QACN,2BAA2B,EAAE;YAC5B,UAAU,EAAE,IAAI,UAAU,CAAC,2BAA2B,CAAC;YACvD,MAAM,EAAE,2BAA2B,CAAC,QAAQ,EAAE;SAC9C;QACD,2BAA2B;QAC3B,gBAAgB;QAChB,kBAAkB;KAClB,CAAC;AACH,CAAC,CAAC;AA3EW,QAAA,cAAc,kBA2EzB;AAEF;;GAEG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAGjD;;;OAGG;IACH,YAAY,UAAkB,sBAAsB;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAPhB,SAAI,GAAG,yBAAyB,CAAC;QAQhC,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC7B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;QACxD,CAAC;IACF,CAAC;CACD;AAbD,0DAaC;AAkBD,8EAA8E;AAC9E;;;;;;;;;;;;;GAaG;AACI,MAAM,iBAAiB,GAAG,KAAK,EAAE,EACvC,MAAM,EACN,2BAA2B,EAC3B,qBAAqB,EACrB,cAAc,EACd,SAAS,GACW,EAAuB,EAAE;IAC7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YACjC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;YACrC,IAAI,WAAW,IAAI,qBAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACrD,SAAS,EAAE,CAAC;gBACZ,aAAa,CAAC,QAAQ,CAAC,CAAC;gBACxB,MAAM,CAAC,IAAI,uBAAuB,EAAE,CAAC,CAAC;YACvC,CAAC;QACF,CAAC,EAAE,2BAAqB,CAAC,CAAC;QAE1B,MAAM;aACJ,WAAW,CAAC,2BAA2B,CAAC;aACxC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YACvB,OAAO,CAAC,aAAa,CAAC,CAAC;QACxB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChB,MAAM,CAAC,KAAK,CAAC,CAAC;QACf,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACb,aAAa,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AA7BW,QAAA,iBAAiB,qBA6B5B;AAgCF,8EAA8E;AAC9E;;;;;;;;;;;;;;;;;;;GAmBG;AACI,MAAM,cAAc,GAAG,CAAC,EAC9B,WAAW,EACX,QAAQ,EACR,iCAAiC,EAAE,2BAA2B,EAC9D,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,2BAA2B,GAAG,EAAE,GACV,EAAoB,EAAE;IAC5C,MAAM,gCAAgC,GAAG,IAAA,sCAAgC,EACxE,WAAW,CAAC,OAAO,CAAC,SAAS,EAC7B,cAAc,CACd,CAAC;IAEF,MAAM,oBAAoB,GAAG,yBAAW,CAAC,0BAA0B,CAClE,WAAW,CAAC,UAAU,EACtB,WAAW,EACX,QAAQ,CAAC,WAAW,EACpB,QAAQ,CAAC,UAAU,EACnB,2BAA2B,CAAC,QAAQ,EAAE,EACtC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAC1B,cAAc,EACd,gCAAgC,EAChC,kBAAkB,EAClB,CAAC,CAAC,mBAAmB,aAAnB,mBAAmB,cAAnB,mBAAmB,GAAI,CAAC,CAAC,GAAG,2BAA2B,CAAC;QACzD,2BAAqB,EACtB,gBAAgB,CAChB,CAAC;IAEF,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;AACrE,CAAC,CAAC;AAhCW,QAAA,cAAc,kBAgCzB","sourcesContent":["import {\n\tgetSignedMsgUserAccountPublicKey,\n\tSignedMsgOrderParamsDelegateMessage,\n\tSignedMsgOrderParamsMessage,\n\tSLOT_TIME_ESTIMATE_MS,\n} from '@drift-labs/sdk';\nimport {\n\tBN,\n\tDriftClient,\n\tgenerateSignedMsgUuid,\n\tgetOrderParams,\n\tOptionalOrderParams,\n\tPublicKey,\n} from '@drift-labs/sdk';\nimport {\n\tSwiftClient,\n\tSwiftOrderEvent,\n} from '../../../../../../clients/swiftClient';\nimport { MarketId } from '../../../../../../types';\nimport { Observable } from 'rxjs';\n\nexport interface SwiftOrderOptions {\n\twallet: {\n\t\tsignMessage: (message: Uint8Array) => Promise<Uint8Array>;\n\t\tpublicKey: PublicKey;\n\t};\n\tswiftServerUrl: string;\n\tsignedMessageOrderSlotBuffer?: number;\n\tconfirmDuration?: number;\n\tisDelegate?: boolean;\n}\n\nexport type SwiftOrderResult = {\n\tswiftOrderObservable: Observable<SwiftOrderEvent>;\n\tswiftOrderUuid: Uint8Array;\n};\n\nexport interface OptionalTriggerOrderParams extends OptionalOrderParams {\n\t/** The trigger price for the order */\n\ttriggerPrice: BN;\n}\n\ninterface PrepSwiftOrderParams {\n\t/** The Drift client instance */\n\tdriftClient: DriftClient;\n\t/** The taker user account information */\n\ttakerUserAccount: {\n\t\t/** Public key of the user account */\n\t\tpubKey: PublicKey;\n\t\t/** User account ID */\n\t\tsubAccountId: number;\n\t};\n\t/** Current blockchain slot number */\n\tcurrentSlot: number;\n\t/** Whether this is a delegate order */\n\tisDelegate: boolean;\n\t/** Order parameters including main order and optional stop loss/take profit */\n\torderParams: {\n\t\t/** Main order parameters */\n\t\tmain: OptionalOrderParams;\n\t\t/** Optional stop loss order parameters */\n\t\tstopLoss?: OptionalTriggerOrderParams;\n\t\t/** Optional take profit order parameters */\n\t\ttakeProfit?: OptionalTriggerOrderParams;\n\t};\n\t/** Buffer slots to account for signing time (default: 2 slots ~1 second). If a user is required to manually sign the message, this should be a higher number. */\n\tslotBuffer?: number;\n}\n\n/**\n * Prepares a swift order by encoding the order parameters into a message format\n * suitable for signing and sending to the Swift server.\n *\n * @param driftClient - The Drift client instance\n * @param takerUserAccount - The taker user account information\n * @param currentSlot - Current blockchain slot number\n * @param isDelegate - Whether this is a delegate order\n * @param orderParams - Order parameters including main order and optional stop loss/take profit\n * @param slotBuffer - Buffer slots to account for signing time (default: 2 slots ~1 second).  If a user is required to manually sign the message, this should be a higher number.\n *\n * @returns An object containing:\n *   - `hexEncodedSwiftOrderMessage`: The encoded order message in both Uint8Array and string formats. The Uint8Array format is for a wallet to sign, while the string format is used to send to the SWIFT server.\n *   - `signedMsgOrderParamsMessage`: The signed message order parameters\n *   - `slotForSignedMsg`: The slot number for the signed message\n *   - `signedMsgOrderUuid`: Unique identifier for the signed message order\n */\nexport const prepSwiftOrder = ({\n\tdriftClient,\n\ttakerUserAccount,\n\tcurrentSlot,\n\tisDelegate,\n\torderParams,\n\tslotBuffer = 2, // ~1 second\n}: PrepSwiftOrderParams): {\n\thexEncodedSwiftOrderMessage: {\n\t\tuInt8Array: Uint8Array;\n\t\tstring: string;\n\t};\n\tsignedMsgOrderParamsMessage:\n\t\t| SignedMsgOrderParamsMessage\n\t\t| SignedMsgOrderParamsDelegateMessage;\n\tslotForSignedMsg: BN;\n\tsignedMsgOrderUuid: Uint8Array;\n} => {\n\tconst mainOrderParams = getOrderParams({\n\t\t...orderParams.main,\n\t\tauctionDuration: orderParams.main.auctionDuration || null, // swift server expects auctionDuration to be null if not set, won't handle 0\n\t});\n\n\t// buffer for time the user takes to sign a message and send to the swift server\n\tconst slotForSignedMsg = new BN(currentSlot + slotBuffer);\n\n\tconst signedMsgOrderUuid = generateSignedMsgUuid();\n\n\tconst baseSignedMsgOrderParamsMessage = {\n\t\tsignedMsgOrderParams: mainOrderParams,\n\t\tuuid: signedMsgOrderUuid,\n\t\tslot: slotForSignedMsg,\n\t\tstopLossOrderParams: orderParams.stopLoss\n\t\t\t? {\n\t\t\t\t\tbaseAssetAmount: orderParams.stopLoss.baseAssetAmount,\n\t\t\t\t\ttriggerPrice: orderParams.stopLoss.triggerPrice,\n\t\t\t  }\n\t\t\t: null,\n\t\ttakeProfitOrderParams: orderParams.takeProfit\n\t\t\t? {\n\t\t\t\t\tbaseAssetAmount: orderParams.takeProfit.baseAssetAmount,\n\t\t\t\t\ttriggerPrice: orderParams.takeProfit.triggerPrice,\n\t\t\t  }\n\t\t\t: null,\n\t};\n\n\tconst signedMsgOrderParamsMessage:\n\t\t| SignedMsgOrderParamsMessage\n\t\t| SignedMsgOrderParamsDelegateMessage = isDelegate\n\t\t? {\n\t\t\t\t...baseSignedMsgOrderParamsMessage,\n\t\t\t\ttakerPubkey: takerUserAccount.pubKey,\n\t\t  }\n\t\t: {\n\t\t\t\t...baseSignedMsgOrderParamsMessage,\n\t\t\t\tsubAccountId: takerUserAccount.subAccountId,\n\t\t  };\n\n\tconst encodedOrderMessage = driftClient.encodeSignedMsgOrderParamsMessage(\n\t\tsignedMsgOrderParamsMessage,\n\t\tisDelegate\n\t);\n\tconst hexEncodedSwiftOrderMessage = Buffer.from(\n\t\tencodedOrderMessage.toString('hex')\n\t);\n\n\treturn {\n\t\thexEncodedSwiftOrderMessage: {\n\t\t\tuInt8Array: new Uint8Array(hexEncodedSwiftOrderMessage),\n\t\t\tstring: hexEncodedSwiftOrderMessage.toString(),\n\t\t},\n\t\tsignedMsgOrderParamsMessage,\n\t\tslotForSignedMsg,\n\t\tsignedMsgOrderUuid,\n\t};\n};\n\n/**\n * Error thrown when an auction slot has expired\n */\nexport class AuctionSlotExpiredError extends Error {\n\tname = 'AuctionSlotExpiredError';\n\n\t/**\n\t * Creates an instance of AuctionSlotExpiredError\n\t * @param message - Error message (default: 'Auction slot expired')\n\t */\n\tconstructor(message: string = 'Auction slot expired') {\n\t\tsuper(message);\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, AuctionSlotExpiredError);\n\t\t}\n\t}\n}\n\ninterface SignOrderMsgParams {\n\t/** Wallet instance with message signing capability */\n\twallet: {\n\t\t/** Function to sign a message */\n\t\tsignMessage: (message: Uint8Array) => Promise<Uint8Array>;\n\t};\n\t/** Hex-encoded swift order message to sign */\n\thexEncodedSwiftOrderMessage: Uint8Array;\n\t/** Slot number when the auction expires */\n\tauctionExpirationSlot: BN;\n\t/** Function to get the current blockchain slot */\n\tgetCurrentSlot: () => number;\n\t/** Callback function called when the auction expires */\n\tonExpired: () => void;\n}\n\n// TODO: Signing the swift order should be part of the Drift wrapper, not here\n/**\n * Signs a swift order message with slot expiration monitoring.\n * Continuously monitors the current slot and rejects with AuctionSlotExpiredError\n * if the auction slot expires before signing is complete.\n *\n * @param wallet - Wallet instance with message signing capability\n * @param hexEncodedSwiftOrderMessage - Hex-encoded swift order message to sign\n * @param auctionExpirationSlot - Slot number when the auction expires\n * @param getCurrentSlot - Function to get the current blockchain slot\n * @param onExpired - Callback function called when the auction expires\n *\n * @returns Promise resolving to the signed message as Uint8Array\n * @throws {AuctionSlotExpiredError} When the auction slot expires before signing completes\n */\nexport const signSwiftOrderMsg = async ({\n\twallet,\n\thexEncodedSwiftOrderMessage,\n\tauctionExpirationSlot,\n\tgetCurrentSlot,\n\tonExpired,\n}: SignOrderMsgParams): Promise<Uint8Array> => {\n\treturn new Promise((resolve, reject) => {\n\t\tconst interval = setInterval(() => {\n\t\t\tconst currentSlot = getCurrentSlot();\n\t\t\tif (currentSlot >= auctionExpirationSlot.toNumber()) {\n\t\t\t\tonExpired();\n\t\t\t\tclearInterval(interval);\n\t\t\t\treject(new AuctionSlotExpiredError());\n\t\t\t}\n\t\t}, SLOT_TIME_ESTIMATE_MS);\n\n\t\twallet\n\t\t\t.signMessage(hexEncodedSwiftOrderMessage)\n\t\t\t.then((signedMessage) => {\n\t\t\t\tresolve(signedMessage);\n\t\t\t})\n\t\t\t.catch((error) => {\n\t\t\t\treject(error);\n\t\t\t})\n\t\t\t.finally(() => {\n\t\t\t\tclearInterval(interval);\n\t\t\t});\n\t});\n};\n\n/**\n * Parameters for sending a swift order to the Swift server\n * @interface SendSwiftOrderParams\n */\ninterface SendSwiftOrderParams {\n\t/** The Drift client instance */\n\tdriftClient: DriftClient;\n\t/** Market identifier for the order */\n\tmarketId: MarketId;\n\t/** Hex-encoded swift order message as string */\n\thexEncodedSwiftOrderMessageString: string;\n\t/** The signed message from the wallet */\n\tsignedMessage: Uint8Array;\n\t/** Unique identifier for the signed message order */\n\tsignedMsgOrderUuid: Uint8Array;\n\t/** Public key of the taker authority */\n\ttakerAuthority: PublicKey;\n\t/** Public key of the signing authority */\n\tsigningAuthority: PublicKey;\n\t/** Duration of the auction in slots (optional) */\n\tauctionDurationSlot?: number;\n\n\t/**\n\t * This is a slot buffer to account for the time it takes for the swift server to confirm the order.\n\t * If there is an auction duration component, it will be added to the final confirmation delay.\n\t * @default 15\n\t */\n\tswiftConfirmationSlotBuffer?: number;\n}\n\n// TODO: Sending the swift order should be part of the Drift wrapper, not here\n/**\n * Sends a swift order to the Swift server and handles the response.\n * Monitors the order status and calls appropriate callback functions based on the response type.\n *\n * @param driftClient - The Drift client instance\n * @param marketId - Market identifier for the order\n * @param hexEncodedSwiftOrderMessageString - Hex-encoded swift order message as string\n * @param signedMessage - The signed message from the wallet\n * @param signedMsgOrderUuid - Unique identifier for the signed message order\n * @param takerAuthority - Public key of the taker authority\n * @param signingAuthority - Public key of the signing authority\n * @param auctionDurationSlot - Duration of the auction in slots (optional)\n * @param swiftConfirmationSlotBuffer - Slot buffer for swift server confirmation time (default: 15)\n * @param onExpired - Callback function called when the order expires\n * @param onErrored - Callback function called when the order encounters an error\n * @param onConfirmed - Callback function called when the order is confirmed\n *\n * @returns Promise that resolves when the order processing is complete\n *\n */\nexport const sendSwiftOrder = ({\n\tdriftClient,\n\tmarketId,\n\thexEncodedSwiftOrderMessageString: hexEncodedSwiftOrderMessage,\n\tsignedMessage,\n\tsignedMsgOrderUuid,\n\ttakerAuthority,\n\tsigningAuthority,\n\tauctionDurationSlot,\n\tswiftConfirmationSlotBuffer = 15,\n}: SendSwiftOrderParams): SwiftOrderResult => {\n\tconst signedMsgUserOrdersAccountPubkey = getSignedMsgUserAccountPublicKey(\n\t\tdriftClient.program.programId,\n\t\ttakerAuthority\n\t);\n\n\tconst swiftOrderObservable = SwiftClient.sendAndConfirmSwiftOrderWS(\n\t\tdriftClient.connection,\n\t\tdriftClient,\n\t\tmarketId.marketIndex,\n\t\tmarketId.marketType,\n\t\thexEncodedSwiftOrderMessage.toString(),\n\t\tBuffer.from(signedMessage),\n\t\ttakerAuthority,\n\t\tsignedMsgUserOrdersAccountPubkey,\n\t\tsignedMsgOrderUuid,\n\t\t((auctionDurationSlot ?? 0) + swiftConfirmationSlotBuffer) *\n\t\t\tSLOT_TIME_ESTIMATE_MS,\n\t\tsigningAuthority\n\t);\n\n\treturn { swiftOrderObservable, swiftOrderUuid: signedMsgOrderUuid };\n};\n"]}

package/lib/drift/base/actions/trade/swap.d.ts

@@ -0,0 +1,62 @@
+import { BN, DriftClient, JupiterClient, QuoteResponse, TxParams, User } from '@drift-labs/sdk';
+import { AddressLookupTableAccount, Transaction, TransactionInstruction, VersionedTransaction } from '@solana/web3.js';
+/**
+ * Parameters for creating swap instruction details
+ */
+interface CreateSwapIxDetailsParams {
+    /** The Drift client instance for interacting with the Drift protocol */
+    driftClient: DriftClient;
+    /** Quote response from Jupiter containing swap route information */
+    quote: QuoteResponse;
+    /** Jupiter client instance for performing the swap */
+    jupiterClient: JupiterClient;
+    /** Market index of the token being swapped from */
+    swapFromMarketIndex: number;
+    /** Market index of the token being swapped to */
+    swapToMarketIndex: number;
+    /** Amount to swap in base units */
+    amount: BN;
+    /** User instance containing account information */
+    user: User;
+}
+/**
+ * Creates swap instruction details for a Jupiter swap through Drift
+ *
+ * @param driftClient - The Drift client instance
+ * @param jupiterClient - The Jupiter client instance
+ * @param quote - Quote response from Jupiter with routing information
+ * @param swapFromMarketIndex - Source token market index
+ * @param swapToMarketIndex - Destination token market index
+ * @param amount - Amount to swap in base units
+ * @param user - User account instance
+ * @returns Promise resolving to an object containing transaction instructions and lookup tables
+ * @returns ixs - Array of Solana transaction instructions for the swap
+ * @returns lookupTables - Address lookup table accounts for transaction compression
+ */
+export declare const createSwapIxDetails: ({ driftClient, jupiterClient, quote, swapFromMarketIndex, swapToMarketIndex, amount, user, }: CreateSwapIxDetailsParams) => Promise<{
+    ixs: TransactionInstruction[];
+    lookupTables: AddressLookupTableAccount[];
+}>;
+/**
+ * Parameters for creating a complete swap transaction
+ * Extends CreateSwapIxDetailsParams with additional transaction parameters
+ */
+interface CreateSwapTxnParams extends CreateSwapIxDetailsParams {
+    /** Transaction parameters including compute units, priority fees, and other options */
+    txParams?: TxParams;
+}
+/**
+ * Creates a complete swap transaction ready for signing and submission
+ *
+ * @param driftClient - The Drift client instance
+ * @param jupiterClient - The Jupiter client instance
+ * @param quote - Quote response from Jupiter with routing information
+ * @param swapFromMarketIndex - Source token market index
+ * @param swapToMarketIndex - Destination token market index
+ * @param amount - Amount to swap in base units
+ * @param user - User account instance
+ * @param txParams - Transaction parameters for fees and compute units
+ * @returns Promise resolving to either a legacy Transaction or VersionedTransaction ready for signing
+ */
+export declare const createSwapTxn: ({ driftClient, jupiterClient, quote, swapFromMarketIndex, swapToMarketIndex, amount, user, txParams, }: CreateSwapTxnParams) => Promise<Transaction | VersionedTransaction>;
+export {};

package/lib/drift/base/actions/trade/swap.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSwapTxn = exports.createSwapIxDetails = void 0;
+/**
+ * Creates swap instruction details for a Jupiter swap through Drift
+ *
+ * @param driftClient - The Drift client instance
+ * @param jupiterClient - The Jupiter client instance
+ * @param quote - Quote response from Jupiter with routing information
+ * @param swapFromMarketIndex - Source token market index
+ * @param swapToMarketIndex - Destination token market index
+ * @param amount - Amount to swap in base units
+ * @param user - User account instance
+ * @returns Promise resolving to an object containing transaction instructions and lookup tables
+ * @returns ixs - Array of Solana transaction instructions for the swap
+ * @returns lookupTables - Address lookup table accounts for transaction compression
+ */
+const createSwapIxDetails = async ({ driftClient, jupiterClient, quote, swapFromMarketIndex, swapToMarketIndex, amount, user, }) => {
+    const userPublicKey = user.getUserAccountPublicKey();
+    const swapIxsDetails = await driftClient.getJupiterSwapIxV6({
+        jupiterClient,
+        outMarketIndex: swapToMarketIndex,
+        inMarketIndex: swapFromMarketIndex,
+        amount,
+        quote,
+        userAccountPublicKey: userPublicKey,
+        // we skip passing in the associated token accounts and have getJupiterSwapIxV6 derive them instead.
+        // getJupiterSwapIxV6 will also add the ixs to create the associated token accounts if they don't exist.
+    });
+    return swapIxsDetails;
+};
+exports.createSwapIxDetails = createSwapIxDetails;
+/**
+ * Creates a complete swap transaction ready for signing and submission
+ *
+ * @param driftClient - The Drift client instance
+ * @param jupiterClient - The Jupiter client instance
+ * @param quote - Quote response from Jupiter with routing information
+ * @param swapFromMarketIndex - Source token market index
+ * @param swapToMarketIndex - Destination token market index
+ * @param amount - Amount to swap in base units
+ * @param user - User account instance
+ * @param txParams - Transaction parameters for fees and compute units
+ * @returns Promise resolving to either a legacy Transaction or VersionedTransaction ready for signing
+ */
+const createSwapTxn = async ({ driftClient, jupiterClient, quote, swapFromMarketIndex, swapToMarketIndex, amount, user, txParams, }) => {
+    const swapIxsDetails = await (0, exports.createSwapIxDetails)({
+        driftClient,
+        jupiterClient,
+        quote,
+        swapFromMarketIndex,
+        swapToMarketIndex,
+        amount,
+        user,
+    });
+    const tx = await driftClient.buildTransaction(swapIxsDetails.ixs, txParams, 0, swapIxsDetails.lookupTables);
+    return tx;
+};
+exports.createSwapTxn = createSwapTxn;
+//# sourceMappingURL=swap.js.map

package/lib/drift/base/actions/trade/swap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swap.js","sourceRoot":"","sources":["../../../../../src/drift/base/actions/trade/swap.ts"],"names":[],"mappings":";;;AAmCA;;;;;;;;;;;;;GAaG;AACI,MAAM,mBAAmB,GAAG,KAAK,EAAE,EACzC,WAAW,EACX,aAAa,EACb,KAAK,EACL,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,EACN,IAAI,GACuB,EAGzB,EAAE;IACJ,MAAM,aAAa,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAErD,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,kBAAkB,CAAC;QAC3D,aAAa;QACb,cAAc,EAAE,iBAAiB;QACjC,aAAa,EAAE,mBAAmB;QAClC,MAAM;QACN,KAAK;QACL,oBAAoB,EAAE,aAAa;QACnC,oGAAoG;QACpG,wGAAwG;KACxG,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC;AACvB,CAAC,CAAC;AA1BW,QAAA,mBAAmB,uBA0B9B;AAWF;;;;;;;;;;;;GAYG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,EACnC,WAAW,EACX,aAAa,EACb,KAAK,EACL,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,EACN,IAAI,EACJ,QAAQ,GACa,EAA+C,EAAE;IACtE,MAAM,cAAc,GAAG,MAAM,IAAA,2BAAmB,EAAC;QAChD,WAAW;QACX,aAAa;QACb,KAAK;QACL,mBAAmB;QACnB,iBAAiB;QACjB,MAAM;QACN,IAAI;KACJ,CAAC,CAAC;IAEH,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAC5C,cAAc,CAAC,GAAG,EAClB,QAAQ,EACR,CAAC,EACD,cAAc,CAAC,YAAY,CAC3B,CAAC;IAEF,OAAO,EAAE,CAAC;AACX,CAAC,CAAC;AA5BW,QAAA,aAAa,iBA4BxB","sourcesContent":["import {\n\tBN,\n\tDriftClient,\n\tJupiterClient,\n\tQuoteResponse,\n\tTxParams,\n\tUser,\n} from '@drift-labs/sdk';\nimport {\n\tAddressLookupTableAccount,\n\tTransaction,\n\tTransactionInstruction,\n\tVersionedTransaction,\n} from '@solana/web3.js';\n\n/**\n * Parameters for creating swap instruction details\n */\ninterface CreateSwapIxDetailsParams {\n\t/** The Drift client instance for interacting with the Drift protocol */\n\tdriftClient: DriftClient;\n\t/** Quote response from Jupiter containing swap route information */\n\tquote: QuoteResponse;\n\t/** Jupiter client instance for performing the swap */\n\tjupiterClient: JupiterClient;\n\t/** Market index of the token being swapped from */\n\tswapFromMarketIndex: number;\n\t/** Market index of the token being swapped to */\n\tswapToMarketIndex: number;\n\t/** Amount to swap in base units */\n\tamount: BN;\n\t/** User instance containing account information */\n\tuser: User;\n}\n\n/**\n * Creates swap instruction details for a Jupiter swap through Drift\n *\n * @param driftClient - The Drift client instance\n * @param jupiterClient - The Jupiter client instance\n * @param quote - Quote response from Jupiter with routing information\n * @param swapFromMarketIndex - Source token market index\n * @param swapToMarketIndex - Destination token market index\n * @param amount - Amount to swap in base units\n * @param user - User account instance\n * @returns Promise resolving to an object containing transaction instructions and lookup tables\n * @returns ixs - Array of Solana transaction instructions for the swap\n * @returns lookupTables - Address lookup table accounts for transaction compression\n */\nexport const createSwapIxDetails = async ({\n\tdriftClient,\n\tjupiterClient,\n\tquote,\n\tswapFromMarketIndex,\n\tswapToMarketIndex,\n\tamount,\n\tuser,\n}: CreateSwapIxDetailsParams): Promise<{\n\tixs: TransactionInstruction[];\n\tlookupTables: AddressLookupTableAccount[];\n}> => {\n\tconst userPublicKey = user.getUserAccountPublicKey();\n\n\tconst swapIxsDetails = await driftClient.getJupiterSwapIxV6({\n\t\tjupiterClient,\n\t\toutMarketIndex: swapToMarketIndex,\n\t\tinMarketIndex: swapFromMarketIndex,\n\t\tamount,\n\t\tquote,\n\t\tuserAccountPublicKey: userPublicKey,\n\t\t// we skip passing in the associated token accounts and have getJupiterSwapIxV6 derive them instead.\n\t\t// getJupiterSwapIxV6 will also add the ixs to create the associated token accounts if they don't exist.\n\t});\n\n\treturn swapIxsDetails;\n};\n\n/**\n * Parameters for creating a complete swap transaction\n * Extends CreateSwapIxDetailsParams with additional transaction parameters\n */\ninterface CreateSwapTxnParams extends CreateSwapIxDetailsParams {\n\t/** Transaction parameters including compute units, priority fees, and other options */\n\ttxParams?: TxParams;\n}\n\n/**\n * Creates a complete swap transaction ready for signing and submission\n *\n * @param driftClient - The Drift client instance\n * @param jupiterClient - The Jupiter client instance\n * @param quote - Quote response from Jupiter with routing information\n * @param swapFromMarketIndex - Source token market index\n * @param swapToMarketIndex - Destination token market index\n * @param amount - Amount to swap in base units\n * @param user - User account instance\n * @param txParams - Transaction parameters for fees and compute units\n * @returns Promise resolving to either a legacy Transaction or VersionedTransaction ready for signing\n */\nexport const createSwapTxn = async ({\n\tdriftClient,\n\tjupiterClient,\n\tquote,\n\tswapFromMarketIndex,\n\tswapToMarketIndex,\n\tamount,\n\tuser,\n\ttxParams,\n}: CreateSwapTxnParams): Promise<Transaction | VersionedTransaction> => {\n\tconst swapIxsDetails = await createSwapIxDetails({\n\t\tdriftClient,\n\t\tjupiterClient,\n\t\tquote,\n\t\tswapFromMarketIndex,\n\t\tswapToMarketIndex,\n\t\tamount,\n\t\tuser,\n\t});\n\n\tconst tx = await driftClient.buildTransaction(\n\t\tswapIxsDetails.ixs,\n\t\ttxParams,\n\t\t0,\n\t\tswapIxsDetails.lookupTables\n\t);\n\n\treturn tx;\n};\n"]}

package/lib/drift/base/actions/user/create.d.ts

@@ -0,0 +1,75 @@
+import { BN, DriftClient, PublicKey, SpotMarketConfig, TxParams, UserStatsAccount } from '@drift-labs/sdk';
+import { Transaction, TransactionInstruction, VersionedTransaction } from '@solana/web3.js';
+interface CreateUserAndDepositCollateralBaseIxsParams {
+    driftClient: DriftClient;
+    amount: BN;
+    spotMarketConfig: SpotMarketConfig;
+    authority: PublicKey;
+    userStatsAccount: UserStatsAccount | undefined;
+    referrerName?: string;
+    accountName?: string;
+    poolId?: number;
+    fromSubAccountId?: number;
+    customMaxMarginRatio?: number;
+}
+/**
+ * Creates transaction instructions for initializing a new user account and depositing collateral.
+ *
+ * This function generates the necessary transaction instructions to:
+ * 1. Initialize a new user account in the Drift protocol
+ * 2. Deposit collateral into the newly created account
+ *
+ * @param driftClient - The Drift client instance for interacting with the protocol
+ * @param amount - The amount of collateral to deposit (in base units)
+ * @param spotMarketConfig - The spot market config of the deposit collateral
+ * @param authority - The public key of the account authority (wallet owner)
+ * @param userStatsAccount - Existing user stats account, used to determine next sub-account ID
+ * @param referrerName - Optional name of the referrer for referral tracking
+ * @param accountName - Optional custom name for the account (defaults to pool-specific name)
+ * @param poolId - The pool ID to associate the account with (defaults to MAIN_POOL_ID)
+ * @param fromSubAccountId - Optional sub-account ID to transfer funds from
+ * @param customMaxMarginRatio - Optional custom maximum margin ratio for the account
+ *
+ * @returns Promise resolving to an object containing:
+ *   - subAccountId: The ID of the newly created sub-account
+ *   - userAccountPublicKey: The public key of the created user account
+ *   - ixs: Array of transaction instructions to execute
+ */
+export declare const createUserAndDepositCollateralBaseIxs: ({ driftClient, amount, spotMarketConfig, authority, userStatsAccount, referrerName, accountName, poolId, fromSubAccountId, customMaxMarginRatio, }: CreateUserAndDepositCollateralBaseIxsParams) => Promise<{
+    subAccountId: number;
+    userAccountPublicKey: PublicKey;
+    ixs: TransactionInstruction[];
+}>;
+interface CreateUserAndDepositCollateralBaseTxnParams extends CreateUserAndDepositCollateralBaseIxsParams {
+    txParams?: TxParams;
+}
+/**
+ * Creates a complete transaction for initializing a new user account and depositing collateral.
+ *
+ * This function is a higher-level wrapper around `createUserAndDepositCollateralBaseIxs` that:
+ * 1. Generates the necessary transaction instructions
+ * 2. Builds a complete transaction ready for signing and submission
+ *
+ * @param driftClient - The Drift client instance for interacting with the protocol
+ * @param amount - The amount of collateral to deposit (in base units)
+ * @param spotMarketConfig - The spot market config of the deposit collateral
+ * @param authority - The public key of the account authority (wallet owner)
+ * @param userStatsAccount - Existing user stats account, used to determine next sub-account ID
+ * @param referrerName - Optional name of the referrer for referral tracking
+ * @param accountName - Optional custom name for the account (defaults to pool-specific name)
+ * @param poolId - The pool ID to associate the account with (defaults to MAIN_POOL_ID)
+ * @param fromSubAccountId - Optional sub-account ID to transfer funds from
+ * @param customMaxMarginRatio - Optional custom maximum margin ratio for the account
+ * @param txParams - Transaction parameters for building the transaction (compute units, priority fees, etc.)
+ *
+ * @returns Promise resolving to an object containing:
+ *   - transaction: The built transaction ready for signing (Transaction or VersionedTransaction)
+ *   - userAccountPublicKey: The public key of the created user account
+ *   - subAccountId: The ID of the newly created sub-account
+ */
+export declare const createUserAndDepositCollateralBaseTxn: ({ driftClient, amount, spotMarketConfig, authority, userStatsAccount, referrerName, accountName, poolId, fromSubAccountId, customMaxMarginRatio, txParams, }: CreateUserAndDepositCollateralBaseTxnParams) => Promise<{
+    transaction: Transaction | VersionedTransaction;
+    userAccountPublicKey: PublicKey;
+    subAccountId: number;
+}>;
+export {};