@drift-labs/sdk 0.1.21-master.0 → 0.1.21-master.3

package/lib/clearingHouse.js

@@ -101,6 +101,7 @@ class ClearingHouse {
                 'fundingRateHistoryAccount',
                 'liquidationHistoryAccount',
                 'tradeHistoryAccount',
+                'orderHistoryAccount',
             ]);
         });
     }
@@ -160,6 +161,21 @@ class ClearingHouse {
     getCurveHistoryAccount() {
         return this.accountSubscriber.getCurveHistoryAccount();
     }
+    getOrderHistoryAccount() {
+        return this.accountSubscriber.getOrderHistoryAccount();
+    }
+    getOrderStatePublicKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.orderStatePublicKey) {
+                return this.orderStatePublicKey;
+            }
+            this.orderStatePublicKey = yield addresses_1.getOrderStateAccountPublicKey(this.program.programId);
+            return this.orderStatePublicKey;
+        });
+    }
+    getOrderStateAccount() {
+        return this.accountSubscriber.getOrderStateAccount();
+    }
     /**
      * Update the wallet to use for clearing house transactions and linked user account
      * @param newWallet
@@ -177,15 +193,17 @@ class ClearingHouse {
     }
     initializeUserAccount() {
         return __awaiter(this, void 0, void 0, function* () {
-            const [userPositionsAccount, userAccountPublicKey, initializeUserAccountIx,] = yield this.getInitializeUserInstructions();
-            const tx = new web3_js_1.Transaction().add(initializeUserAccountIx);
+            const [userPositionsAccount, userAccountPublicKey, initializeUserAccountIx, initializeUserOrdersAccountIx,] = yield this.getInitializeUserInstructions();
+            const tx = new web3_js_1.Transaction()
+                .add(initializeUserAccountIx)
+                .add(initializeUserOrdersAccountIx);
             const txSig = yield this.txSender.send(tx, [userPositionsAccount], this.opts);
             return [txSig, userAccountPublicKey];
         });
     }
     getInitializeUserInstructions() {
         return __awaiter(this, void 0, void 0, function* () {
-            const [userPublicKey, userAccountNonce] = yield addresses_1.getUserAccountPublicKeyAndNonce(this.program.programId, this.wallet.publicKey);
+            const [userAccountPublicKey, userAccountNonce] = yield addresses_1.getUserAccountPublicKeyAndNonce(this.program.programId, this.wallet.publicKey);
             const remainingAccounts = [];
             const optionalAccounts = {
                 whitelistToken: false,
@@ -203,7 +221,7 @@ class ClearingHouse {
             const userPositions = new web3_js_1.Keypair();
             const initializeUserAccountIx = yield this.program.instruction.initializeUser(userAccountNonce, optionalAccounts, {
                 accounts: {
-                    user: userPublicKey,
+                    user: userAccountPublicKey,
                     authority: this.wallet.publicKey,
                     rent: anchor.web3.SYSVAR_RENT_PUBKEY,
                     systemProgram: anchor.web3.SystemProgram.programId,
@@ -212,7 +230,31 @@ class ClearingHouse {
                 },
                 remainingAccounts: remainingAccounts,
             });
-            return [userPositions, userPublicKey, initializeUserAccountIx];
+            const initializeUserOrdersAccountIx = yield this.getInitializeUserOrdersInstruction(userAccountPublicKey);
+            return [
+                userPositions,
+                userAccountPublicKey,
+                initializeUserAccountIx,
+                initializeUserOrdersAccountIx,
+            ];
+        });
+    }
+    getInitializeUserOrdersInstruction(userAccountPublicKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!userAccountPublicKey) {
+                userAccountPublicKey = yield this.getUserAccountPublicKey();
+            }
+            const [userOrdersAccountPublicKey, userOrdersAccountNonce] = yield addresses_1.getUserOrdersAccountPublicKeyAndNonce(this.program.programId, userAccountPublicKey);
+            return yield this.program.instruction.initializeUserOrders(userOrdersAccountNonce, {
+                accounts: {
+                    user: userAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    rent: anchor.web3.SYSVAR_RENT_PUBKEY,
+                    systemProgram: anchor.web3.SystemProgram.programId,
+                    userOrders: userOrdersAccountPublicKey,
+                    state: yield this.getStatePublicKey(),
+                },
+            });
         });
     }
     /**
@@ -237,6 +279,29 @@ class ClearingHouse {
             return this.userAccount;
         });
     }
+    /**
+     * Get the address for the Clearing House User Order's account. NOT the user's wallet address.
+     * @returns
+     */
+    getUserOrdersAccountPublicKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.userOrdersAccountPublicKey) {
+                return this.userOrdersAccountPublicKey;
+            }
+            this.userOrdersAccountPublicKey = yield addresses_1.getUserOrdersAccountPublicKey(this.program.programId, yield this.getUserAccountPublicKey());
+            return this.userOrdersAccountPublicKey;
+        });
+    }
+    userOrdersAccountExists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.userOrdersExist) {
+                return this.userOrdersExist;
+            }
+            const userOrdersAccountRPCResponse = yield this.connection.getParsedAccountInfo(yield this.getUserOrdersAccountPublicKey());
+            this.userOrdersExist = userOrdersAccountRPCResponse.value !== null;
+            return this.userOrdersExist;
+        });
+    }
     depositCollateral(amount, collateralAccountPublicKey, userPositionsAccountPublicKey) {
         return __awaiter(this, void 0, void 0, function* () {
             const depositCollateralIx = yield this.getDepositCollateralInstruction(amount, collateralAccountPublicKey, userPositionsAccountPublicKey);
@@ -275,10 +340,11 @@ class ClearingHouse {
      */
     initializeUserAccountAndDepositCollateral(amount, collateralAccountPublicKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            const [userPositionsAccount, userAccountPublicKey, initializeUserAccountIx,] = yield this.getInitializeUserInstructions();
+            const [userPositionsAccount, userAccountPublicKey, initializeUserAccountIx, initializeUserOrdersAccountIx,] = yield this.getInitializeUserInstructions();
             const depositCollateralIx = yield this.getDepositCollateralInstruction(amount, collateralAccountPublicKey, userPositionsAccount.publicKey);
             const tx = new web3_js_1.Transaction()
                 .add(initializeUserAccountIx)
+                .add(initializeUserOrdersAccountIx)
                 .add(depositCollateralIx);
             const txSig = yield this.program.provider.send(tx, [userPositionsAccount]);
             return [txSig, userAccountPublicKey];
@@ -287,12 +353,13 @@ class ClearingHouse {
     initializeUserAccountForDevnet(mockUSDCFaucet, amount) {
         return __awaiter(this, void 0, void 0, function* () {
             const [associateTokenPublicKey, createAssociatedAccountIx, mintToIx] = yield mockUSDCFaucet.createAssociatedTokenAccountAndMintToInstructions(this.wallet.publicKey, amount);
-            const [userPositionsAccount, userAccountPublicKey, initializeUserAccountIx,] = yield this.getInitializeUserInstructions();
+            const [userPositionsAccount, userAccountPublicKey, initializeUserAccountIx, initializeUserOrdersAccountIx,] = yield this.getInitializeUserInstructions();
             const depositCollateralIx = yield this.getDepositCollateralInstruction(amount, associateTokenPublicKey, userPositionsAccount.publicKey);
             const tx = new web3_js_1.Transaction()
                 .add(createAssociatedAccountIx)
                 .add(mintToIx)
                 .add(initializeUserAccountIx)
+                .add(initializeUserOrdersAccountIx)
                 .add(depositCollateralIx);
             const txSig = yield this.program.provider.send(tx, [userPositionsAccount]);
             return [txSig, userAccountPublicKey];
@@ -392,6 +459,239 @@ class ClearingHouse {
             });
         });
     }
+    initializeUserOrdersThenPlaceOrder(orderParams, discountToken, referrer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const instructions = [];
+            const userOrdersAccountExists = yield this.userOrdersAccountExists();
+            if (!userOrdersAccountExists) {
+                instructions.push(yield this.getInitializeUserOrdersInstruction());
+            }
+            instructions.push(yield this.getPlaceOrderIx(orderParams, discountToken, referrer));
+            const tx = new web3_js_1.Transaction();
+            for (const instruction of instructions) {
+                tx.add(instruction);
+            }
+            return yield this.txSender.send(tx, [], this.opts);
+        });
+    }
+    placeOrder(orderParams, discountToken, referrer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.txSender.send(utils_1.wrapInTx(yield this.getPlaceOrderIx(orderParams, discountToken, referrer)), [], this.opts);
+        });
+    }
+    getPlaceOrderIx(orderParams, discountToken, referrer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userAccountPublicKey = yield this.getUserAccountPublicKey();
+            const userAccount = yield this.getUserAccount();
+            const priceOracle = this.getMarketsAccount().markets[orderParams.marketIndex.toNumber()].amm
+                .oracle;
+            const remainingAccounts = [];
+            if (orderParams.optionalAccounts.discountToken) {
+                if (!discountToken) {
+                    throw Error('Optional accounts specified discount token but no discount token present');
+                }
+                remainingAccounts.push({
+                    pubkey: discountToken,
+                    isWritable: false,
+                    isSigner: false,
+                });
+            }
+            if (orderParams.optionalAccounts.referrer) {
+                if (!referrer) {
+                    throw Error('Optional accounts specified referrer but no referrer present');
+                }
+                remainingAccounts.push({
+                    pubkey: referrer,
+                    isWritable: false,
+                    isSigner: false,
+                });
+            }
+            const state = this.getStateAccount();
+            const orderState = this.getOrderStateAccount();
+            return yield this.program.instruction.placeOrder(orderParams, {
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    user: userAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    markets: state.markets,
+                    userOrders: yield this.getUserOrdersAccountPublicKey(),
+                    userPositions: userAccount.positions,
+                    fundingPaymentHistory: state.fundingPaymentHistory,
+                    fundingRateHistory: state.fundingRateHistory,
+                    orderState: yield this.getOrderStatePublicKey(),
+                    orderHistory: orderState.orderHistory,
+                    oracle: priceOracle,
+                },
+                remainingAccounts,
+            });
+        });
+    }
+    cancelOrder(orderId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.txSender.send(utils_1.wrapInTx(yield this.getCancelOrderIx(orderId)), [], this.opts);
+        });
+    }
+    getCancelOrderIx(orderId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userAccountPublicKey = yield this.getUserAccountPublicKey();
+            const userAccount = yield this.getUserAccount();
+            const state = this.getStateAccount();
+            const orderState = this.getOrderStateAccount();
+            return yield this.program.instruction.cancelOrder(orderId, {
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    user: userAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    markets: state.markets,
+                    userOrders: yield this.getUserOrdersAccountPublicKey(),
+                    userPositions: userAccount.positions,
+                    fundingPaymentHistory: state.fundingPaymentHistory,
+                    fundingRateHistory: state.fundingRateHistory,
+                    orderState: yield this.getOrderStatePublicKey(),
+                    orderHistory: orderState.orderHistory,
+                },
+            });
+        });
+    }
+    cancelOrderByUserId(userOrderId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.txSender.send(utils_1.wrapInTx(yield this.getCancelOrderByUserIdIx(userOrderId)), [], this.opts);
+        });
+    }
+    getCancelOrderByUserIdIx(userOrderId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userAccountPublicKey = yield this.getUserAccountPublicKey();
+            const userAccount = yield this.getUserAccount();
+            const state = this.getStateAccount();
+            const orderState = this.getOrderStateAccount();
+            return yield this.program.instruction.cancelOrderByUserId(userOrderId, {
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    user: userAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    markets: state.markets,
+                    userOrders: yield this.getUserOrdersAccountPublicKey(),
+                    userPositions: userAccount.positions,
+                    fundingPaymentHistory: state.fundingPaymentHistory,
+                    fundingRateHistory: state.fundingRateHistory,
+                    orderState: yield this.getOrderStatePublicKey(),
+                    orderHistory: orderState.orderHistory,
+                },
+            });
+        });
+    }
+    fillOrder(userAccountPublicKey, userOrdersAccountPublicKey, order) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.txSender.send(utils_1.wrapInTx(yield this.getFillOrderIx(userAccountPublicKey, userOrdersAccountPublicKey, order)), [], this.opts);
+        });
+    }
+    getFillOrderIx(userAccountPublicKey, userOrdersAccountPublicKey, order) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fillerPublicKey = yield this.getUserAccountPublicKey();
+            const userAccount = yield this.program.account.user.fetch(userAccountPublicKey);
+            const marketIndex = order.marketIndex;
+            const oracle = this.getMarket(marketIndex).amm.oracle;
+            const state = this.getStateAccount();
+            const orderState = this.getOrderStateAccount();
+            const remainingAccounts = [];
+            if (!order.referrer.equals(web3_js_1.PublicKey.default)) {
+                remainingAccounts.push({
+                    pubkey: order.referrer,
+                    isWritable: true,
+                    isSigner: false,
+                });
+            }
+            const orderId = order.orderId;
+            return yield this.program.instruction.fillOrder(orderId, {
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    filler: fillerPublicKey,
+                    user: userAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    markets: state.markets,
+                    userPositions: userAccount.positions,
+                    userOrders: userOrdersAccountPublicKey,
+                    tradeHistory: state.tradeHistory,
+                    fundingPaymentHistory: state.fundingPaymentHistory,
+                    fundingRateHistory: state.fundingRateHistory,
+                    orderState: yield this.getOrderStatePublicKey(),
+                    orderHistory: orderState.orderHistory,
+                    extendedCurveHistory: state.extendedCurveHistory,
+                    oracle: oracle,
+                },
+                remainingAccounts,
+            });
+        });
+    }
+    initializeUserOrdersThenPlaceAndFillOrder(orderParams, discountToken, referrer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const instructions = [];
+            const userOrdersAccountExists = yield this.userOrdersAccountExists();
+            if (!userOrdersAccountExists) {
+                instructions.push(yield this.getInitializeUserOrdersInstruction());
+            }
+            instructions.push(yield this.getPlaceAndFillOrderIx(orderParams, discountToken, referrer));
+            const tx = new web3_js_1.Transaction();
+            for (const instruction of instructions) {
+                tx.add(instruction);
+            }
+            return yield this.txSender.send(tx, [], this.opts);
+        });
+    }
+    placeAndFillOrder(orderParams, discountToken, referrer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.txSender.send(utils_1.wrapInTx(yield this.getPlaceAndFillOrderIx(orderParams, discountToken, referrer)), [], this.opts);
+        });
+    }
+    getPlaceAndFillOrderIx(orderParams, discountToken, referrer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userAccountPublicKey = yield this.getUserAccountPublicKey();
+            const userAccount = yield this.getUserAccount();
+            const priceOracle = this.getMarketsAccount().markets[orderParams.marketIndex.toNumber()].amm
+                .oracle;
+            const remainingAccounts = [];
+            if (orderParams.optionalAccounts.discountToken) {
+                if (!discountToken) {
+                    throw Error('Optional accounts specified discount token but no discount token present');
+                }
+                remainingAccounts.push({
+                    pubkey: discountToken,
+                    isWritable: false,
+                    isSigner: false,
+                });
+            }
+            if (orderParams.optionalAccounts.referrer) {
+                if (!referrer) {
+                    throw Error('Optional accounts specified referrer but no referrer present');
+                }
+                remainingAccounts.push({
+                    pubkey: referrer,
+                    isWritable: true,
+                    isSigner: false,
+                });
+            }
+            const state = this.getStateAccount();
+            const orderState = this.getOrderStateAccount();
+            return yield this.program.instruction.placeAndFillOrder(orderParams, {
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    user: userAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    markets: state.markets,
+                    userOrders: yield this.getUserOrdersAccountPublicKey(),
+                    userPositions: userAccount.positions,
+                    tradeHistory: state.tradeHistory,
+                    fundingPaymentHistory: state.fundingPaymentHistory,
+                    fundingRateHistory: state.fundingRateHistory,
+                    orderState: yield this.getOrderStatePublicKey(),
+                    orderHistory: orderState.orderHistory,
+                    extendedCurveHistory: state.extendedCurveHistory,
+                    oracle: priceOracle,
+                },
+                remainingAccounts,
+            });
+        });
+    }
     /**
      * Close an entire position. If you want to reduce a position, use the {@link openPosition} method in the opposite direction of the current position.
      * @param marketIndex

package/lib/clearingHouseUser.d.ts

@@ -4,7 +4,7 @@ import { PublicKey } from '@solana/web3.js';
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import { ClearingHouse } from './clearingHouse';
-import { UserAccount, UserPosition, UserPositionsAccount } from './types';
+import { Order, UserAccount, UserOrdersAccount, UserPosition, UserPositionsAccount } from './types';
 import { UserAccountSubscriber, UserAccountEvents } from './accounts/types';
 import { PositionDirection, BN } from '.';
 export declare class ClearingHouseUser {
@@ -12,6 +12,7 @@ export declare class ClearingHouseUser {
     authority: PublicKey;
     accountSubscriber: UserAccountSubscriber;
     userAccountPublicKey?: PublicKey;
+    userOrdersAccountPublicKey?: PublicKey;
     _isSubscribed: boolean;
     eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
     get isSubscribed(): boolean;
@@ -36,6 +37,7 @@ export declare class ClearingHouseUser {
     unsubscribe(): Promise<void>;
     getUserAccount(): UserAccount;
     getUserPositionsAccount(): UserPositionsAccount;
+    getUserOrdersAccount(): UserOrdersAccount | undefined;
     /**
      * Gets the user's current position for a given market. If the user has no position returns undefined
      * @param marketIndex
@@ -43,7 +45,18 @@ export declare class ClearingHouseUser {
      */
     getUserPosition(marketIndex: BN): UserPosition | undefined;
     getEmptyPosition(marketIndex: BN): UserPosition;
+    /**
+     * @param orderId
+     * @returns Order
+     */
+    getOrder(orderId: BN): Order | undefined;
+    /**
+     * @param userOrderId
+     * @returns Order
+     */
+    getOrderByUserOrderId(userOrderId: number): Order | undefined;
     getUserAccountPublicKey(): Promise<PublicKey>;
+    getUserOrdersAccountPublicKey(): Promise<PublicKey>;
     exists(): Promise<boolean>;
     /**
      * calculates Buying Power = FC * MAX_LEVERAGE
@@ -133,21 +146,6 @@ export declare class ClearingHouseUser {
     liquidationPriceAfterClose(positionMarketIndex: BN, closeQuoteAmount: BN): BN;
     /**
      * Get the maximum trade size for a given market, taking into account the user's current leverage, positions, collateral, etc.
-     *
-     * To Calculate Max Quote Available:
-     *
-     * Case 1: SameSide
-     * 	=> Remaining quote to get to maxLeverage
-     *
-     * Case 2: NOT SameSide && currentLeverage <= maxLeverage
-     * 	=> Current opposite position x2 + remaining to get to maxLeverage
-     *
-     * Case 3: NOT SameSide && currentLeverage > maxLeverage && otherPositions - currentPosition > maxLeverage
-     * 	=> strictly reduce current position size
-     *
-     * Case 4: NOT SameSide && currentLeverage > maxLeverage && otherPositions - currentPosition < maxLeverage
-     * 	=> current position + remaining to get to maxLeverage
-     *
      * @param marketIndex
      * @param tradeSide
      * @param userMaxLeverageSetting - leverage : Precision TEN_THOUSAND
@@ -174,5 +172,5 @@ export declare class ClearingHouseUser {
      * @returns positionValue : Precision QUOTE_PRECISION
      */
     private getTotalPositionValueExcludingMarket;
+    canFillOrder(order: Order): boolean;
 }
-//# sourceMappingURL=clearingHouseUser.d.ts.map