mm oracle sdk additions (#1824)

* strict typing for more MM oracle contact points

* add comments to auction.ts

* prettify

Author: moosecat2

sdk/src/dlob/DLOB.ts

@@ -1096,15 +1096,15 @@ export class DLOB {
 		}
 	}
 
-	protected *getBestNode(
+	protected *getBestNode<T extends MarketTypeStr>(
 		generatorList: Array<Generator<DLOBNode>>,
-		oraclePriceData: OraclePriceData,
+		oraclePriceData: T extends 'spot' ? OraclePriceData : MMOraclePriceData,
 		slot: number,
 		compareFcn: (
 			bestDLOBNode: DLOBNode,
 			currentDLOBNode: DLOBNode,
 			slot: number,
-			oraclePriceData: OraclePriceData
+			oraclePriceData: T extends 'spot' ? OraclePriceData : MMOraclePriceData
 		) => boolean,
 		filterFcn?: DLOBFilterFcn
 	): Generator<DLOBNode> {

sdk/src/dlob/DLOBNode.ts

@@ -5,8 +5,13 @@ import {
 	ZERO,
 } from '../constants/numericConstants';
 import { getLimitPrice } from '../math/orders';
-import { isVariant, Order, ProtectedMakerParams } from '../types';
-import { OraclePriceData } from '../oracles/types';
+import {
+	isVariant,
+	MarketTypeStr,
+	Order,
+	ProtectedMakerParams,
+} from '../types';
+import { MMOraclePriceData, OraclePriceData } from '../oracles/types';
 import { convertToNumber } from '../math/conversion';
 import { getOrderSignature } from './NodeList';
 
@@ -81,8 +86,11 @@ export abstract class OrderNode implements DLOBNode {
 		return msg;
 	}
 
-	getPrice(oraclePriceData: OraclePriceData, slot: number): BN {
-		return getLimitPrice(
+	getPrice<T extends MarketTypeStr>(
+		oraclePriceData: T extends 'spot' ? OraclePriceData : MMOraclePriceData,
+		slot: number
+	): BN {
+		return getLimitPrice<T>(
 			this.order,
 			oraclePriceData,
 			slot,

sdk/src/driftClient.ts

@@ -1590,21 +1590,26 @@ export class DriftClient {
 	public async getUpdateUserDelegateIx(
 		delegate: PublicKey,
 		overrides: {
-			subAccountId?: number,
-			userAccountPublicKey?: PublicKey,
-			authority?: PublicKey,
+			subAccountId?: number;
+			userAccountPublicKey?: PublicKey;
+			authority?: PublicKey;
 		}
 	): Promise<TransactionInstruction> {
 		const subAccountId = overrides.subAccountId ?? this.activeSubAccountId;
-		const userAccountPublicKey = overrides.userAccountPublicKey ?? await this.getUserAccountPublicKey();
+		const userAccountPublicKey =
+			overrides.userAccountPublicKey ?? (await this.getUserAccountPublicKey());
 		const authority = overrides.authority ?? this.wallet.publicKey;
 
-		return await this.program.instruction.updateUserDelegate(subAccountId, delegate, {
-			accounts: {
-				user: userAccountPublicKey,
-				authority,
-			},
-		});
+		return await this.program.instruction.updateUserDelegate(
+			subAccountId,
+			delegate,
+			{
+				accounts: {
+					user: userAccountPublicKey,
+					authority,
+				},
+			}
+		);
 	}
 
 	public async updateUserDelegate(

sdk/src/math/auction.ts

@@ -29,6 +29,13 @@ export function isFallbackAvailableLiquiditySource(
 	return new BN(slot).sub(order.slot).gt(new BN(minAuctionDuration));
 }
 
+/**
+ *
+ * @param order
+ * @param slot
+ * @param oraclePrice Use MMOraclePriceData source for perp orders, OraclePriceData for spot
+ * @returns BN
+ */
 export function getAuctionPrice(
 	order: Order,
 	slot: number,
@@ -92,6 +99,13 @@ export function getAuctionPriceForFixedAuction(order: Order, slot: number): BN {
 	return price;
 }
 
+/**
+ *
+ * @param order
+ * @param slot
+ * @param oraclePrice Use MMOraclePriceData source for perp orders, OraclePriceData for spot
+ * @returns
+ */
 export function getAuctionPriceForOracleOffsetAuction(
 	order: Order,
 	slot: number,
@@ -186,6 +200,11 @@ export function deriveOracleAuctionParams({
 	};
 }
 
+/**
+ *
+ * @param params Use OraclePriceData.price for oraclePrice param
+ * @returns
+ */
 export function getTriggerAuctionStartPrice(params: {
 	perpMarket: PerpMarketAccount;
 	direction: PositionDirection;

sdk/src/math/orders.ts

@@ -7,6 +7,7 @@ import {
 	Order,
 	PositionDirection,
 	ProtectedMakerParams,
+	MarketTypeStr,
 } from '../types';
 import { ZERO, TWO, ONE } from '../constants/numericConstants';
 import { BN } from '@coral-xyz/anchor';
@@ -151,9 +152,9 @@ export function standardizePrice(
 	}
 }
 
-export function getLimitPrice(
+export function getLimitPrice<T extends MarketTypeStr>(
 	order: Order,
-	oraclePriceData: OraclePriceData | MMOraclePriceData,
+	oraclePriceData: T extends 'spot' ? OraclePriceData : MMOraclePriceData,
 	slot: number,
 	fallbackPrice?: BN,
 	protectedMakerParams?: ProtectedMakerParams

sdk/src/user.ts

@@ -671,7 +671,7 @@ export class User {
 		)[0];
 
 		const perpMarket = this.driftClient.getPerpMarketAccount(marketIndex);
-		const oraclePriceData = this.getMMOracleDataForPerpMarket(marketIndex);
+		const oraclePriceData = this.getOracleDataForPerpMarket(marketIndex);
 		const worstCaseBaseAssetAmount = perpPosition
 			? calculateWorstCaseBaseAssetAmount(
 					perpPosition,
@@ -1447,7 +1447,7 @@ export class User {
 			)[0];
 		}
 
-		let valuationPrice = this.getMMOracleDataForPerpMarket(
+		let valuationPrice = this.getOracleDataForPerpMarket(
 			market.marketIndex
 		).price;
 
@@ -3426,7 +3426,7 @@ export class User {
 			this.getEmptyPosition(targetMarketIndex);
 
 		const perpMarket = this.driftClient.getPerpMarketAccount(targetMarketIndex);
-		const oracleData = this.getMMOracleDataForPerpMarket(targetMarketIndex);
+		const oracleData = this.getOracleDataForPerpMarket(targetMarketIndex);
 
 		let {
 			// eslint-disable-next-line prefer-const
@@ -4106,7 +4106,7 @@ export class User {
 				!!marginCategory
 			)[0] || this.getEmptyPosition(marketToIgnore);
 
-		const oracleData = this.getMMOracleDataForPerpMarket(marketToIgnore);
+		const oracleData = this.getOracleDataForPerpMarket(marketToIgnore);
 
 		let currentPerpPositionValueUSDC = ZERO;
 		if (currentPerpPosition) {
@@ -4128,6 +4128,10 @@ export class User {
 		return this.driftClient.getMMOracleDataForPerpMarket(marketIndex);
 	}
 
+	private getOracleDataForPerpMarket(marketIndex: number): OraclePriceData {
+		return this.driftClient.getOracleDataForPerpMarket(marketIndex);
+	}
+
 	private getOracleDataForSpotMarket(marketIndex: number): OraclePriceData {
 		return this.driftClient.getOracleDataForSpotMarket(marketIndex);
 	}