@drift-labs/sdk 0.1.36-master.4 → 0.1.36-master.7

package/lib/accounts/bulkAccountLoader.d.ts

@@ -16,6 +16,7 @@ export declare class BulkAccountLoader {
     loadPromise?: Promise<void>;
     loadPromiseResolver: () => void;
     lastTimeLoadingPromiseCleared: number;
+    mostRecentSlot: number;
     constructor(connection: Connection, commitment: Commitment, pollingFrequency: number);
     addAccount(publicKey: PublicKey, callback: (buffer: Buffer) => void): string;
     removeAccount(publicKey: PublicKey, callbackId: string): void;

package/lib/accounts/bulkAccountLoader.js

@@ -20,6 +20,7 @@ class BulkAccountLoader {
         this.accountData = new Map();
         this.errorCallbacks = new Map();
         this.lastTimeLoadingPromiseCleared = Date.now();
+        this.mostRecentSlot = 0;
         this.connection = connection;
         this.commitment = commitment;
         this.pollingFrequency = pollingFrequency;
@@ -127,6 +128,9 @@ class BulkAccountLoader {
                 return;
             }
             const newSlot = rpcResponse.result.context.slot;
+            if (newSlot > this.mostRecentSlot) {
+                this.mostRecentSlot = newSlot;
+            }
             for (const i in accountsToLoad) {
                 const accountToLoad = accountsToLoad[i];
                 const key = accountToLoad.publicKey.toString();

package/lib/addresses.d.ts

@@ -7,3 +7,4 @@ export declare function getUserAccountPublicKeyAndNonce(programId: PublicKey, au
 export declare function getUserAccountPublicKey(programId: PublicKey, authority: PublicKey): Promise<PublicKey>;
 export declare function getUserOrdersAccountPublicKeyAndNonce(programId: PublicKey, userAccount: PublicKey): Promise<[PublicKey, number]>;
 export declare function getUserOrdersAccountPublicKey(programId: PublicKey, userAccount: PublicKey): Promise<PublicKey>;
+export declare function getSettlementStatePublicKey(programId: PublicKey): Promise<PublicKey>;

package/lib/addresses.js

@@ -32,7 +32,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserOrdersAccountPublicKey = exports.getUserOrdersAccountPublicKeyAndNonce = exports.getUserAccountPublicKey = exports.getUserAccountPublicKeyAndNonce = exports.getClearingHouseStateAccountPublicKey = exports.getOrderStateAccountPublicKeyAndNonce = exports.getOrderStateAccountPublicKey = exports.getClearingHouseStateAccountPublicKeyAndNonce = void 0;
+exports.getSettlementStatePublicKey = exports.getUserOrdersAccountPublicKey = exports.getUserOrdersAccountPublicKeyAndNonce = exports.getUserAccountPublicKey = exports.getUserAccountPublicKeyAndNonce = exports.getClearingHouseStateAccountPublicKey = exports.getOrderStateAccountPublicKeyAndNonce = exports.getOrderStateAccountPublicKey = exports.getClearingHouseStateAccountPublicKeyAndNonce = void 0;
 const anchor = __importStar(require("@project-serum/anchor"));
 function getClearingHouseStateAccountPublicKeyAndNonce(programId) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -85,3 +85,9 @@ function getUserOrdersAccountPublicKey(programId, userAccount) {
     });
 }
 exports.getUserOrdersAccountPublicKey = getUserOrdersAccountPublicKey;
+function getSettlementStatePublicKey(programId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return (yield anchor.web3.PublicKey.findProgramAddress([Buffer.from(anchor.utils.bytes.utf8.encode('settlement_state'))], programId))[0];
+    });
+}
+exports.getSettlementStatePublicKey = getSettlementStatePublicKey;

package/lib/admin.d.ts

@@ -42,4 +42,9 @@ export declare class Admin extends ClearingHouse {
     updateFundingPaused(fundingPaused: boolean): Promise<TransactionSignature>;
     updateExchangePaused(exchangePaused: boolean): Promise<TransactionSignature>;
     disableAdminControlsPrices(): Promise<TransactionSignature>;
+    transferFromInsuranceVaultToCollateralVault(): Promise<TransactionSignature>;
+    adminUpdateUserForgoSettlement(authority: PublicKey): Promise<TransactionSignature>;
+    initializeSettlementState(): Promise<TransactionSignature>;
+    updateSettlementState(): Promise<TransactionSignature>;
+    updateSettlementStateEnabled(enabled: boolean): Promise<TransactionSignature>;
 }

package/lib/admin.js

@@ -526,5 +526,73 @@ class Admin extends clearingHouse_1.ClearingHouse {
             });
         });
     }
+    transferFromInsuranceVaultToCollateralVault() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const state = yield this.getStateAccount();
+            return yield this.program.rpc.transferFromInsuranceVaultToCollateralVault({
+                accounts: {
+                    admin: this.wallet.publicKey,
+                    state: yield this.getStatePublicKey(),
+                    insuranceVault: state.insuranceVault,
+                    insuranceVaultAuthority: state.insuranceVaultAuthority,
+                    collateralVault: state.collateralVault,
+                    tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
+                },
+            });
+        });
+    }
+    adminUpdateUserForgoSettlement(authority) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const user = yield (0, addresses_1.getUserAccountPublicKey)(this.program.programId, authority);
+            return yield this.program.rpc.adminUpdateUserForgoSettlement({
+                accounts: {
+                    admin: this.wallet.publicKey,
+                    state: yield this.getStatePublicKey(),
+                    user: user,
+                },
+            });
+        });
+    }
+    initializeSettlementState() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const settlementState = yield (0, addresses_1.getSettlementStatePublicKey)(this.program.programId);
+            const settlementSize = yield this.getTotalSettlementSize();
+            return yield this.program.rpc.initializeSettlementState(settlementSize, {
+                accounts: {
+                    admin: this.wallet.publicKey,
+                    state: yield this.getStatePublicKey(),
+                    settlementState: settlementState,
+                    rent: web3_js_1.SYSVAR_RENT_PUBKEY,
+                    systemProgram: anchor.web3.SystemProgram.programId,
+                    collateralVault: (yield this.getStateAccount()).collateralVault,
+                },
+            });
+        });
+    }
+    updateSettlementState() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const settlementState = yield (0, addresses_1.getSettlementStatePublicKey)(this.program.programId);
+            return yield this.program.rpc.updateSettlementState({
+                accounts: {
+                    admin: this.wallet.publicKey,
+                    state: yield this.getStatePublicKey(),
+                    settlementState: settlementState,
+                    collateralVault: (yield this.getStateAccount()).collateralVault,
+                },
+            });
+        });
+    }
+    updateSettlementStateEnabled(enabled) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const settlementState = yield (0, addresses_1.getSettlementStatePublicKey)(this.program.programId);
+            return yield this.program.rpc.updateSettlementStateEnabled(enabled, {
+                accounts: {
+                    admin: this.wallet.publicKey,
+                    state: yield this.getStatePublicKey(),
+                    settlementState: settlementState,
+                },
+            });
+        });
+    }
 }
 exports.Admin = Admin;

package/lib/clearingHouse.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="bn.js" />
 import { AnchorProvider, BN, Program } from '@project-serum/anchor';
-import { MarketsAccount, StateAccount, DepositHistoryAccount, FundingPaymentHistoryAccount, FundingRateHistoryAccount, IWallet, LiquidationHistoryAccount, PositionDirection, TradeHistoryAccount, UserAccount, Market, OrderHistoryAccount, OrderStateAccount, OrderParams, Order, ExtendedCurveHistoryAccount, UserPositionsAccount } from './types';
+import { MarketsAccount, StateAccount, DepositHistoryAccount, FundingPaymentHistoryAccount, FundingRateHistoryAccount, IWallet, LiquidationHistoryAccount, PositionDirection, TradeHistoryAccount, UserAccount, Market, OrderHistoryAccount, OrderStateAccount, OrderParams, Order, ExtendedCurveHistoryAccount, UserPositionsAccount, SettlementStateAccount } from './types';
 import { Connection, PublicKey, TransactionSignature, Keypair, ConfirmOptions, TransactionInstruction } from '@solana/web3.js';
 import { MockUSDCFaucet } from './mockUSDCFaucet';
 import { EventEmitter } from 'events';
@@ -59,6 +59,7 @@ export declare class ClearingHouse {
     statePublicKey?: PublicKey;
     getStatePublicKey(): Promise<PublicKey>;
     getStateAccount(): StateAccount;
+    getSettlementAccount(): Promise<SettlementStateAccount>;
     getMarketsAccount(): MarketsAccount;
     getMarket(marketIndex: BN | number): Market;
     getFundingPaymentHistoryAccount(): FundingPaymentHistoryAccount;
@@ -126,8 +127,10 @@ export declare class ClearingHouse {
     getCancelOrderIx(orderId: BN, oracle?: PublicKey): Promise<TransactionInstruction>;
     cancelOrderByUserId(userOrderId: number, oracle?: PublicKey): Promise<TransactionSignature>;
     getCancelOrderByUserIdIx(userOrderId: number, oracle?: PublicKey): Promise<TransactionInstruction>;
-    cancelAllOrders(oracles?: PublicKey[]): Promise<TransactionSignature>;
-    getCancelAllOrdersIx(oracles: PublicKey[]): Promise<TransactionInstruction>;
+    cancelAllOrders(oracles?: PublicKey[], bestEffort?: boolean): Promise<TransactionSignature>;
+    getCancelAllOrdersIx(oracles: PublicKey[], bestEffort?: boolean): Promise<TransactionInstruction>;
+    cancelOrdersByMarketAndSide(oracles?: PublicKey[], bestEffort?: boolean, marketIndexOnly?: BN, directionOnly?: PositionDirection): Promise<TransactionSignature>;
+    getCancelOrdersByMarketAndSideIx(oracles: PublicKey[], bestEffort?: boolean, marketIndexOnly?: BN, directionOnly?: PositionDirection): Promise<TransactionInstruction>;
     fillOrder(userAccountPublicKey: PublicKey, userOrdersAccountPublicKey: PublicKey, order: Order): Promise<TransactionSignature>;
     getFillOrderIx(userAccountPublicKey: PublicKey, userOrdersAccountPublicKey: PublicKey, order: Order): Promise<TransactionInstruction>;
     initializeUserOrdersThenPlaceAndFillOrder(orderParams: OrderParams, discountToken?: PublicKey, referrer?: PublicKey): Promise<TransactionSignature>;
@@ -150,4 +153,9 @@ export declare class ClearingHouse {
     settleFundingPayment(userAccount: PublicKey, userPositionsAccount: PublicKey): Promise<TransactionSignature>;
     getSettleFundingPaymentIx(userAccount: PublicKey, userPositionsAccount: PublicKey): Promise<TransactionInstruction>;
     triggerEvent(eventName: keyof ClearingHouseAccountEvents, data?: any): void;
+    settlePositionAndClaimCollateral(collateralAccountPublicKey: PublicKey): Promise<TransactionSignature>;
+    getSettlePositionIx(): Promise<TransactionInstruction>;
+    getClaimCollateralIx(collateralAccountPublicKey: PublicKey): Promise<TransactionInstruction>;
+    getTotalSettlementSize(): Promise<BN>;
+    updateUserForgoSettlement(): Promise<TransactionSignature>;
 }

package/lib/clearingHouse.js

@@ -45,6 +45,9 @@ const addresses_1 = require("./addresses");
 const utils_1 = require("./tx/utils");
 const clearingHouse_1 = require("./factory/clearingHouse");
 const numericConstants_1 = require("./constants/numericConstants");
+const bulkAccountLoader_1 = require("./accounts/bulkAccountLoader");
+const clearingHouseUser_1 = require("./factory/clearingHouseUser");
+const bulkUserSubscription_1 = require("./accounts/bulkUserSubscription");
 /**
  * # ClearingHouse
  * 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.
@@ -138,6 +141,12 @@ class ClearingHouse {
     getStateAccount() {
         return this.accountSubscriber.getStateAccount();
     }
+    getSettlementAccount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // @ts-ignore
+            return yield this.program.account.settlementState.fetch(yield (0, addresses_1.getSettlementStatePublicKey)(this.program.programId));
+        });
+    }
     getMarketsAccount() {
         return this.accountSubscriber.getMarketsAccount();
     }
@@ -622,12 +631,12 @@ class ClearingHouse {
             });
         });
     }
-    cancelAllOrders(oracles) {
+    cancelAllOrders(oracles, bestEffort) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.txSender.send((0, utils_1.wrapInTx)(yield this.getCancelAllOrdersIx(oracles)), [], this.opts);
+            return yield this.txSender.send((0, utils_1.wrapInTx)(yield this.getCancelAllOrdersIx(oracles, bestEffort)), [], this.opts);
         });
     }
-    getCancelAllOrdersIx(oracles) {
+    getCancelAllOrdersIx(oracles, bestEffort) {
         return __awaiter(this, void 0, void 0, function* () {
             const userAccountPublicKey = yield this.getUserAccountPublicKey();
             const userAccount = yield this.getUserAccount();
@@ -641,7 +650,43 @@ class ClearingHouse {
                     isSigner: false,
                 });
             }
-            return yield this.program.instruction.cancelAllOrders({
+            return yield this.program.instruction.cancelAllOrders(bestEffort, {
+                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,
+                },
+                remainingAccounts,
+            });
+        });
+    }
+    cancelOrdersByMarketAndSide(oracles, bestEffort, marketIndexOnly, directionOnly) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.txSender.send((0, utils_1.wrapInTx)(yield this.getCancelOrdersByMarketAndSideIx(oracles, bestEffort, marketIndexOnly, directionOnly)), [], this.opts);
+        });
+    }
+    getCancelOrdersByMarketAndSideIx(oracles, bestEffort, marketIndexOnly, directionOnly) {
+        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();
+            const remainingAccounts = [];
+            for (const oracle of oracles) {
+                remainingAccounts.push({
+                    pubkey: oracle,
+                    isWritable: false,
+                    isSigner: false,
+                });
+            }
+            return yield this.program.instruction.cancelOrdersByMarketAndSide(bestEffort, marketIndexOnly, directionOnly, {
                 accounts: {
                     state: yield this.getStatePublicKey(),
                     user: userAccountPublicKey,
@@ -922,5 +967,86 @@ class ClearingHouse {
     triggerEvent(eventName, data) {
         this.eventEmitter.emit(eventName, data);
     }
+    settlePositionAndClaimCollateral(collateralAccountPublicKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const settlePositionIx = yield this.getSettlePositionIx();
+            const claimCollateralIx = yield this.getClaimCollateralIx(collateralAccountPublicKey);
+            const tx = new web3_js_1.Transaction().add(settlePositionIx).add(claimCollateralIx);
+            return this.txSender.send(tx, [], this.opts);
+        });
+    }
+    getSettlePositionIx() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userAccountPublicKey = yield this.getUserAccountPublicKey();
+            const user = yield this.program.account.user.fetch(userAccountPublicKey);
+            const state = this.getStateAccount();
+            const settlementState = yield (0, addresses_1.getSettlementStatePublicKey)(this.program.programId);
+            return yield this.program.instruction.settlePosition({
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    user: userAccountPublicKey,
+                    markets: state.markets,
+                    authority: this.wallet.publicKey,
+                    userPositions: user.positions,
+                    settlementState,
+                    fundingPaymentHistory: state.fundingPaymentHistory,
+                },
+            });
+        });
+    }
+    getClaimCollateralIx(collateralAccountPublicKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userAccountPublicKey = yield this.getUserAccountPublicKey();
+            const state = this.getStateAccount();
+            const settlementState = yield (0, addresses_1.getSettlementStatePublicKey)(this.program.programId);
+            return yield this.program.instruction.claimCollateral({
+                accounts: {
+                    state: yield this.getStatePublicKey(),
+                    user: userAccountPublicKey,
+                    collateralVault: state.collateralVault,
+                    collateralVaultAuthority: state.collateralVaultAuthority,
+                    userCollateralAccount: collateralAccountPublicKey,
+                    authority: this.wallet.publicKey,
+                    tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
+                    settlementState,
+                },
+            });
+        });
+    }
+    getTotalSettlementSize() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const accountLoader = new bulkAccountLoader_1.BulkAccountLoader(this.connection, 'processed', 50000);
+            const clearingHouse = (0, clearingHouse_1.getClearingHouse)((0, clearingHouse_1.getPollingClearingHouseConfig)(this.connection, this.wallet, this.program.programId, accountLoader));
+            console.log('loading all users');
+            const programUserAccounts = (yield this.program.account.user.all());
+            const userArray = [];
+            for (const programUserAccount of programUserAccounts) {
+                const user = (0, clearingHouseUser_1.getClearingHouseUser)((0, clearingHouseUser_1.getPollingClearingHouseUserConfig)(clearingHouse, programUserAccount.account.authority, accountLoader));
+                userArray.push(user);
+            }
+            console.log('subscribing all users');
+            yield (0, bulkUserSubscription_1.bulkPollingUserSubscribe)(userArray, accountLoader);
+            console.log('calculating settlement size');
+            const settlementSize = userArray.reduce((collateralToBeSettled, user) => {
+                return collateralToBeSettled.add(user.getUserAccount().forgoPositionSettlement === 0
+                    ? user.getSettledPositionValue()
+                    : numericConstants_1.ZERO);
+            }, numericConstants_1.ZERO);
+            for (const user of userArray) {
+                yield user.unsubscribe();
+            }
+            return settlementSize;
+        });
+    }
+    updateUserForgoSettlement() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.program.rpc.updateUserForgoSettlement({
+                accounts: {
+                    authority: this.wallet.publicKey,
+                    user: yield this.getUserAccountPublicKey(),
+                },
+            });
+        });
+    }
 }
 exports.ClearingHouse = ClearingHouse;

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 { MarginCategory, Order, UserAccount, UserOrdersAccount, UserPosition, UserPositionsAccount } from './types';
+import { MarginCategory, Order, SettlementStateAccount, UserAccount, UserOrdersAccount, UserPosition, UserPositionsAccount } from './types';
 import { UserAccountSubscriber, UserAccountEvents } from './accounts/types';
 import { PositionDirection, BN } from '.';
 export declare class ClearingHouseUser {
@@ -183,4 +183,8 @@ export declare class ClearingHouseUser {
      * @returns positionValue : Precision QUOTE_PRECISION
      */
     private getTotalPositionValueExcludingMarket;
+    getClaimableCollateral(settlementState: SettlementStateAccount): BN;
+    getSettledPositionValue(): BN;
+    getSettledPositionsPNL(): BN;
+    estimateClaimableCollateral(): Promise<BN>;
 }

package/lib/clearingHouseUser.js

@@ -597,5 +597,33 @@ class ClearingHouseUser {
         }
         return this.getTotalPositionValue().sub(currentMarketPositionValueUSDC);
     }
+    getClaimableCollateral(settlementState) {
+        return this.getSettledPositionValue()
+            .mul(settlementState.collateralAvailableToClaim.sub(this.getUserAccount().lastCollateralAvailableToClaim))
+            .div(settlementState.totalSettlementValue);
+    }
+    getSettledPositionValue() {
+        return _1.BN.max(this.getUserAccount()
+            .collateral.add(this.getUnrealizedFundingPNL().div(numericConstants_1.PRICE_TO_QUOTE_PRECISION))
+            .add(this.getSettledPositionsPNL()), numericConstants_1.ZERO);
+    }
+    getSettledPositionsPNL() {
+        return this.getUserPositionsAccount().positions.reduce((pnl, marketPosition) => {
+            const market = this.clearingHouse.getMarket(marketPosition.marketIndex);
+            return pnl.add((0, position_1.calculateSettledPositionPNL)(market, marketPosition));
+        }, numericConstants_1.ZERO);
+    }
+    estimateClaimableCollateral() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const currentCollateralVaultBalance = new _1.BN((yield this.clearingHouse.connection.getTokenAccountBalance(this.clearingHouse.getStateAccount().collateralVault)).value.amount);
+            const currentInsuranceVaultBalance = new _1.BN((yield this.clearingHouse.connection.getTokenAccountBalance(this.clearingHouse.getStateAccount().insuranceVault)).value.amount);
+            const totalClaimableCollateral = currentCollateralVaultBalance.add(currentInsuranceVaultBalance);
+            const totalEstimatedSettlementValue = yield this.clearingHouse.getTotalSettlementSize();
+            const userSettledPositionValue = yield this.getSettledPositionValue();
+            return totalClaimableCollateral
+                .mul(userSettledPositionValue)
+                .div(totalEstimatedSettlementValue);
+        });
+    }
 }
 exports.ClearingHouseUser = ClearingHouseUser;