@drift-labs/sdk 0.2.0-master.37 → 0.2.0-master.39

package/lib/{clearingHouse.js → driftClient.js}

@@ -26,13 +26,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClearingHouse = void 0;
+exports.DriftClient = void 0;
 const anchor_1 = require("@project-serum/anchor");
 const bs58_1 = __importDefault(require("bs58"));
 const spl_token_1 = require("@solana/spl-token");
 const types_1 = require("./types");
 const anchor = __importStar(require("@project-serum/anchor"));
-const clearing_house_json_1 = __importDefault(require("./idl/clearing_house.json"));
+const drift_json_1 = __importDefault(require("./idl/drift.json"));
 const web3_js_1 = require("@solana/web3.js");
 const pda_1 = require("./addresses/pda");
 const utils_1 = require("./tx/utils");
@@ -40,19 +40,19 @@ const numericConstants_1 = require("./constants/numericConstants");
 const position_1 = require("./math/position");
 const spotBalance_1 = require("./math/spotBalance");
 const userName_1 = require("./userName");
-const pollingClearingHouseAccountSubscriber_1 = require("./accounts/pollingClearingHouseAccountSubscriber");
-const webSocketClearingHouseAccountSubscriber_1 = require("./accounts/webSocketClearingHouseAccountSubscriber");
+const pollingDriftClientAccountSubscriber_1 = require("./accounts/pollingDriftClientAccountSubscriber");
+const webSocketDriftClientAccountSubscriber_1 = require("./accounts/webSocketDriftClientAccountSubscriber");
 const retryTxSender_1 = require("./tx/retryTxSender");
-const clearingHouseUser_1 = require("./clearingHouseUser");
+const user_1 = require("./user");
 const config_1 = require("./config");
 const spotMarkets_1 = require("./constants/spotMarkets");
-const clearingHouseUserStats_1 = require("./clearingHouseUserStats");
+const userStats_1 = require("./userStats");
 const spotPosition_1 = require("./math/spotPosition");
 /**
- * # ClearingHouse
+ * # DriftClient
  * This class is the main way to interact with Drift Protocol. It allows you to subscribe to the various accounts where the Market's state is stored, as well as: opening positions, liquidating, settling funding, depositing & withdrawing, and more.
  */
-class ClearingHouse {
+class DriftClient {
     constructor(config) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         this.users = new Map();
@@ -63,7 +63,7 @@ class ClearingHouse {
         this.wallet = config.wallet;
         this.opts = config.opts || anchor_1.AnchorProvider.defaultOptions();
         this.provider = new anchor_1.AnchorProvider(config.connection, config.wallet, this.opts);
-        this.program = new anchor_1.Program(clearing_house_json_1.default, config.programID, this.provider);
+        this.program = new anchor_1.Program(drift_json_1.default, config.programID, this.provider);
         this.authority = (_a = config.authority) !== null && _a !== void 0 ? _a : this.wallet.publicKey;
         const subAccountIds = (_b = config.subAccountIds) !== null && _b !== void 0 ? _b : [0];
         this.activeSubAccountId = (_c = config.activeSubAccountId) !== null && _c !== void 0 ? _c : subAccountIds[0];
@@ -78,8 +78,8 @@ class ClearingHouse {
                 };
         this.createUsers(subAccountIds, this.userAccountSubscriptionConfig);
         if (config.userStats) {
-            this.userStats = new clearingHouseUserStats_1.ClearingHouseUserStats({
-                clearingHouse: this,
+            this.userStats = new userStats_1.UserStats({
+                driftClient: this,
                 userStatsAccountPublicKey: (0, pda_1.getUserStatsAccountPublicKey)(this.program.programId, this.authority),
                 accountSubscription: this.userAccountSubscriptionConfig,
             });
@@ -98,10 +98,10 @@ class ClearingHouse {
             oracleInfos = oracleInfos ? oracleInfos : envOralceInfos;
         }
         if (((_e = config.accountSubscription) === null || _e === void 0 ? void 0 : _e.type) === 'polling') {
-            this.accountSubscriber = new pollingClearingHouseAccountSubscriber_1.PollingClearingHouseAccountSubscriber(this.program, config.accountSubscription.accountLoader, perpMarketIndexes !== null && perpMarketIndexes !== void 0 ? perpMarketIndexes : [], spotMarketIndexes !== null && spotMarketIndexes !== void 0 ? spotMarketIndexes : [], oracleInfos !== null && oracleInfos !== void 0 ? oracleInfos : []);
+            this.accountSubscriber = new pollingDriftClientAccountSubscriber_1.PollingDriftClientAccountSubscriber(this.program, config.accountSubscription.accountLoader, perpMarketIndexes !== null && perpMarketIndexes !== void 0 ? perpMarketIndexes : [], spotMarketIndexes !== null && spotMarketIndexes !== void 0 ? spotMarketIndexes : [], oracleInfos !== null && oracleInfos !== void 0 ? oracleInfos : []);
         }
         else {
-            this.accountSubscriber = new webSocketClearingHouseAccountSubscriber_1.WebSocketClearingHouseAccountSubscriber(this.program, (_f = config.perpMarketIndexes) !== null && _f !== void 0 ? _f : [], (_g = config.spotMarketIndexes) !== null && _g !== void 0 ? _g : [], (_h = config.oracleInfos) !== null && _h !== void 0 ? _h : []);
+            this.accountSubscriber = new webSocketDriftClientAccountSubscriber_1.WebSocketDriftClientAccountSubscriber(this.program, (_f = config.perpMarketIndexes) !== null && _f !== void 0 ? _f : [], (_g = config.spotMarketIndexes) !== null && _g !== void 0 ? _g : [], (_h = config.oracleInfos) !== null && _h !== void 0 ? _h : []);
         }
         this.eventEmitter = this.accountSubscriber.eventEmitter;
         this.txSender = new retryTxSender_1.RetryTxSender(this.provider, (_j = config.txSenderConfig) === null || _j === void 0 ? void 0 : _j.timeout, (_k = config.txSenderConfig) === null || _k === void 0 ? void 0 : _k.retrySleep, (_l = config.txSenderConfig) === null || _l === void 0 ? void 0 : _l.additionalConnections);
@@ -120,8 +120,8 @@ class ClearingHouse {
     }
     createUser(subAccountId, accountSubscriptionConfig) {
         const userAccountPublicKey = (0, pda_1.getUserAccountPublicKeySync)(this.program.programId, this.authority, subAccountId);
-        return new clearingHouseUser_1.ClearingHouseUser({
-            clearingHouse: this,
+        return new user_1.User({
+            driftClient: this,
             userAccountPublicKey,
             accountSubscription: accountSubscriptionConfig,
         });
@@ -164,14 +164,14 @@ class ClearingHouse {
         if (this.statePublicKey) {
             return this.statePublicKey;
         }
-        this.statePublicKey = await (0, pda_1.getClearingHouseStateAccountPublicKey)(this.program.programId);
+        this.statePublicKey = await (0, pda_1.getDriftStateAccountPublicKey)(this.program.programId);
         return this.statePublicKey;
     }
     getSignerPublicKey() {
         if (this.signerPublicKey) {
             return this.signerPublicKey;
         }
-        this.signerPublicKey = (0, pda_1.getClearingHouseSignerPublicKey)(this.program.programId);
+        this.signerPublicKey = (0, pda_1.getDriftSignerPublicKey)(this.program.programId);
         return this.signerPublicKey;
     }
     getStateAccount() {
@@ -205,14 +205,14 @@ class ClearingHouse {
         return (await this.program.account.serumV3FulfillmentConfig.fetch(address));
     }
     /**
-     * Update the wallet to use for clearing house transactions and linked user account
+     * Update the wallet to use for drift transactions and linked user account
      * @param newWallet
      * @param subAccountIds
      * @param activeSubAccountId
      */
     async updateWallet(newWallet, subAccountIds = [0], activeSubAccountId = 0) {
         const newProvider = new anchor_1.AnchorProvider(this.connection, newWallet, this.opts);
-        const newProgram = new anchor_1.Program(clearing_house_json_1.default, this.program.programId, newProvider);
+        const newProgram = new anchor_1.Program(drift_json_1.default, this.program.programId, newProvider);
         // Update provider for txSender with new wallet details
         this.txSender.provider = newProvider;
         this.wallet = newWallet;
@@ -779,7 +779,7 @@ class ClearingHouse {
                 state: await this.getStatePublicKey(),
                 spotMarket: spotMarketAccount.pubkey,
                 spotMarketVault: spotMarketAccount.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 user: userAccountPublicKey,
                 userStats: this.getUserStatsAccountPublicKey(),
                 userTokenAccount: userTokenAccount,
@@ -1271,9 +1271,7 @@ class ClearingHouse {
         }
         const orderId = order.orderId;
         const makerOrderId = makerInfo ? makerInfo.order.orderId : null;
-        if (fulfillmentConfig) {
-            this.addSerumRemainingAccounts(marketIndex, remainingAccounts, fulfillmentConfig);
-        }
+        this.addSpotFulfillmentAccounts(marketIndex, remainingAccounts, fulfillmentConfig);
         return await this.program.instruction.fillSpotOrder(orderId, fulfillmentConfig ? fulfillmentConfig.fulfillmentType : null, makerOrderId, {
             accounts: {
                 state: await this.getStatePublicKey(),
@@ -1286,6 +1284,23 @@ class ClearingHouse {
             remainingAccounts,
         });
     }
+    addSpotFulfillmentAccounts(marketIndex, remainingAccounts, fulfillmentConfig) {
+        if (fulfillmentConfig) {
+            this.addSerumRemainingAccounts(marketIndex, remainingAccounts, fulfillmentConfig);
+        }
+        else {
+            remainingAccounts.push({
+                pubkey: this.getSpotMarketAccount(marketIndex).vault,
+                isWritable: false,
+                isSigner: false,
+            });
+            remainingAccounts.push({
+                pubkey: this.getQuoteSpotMarketAccount().vault,
+                isWritable: false,
+                isSigner: false,
+            });
+        }
+    }
     addSerumRemainingAccounts(marketIndex, remainingAccounts, fulfillmentConfig) {
         remainingAccounts.push({
             pubkey: fulfillmentConfig.pubkey,
@@ -1540,9 +1555,7 @@ class ClearingHouse {
                 isSigner: false,
             });
         }
-        if (fulfillmentConfig) {
-            this.addSerumRemainingAccounts(orderParams.marketIndex, remainingAccounts, fulfillmentConfig);
-        }
+        this.addSpotFulfillmentAccounts(orderParams.marketIndex, remainingAccounts, fulfillmentConfig);
         return await this.program.instruction.placeAndTakeSpotOrder(orderParams, fulfillmentConfig ? fulfillmentConfig.fulfillmentType : null, makerOrderId, {
             accounts: {
                 state: await this.getStatePublicKey(),
@@ -1583,9 +1596,7 @@ class ClearingHouse {
                 isSigner: false,
             });
         }
-        if (fulfillmentConfig) {
-            this.addSerumRemainingAccounts(orderParams.marketIndex, remainingAccounts, fulfillmentConfig);
-        }
+        this.addSpotFulfillmentAccounts(orderParams.marketIndex, remainingAccounts, fulfillmentConfig);
         const takerOrderId = takerInfo.order.orderId;
         return await this.program.instruction.placeAndMakeSpotOrder(orderParams, takerOrderId, fulfillmentConfig ? fulfillmentConfig.fulfillmentType : null, {
             accounts: {
@@ -1605,7 +1616,7 @@ class ClearingHouse {
      * @returns
      */
     async closePosition(marketIndex, limitPrice) {
-        const userPosition = this.getUser().getUserPosition(marketIndex);
+        const userPosition = this.getUser().getPerpPosition(marketIndex);
         if (!userPosition) {
             throw Error(`No position in market ${marketIndex.toString()}`);
         }
@@ -1830,7 +1841,7 @@ class ClearingHouse {
                 liquidatorStats: liquidatorStatsPublicKey,
                 spotMarketVault: spotMarket.vault,
                 insuranceFundVault: spotMarket.insuranceFund.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
             remainingAccounts: remainingAccounts,
@@ -1859,7 +1870,7 @@ class ClearingHouse {
                 liquidator: liquidatorPublicKey,
                 spotMarketVault: spotMarket.vault,
                 insuranceFundVault: spotMarket.insuranceFund.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
             remainingAccounts: remainingAccounts,
@@ -1952,7 +1963,7 @@ class ClearingHouse {
                 authority: this.wallet.publicKey,
                 spotMarketVault: spotMarket.vault,
                 insuranceFundVault: spotMarket.insuranceFund.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 userTokenAccount: collateralAccountPublicKey,
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
@@ -2015,7 +2026,7 @@ class ClearingHouse {
                 userStats: this.getUserStatsAccountPublicKey(),
                 authority: this.wallet.publicKey,
                 insuranceFundVault: spotMarketAccount.insuranceFund.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 userTokenAccount: collateralAccountPublicKey,
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
@@ -2034,7 +2045,7 @@ class ClearingHouse {
                 state: await this.getStatePublicKey(),
                 spotMarket: spotMarketAccount.pubkey,
                 spotMarketVault: spotMarketAccount.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 insuranceFundVault: spotMarketAccount.insuranceFund.vault,
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
@@ -2059,11 +2070,11 @@ class ClearingHouse {
                 authority: this.wallet.publicKey,
                 spotMarketVault: spotMarket.vault,
                 insuranceFundVault: spotMarket.insuranceFund.vault,
-                clearingHouseSigner: this.getSignerPublicKey(),
+                driftSigner: this.getSignerPublicKey(),
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
             remainingAccounts: remainingAccounts,
         });
     }
 }
-exports.ClearingHouse = ClearingHouse;
+exports.DriftClient = DriftClient;

package/lib/{clearingHouseConfig.d.ts → driftClientConfig.d.ts}

@@ -3,11 +3,11 @@ import { IWallet } from './types';
 import { OracleInfo } from './oracles/types';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
 import { DriftEnv } from './config';
-export declare type ClearingHouseConfig = {
+export declare type DriftClientConfig = {
     connection: Connection;
     wallet: IWallet;
     programID: PublicKey;
-    accountSubscription?: ClearingHouseSubscriptionConfig;
+    accountSubscription?: DriftClientSubscriptionConfig;
     opts?: ConfirmOptions;
     txSenderConfig?: TxSenderConfig;
     subAccountIds?: number[];
@@ -19,7 +19,7 @@ export declare type ClearingHouseConfig = {
     userStats?: boolean;
     authority?: PublicKey;
 };
-declare type ClearingHouseSubscriptionConfig = {
+declare type DriftClientSubscriptionConfig = {
     type: 'websocket';
 } | {
     type: 'polling';

package/lib/examples/makeTradeExample.js

@@ -30,12 +30,12 @@ const main = async () => {
     // Misc. other things to set up
     const usdcTokenAddress = await (0, exports.getTokenAddress)(sdkConfig.USDC_MINT_ADDRESS, wallet.publicKey.toString());
     // Set up the Drift Clearing House
-    const clearingHousePublicKey = new web3_js_1.PublicKey(sdkConfig.CLEARING_HOUSE_PROGRAM_ID);
+    const driftPublicKey = new web3_js_1.PublicKey(sdkConfig.CLEARING_HOUSE_PROGRAM_ID);
     const bulkAccountLoader = new __2.BulkAccountLoader(connection, 'confirmed', 1000);
-    const clearingHouse = new __2.ClearingHouse({
+    const driftClient = new __2.DriftClient({
         connection,
         wallet: provider.wallet,
-        programID: clearingHousePublicKey,
+        programID: driftPublicKey,
         perpMarketIndexes: __2.PerpMarkets[cluster].map((market) => market.marketIndex),
         spotMarketIndexes: spotMarkets_1.SpotMarkets[cluster].map((spotMarket) => spotMarket.marketIndex),
         accountSubscription: {
@@ -43,11 +43,11 @@ const main = async () => {
             accountLoader: bulkAccountLoader,
         },
     });
-    await clearingHouse.subscribe();
+    await driftClient.subscribe();
     // Set up Clearing House user client
-    const user = new __2.ClearingHouseUser({
-        clearingHouse,
-        userAccountPublicKey: await clearingHouse.getUserAccountPublicKey(),
+    const user = new __2.User({
+        driftClient: driftClient,
+        userAccountPublicKey: await driftClient.getUserAccountPublicKey(),
         accountSubscription: {
             type: 'polling',
             accountLoader: bulkAccountLoader,
@@ -58,26 +58,26 @@ const main = async () => {
     if (!userAccountExists) {
         //// Create a Clearing House account by Depositing some USDC ($10,000 in this case)
         const depositAmount = new anchor_1.BN(10000).mul(__2.QUOTE_PRECISION);
-        await clearingHouse.initializeUserAccountAndDepositCollateral(depositAmount, await (0, exports.getTokenAddress)(usdcTokenAddress.toString(), wallet.publicKey.toString()), spotMarkets_1.SpotMarkets['devnet'][0].marketIndex);
+        await driftClient.initializeUserAccountAndDepositCollateral(depositAmount, await (0, exports.getTokenAddress)(usdcTokenAddress.toString(), wallet.publicKey.toString()), spotMarkets_1.SpotMarkets['devnet'][0].marketIndex);
     }
     await user.subscribe();
     // Get current price
     const solMarketInfo = sdkConfig.PERP_MARKETS.find((market) => market.baseAssetSymbol === 'SOL');
-    const currentMarketPrice = (0, __2.calculateReservePrice)(clearingHouse.getPerpMarketAccount(solMarketInfo.marketIndex), undefined);
+    const currentMarketPrice = (0, __2.calculateReservePrice)(driftClient.getPerpMarketAccount(solMarketInfo.marketIndex), undefined);
     const formattedPrice = (0, __2.convertToNumber)(currentMarketPrice, __2.PRICE_PRECISION);
     console.log(`Current Market Price is $${formattedPrice}`);
     // Estimate the slippage for a $5000 LONG trade
-    const solMarketAccount = clearingHouse.getPerpMarketAccount(solMarketInfo.marketIndex);
+    const solMarketAccount = driftClient.getPerpMarketAccount(solMarketInfo.marketIndex);
     const longAmount = new anchor_1.BN(5000).mul(__2.QUOTE_PRECISION);
     const slippage = (0, __2.convertToNumber)((0, __2.calculateTradeSlippage)(__2.PositionDirection.LONG, longAmount, solMarketAccount, 'quote', undefined)[0], __2.PRICE_PRECISION);
     console.log(`Slippage for a $5000 LONG on the SOL market would be $${slippage}`);
     // Make a $5000 LONG trade
-    await clearingHouse.openPosition(__2.PositionDirection.LONG, longAmount, solMarketInfo.marketIndex);
+    await driftClient.openPosition(__2.PositionDirection.LONG, longAmount, solMarketInfo.marketIndex);
     console.log(`LONGED $5000 SOL`);
     // Reduce the position by $2000
     const reduceAmount = new anchor_1.BN(2000).mul(__2.QUOTE_PRECISION);
-    await clearingHouse.openPosition(__2.PositionDirection.SHORT, reduceAmount, solMarketInfo.marketIndex);
+    await driftClient.openPosition(__2.PositionDirection.SHORT, reduceAmount, solMarketInfo.marketIndex);
     // Close the rest of the position
-    await clearingHouse.closePosition(solMarketInfo.marketIndex);
+    await driftClient.closePosition(solMarketInfo.marketIndex);
 };
 main();