@drift-labs/sdk 0.2.0-temp.1 → 2.0.0

package/lib/clearingHouse.d.ts

@@ -1,146 +0,0 @@
-/// <reference types="node" />
-/// <reference types="bn.js" />
-import { AnchorProvider, BN, Program } from '@project-serum/anchor';
-import { StateAccount, IWallet, PositionDirection, UserAccount, MarketAccount, OrderParams, Order, BankAccount, UserBankBalance, MakerInfo, TakerInfo, OptionalOrderParams } from './types';
-import { Connection, PublicKey, TransactionSignature, ConfirmOptions, TransactionInstruction, AccountMeta } from '@solana/web3.js';
-import { TokenFaucet } from './tokenFaucet';
-import { EventEmitter } from 'events';
-import StrictEventEmitter from 'strict-event-emitter-types';
-import { ClearingHouseAccountSubscriber, ClearingHouseAccountEvents, DataAndSlot } from './accounts/types';
-import { TxSender } from './tx/types';
-import { OraclePriceData } from './oracles/types';
-import { ClearingHouseConfig } from './clearingHouseConfig';
-import { ClearingHouseUser } from './clearingHouseUser';
-import { ClearingHouseUserAccountSubscriptionConfig } from './clearingHouseUserConfig';
-/**
- * # 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.
- */
-export declare class ClearingHouse {
-    connection: Connection;
-    wallet: IWallet;
-    program: Program;
-    provider: AnchorProvider;
-    opts?: ConfirmOptions;
-    users: Map<number, ClearingHouseUser>;
-    activeUserId: number;
-    userAccountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig;
-    accountSubscriber: ClearingHouseAccountSubscriber;
-    eventEmitter: StrictEventEmitter<EventEmitter, ClearingHouseAccountEvents>;
-    _isSubscribed: boolean;
-    txSender: TxSender;
-    marketLastSlotCache: Map<number, number>;
-    get isSubscribed(): boolean;
-    set isSubscribed(val: boolean);
-    constructor(config: ClearingHouseConfig);
-    createUsers(userIds: number[], accountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig): void;
-    createUser(userId: number, accountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig): ClearingHouseUser;
-    subscribe(): Promise<boolean>;
-    subscribeUsers(): Promise<boolean>[];
-    /**
-     *	Forces the accountSubscriber to fetch account updates from rpc
-     */
-    fetchAccounts(): Promise<void>;
-    unsubscribe(): Promise<void>;
-    unsubscribeUsers(): Promise<void>[];
-    statePublicKey?: PublicKey;
-    getStatePublicKey(): Promise<PublicKey>;
-    getStateAccount(): StateAccount;
-    getMarketAccount(marketIndex: BN | number): MarketAccount | undefined;
-    getMarketAccounts(): MarketAccount[];
-    getBankAccount(bankIndex: BN | number): BankAccount | undefined;
-    getQuoteAssetBankAccount(): BankAccount;
-    getOraclePriceDataAndSlot(oraclePublicKey: PublicKey): DataAndSlot<OraclePriceData> | undefined;
-    /**
-     * Update the wallet to use for clearing house transactions and linked user account
-     * @param newWallet
-     * @param userIds
-     * @param activeUserId
-     */
-    updateWallet(newWallet: IWallet, userIds?: number[], activeUserId?: number): Promise<void>;
-    switchActiveUser(userId: number): Promise<void>;
-    addUser(userId: number): Promise<void>;
-    initializeUserAccount(userId?: number, name?: string): Promise<[TransactionSignature, PublicKey]>;
-    getInitializeUserInstructions(userId?: number, name?: string): Promise<[PublicKey, TransactionInstruction]>;
-    getUser(userId?: number): ClearingHouseUser;
-    getUsers(): ClearingHouseUser[];
-    getUserAccountPublicKey(): Promise<PublicKey>;
-    getUserAccount(userId?: number): UserAccount | undefined;
-    getUserAccountAndSlot(userId?: number): DataAndSlot<UserAccount> | undefined;
-    getUserBankBalance(bankIndex: number | BN): UserBankBalance | undefined;
-    getQuoteAssetTokenAmount(): BN;
-    getRemainingAccounts(params: {
-        writableMarketIndex?: BN;
-        writableBankIndex?: BN;
-    }): AccountMeta[];
-    getOrder(orderId: BN | number): Order | undefined;
-    getOrderByUserId(userOrderId: number): Order | undefined;
-    deposit(amount: BN, bankIndex: BN, collateralAccountPublicKey: PublicKey, userId?: number, reduceOnly?: boolean): Promise<TransactionSignature>;
-    getDepositInstruction(amount: BN, bankIndex: BN, userTokenAccount: PublicKey, userId?: number, reduceOnly?: boolean, userInitialized?: boolean): Promise<TransactionInstruction>;
-    /**
-     * Creates the Clearing House User account for a user, and deposits some initial collateral
-     * @param userId
-     * @param name
-     * @param amount
-     * @param userTokenAccount
-     * @param fromUserId
-     * @returns
-     */
-    initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, bankIndex?: BN, userId?: number, name?: string, fromUserId?: number): Promise<[TransactionSignature, PublicKey]>;
-    initializeUserAccountForDevnet(userId: number, name: string, bankIndex: BN, tokenFaucet: TokenFaucet, amount: BN): Promise<[TransactionSignature, PublicKey]>;
-    withdraw(amount: BN, bankIndex: BN, userTokenAccount: PublicKey, reduceOnly?: boolean): Promise<TransactionSignature>;
-    getWithdrawIx(amount: BN, bankIndex: BN, userTokenAccount: PublicKey, reduceOnly?: boolean): Promise<TransactionInstruction>;
-    transferDeposit(amount: BN, bankIndex: BN, fromUserId: number, toUserId: number): Promise<TransactionSignature>;
-    getTransferDepositIx(amount: BN, bankIndex: BN, fromUserId: number, toUserId: number): Promise<TransactionInstruction>;
-    updateBankCumulativeInterest(bankIndex: BN): Promise<TransactionSignature>;
-    updateBankCumulativeInterestIx(bankIndex: BN): Promise<TransactionInstruction>;
-    openPosition(direction: PositionDirection, amount: BN, marketIndex: BN, limitPrice?: BN): Promise<TransactionSignature>;
-    placeOrder(orderParams: OptionalOrderParams): Promise<TransactionSignature>;
-    getOrderParams(optionalOrderParams: OptionalOrderParams): OrderParams;
-    getPlaceOrderIx(orderParams: OptionalOrderParams): Promise<TransactionInstruction>;
-    updateAMMs(marketIndexes: BN[]): Promise<TransactionSignature>;
-    getUpdateAMMsIx(marketIndexes: BN[]): Promise<TransactionInstruction>;
-    cancelOrder(orderId?: BN): Promise<TransactionSignature>;
-    getCancelOrderIx(orderId?: BN): Promise<TransactionInstruction>;
-    cancelOrderByUserId(userOrderId: number): Promise<TransactionSignature>;
-    getCancelOrderByUserIdIx(userOrderId: number): Promise<TransactionInstruction>;
-    fillOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Order, makerInfo?: MakerInfo): Promise<TransactionSignature>;
-    getFillOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order, makerInfo?: MakerInfo): Promise<TransactionInstruction>;
-    triggerOrder(userAccountPublicKey: PublicKey, user: UserAccount, order: Order): Promise<TransactionSignature>;
-    getTriggerOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order): Promise<TransactionInstruction>;
-    placeAndTake(orderParams: OptionalOrderParams, makerInfo?: MakerInfo): Promise<TransactionSignature>;
-    getPlaceAndTakeIx(orderParams: OptionalOrderParams, makerInfo?: MakerInfo): Promise<TransactionInstruction>;
-    placeAndMake(orderParams: OptionalOrderParams, takerInfo: TakerInfo): Promise<TransactionSignature>;
-    getPlaceAndMakeIx(orderParams: OptionalOrderParams, takerInfo: TakerInfo): Promise<TransactionInstruction>;
-    /**
-     * 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
-     * @returns
-     */
-    closePosition(marketIndex: BN): Promise<TransactionSignature>;
-    settlePNLs(users: {
-        settleeUserAccountPublicKey: PublicKey;
-        settleeUserAccount: UserAccount;
-    }[], marketIndex: BN): Promise<TransactionSignature>;
-    settlePNL(settleeUserAccountPublicKey: PublicKey, settleeUserAccount: UserAccount, marketIndex: BN): Promise<TransactionSignature>;
-    settlePNLIx(settleeUserAccountPublicKey: PublicKey, settleeUserAccount: UserAccount, marketIndex: BN): Promise<TransactionInstruction>;
-    liquidatePerp(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: BN, maxBaseAssetAmount: BN): Promise<TransactionSignature>;
-    getLiquidatePerpIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: BN, maxBaseAssetAmount: BN): Promise<TransactionInstruction>;
-    liquidateBorrow(userAccountPublicKey: PublicKey, userAccount: UserAccount, assetBankIndex: BN, liabilityBankIndex: BN, maxLiabilityTransfer: BN): Promise<TransactionSignature>;
-    getLiquidateBorrowIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, assetBankIndex: BN, liabilityBankIndex: BN, maxLiabilityTransfer: BN): Promise<TransactionInstruction>;
-    liquidateBorrowForPerpPnl(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: BN, liabilityBankIndex: BN, maxLiabilityTransfer: BN): Promise<TransactionSignature>;
-    getLiquidateBorrowForPerpPnlIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: BN, liabilityBankIndex: BN, maxLiabilityTransfer: BN): Promise<TransactionInstruction>;
-    liquidatePerpPnlForDeposit(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: BN, assetBankIndex: BN, maxPnlTransfer: BN): Promise<TransactionSignature>;
-    getLiquidatePerpPnlForDepositIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: BN, assetBankIndex: BN, maxPnlTransfer: BN): Promise<TransactionInstruction>;
-    getRemainingAccountsForLiquidation(params: {
-        userAccount: UserAccount;
-        writableMarketIndex?: BN;
-        writableBankIndexes?: BN[];
-    }): AccountMeta[];
-    updateFundingRate(oracle: PublicKey, marketIndex: BN): Promise<TransactionSignature>;
-    getUpdateFundingRateIx(oracle: PublicKey, marketIndex: BN): Promise<TransactionInstruction>;
-    settleFundingPayment(userAccount: PublicKey): Promise<TransactionSignature>;
-    getSettleFundingPaymentIx(userAccount: PublicKey): Promise<TransactionInstruction>;
-    triggerEvent(eventName: keyof ClearingHouseAccountEvents, data?: any): void;
-    getOracleDataForMarket(marketIndex: BN): OraclePriceData;
-}