@drift-labs/sdk 2.0.17 → 2.0.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/dlob/DLOB.js CHANGED
@@ -560,34 +560,39 @@ class DLOB {
560
560
  }
561
561
  const nodesToTrigger = [];
562
562
  const marketTypeStr = (0, __1.getVariant)(marketType);
563
- for (const node of this.orderLists
564
- .get(marketTypeStr)
565
- .get(marketIndex)
566
- .trigger.above.getGenerator()) {
567
- if (oraclePrice.gt(node.order.triggerPrice)) {
568
- if ((0, __1.isAuctionComplete)(node.order, slot)) {
569
- nodesToTrigger.push({
570
- node: node,
571
- });
563
+ const marketNodeLists = this.orderLists.get(marketTypeStr).get(marketIndex);
564
+ const triggerAboveList = marketNodeLists
565
+ ? marketNodeLists.trigger.above
566
+ : undefined;
567
+ if (triggerAboveList) {
568
+ for (const node of triggerAboveList.getGenerator()) {
569
+ if (oraclePrice.gt(node.order.triggerPrice)) {
570
+ if ((0, __1.isAuctionComplete)(node.order, slot)) {
571
+ nodesToTrigger.push({
572
+ node: node,
573
+ });
574
+ }
575
+ }
576
+ else {
577
+ break;
572
578
  }
573
- }
574
- else {
575
- break;
576
579
  }
577
580
  }
578
- for (const node of this.orderLists
579
- .get(marketTypeStr)
580
- .get(marketIndex)
581
- .trigger.below.getGenerator()) {
582
- if (oraclePrice.lt(node.order.triggerPrice)) {
583
- if ((0, __1.isAuctionComplete)(node.order, slot)) {
584
- nodesToTrigger.push({
585
- node: node,
586
- });
581
+ const triggerBelowList = marketNodeLists
582
+ ? marketNodeLists.trigger.below
583
+ : undefined;
584
+ if (triggerBelowList) {
585
+ for (const node of triggerBelowList.getGenerator()) {
586
+ if (oraclePrice.lt(node.order.triggerPrice)) {
587
+ if ((0, __1.isAuctionComplete)(node.order, slot)) {
588
+ nodesToTrigger.push({
589
+ node: node,
590
+ });
591
+ }
592
+ }
593
+ else {
594
+ break;
587
595
  }
588
- }
589
- else {
590
- break;
591
596
  }
592
597
  }
593
598
  return nodesToTrigger;
package/lib/index.d.ts CHANGED
@@ -62,6 +62,7 @@ export * from './constants/spotMarkets';
62
62
  export * from './driftClientConfig';
63
63
  export * from './dlob/DLOB';
64
64
  export * from './dlob/DLOBNode';
65
+ export * from './dlob/DLOBOrders';
65
66
  export * from './dlob/NodeList';
66
67
  export * from './userMap/userMap';
67
68
  export * from './userMap/userStatsMap';
package/lib/index.js CHANGED
@@ -85,6 +85,7 @@ __exportStar(require("./constants/spotMarkets"), exports);
85
85
  __exportStar(require("./driftClientConfig"), exports);
86
86
  __exportStar(require("./dlob/DLOB"), exports);
87
87
  __exportStar(require("./dlob/DLOBNode"), exports);
88
+ __exportStar(require("./dlob/DLOBOrders"), exports);
88
89
  __exportStar(require("./dlob/NodeList"), exports);
89
90
  __exportStar(require("./userMap/userMap"), exports);
90
91
  __exportStar(require("./userMap/userStatsMap"), exports);
package/lib/math/amm.d.ts CHANGED
@@ -38,7 +38,27 @@ export declare function calculateInventoryScale(baseAssetAmountWithAmm: BN, base
38
38
  export declare function calculateEffectiveLeverage(baseSpread: number, quoteAssetReserve: BN, terminalQuoteAssetReserve: BN, pegMultiplier: BN, netBaseAssetAmount: BN, reservePrice: BN, totalFeeMinusDistributions: BN): number;
39
39
  export declare function calculateMaxSpread(marginRatioInitial: number): number;
40
40
  export declare function calculateVolSpreadBN(lastOracleConfPct: BN, reservePrice: BN, markStd: BN, oracleStd: BN, longIntensity: BN, shortIntensity: BN, volume24H: BN): [BN, BN];
41
- export declare function calculateSpreadBN(baseSpread: number, lastOracleReservePriceSpreadPct: BN, lastOracleConfPct: BN, maxSpread: number, quoteAssetReserve: BN, terminalQuoteAssetReserve: BN, pegMultiplier: BN, baseAssetAmountWithAmm: BN, reservePrice: BN, totalFeeMinusDistributions: BN, netRevenueSinceLastFunding: BN, baseAssetReserve: BN, minBaseAssetReserve: BN, maxBaseAssetReserve: BN, markStd: BN, oracleStd: BN, longIntensity: BN, shortIntensity: BN, volume24H: BN): [number, number];
41
+ export declare function calculateSpreadBN(baseSpread: number, lastOracleReservePriceSpreadPct: BN, lastOracleConfPct: BN, maxSpread: number, quoteAssetReserve: BN, terminalQuoteAssetReserve: BN, pegMultiplier: BN, baseAssetAmountWithAmm: BN, reservePrice: BN, totalFeeMinusDistributions: BN, netRevenueSinceLastFunding: BN, baseAssetReserve: BN, minBaseAssetReserve: BN, maxBaseAssetReserve: BN, markStd: BN, oracleStd: BN, longIntensity: BN, shortIntensity: BN, volume24H: BN, returnTerms?: boolean): number[] | {
42
+ longVolSpread: number;
43
+ shortVolSpread: number;
44
+ longSpreadwPS: number;
45
+ shortSpreadwPS: number;
46
+ maxTargetSpread: number;
47
+ inventorySpreadScale: number;
48
+ longSpreadwInvScale: number;
49
+ shortSpreadwInvScale: number;
50
+ effectiveLeverage: number;
51
+ effectiveLeverageCapped: number;
52
+ longSpreadwEL: number;
53
+ shortSpreadwEL: number;
54
+ revenueRetreatAmount: number;
55
+ halfRevenueRetreatAmount: number;
56
+ longSpreadwRevRetreat: number;
57
+ shortSpreadwRevRetreat: number;
58
+ totalSpread: number;
59
+ longSpread: number;
60
+ shortSpread: number;
61
+ };
42
62
  export declare function calculateSpread(amm: AMM, oraclePriceData: OraclePriceData): [number, number];
43
63
  export declare function calculateSpreadReserves(amm: AMM, oraclePriceData: OraclePriceData): {
44
64
  baseAssetReserve: any;
package/lib/math/amm.js CHANGED
@@ -250,8 +250,33 @@ function calculateVolSpreadBN(lastOracleConfPct, reservePrice, markStd, oracleSt
250
250
  return [longVolSpread, shortVolSpread];
251
251
  }
252
252
  exports.calculateVolSpreadBN = calculateVolSpreadBN;
253
- function calculateSpreadBN(baseSpread, lastOracleReservePriceSpreadPct, lastOracleConfPct, maxSpread, quoteAssetReserve, terminalQuoteAssetReserve, pegMultiplier, baseAssetAmountWithAmm, reservePrice, totalFeeMinusDistributions, netRevenueSinceLastFunding, baseAssetReserve, minBaseAssetReserve, maxBaseAssetReserve, markStd, oracleStd, longIntensity, shortIntensity, volume24H) {
253
+ function calculateSpreadBN(baseSpread, lastOracleReservePriceSpreadPct, lastOracleConfPct, maxSpread, quoteAssetReserve, terminalQuoteAssetReserve, pegMultiplier, baseAssetAmountWithAmm, reservePrice, totalFeeMinusDistributions, netRevenueSinceLastFunding, baseAssetReserve, minBaseAssetReserve, maxBaseAssetReserve, markStd, oracleStd, longIntensity, shortIntensity, volume24H, returnTerms = false) {
254
+ (0, assert_1.assert)(Number.isInteger(baseSpread));
255
+ (0, assert_1.assert)(Number.isInteger(maxSpread));
256
+ const spreadTerms = {
257
+ longVolSpread: 0,
258
+ shortVolSpread: 0,
259
+ longSpreadwPS: 0,
260
+ shortSpreadwPS: 0,
261
+ maxTargetSpread: 0,
262
+ inventorySpreadScale: 0,
263
+ longSpreadwInvScale: 0,
264
+ shortSpreadwInvScale: 0,
265
+ effectiveLeverage: 0,
266
+ effectiveLeverageCapped: 0,
267
+ longSpreadwEL: 0,
268
+ shortSpreadwEL: 0,
269
+ revenueRetreatAmount: 0,
270
+ halfRevenueRetreatAmount: 0,
271
+ longSpreadwRevRetreat: 0,
272
+ shortSpreadwRevRetreat: 0,
273
+ totalSpread: 0,
274
+ longSpread: 0,
275
+ shortSpread: 0,
276
+ };
254
277
  const [longVolSpread, shortVolSpread] = calculateVolSpreadBN(lastOracleConfPct, reservePrice, markStd, oracleStd, longIntensity, shortIntensity, volume24H);
278
+ spreadTerms.longVolSpread = longVolSpread.toNumber();
279
+ spreadTerms.shortVolSpread = shortVolSpread.toNumber();
255
280
  let longSpread = Math.max(baseSpread / 2, longVolSpread.toNumber());
256
281
  let shortSpread = Math.max(baseSpread / 2, shortVolSpread.toNumber());
257
282
  if (lastOracleReservePriceSpreadPct.gt(numericConstants_1.ZERO)) {
@@ -262,7 +287,9 @@ function calculateSpreadBN(baseSpread, lastOracleReservePriceSpreadPct, lastOrac
262
287
  longSpread = Math.max(longSpread, lastOracleReservePriceSpreadPct.abs().toNumber() +
263
288
  longVolSpread.toNumber());
264
289
  }
265
- const maxTargetSpread = Math.max(maxSpread, lastOracleReservePriceSpreadPct.abs().toNumber());
290
+ spreadTerms.longSpreadwPS = longSpread;
291
+ spreadTerms.shortSpreadwPS = shortSpread;
292
+ const maxTargetSpread = Math.floor(Math.max(maxSpread, lastOracleReservePriceSpreadPct.abs().toNumber()));
266
293
  const inventorySpreadScale = calculateInventoryScale(baseAssetAmountWithAmm, baseAssetReserve, minBaseAssetReserve, maxBaseAssetReserve, baseAssetAmountWithAmm.gt(numericConstants_1.ZERO) ? longSpread : shortSpread, maxTargetSpread);
267
294
  if (baseAssetAmountWithAmm.gt(numericConstants_1.ZERO)) {
268
295
  longSpread *= inventorySpreadScale;
@@ -270,49 +297,69 @@ function calculateSpreadBN(baseSpread, lastOracleReservePriceSpreadPct, lastOrac
270
297
  else if (baseAssetAmountWithAmm.lt(numericConstants_1.ZERO)) {
271
298
  shortSpread *= inventorySpreadScale;
272
299
  }
300
+ spreadTerms.maxTargetSpread = maxTargetSpread;
301
+ spreadTerms.inventorySpreadScale = inventorySpreadScale;
302
+ spreadTerms.longSpreadwInvScale = longSpread;
303
+ spreadTerms.shortSpreadwInvScale = shortSpread;
273
304
  const MAX_SPREAD_SCALE = 10;
274
305
  if (totalFeeMinusDistributions.gt(numericConstants_1.ZERO)) {
275
306
  const effectiveLeverage = calculateEffectiveLeverage(baseSpread, quoteAssetReserve, terminalQuoteAssetReserve, pegMultiplier, baseAssetAmountWithAmm, reservePrice, totalFeeMinusDistributions);
307
+ spreadTerms.effectiveLeverage = effectiveLeverage;
276
308
  const spreadScale = Math.min(MAX_SPREAD_SCALE, 1 + effectiveLeverage);
309
+ spreadTerms.effectiveLeverageCapped = spreadScale;
277
310
  if (baseAssetAmountWithAmm.gt(numericConstants_1.ZERO)) {
278
311
  longSpread *= spreadScale;
312
+ shortSpread = Math.floor(longSpread);
279
313
  }
280
314
  else {
281
315
  shortSpread *= spreadScale;
316
+ shortSpread = Math.floor(shortSpread);
282
317
  }
283
318
  }
284
319
  else {
285
320
  longSpread *= MAX_SPREAD_SCALE;
286
321
  shortSpread *= MAX_SPREAD_SCALE;
287
322
  }
323
+ spreadTerms.longSpreadwEL = longSpread;
324
+ spreadTerms.shortSpreadwEL = shortSpread;
288
325
  if (netRevenueSinceLastFunding.lt(numericConstants_1.DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT)) {
289
- const retreatAmount = Math.min(maxTargetSpread / 10, Math.floor((baseSpread * netRevenueSinceLastFunding.abs().toNumber()) /
326
+ const revenueRetreatAmount = Math.min(maxTargetSpread / 10, Math.floor((baseSpread * netRevenueSinceLastFunding.abs().toNumber()) /
290
327
  numericConstants_1.DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT.toNumber()));
291
- const halfRetreatAmount = Math.floor(retreatAmount / 2);
328
+ const halfRevenueRetreatAmount = Math.floor(revenueRetreatAmount / 2);
329
+ spreadTerms.revenueRetreatAmount = revenueRetreatAmount;
330
+ spreadTerms.halfRevenueRetreatAmount = halfRevenueRetreatAmount;
292
331
  if (baseAssetAmountWithAmm.gt(numericConstants_1.ZERO)) {
293
- longSpread += retreatAmount;
294
- shortSpread += halfRetreatAmount;
332
+ longSpread += revenueRetreatAmount;
333
+ shortSpread += halfRevenueRetreatAmount;
295
334
  }
296
335
  else if (baseAssetAmountWithAmm.lt(numericConstants_1.ZERO)) {
297
- longSpread += halfRetreatAmount;
298
- shortSpread += retreatAmount;
336
+ longSpread += halfRevenueRetreatAmount;
337
+ shortSpread += revenueRetreatAmount;
299
338
  }
300
339
  else {
301
- longSpread += halfRetreatAmount;
302
- shortSpread += halfRetreatAmount;
340
+ longSpread += halfRevenueRetreatAmount;
341
+ shortSpread += halfRevenueRetreatAmount;
303
342
  }
304
343
  }
344
+ spreadTerms.longSpreadwRevRetreat = longSpread;
345
+ spreadTerms.shortSpreadwRevRetreat = shortSpread;
305
346
  const totalSpread = longSpread + shortSpread;
306
347
  if (totalSpread > maxTargetSpread) {
307
348
  if (longSpread > shortSpread) {
308
349
  longSpread = Math.ceil((longSpread * maxTargetSpread) / totalSpread);
309
- shortSpread = maxTargetSpread - longSpread;
350
+ shortSpread = Math.floor(maxTargetSpread - longSpread);
310
351
  }
311
352
  else {
312
353
  shortSpread = Math.ceil((shortSpread * maxTargetSpread) / totalSpread);
313
- longSpread = maxTargetSpread - shortSpread;
354
+ longSpread = Math.floor(maxTargetSpread - shortSpread);
314
355
  }
315
356
  }
357
+ spreadTerms.totalSpread = totalSpread;
358
+ spreadTerms.longSpread = longSpread;
359
+ spreadTerms.shortSpread = shortSpread;
360
+ if (returnTerms) {
361
+ return spreadTerms;
362
+ }
316
363
  return [longSpread, shortSpread];
317
364
  }
318
365
  exports.calculateSpreadBN = calculateSpreadBN;
@@ -332,7 +379,9 @@ function calculateSpread(amm, oraclePriceData) {
332
379
  .div(reservePrice);
333
380
  const now = new anchor_1.BN(new Date().getTime() / 1000); //todo
334
381
  const liveOracleStd = (0, oracles_1.calculateLiveOracleStd)(amm, oraclePriceData, now);
335
- const [longSpread, shortSpread] = calculateSpreadBN(amm.baseSpread, targetMarkSpreadPct, confIntervalPct, amm.maxSpread, amm.quoteAssetReserve, amm.terminalQuoteAssetReserve, amm.pegMultiplier, amm.baseAssetAmountWithAmm, reservePrice, amm.totalFeeMinusDistributions, amm.netRevenueSinceLastFunding, amm.baseAssetReserve, amm.minBaseAssetReserve, amm.maxBaseAssetReserve, amm.markStd, liveOracleStd, amm.longIntensityVolume, amm.shortIntensityVolume, amm.volume24H);
382
+ const spreads = calculateSpreadBN(amm.baseSpread, targetMarkSpreadPct, confIntervalPct, amm.maxSpread, amm.quoteAssetReserve, amm.terminalQuoteAssetReserve, amm.pegMultiplier, amm.baseAssetAmountWithAmm, reservePrice, amm.totalFeeMinusDistributions, amm.netRevenueSinceLastFunding, amm.baseAssetReserve, amm.minBaseAssetReserve, amm.maxBaseAssetReserve, amm.markStd, liveOracleStd, amm.longIntensityVolume, amm.shortIntensityVolume, amm.volume24H);
383
+ const longSpread = spreads[0];
384
+ const shortSpread = spreads[1];
336
385
  return [longSpread, shortSpread];
337
386
  }
338
387
  exports.calculateSpread = calculateSpread;
@@ -59,8 +59,7 @@ function calculateLiveOracleTwap(amm, oraclePriceData, now) {
59
59
  const clampedOraclePrice = index_1.BN.min(amm.historicalOracleData.lastOraclePriceTwap.add(clampRange), index_1.BN.max(oraclePriceData.price, amm.historicalOracleData.lastOraclePriceTwap.sub(clampRange)));
60
60
  const newOracleTwap = amm.historicalOracleData.lastOraclePriceTwap
61
61
  .mul(sinceStart)
62
- .add(clampedOraclePrice)
63
- .mul(sinceLastUpdate)
62
+ .add(clampedOraclePrice.mul(sinceLastUpdate))
64
63
  .div(sinceStart.add(sinceLastUpdate));
65
64
  return newOracleTwap;
66
65
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@drift-labs/sdk",
3
- "version": "2.0.17",
3
+ "version": "2.0.19",
4
4
  "main": "lib/index.js",
5
5
  "types": "lib/index.d.ts",
6
6
  "author": "crispheaney",
package/src/dlob/DLOB.ts CHANGED
@@ -1018,33 +1018,39 @@ export class DLOB {
1018
1018
 
1019
1019
  const nodesToTrigger = [];
1020
1020
  const marketTypeStr = getVariant(marketType) as MarketTypeStr;
1021
- for (const node of this.orderLists
1022
- .get(marketTypeStr)
1023
- .get(marketIndex)
1024
- .trigger.above.getGenerator()) {
1025
- if (oraclePrice.gt(node.order.triggerPrice)) {
1026
- if (isAuctionComplete(node.order, slot)) {
1027
- nodesToTrigger.push({
1028
- node: node,
1029
- });
1021
+ const marketNodeLists = this.orderLists.get(marketTypeStr).get(marketIndex);
1022
+
1023
+ const triggerAboveList = marketNodeLists
1024
+ ? marketNodeLists.trigger.above
1025
+ : undefined;
1026
+ if (triggerAboveList) {
1027
+ for (const node of triggerAboveList.getGenerator()) {
1028
+ if (oraclePrice.gt(node.order.triggerPrice)) {
1029
+ if (isAuctionComplete(node.order, slot)) {
1030
+ nodesToTrigger.push({
1031
+ node: node,
1032
+ });
1033
+ }
1034
+ } else {
1035
+ break;
1030
1036
  }
1031
- } else {
1032
- break;
1033
1037
  }
1034
1038
  }
1035
1039
 
1036
- for (const node of this.orderLists
1037
- .get(marketTypeStr)
1038
- .get(marketIndex)
1039
- .trigger.below.getGenerator()) {
1040
- if (oraclePrice.lt(node.order.triggerPrice)) {
1041
- if (isAuctionComplete(node.order, slot)) {
1042
- nodesToTrigger.push({
1043
- node: node,
1044
- });
1040
+ const triggerBelowList = marketNodeLists
1041
+ ? marketNodeLists.trigger.below
1042
+ : undefined;
1043
+ if (triggerBelowList) {
1044
+ for (const node of triggerBelowList.getGenerator()) {
1045
+ if (oraclePrice.lt(node.order.triggerPrice)) {
1046
+ if (isAuctionComplete(node.order, slot)) {
1047
+ nodesToTrigger.push({
1048
+ node: node,
1049
+ });
1050
+ }
1051
+ } else {
1052
+ break;
1045
1053
  }
1046
- } else {
1047
- break;
1048
1054
  }
1049
1055
  }
1050
1056
 
package/src/index.ts CHANGED
@@ -63,6 +63,7 @@ export * from './constants/spotMarkets';
63
63
  export * from './driftClientConfig';
64
64
  export * from './dlob/DLOB';
65
65
  export * from './dlob/DLOBNode';
66
+ export * from './dlob/DLOBOrders';
66
67
  export * from './dlob/NodeList';
67
68
  export * from './userMap/userMap';
68
69
  export * from './userMap/userStatsMap';
package/src/math/amm.ts CHANGED
@@ -479,8 +479,34 @@ export function calculateSpreadBN(
479
479
  oracleStd: BN,
480
480
  longIntensity: BN,
481
481
  shortIntensity: BN,
482
- volume24H: BN
483
- ): [number, number] {
482
+ volume24H: BN,
483
+ returnTerms = false
484
+ ) {
485
+ assert(Number.isInteger(baseSpread));
486
+ assert(Number.isInteger(maxSpread));
487
+
488
+ const spreadTerms = {
489
+ longVolSpread: 0,
490
+ shortVolSpread: 0,
491
+ longSpreadwPS: 0,
492
+ shortSpreadwPS: 0,
493
+ maxTargetSpread: 0,
494
+ inventorySpreadScale: 0,
495
+ longSpreadwInvScale: 0,
496
+ shortSpreadwInvScale: 0,
497
+ effectiveLeverage: 0,
498
+ effectiveLeverageCapped: 0,
499
+ longSpreadwEL: 0,
500
+ shortSpreadwEL: 0,
501
+ revenueRetreatAmount: 0,
502
+ halfRevenueRetreatAmount: 0,
503
+ longSpreadwRevRetreat: 0,
504
+ shortSpreadwRevRetreat: 0,
505
+ totalSpread: 0,
506
+ longSpread: 0,
507
+ shortSpread: 0,
508
+ };
509
+
484
510
  const [longVolSpread, shortVolSpread] = calculateVolSpreadBN(
485
511
  lastOracleConfPct,
486
512
  reservePrice,
@@ -491,6 +517,9 @@ export function calculateSpreadBN(
491
517
  volume24H
492
518
  );
493
519
 
520
+ spreadTerms.longVolSpread = longVolSpread.toNumber();
521
+ spreadTerms.shortVolSpread = shortVolSpread.toNumber();
522
+
494
523
  let longSpread = Math.max(baseSpread / 2, longVolSpread.toNumber());
495
524
  let shortSpread = Math.max(baseSpread / 2, shortVolSpread.toNumber());
496
525
 
@@ -507,10 +536,11 @@ export function calculateSpreadBN(
507
536
  longVolSpread.toNumber()
508
537
  );
509
538
  }
539
+ spreadTerms.longSpreadwPS = longSpread;
540
+ spreadTerms.shortSpreadwPS = shortSpread;
510
541
 
511
- const maxTargetSpread: number = Math.max(
512
- maxSpread,
513
- lastOracleReservePriceSpreadPct.abs().toNumber()
542
+ const maxTargetSpread: number = Math.floor(
543
+ Math.max(maxSpread, lastOracleReservePriceSpreadPct.abs().toNumber())
514
544
  );
515
545
 
516
546
  const inventorySpreadScale = calculateInventoryScale(
@@ -527,6 +557,10 @@ export function calculateSpreadBN(
527
557
  } else if (baseAssetAmountWithAmm.lt(ZERO)) {
528
558
  shortSpread *= inventorySpreadScale;
529
559
  }
560
+ spreadTerms.maxTargetSpread = maxTargetSpread;
561
+ spreadTerms.inventorySpreadScale = inventorySpreadScale;
562
+ spreadTerms.longSpreadwInvScale = longSpread;
563
+ spreadTerms.shortSpreadwInvScale = shortSpread;
530
564
 
531
565
  const MAX_SPREAD_SCALE = 10;
532
566
  if (totalFeeMinusDistributions.gt(ZERO)) {
@@ -539,53 +573,76 @@ export function calculateSpreadBN(
539
573
  reservePrice,
540
574
  totalFeeMinusDistributions
541
575
  );
576
+ spreadTerms.effectiveLeverage = effectiveLeverage;
577
+
542
578
  const spreadScale = Math.min(MAX_SPREAD_SCALE, 1 + effectiveLeverage);
579
+ spreadTerms.effectiveLeverageCapped = spreadScale;
580
+
543
581
  if (baseAssetAmountWithAmm.gt(ZERO)) {
544
582
  longSpread *= spreadScale;
583
+ shortSpread = Math.floor(longSpread);
545
584
  } else {
546
585
  shortSpread *= spreadScale;
586
+ shortSpread = Math.floor(shortSpread);
547
587
  }
548
588
  } else {
549
589
  longSpread *= MAX_SPREAD_SCALE;
550
590
  shortSpread *= MAX_SPREAD_SCALE;
551
591
  }
552
592
 
593
+ spreadTerms.longSpreadwEL = longSpread;
594
+ spreadTerms.shortSpreadwEL = shortSpread;
595
+
553
596
  if (
554
597
  netRevenueSinceLastFunding.lt(
555
598
  DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT
556
599
  )
557
600
  ) {
558
- const retreatAmount = Math.min(
601
+ const revenueRetreatAmount = Math.min(
559
602
  maxTargetSpread / 10,
560
603
  Math.floor(
561
604
  (baseSpread * netRevenueSinceLastFunding.abs().toNumber()) /
562
605
  DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT.toNumber()
563
606
  )
564
607
  );
565
- const halfRetreatAmount = Math.floor(retreatAmount / 2);
608
+ const halfRevenueRetreatAmount = Math.floor(revenueRetreatAmount / 2);
609
+
610
+ spreadTerms.revenueRetreatAmount = revenueRetreatAmount;
611
+ spreadTerms.halfRevenueRetreatAmount = halfRevenueRetreatAmount;
612
+
566
613
  if (baseAssetAmountWithAmm.gt(ZERO)) {
567
- longSpread += retreatAmount;
568
- shortSpread += halfRetreatAmount;
614
+ longSpread += revenueRetreatAmount;
615
+ shortSpread += halfRevenueRetreatAmount;
569
616
  } else if (baseAssetAmountWithAmm.lt(ZERO)) {
570
- longSpread += halfRetreatAmount;
571
- shortSpread += retreatAmount;
617
+ longSpread += halfRevenueRetreatAmount;
618
+ shortSpread += revenueRetreatAmount;
572
619
  } else {
573
- longSpread += halfRetreatAmount;
574
- shortSpread += halfRetreatAmount;
620
+ longSpread += halfRevenueRetreatAmount;
621
+ shortSpread += halfRevenueRetreatAmount;
575
622
  }
576
623
  }
577
624
 
625
+ spreadTerms.longSpreadwRevRetreat = longSpread;
626
+ spreadTerms.shortSpreadwRevRetreat = shortSpread;
627
+
578
628
  const totalSpread = longSpread + shortSpread;
579
629
  if (totalSpread > maxTargetSpread) {
580
630
  if (longSpread > shortSpread) {
581
631
  longSpread = Math.ceil((longSpread * maxTargetSpread) / totalSpread);
582
- shortSpread = maxTargetSpread - longSpread;
632
+ shortSpread = Math.floor(maxTargetSpread - longSpread);
583
633
  } else {
584
634
  shortSpread = Math.ceil((shortSpread * maxTargetSpread) / totalSpread);
585
- longSpread = maxTargetSpread - shortSpread;
635
+ longSpread = Math.floor(maxTargetSpread - shortSpread);
586
636
  }
587
637
  }
588
638
 
639
+ spreadTerms.totalSpread = totalSpread;
640
+ spreadTerms.longSpread = longSpread;
641
+ spreadTerms.shortSpread = shortSpread;
642
+
643
+ if (returnTerms) {
644
+ return spreadTerms;
645
+ }
589
646
  return [longSpread, shortSpread];
590
647
  }
591
648
 
@@ -617,7 +674,7 @@ export function calculateSpread(
617
674
  const now = new BN(new Date().getTime() / 1000); //todo
618
675
  const liveOracleStd = calculateLiveOracleStd(amm, oraclePriceData, now);
619
676
 
620
- const [longSpread, shortSpread] = calculateSpreadBN(
677
+ const spreads = calculateSpreadBN(
621
678
  amm.baseSpread,
622
679
  targetMarkSpreadPct,
623
680
  confIntervalPct,
@@ -638,6 +695,8 @@ export function calculateSpread(
638
695
  amm.shortIntensityVolume,
639
696
  amm.volume24H
640
697
  );
698
+ const longSpread = spreads[0];
699
+ const shortSpread = spreads[1];
641
700
 
642
701
  return [longSpread, shortSpread];
643
702
  }
@@ -113,8 +113,7 @@ export function calculateLiveOracleTwap(
113
113
 
114
114
  const newOracleTwap = amm.historicalOracleData.lastOraclePriceTwap
115
115
  .mul(sinceStart)
116
- .add(clampedOraclePrice)
117
- .mul(sinceLastUpdate)
116
+ .add(clampedOraclePrice.mul(sinceLastUpdate))
118
117
  .div(sinceStart.add(sinceLastUpdate));
119
118
 
120
119
  return newOracleTwap;
@@ -0,0 +1,178 @@
1
+ import {
2
+ BN,
3
+ PEG_PRECISION, PRICE_PRECISION,
4
+ AMM_RESERVE_PRECISION,
5
+ QUOTE_PRECISION,
6
+ calculateSpreadBN,
7
+ ZERO,
8
+ calculateLiveOracleStd,
9
+ calculateLiveOracleTwap
10
+ } from '../../src';
11
+ import {
12
+ mockPerpMarkets,
13
+ } from '../dlob/helpers';
14
+
15
+ import { assert } from '../../src/assert/assert';
16
+
17
+ class AMMSpreadTerms {
18
+ longVolSpread: number;
19
+ shortVolSpread: number;
20
+ longSpreadwPS: number;
21
+ shortSpreadwPS: number;
22
+ maxTargetSpread: number;
23
+ inventorySpreadScale: number;
24
+ longSpreadwInvScale: number;
25
+ shortSpreadwInvScale: number;
26
+ effectiveLeverage: number;
27
+ effectiveLeverageCapped: number;
28
+ longSpreadwEL: number;
29
+ shortSpreadwEL: number;
30
+ revenueRetreatAmount: number;
31
+ halfRevenueRetreatAmount: number;
32
+ longSpreadwRevRetreat: number;
33
+ shortSpreadwRevRetreat: number;
34
+ totalSpread: number;
35
+ longSpread: number;
36
+ shortSpread: number;
37
+ }
38
+
39
+ describe('AMM Tests', () => {
40
+ it('Various Spreads', () => {
41
+
42
+ const baseSpread: number = .025 * 1e6;
43
+ const lastOracleReservePriceSpreadPct: BN = ZERO;
44
+ const lastOracleConfPct: BN = ZERO;
45
+ const maxSpread: number = .03 * 1e6;
46
+ const quoteAssetReserve: BN = new BN(AMM_RESERVE_PRECISION.toNumber() * 100);
47
+ const terminalQuoteAssetReserve: BN = new BN(AMM_RESERVE_PRECISION.toNumber() * 100);
48
+ const pegMultiplier: BN = new BN(13.455 * PEG_PRECISION.toNumber());
49
+ const baseAssetAmountWithAmm: BN = ZERO;
50
+ const reservePrice: BN = new BN(13.455 * PRICE_PRECISION.toNumber());
51
+ const totalFeeMinusDistributions: BN = new BN(1);
52
+ const netRevenueSinceLastFunding: BN = new BN(QUOTE_PRECISION.toNumber() * 2);
53
+ const baseAssetReserve: BN = new BN(AMM_RESERVE_PRECISION.toNumber() * 100);
54
+ const minBaseAssetReserve: BN = new BN(AMM_RESERVE_PRECISION.toNumber() * 90);
55
+ const maxBaseAssetReserve: BN = new BN(AMM_RESERVE_PRECISION.toNumber() * 110);
56
+ const markStd: BN = new BN(.45 * PRICE_PRECISION.toNumber());
57
+ const oracleStd: BN = new BN(.55 * PRICE_PRECISION.toNumber());
58
+ const longIntensity: BN = new BN(QUOTE_PRECISION.toNumber() * 20);
59
+ const shortIntensity: BN =new BN(QUOTE_PRECISION.toNumber() * 2);
60
+ const volume24H: BN = new BN(QUOTE_PRECISION.toNumber() * 25);
61
+
62
+ const spreads = calculateSpreadBN(
63
+ baseSpread,
64
+ lastOracleReservePriceSpreadPct,
65
+ lastOracleConfPct,
66
+ maxSpread,
67
+ quoteAssetReserve,
68
+ terminalQuoteAssetReserve,
69
+ pegMultiplier,
70
+ baseAssetAmountWithAmm,
71
+ reservePrice,
72
+ totalFeeMinusDistributions,
73
+ netRevenueSinceLastFunding,
74
+ baseAssetReserve,
75
+ minBaseAssetReserve,
76
+ maxBaseAssetReserve,
77
+ markStd,
78
+ oracleStd,
79
+ longIntensity,
80
+ shortIntensity,
81
+ volume24H,
82
+ );
83
+ const l1 = spreads[0];
84
+ const s1 = spreads[1];
85
+
86
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
87
+ // @ts-ignore
88
+ const terms1: AMMSpreadTerms = calculateSpreadBN(
89
+ baseSpread,
90
+ lastOracleReservePriceSpreadPct,
91
+ lastOracleConfPct,
92
+ maxSpread,
93
+ quoteAssetReserve,
94
+ terminalQuoteAssetReserve,
95
+ pegMultiplier,
96
+ baseAssetAmountWithAmm,
97
+ reservePrice,
98
+ totalFeeMinusDistributions,
99
+ netRevenueSinceLastFunding,
100
+ baseAssetReserve,
101
+ minBaseAssetReserve,
102
+ maxBaseAssetReserve,
103
+ markStd,
104
+ oracleStd,
105
+ longIntensity,
106
+ shortIntensity,
107
+ volume24H,
108
+ true
109
+ );
110
+ console.log(terms1);
111
+
112
+ console.log('long/short spread:', l1, s1);
113
+ assert(l1==14864);
114
+ assert(s1==12500);
115
+ assert(l1==terms1.longSpread);
116
+ assert(s1==terms1.shortSpread);
117
+
118
+
119
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
120
+ // @ts-ignore
121
+ const terms2: AMMSpreadTerms = calculateSpreadBN(
122
+ 300,
123
+ new BN(0),
124
+ new BN(484),
125
+ 47500,
126
+ new BN(923807816209694),
127
+ new BN(925117623772584),
128
+ new BN(13731157),
129
+ new BN(-1314027016625),
130
+ new BN(13667686),
131
+ new BN(115876379475),
132
+ new BN(91316628),
133
+ new BN(928097825691666),
134
+ new BN(907979542352912),
135
+ new BN(945977491145601),
136
+ new BN(161188),
137
+ new BN(1459632439),
138
+ new BN(12358265776),
139
+ new BN(72230366233),
140
+ new BN(432067603632),
141
+ true
142
+ );
143
+
144
+ console.log(terms2);
145
+ assert(terms2.effectiveLeverageCapped>=1.0002);
146
+ assert(terms2.inventorySpreadScale==10);
147
+ assert(terms2.longSpread==798);
148
+ assert(terms2.shortSpread==46702);
149
+
150
+ });
151
+
152
+ it('live update functions', () => {
153
+
154
+ const mockAmm = mockPerpMarkets[0].amm;
155
+ const now = new BN(new Date().getTime() / 1000); //todo
156
+
157
+ const oraclePriceData = {
158
+ price: new BN(13.553 * PRICE_PRECISION.toNumber()),
159
+ slot: new BN(68 + 1),
160
+ confidence: new BN(1),
161
+ hasSufficientNumberOfDataPoints: true,
162
+ };
163
+ mockAmm.oracleStd = new BN(.18 * PRICE_PRECISION.toNumber());
164
+ mockAmm.fundingPeriod = new BN(3600);
165
+ mockAmm.historicalOracleData.lastOraclePriceTwap = oraclePriceData.price.mul(new BN(999)).div(new BN(1000));
166
+ mockAmm.historicalOracleData.lastOraclePriceTwapTs = now.sub(new BN(11));
167
+
168
+
169
+ const liveOracleTwap = calculateLiveOracleTwap(mockAmm, oraclePriceData, now);
170
+ console.log('liveOracleTwap:', liveOracleTwap.toNumber());
171
+ assert(liveOracleTwap.eq(new BN(13539488)));
172
+
173
+
174
+ const liveOracleStd = calculateLiveOracleStd(mockAmm, oraclePriceData, now);
175
+ console.log('liveOracleStd:', liveOracleStd.toNumber());
176
+ assert(liveOracleStd.eq(new BN(192962)));
177
+ });
178
+ });