@drift-labs/sdk 2.19.0 → 2.20.0-beta.1

package/lib/types.d.ts

@@ -308,8 +308,8 @@ export declare enum TradeSide {
     Buy = 1,
     Sell = 2
 }
-export declare type CandleResolution = '1' | '5' | '15' | '60' | '240' | 'D' | 'W' | 'M';
-export declare type NewUserRecord = {
+export type CandleResolution = '1' | '5' | '15' | '60' | '240' | 'D' | 'W' | 'M';
+export type NewUserRecord = {
     ts: BN;
     userAuthority: PublicKey;
     user: PublicKey;
@@ -317,7 +317,7 @@ export declare type NewUserRecord = {
     name: number[];
     referrer: PublicKey;
 };
-export declare type DepositRecord = {
+export type DepositRecord = {
     ts: BN;
     userAuthority: PublicKey;
     user: PublicKey;
@@ -338,7 +338,7 @@ export declare type DepositRecord = {
     explanation: DepositExplanation;
     transferUser?: PublicKey;
 };
-export declare type SpotInterestRecord = {
+export type SpotInterestRecord = {
     ts: BN;
     marketIndex: number;
     depositBalance: BN;
@@ -349,7 +349,7 @@ export declare type SpotInterestRecord = {
     optimalBorrowRate: number;
     maxBorrowRate: number;
 };
-export declare type CurveRecord = {
+export type CurveRecord = {
     ts: BN;
     recordId: BN;
     marketIndex: number;
@@ -397,7 +397,7 @@ export declare type InsuranceFundStakeRecord = {
     userIfSharesAfter: BN;
     totalIfSharesAfter: BN;
 };
-export declare type LPRecord = {
+export type LPRecord = {
     ts: BN;
     user: PublicKey;
     action: LPAction;
@@ -418,7 +418,7 @@ export declare class LPAction {
         settleLiquidity: {};
     };
 }
-export declare type FundingRateRecord = {
+export type FundingRateRecord = {
     ts: BN;
     recordId: BN;
     marketIndex: number;
@@ -433,7 +433,7 @@ export declare type FundingRateRecord = {
     baseAssetAmountWithAmm: BN;
     baseAssetAmountWithUnsettledLp: BN;
 };
-export declare type FundingPaymentRecord = {
+export type FundingPaymentRecord = {
     ts: BN;
     userAuthority: PublicKey;
     user: PublicKey;
@@ -444,7 +444,7 @@ export declare type FundingPaymentRecord = {
     ammCumulativeFundingLong: BN;
     ammCumulativeFundingShort: BN;
 };
-export declare type LiquidationRecord = {
+export type LiquidationRecord = {
     ts: BN;
     user: PublicKey;
     liquidator: PublicKey;
@@ -482,7 +482,7 @@ export declare class LiquidationType {
         liquidateSpot: {};
     };
 }
-export declare type LiquidatePerpRecord = {
+export type LiquidatePerpRecord = {
     marketIndex: number;
     oraclePrice: BN;
     baseAssetAmount: BN;
@@ -494,7 +494,7 @@ export declare type LiquidatePerpRecord = {
     liquidatorFee: BN;
     ifFee: BN;
 };
-export declare type LiquidateSpotRecord = {
+export type LiquidateSpotRecord = {
     assetMarketIndex: number;
     assetPrice: BN;
     assetTransfer: BN;
@@ -503,7 +503,7 @@ export declare type LiquidateSpotRecord = {
     liabilityTransfer: BN;
     ifFee: BN;
 };
-export declare type LiquidateBorrowForPerpPnlRecord = {
+export type LiquidateBorrowForPerpPnlRecord = {
     perpMarketIndex: number;
     marketOraclePrice: BN;
     pnlTransfer: BN;
@@ -511,7 +511,7 @@ export declare type LiquidateBorrowForPerpPnlRecord = {
     liabilityPrice: BN;
     liabilityTransfer: BN;
 };
-export declare type LiquidatePerpPnlForDepositRecord = {
+export type LiquidatePerpPnlForDepositRecord = {
     perpMarketIndex: number;
     marketOraclePrice: BN;
     pnlTransfer: BN;
@@ -519,7 +519,7 @@ export declare type LiquidatePerpPnlForDepositRecord = {
     assetPrice: BN;
     assetTransfer: BN;
 };
-export declare type PerpBankruptcyRecord = {
+export type PerpBankruptcyRecord = {
     marketIndex: number;
     pnl: BN;
     ifPayment: BN;
@@ -527,13 +527,13 @@ export declare type PerpBankruptcyRecord = {
     clawbackUserPayment: BN | null;
     cumulativeFundingRateDelta: BN;
 };
-export declare type SpotBankruptcyRecord = {
+export type SpotBankruptcyRecord = {
     marketIndex: number;
     borrowAmount: BN;
     cumulativeDepositInterestDelta: BN;
     ifPayment: BN;
 };
-export declare type SettlePnlRecord = {
+export type SettlePnlRecord = {
     ts: BN;
     user: PublicKey;
     marketIndex: number;
@@ -544,12 +544,12 @@ export declare type SettlePnlRecord = {
     settlePrice: BN;
     explanation: SettlePnlExplanation;
 };
-export declare type OrderRecord = {
+export type OrderRecord = {
     ts: BN;
     user: PublicKey;
     order: Order;
 };
-export declare type OrderActionRecord = {
+export type OrderActionRecord = {
     ts: BN;
     action: OrderAction;
     actionExplanation: OrderActionExplanation;
@@ -579,7 +579,7 @@ export declare type OrderActionRecord = {
     makerOrderCumulativeQuoteAssetAmountFilled: BN | null;
     oraclePrice: BN;
 };
-export declare type StateAccount = {
+export type StateAccount = {
     admin: PublicKey;
     exchangeStatus: number;
     whitelistMint: PublicKey;
@@ -603,7 +603,7 @@ export declare type StateAccount = {
     initialPctToLiquidate: number;
     liquidationDuration: number;
 };
-export declare type PerpMarketAccount = {
+export type PerpMarketAccount = {
     status: MarketStatus;
     contractType: ContractType;
     contractTier: ContractTier;
@@ -636,7 +636,7 @@ export declare type PerpMarketAccount = {
         quoteMaxInsurance: BN;
     };
 };
-export declare type HistoricalOracleData = {
+export type HistoricalOracleData = {
     lastOraclePrice: BN;
     lastOracleDelay: BN;
     lastOracleConf: BN;
@@ -644,14 +644,14 @@ export declare type HistoricalOracleData = {
     lastOraclePriceTwap5Min: BN;
     lastOraclePriceTwapTs: BN;
 };
-export declare type HistoricalIndexData = {
+export type HistoricalIndexData = {
     lastIndexBidPrice: BN;
     lastIndexAskPrice: BN;
     lastIndexPriceTwap: BN;
     lastIndexPriceTwap5Min: BN;
     lastIndexPriceTwapTs: BN;
 };
-export declare type SpotMarketAccount = {
+export type SpotMarketAccount = {
     status: MarketStatus;
     assetTier: AssetTier;
     marketIndex: number;
@@ -706,11 +706,11 @@ export declare type SpotMarketAccount = {
     totalSpotFee: BN;
     ordersEnabled: boolean;
 };
-export declare type PoolBalance = {
+export type PoolBalance = {
     scaledBalance: BN;
     marketIndex: number;
 };
-export declare type AMM = {
+export type AMM = {
     baseAssetReserve: BN;
     sqrtK: BN;
     cumulativeFundingRate: BN;
@@ -788,7 +788,7 @@ export declare type AMM = {
     askBaseAssetReserve: BN;
     askQuoteAssetReserve: BN;
 };
-export declare type PerpPosition = {
+export type PerpPosition = {
     baseAssetAmount: BN;
     lastCumulativeFundingRate: BN;
     marketIndex: number;
@@ -804,7 +804,7 @@ export declare type PerpPosition = {
     lastBaseAssetAmountPerLp: BN;
     lastQuoteAssetAmountPerLp: BN;
 };
-export declare type UserStatsAccount = {
+export type UserStatsAccount = {
     numberOfSubAccounts: number;
     numberOfSubAccountsCreated: number;
     makerVolume30D: BN;
@@ -826,7 +826,7 @@ export declare type UserStatsAccount = {
     authority: PublicKey;
     ifStakedQuoteAssetAmount: BN;
 };
-export declare type UserAccount = {
+export type UserAccount = {
     authority: PublicKey;
     delegate: PublicKey;
     name: number[];
@@ -848,7 +848,7 @@ export declare type UserAccount = {
     liquidationStartSlot: BN;
     isMarginTradingEnabled: boolean;
 };
-export declare type SpotPosition = {
+export type SpotPosition = {
     marketIndex: number;
     balanceType: SpotBalanceType;
     scaledBalance: BN;
@@ -857,7 +857,7 @@ export declare type SpotPosition = {
     openAsks: BN;
     cumulativeDeposits: BN;
 };
-export declare type Order = {
+export type Order = {
     status: OrderStatus;
     orderType: OrderType;
     marketType: MarketType;
@@ -883,7 +883,7 @@ export declare type Order = {
     auctionEndPrice: BN;
     maxTs: BN;
 };
-export declare type OrderParams = {
+export type OrderParams = {
     orderType: OrderType;
     marketType: MarketType;
     userOrderId: number;
@@ -914,33 +914,33 @@ export declare class PostOnlyParams {
         tryPostOnly: {};
     };
 }
-export declare type NecessaryOrderParams = {
+export type NecessaryOrderParams = {
     orderType: OrderType;
     marketIndex: number;
     baseAssetAmount: BN;
     direction: PositionDirection;
 };
-export declare type OptionalOrderParams = {
+export type OptionalOrderParams = {
     [Property in keyof OrderParams]?: OrderParams[Property];
 } & NecessaryOrderParams;
 export declare const DefaultOrderParams: OrderParams;
-export declare type MakerInfo = {
+export type MakerInfo = {
     maker: PublicKey;
     makerStats: PublicKey;
     makerUserAccount: UserAccount;
-    order: Order;
+    order?: Order;
 };
-export declare type TakerInfo = {
+export type TakerInfo = {
     taker: PublicKey;
     takerStats: PublicKey;
     takerUserAccount: UserAccount;
     order: Order;
 };
-export declare type ReferrerInfo = {
+export type ReferrerInfo = {
     referrer: PublicKey;
     referrerStats: PublicKey;
 };
-export declare type TxParams = {
+export type TxParams = {
     computeUnits?: number;
     computeUnitsPrice?: number;
 };
@@ -949,7 +949,7 @@ export interface IWallet {
     signAllTransactions(txs: Transaction[]): Promise<Transaction[]>;
     publicKey: PublicKey;
 }
-export declare type FeeStructure = {
+export type FeeStructure = {
     feeTiers: FeeTier[];
     makerRebateNumerator: BN;
     makerRebateDenominator: BN;
@@ -957,7 +957,7 @@ export declare type FeeStructure = {
     flatFillerFee: BN;
     referrerRewardEpochUpperBound: BN;
 };
-export declare type FeeTier = {
+export type FeeTier = {
     feeNumerator: number;
     feeDenominator: number;
     makerRebateNumerator: number;
@@ -967,12 +967,12 @@ export declare type FeeTier = {
     refereeFeeNumerator: number;
     refereeFeeDenominator: number;
 };
-export declare type OrderFillerRewardStructure = {
+export type OrderFillerRewardStructure = {
     rewardNumerator: BN;
     rewardDenominator: BN;
     timeBasedRewardLowerBound: BN;
 };
-export declare type OracleGuardRails = {
+export type OracleGuardRails = {
     priceDivergence: {
         markOracleDivergenceNumerator: BN;
         markOracleDivergenceDenominator: BN;
@@ -984,8 +984,8 @@ export declare type OracleGuardRails = {
         tooVolatileRatio: BN;
     };
 };
-export declare type MarginCategory = 'Initial' | 'Maintenance';
-export declare type InsuranceFundStake = {
+export type MarginCategory = 'Initial' | 'Maintenance';
+export type InsuranceFundStake = {
     marketIndex: number;
     authority: PublicKey;
     ifShares: BN;
@@ -994,7 +994,7 @@ export declare type InsuranceFundStake = {
     lastWithdrawRequestValue: BN;
     lastWithdrawRequestTs: BN;
 };
-export declare type SerumV3FulfillmentConfigAccount = {
+export type SerumV3FulfillmentConfigAccount = {
     fulfillmentType: SpotFulfillmentType;
     status: SpotFulfillmentStatus;
     pubkey: PublicKey;
@@ -1010,3 +1010,24 @@ export declare type SerumV3FulfillmentConfigAccount = {
     serumOpenOrders: PublicKey;
     serumSignerNonce: BN;
 };
+export type PerpMarketExtendedInfo = {
+    marketIndex: number;
+    /**
+     * Min order size measured in base asset, using base precision
+     */
+    minOrderSize: BN;
+    /**
+     * Margin maintenance percentage, using margin precision (1e4)
+     */
+    marginMaintenance: number;
+    /**
+     * Max insurance available, measured in quote asset, using quote preicision
+     */
+    availableInsurance: BN;
+    /**
+     * Pnl pool available, this is measured in quote asset, using quote precision.
+     * Should be generated by using getTokenAmount and passing in the scaled balance of the base asset + quote spot account
+     */
+    pnlPoolValue: BN;
+    contractTier: ContractTier;
+};