@drift-labs/sdk 2.97.0-beta.9 → 2.98.0-beta.0

package/src/idl/switchboard_on_demand_30.json

@@ -443,10 +443,14 @@
           }
         },
         {
-          "name": "queue"
+          "name": "queue",
+          "relations": [
+            "oracle"
+          ]
         },
         {
-          "name": "authority"
+          "name": "authority",
+          "signer": true
         },
         {
           "name": "program_state",
@@ -503,6 +507,9 @@
         },
         {
           "name": "stake_pool"
+        },
+        {
+          "name": "delegation_group"
         }
       ],
       "args": [
@@ -955,10 +962,7 @@
         },
         {
           "name": "authority",
-          "signer": true,
-          "relations": [
-            "queue"
-          ]
+          "signer": true
         },
         {
           "name": "program_authority"
@@ -1038,6 +1042,13 @@
         {
           "name": "oracle",
           "writable": true
+        },
+        {
+          "name": "authority",
+          "signer": true
+        },
+        {
+          "name": "state"
         }
       ],
       "args": [
@@ -1294,10 +1305,7 @@
         },
         {
           "name": "authority",
-          "signer": true,
-          "relations": [
-            "queue"
-          ]
+          "signer": true
         },
         {
           "name": "program_authority"
@@ -1336,10 +1344,7 @@
         },
         {
           "name": "authority",
-          "signer": true,
-          "relations": [
-            "queue"
-          ]
+          "signer": true
         },
         {
           "name": "state"
@@ -1387,6 +1392,13 @@
         {
           "name": "recent_slothashes",
           "address": "SysvarS1otHashes111111111111111111111111111"
+        },
+        {
+          "name": "authority",
+          "signer": true,
+          "relations": [
+            "randomness"
+          ]
         }
       ],
       "args": [
@@ -1860,6 +1872,19 @@
     }
   ],
   "events": [
+    {
+      "name": "CostWhitelistEvent",
+      "discriminator": [
+        56,
+        107,
+        191,
+        127,
+        116,
+        6,
+        138,
+        149
+      ]
+    },
     {
       "name": "GarbageCollectionEvent",
       "discriminator": [
@@ -2235,9 +2260,84 @@
     {
       "code": 6047,
       "name": "InvalidInstruction"
+    },
+    {
+      "code": 6048,
+      "name": "OracleAlreadyVerified"
+    },
+    {
+      "code": 6049,
+      "name": "GuardianNotVerified"
+    },
+    {
+      "code": 6050,
+      "name": "InvalidConstraint"
+    },
+    {
+      "code": 6051,
+      "name": "InvalidDelegationGroup"
+    },
+    {
+      "code": 6052,
+      "name": "OracleKeyNotFound"
+    },
+    {
+      "code": 6053,
+      "name": "GuardianReregisterAttempt"
     }
   ],
   "types": [
+    {
+      "name": "CompactResult",
+      "serialization": "bytemuck",
+      "repr": {
+        "kind": "c"
+      },
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "std_dev",
+            "docs": [
+              "The standard deviation of the submissions needed for quorom size"
+            ],
+            "type": "f32"
+          },
+          {
+            "name": "mean",
+            "docs": [
+              "The mean of the submissions needed for quorom size"
+            ],
+            "type": "f32"
+          },
+          {
+            "name": "slot",
+            "docs": [
+              "The slot at which this value was signed."
+            ],
+            "type": "u64"
+          }
+        ]
+      }
+    },
+    {
+      "name": "CostWhitelistEvent",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "feeds",
+            "type": {
+              "vec": "pubkey"
+            }
+          },
+          {
+            "name": "reward",
+            "type": "u32"
+          }
+        ]
+      }
+    },
     {
       "name": "CurrentResult",
       "serialization": "bytemuck",
@@ -2384,7 +2484,7 @@
             }
           },
           {
-            "name": "idx",
+            "name": "_reserved1",
             "type": "u32"
           },
           {
@@ -2437,12 +2537,7 @@
       "name": "GuardianUnregisterParams",
       "type": {
         "kind": "struct",
-        "fields": [
-          {
-            "name": "idx",
-            "type": "u32"
-          }
-        ]
+        "fields": []
       }
     },
     {
@@ -2948,7 +3043,7 @@
         "kind": "struct",
         "fields": [
           {
-            "name": "recent_slot",
+            "name": "_reserved1",
             "type": "u64"
           }
         ]
@@ -3068,14 +3163,18 @@
             }
           },
           {
-            "name": "_padding1",
+            "name": "padding1",
             "type": {
               "array": [
                 "u8",
-                3
+                2
               ]
             }
           },
+          {
+            "name": "historical_result_idx",
+            "type": "u8"
+          },
           {
             "name": "min_sample_size",
             "type": "u8"
@@ -3089,7 +3188,7 @@
             "type": "u64"
           },
           {
-            "name": "ipfs_hash",
+            "name": "_reserved1",
             "type": {
               "array": [
                 "u8",
@@ -3110,38 +3209,51 @@
             "type": "u32"
           },
           {
-            "name": "_ebuf4",
+            "name": "padding2",
             "type": {
               "array": [
                 "u8",
-                20
+                12
               ]
             }
           },
           {
-            "name": "_ebuf3",
+            "name": "historical_results",
+            "type": {
+              "array": [
+                {
+                  "defined": {
+                    "name": "CompactResult"
+                  }
+                },
+                32
+              ]
+            }
+          },
+          {
+            "name": "_ebuf4",
             "type": {
               "array": [
                 "u8",
-                24
+                8
               ]
             }
           },
           {
-            "name": "_ebuf2",
+            "name": "_ebuf3",
             "type": {
               "array": [
                 "u8",
-                256
+                24
               ]
             }
           },
           {
-            "name": "_ebuf1",
+            "name": "_ebuf2",
             "type": {
               "array": [
                 "u8",
-                512
+                256
               ]
             }
           }
@@ -4237,12 +4349,43 @@
             "name": "lut_slot",
             "type": "u64"
           },
+          {
+            "name": "base_reward",
+            "type": "u32"
+          },
+          {
+            "name": "_ebuf6",
+            "type": {
+              "array": [
+                "u8",
+                28
+              ]
+            }
+          },
+          {
+            "name": "_ebuf5",
+            "type": {
+              "array": [
+                "u8",
+                32
+              ]
+            }
+          },
+          {
+            "name": "_ebuf4",
+            "type": {
+              "array": [
+                "u8",
+                64
+              ]
+            }
+          },
           {
             "name": "_ebuf3",
             "type": {
               "array": [
                 "u8",
-                256
+                128
               ]
             }
           },
@@ -4256,11 +4399,14 @@
             }
           },
           {
-            "name": "_ebuf1",
+            "name": "cost_whitelist",
+            "docs": [
+              "Cost whitelist by authority"
+            ],
             "type": {
               "array": [
-                "u8",
-                1024
+                "pubkey",
+                32
               ]
             }
           }
@@ -4346,6 +4492,18 @@
           {
             "name": "subsidy_amount",
             "type": "u32"
+          },
+          {
+            "name": "base_reward",
+            "type": "u32"
+          },
+          {
+            "name": "add_cost_wl",
+            "type": "pubkey"
+          },
+          {
+            "name": "rm_cost_wl",
+            "type": "pubkey"
           }
         ]
       }

package/src/index.ts

@@ -25,12 +25,14 @@ export * from './accounts/oneShotUserAccountSubscriber';
 export * from './accounts/types';
 export * from './addresses/pda';
 export * from './adminClient';
+export * from './assert/assert';
 export * from './testClient';
 export * from './user';
 export * from './userConfig';
 export * from './userStats';
 export * from './userName';
 export * from './userStatsConfig';
+export * from './decode/user';
 export * from './driftClient';
 export * from './factory/oracleClient';
 export * from './factory/bigNum';
@@ -59,6 +61,7 @@ export * from './math/insurance';
 export * from './math/superStake';
 export * from './math/spotPosition';
 export * from './math/state';
+export * from './math/tiers';
 export * from './marinade';
 export * from './orderParams';
 export * from './slot/SlotSubscriber';
@@ -76,6 +79,9 @@ export * from './priorityFee';
 export * from './phoenix/phoenixFulfillmentConfigMap';
 export * from './openbook/openbookV2Subscriber';
 export * from './openbook/openbookV2FulfillmentConfigMap';
+export * from './oracles/pythClient';
+export * from './oracles/pythPullClient';
+export * from './oracles/switchboardOnDemandClient';
 export * from './tx/fastSingleTxSender';
 export * from './tx/retryTxSender';
 export * from './tx/whileValidTxSender';
@@ -86,6 +92,7 @@ export * from './tx/txHandler';
 export * from './util/computeUnits';
 export * from './util/tps';
 export * from './util/promiseTimeout';
+export * from './util/pythPullOracleUtils';
 export * from './math/spotBalance';
 export * from './constants/spotMarkets';
 export * from './driftClientConfig';
@@ -99,6 +106,7 @@ export * from './dlob/types';
 export * from './dlob/orderBookLevels';
 export * from './userMap/userMap';
 export * from './userMap/userStatsMap';
+export * from './userMap/userMapConfig';
 export * from './math/bankruptcy';
 export * from './orderSubscriber';
 export * from './orderSubscriber/types';

package/src/isomorphic/README.md

@@ -0,0 +1,19 @@
+# Isomorphic Code Explanation
+
+Soem of the features you might want to add to the SDK may only be compatible with particular execution environments (usually a non-browser one). To get that working without breaking the SDK for people in other environments, you need to get your code working in an isomorphic way.
+
+This README will try explain how to do this, and you should be able to follow the example of other pieces of isomorphic code in this folder.
+
+## High Level Explanation
+
+At a high level, we just want to make sure that we're not importing any incompatible code into the final compiled .js output files. The only real way this can "get done" is by importing types or by importing classes/methods/values out of an offending packages. The goal of our isomorphic seperation is to ensure that we have SDK-Side code which is still properly typed and easy for devs to work with, without putting anything bad into the output code. We will do this with some typescript magic and a simple but handy postbuild script.
+
+## Step-by-step isomorphic code:
+
+1. Create [your-package-name].d.ts, [your-package-name].browser.ts, and [your-package-name].node.ts files.
+2. Remove any imports of an offending library which aren't going through our dedicated isomorphic files. Instead import the TYPES of these and place them in the `.d.ts` file (definition file). Note to import ONLY THE TYPES you use `import type {stuff}` instead of just `import {stuff}`.
+3. The definition file should be exporting types only, and the files that were previously importing things directly from the library should be able to import from the definition file now instead. You might see some typescript issues when you import things from this definition file because typescript thinks it's "just a type" -- you can safely @ts-ignore these errors, but the types SHOULD at least be correct when you are using them.
+4. For concrete classes, methods, constants, etc. that you need to make available - you will place them in the `.browser` and `.node` files. You should be able to pretty flexibly export them however you want, just make sure the definition file has a matching type for how you're doing it. See `grpc.d.ts` and `grpc.node.ts` to look at how we're doing this for `createClient`. For the "bad" isomorphic file it's probably best to throw an error so that the consumer knows they shouldn't be using this particular feature.
+5. Note about enums :: they're weird and annoying. If you follow how the enum type `CommitmentLevel` was exported for the grpc package though you should be fine.
+6. Add the name of your package to `postbuild.js`.
+7. when you run `build` it will build the node version of all of these packages. You can run `build:browser` to build the browser side ones instead.

package/src/isomorphic/grpc.browser.ts

@@ -0,0 +1,4 @@
+// Export a function to create a new Client instance
+export function createClient(..._args: any) {
+	throw new Error('Only available in node context');
+}

package/src/isomorphic/grpc.node.ts

@@ -0,0 +1,23 @@
+import Client from '@triton-one/yellowstone-grpc';
+import {
+	SubscribeRequest,
+	SubscribeUpdate,
+	CommitmentLevel,
+} from '@triton-one/yellowstone-grpc';
+import { ClientDuplexStream, ChannelOptions } from '@grpc/grpc-js';
+
+export {
+	ClientDuplexStream,
+	ChannelOptions,
+	SubscribeRequest,
+	SubscribeUpdate,
+	CommitmentLevel,
+	Client,
+};
+
+// Export a function to create a new Client instance
+export function createClient(
+	...args: ConstructorParameters<typeof Client>
+): Client {
+	return new Client(...args);
+}

package/src/isomorphic/grpc.ts

@@ -0,0 +1 @@
+export * from './grpc.node';

package/src/math/auction.ts

@@ -27,14 +27,15 @@ export function getAuctionPrice(
 	oraclePrice: BN
 ): BN {
 	if (
-		isOneOfVariant(order.orderType, [
-			'market',
-			'triggerMarket',
-			'limit',
-			'triggerLimit',
-		])
+		isOneOfVariant(order.orderType, ['market', 'triggerMarket', 'triggerLimit'])
 	) {
 		return getAuctionPriceForFixedAuction(order, slot);
+	} else if (isVariant(order.orderType, 'limit')) {
+		if (order.oraclePriceOffset !== 0) {
+			return getAuctionPriceForOracleOffsetAuction(order, slot, oraclePrice);
+		} else {
+			return getAuctionPriceForFixedAuction(order, slot);
+		}
 	} else if (isVariant(order.orderType, 'oracle')) {
 		return getAuctionPriceForOracleOffsetAuction(order, slot, oraclePrice);
 	} else {

package/src/math/margin.ts

@@ -187,20 +187,20 @@ export function calculateWorstCasePerpLiabilityValue(
 
 export function calculatePerpLiabilityValue(
 	baseAssetAmount: BN,
-	oraclePrice: BN,
+	price: BN,
 	isPredictionMarket: boolean
 ): BN {
 	if (isPredictionMarket) {
 		if (baseAssetAmount.gt(ZERO)) {
-			return baseAssetAmount.mul(oraclePrice).div(BASE_PRECISION);
+			return baseAssetAmount.mul(price).div(BASE_PRECISION);
 		} else {
 			return baseAssetAmount
 				.abs()
-				.mul(MAX_PREDICTION_PRICE.sub(oraclePrice))
+				.mul(MAX_PREDICTION_PRICE.sub(price))
 				.div(BASE_PRECISION);
 		}
 	} else {
-		return baseAssetAmount.abs().mul(oraclePrice).div(BASE_PRECISION);
+		return baseAssetAmount.abs().mul(price).div(BASE_PRECISION);
 	}
 }
 
@@ -215,16 +215,18 @@ export function calculateMarginUSDCRequiredForTrade(
 	targetMarketIndex: number,
 	baseSize: BN,
 	userMaxMarginRatio?: number,
-	userHighLeverageMode?: boolean
+	userHighLeverageMode?: boolean,
+	entryPrice?: BN
 ): BN {
 	const targetMarket = driftClient.getPerpMarketAccount(targetMarketIndex);
-	const oracleData = driftClient.getOracleDataForPerpMarket(
-		targetMarket.marketIndex
-	);
+
+	const price =
+		entryPrice ??
+		driftClient.getOracleDataForPerpMarket(targetMarket.marketIndex).price;
 
 	const perpLiabilityValue = calculatePerpLiabilityValue(
 		baseSize,
-		oracleData.price,
+		price,
 		isVariant(targetMarket.contractType, 'prediction')
 	);
 
@@ -254,14 +256,16 @@ export function calculateCollateralDepositRequiredForTrade(
 	baseSize: BN,
 	collateralIndex: number,
 	userMaxMarginRatio?: number,
-	userHighLeverageMode?: boolean
+	userHighLeverageMode?: boolean,
+	estEntryPrice?: BN
 ): BN {
 	const marginRequiredUsdc = calculateMarginUSDCRequiredForTrade(
 		driftClient,
 		targetMarketIndex,
 		baseSize,
 		userMaxMarginRatio,
-		userHighLeverageMode
+		userHighLeverageMode,
+		estEntryPrice
 	);
 
 	const collateralMarket = driftClient.getSpotMarketAccount(collateralIndex);

package/src/math/position.ts

@@ -118,7 +118,7 @@ export function calculatePositionPNL(
 		.add(perpPosition.quoteAssetAmount);
 
 	if (withFunding) {
-		const fundingRatePnL = calculatePositionFundingPNL(market, perpPosition);
+		const fundingRatePnL = calculateUnsettledFundingPnl(market, perpPosition);
 
 		pnl = pnl.add(fundingRatePnL);
 	}
@@ -159,12 +159,44 @@ export function calculateClaimablePnl(
 }
 
 /**
+ * Returns total fees and funding pnl for a position
+ *
+ * @param market
+ * @param PerpPosition
+ * @param includeUnsettled include unsettled funding in return value (default: true)
+ * @returns — // QUOTE_PRECISION
+ */
+export function calculateFeesAndFundingPnl(
+	market: PerpMarketAccount,
+	perpPosition: PerpPosition,
+	includeUnsettled = true
+): BN {
+	const settledFundingAndFeesPnl = perpPosition.quoteBreakEvenAmount.sub(
+		perpPosition.quoteEntryAmount
+	);
+
+	if (!includeUnsettled) {
+		return settledFundingAndFeesPnl;
+	}
+
+	const unsettledFundingPnl = calculateUnsettledFundingPnl(
+		market,
+		perpPosition
+	);
+
+	return settledFundingAndFeesPnl.add(unsettledFundingPnl);
+}
+
+/**
+ * Returns unsettled funding pnl for the position
+ *
+ * To calculate all fees and funding pnl including settled, use calculateFeesAndFundingPnl
  *
  * @param market
  * @param PerpPosition
  * @returns // QUOTE_PRECISION
  */
-export function calculatePositionFundingPNL(
+export function calculateUnsettledFundingPnl(
 	market: PerpMarketAccount,
 	perpPosition: PerpPosition
 ): BN {
@@ -189,6 +221,16 @@ export function calculatePositionFundingPNL(
 	return perPositionFundingRate;
 }
 
+/**
+ * @deprecated use calculateUnsettledFundingPnl or calculateFeesAndFundingPnl instead
+ */
+export function calculatePositionFundingPNL(
+	market: PerpMarketAccount,
+	perpPosition: PerpPosition
+): BN {
+	return calculateUnsettledFundingPnl(market, perpPosition);
+}
+
 export function positionIsAvailable(position: PerpPosition): boolean {
 	return (
 		position.baseAssetAmount.eq(ZERO) &&

package/src/oracles/pythClient.ts

@@ -67,11 +67,7 @@ export class PythClient implements OracleClient {
 	}
 }
 
-export function convertPythPrice(
-	price: number,
-	exponent: number,
-	multiple: BN
-): BN {
+function convertPythPrice(price: number, exponent: number, multiple: BN): BN {
 	exponent = Math.abs(exponent);
 	const pythPrecision = TEN.pow(new BN(exponent).abs()).div(multiple);
 	return new BN(price * Math.pow(10, exponent))