@drift-labs/sdk 0.2.0-master.1 → 0.2.0-master.10

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.
Files changed (112) hide show
  1. package/lib/accounts/types.d.ts +1 -0
  2. package/lib/admin.d.ts +6 -3
  3. package/lib/admin.js +39 -7
  4. package/lib/clearingHouse.d.ts +13 -14
  5. package/lib/clearingHouse.js +166 -106
  6. package/lib/config.js +1 -1
  7. package/lib/constants/banks.js +8 -1
  8. package/lib/constants/numericConstants.d.ts +1 -0
  9. package/lib/constants/numericConstants.js +2 -1
  10. package/lib/factory/bigNum.d.ts +8 -2
  11. package/lib/factory/bigNum.js +14 -6
  12. package/lib/idl/clearing_house.json +277 -55
  13. package/lib/index.d.ts +2 -1
  14. package/lib/index.js +6 -1
  15. package/lib/math/amm.d.ts +6 -1
  16. package/lib/math/amm.js +124 -41
  17. package/lib/math/auction.js +4 -1
  18. package/lib/math/orders.d.ts +2 -2
  19. package/lib/math/orders.js +18 -11
  20. package/lib/math/position.js +3 -1
  21. package/lib/math/repeg.js +1 -1
  22. package/lib/math/trade.d.ts +1 -1
  23. package/lib/math/trade.js +7 -10
  24. package/lib/orderParams.d.ts +14 -5
  25. package/lib/orderParams.js +8 -96
  26. package/lib/orders.d.ts +1 -2
  27. package/lib/orders.js +6 -85
  28. package/lib/slot/SlotSubscriber.d.ts +7 -0
  29. package/lib/slot/SlotSubscriber.js +3 -0
  30. package/lib/tx/utils.js +1 -1
  31. package/lib/types.d.ts +75 -1
  32. package/lib/types.js +42 -1
  33. package/package.json +3 -3
  34. package/src/accounts/bulkAccountLoader.js +197 -0
  35. package/src/accounts/bulkUserSubscription.js +33 -0
  36. package/src/accounts/fetch.js +29 -0
  37. package/src/accounts/pollingClearingHouseAccountSubscriber.js +311 -0
  38. package/src/accounts/pollingOracleSubscriber.js +93 -0
  39. package/src/accounts/pollingTokenAccountSubscriber.js +90 -0
  40. package/src/accounts/pollingUserAccountSubscriber.js +132 -0
  41. package/src/accounts/types.js +10 -0
  42. package/src/accounts/utils.js +7 -0
  43. package/src/accounts/webSocketAccountSubscriber.js +93 -0
  44. package/src/accounts/webSocketClearingHouseAccountSubscriber.js +233 -0
  45. package/src/accounts/webSocketUserAccountSubscriber.js +62 -0
  46. package/src/addresses/marketAddresses.js +26 -0
  47. package/src/addresses/pda.js +104 -0
  48. package/src/admin.ts +60 -8
  49. package/src/assert/assert.js +9 -0
  50. package/src/clearingHouse.ts +223 -183
  51. package/src/config.ts +1 -1
  52. package/src/constants/banks.ts +8 -1
  53. package/src/constants/numericConstants.ts +1 -0
  54. package/src/events/eventList.js +77 -0
  55. package/src/events/eventSubscriber.js +139 -0
  56. package/src/events/fetchLogs.js +50 -0
  57. package/src/events/pollingLogProvider.js +64 -0
  58. package/src/events/sort.js +44 -0
  59. package/src/events/txEventCache.js +71 -0
  60. package/src/events/types.js +20 -0
  61. package/src/events/webSocketLogProvider.js +41 -0
  62. package/src/examples/makeTradeExample.js +80 -0
  63. package/src/factory/bigNum.js +364 -0
  64. package/src/factory/bigNum.ts +26 -9
  65. package/src/factory/oracleClient.js +20 -0
  66. package/src/idl/clearing_house.json +277 -55
  67. package/src/index.js +69 -0
  68. package/src/index.ts +2 -1
  69. package/src/math/amm.js +369 -0
  70. package/src/math/amm.ts +207 -52
  71. package/src/math/auction.js +42 -0
  72. package/src/math/auction.ts +5 -1
  73. package/src/math/bankBalance.js +75 -0
  74. package/src/math/conversion.js +11 -0
  75. package/src/math/funding.js +248 -0
  76. package/src/math/market.js +57 -0
  77. package/src/math/oracles.js +26 -0
  78. package/src/math/orders.js +110 -0
  79. package/src/math/orders.ts +17 -13
  80. package/src/math/position.js +140 -0
  81. package/src/math/position.ts +5 -1
  82. package/src/math/repeg.js +128 -0
  83. package/src/math/repeg.ts +2 -1
  84. package/src/math/state.js +15 -0
  85. package/src/math/trade.js +253 -0
  86. package/src/math/trade.ts +23 -25
  87. package/src/math/utils.js +0 -1
  88. package/src/mockUSDCFaucet.js +171 -0
  89. package/src/oracles/oracleClientCache.js +19 -0
  90. package/src/oracles/pythClient.js +46 -0
  91. package/src/oracles/quoteAssetOracleClient.js +32 -0
  92. package/src/oracles/switchboardClient.js +69 -0
  93. package/src/oracles/types.js +2 -0
  94. package/src/orderParams.js +20 -0
  95. package/src/orderParams.ts +20 -141
  96. package/src/orders.js +134 -0
  97. package/src/orders.ts +7 -131
  98. package/src/slot/SlotSubscriber.js +39 -0
  99. package/src/slot/SlotSubscriber.ts +11 -1
  100. package/src/token/index.js +38 -0
  101. package/src/tx/retryTxSender.js +188 -0
  102. package/src/tx/types.js +2 -0
  103. package/src/tx/utils.js +17 -0
  104. package/src/tx/utils.ts +1 -1
  105. package/src/types.js +114 -0
  106. package/src/types.ts +69 -3
  107. package/src/userName.js +20 -0
  108. package/src/util/promiseTimeout.js +14 -0
  109. package/src/util/tps.js +27 -0
  110. package/src/wallet.js +35 -0
  111. package/src/util/computeUnits.js +0 -17
  112. package/src/util/computeUnits.js.map +0 -1
@@ -0,0 +1,369 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.calculateQuoteAssetAmountSwapped = exports.calculateMaxBaseAssetAmountToTrade = exports.calculateTerminalPrice = exports.getSwapDirection = exports.calculateSwapOutput = exports.calculateSpreadReserves = exports.calculateSpread = exports.calculateSpreadBN = exports.calculateMaxSpread = exports.calculateEffectiveLeverage = exports.calculateAmmReservesAfterSwap = exports.calculatePrice = exports.calculateBidAskPrice = exports.calculateUpdatedAMMSpreadReserves = exports.calculateUpdatedAMM = exports.calculateNewAmm = exports.calculateOptimalPegAndBudget = exports.calculatePegFromTargetPrice = void 0;
4
+ const anchor_1 = require("@project-serum/anchor");
5
+ const numericConstants_1 = require("../constants/numericConstants");
6
+ const types_1 = require("../types");
7
+ const assert_1 = require("../assert/assert");
8
+ const __1 = require("..");
9
+ const repeg_1 = require("./repeg");
10
+ function calculatePegFromTargetPrice(targetPrice, baseAssetReserve, quoteAssetReserve) {
11
+ return targetPrice
12
+ .mul(baseAssetReserve)
13
+ .div(quoteAssetReserve)
14
+ .add(numericConstants_1.PRICE_DIV_PEG.div(new anchor_1.BN(2)))
15
+ .div(numericConstants_1.PRICE_DIV_PEG);
16
+ }
17
+ exports.calculatePegFromTargetPrice = calculatePegFromTargetPrice;
18
+ function calculateOptimalPegAndBudget(amm, oraclePriceData) {
19
+ const markPriceBefore = calculatePrice(amm.baseAssetReserve, amm.quoteAssetReserve, amm.pegMultiplier);
20
+ const targetPrice = oraclePriceData.price;
21
+ const newPeg = calculatePegFromTargetPrice(targetPrice, amm.baseAssetReserve, amm.quoteAssetReserve);
22
+ const prePegCost = repeg_1.calculateRepegCost(amm, newPeg);
23
+ const totalFeeLB = amm.totalExchangeFee.div(new anchor_1.BN(2));
24
+ const budget = anchor_1.BN.max(numericConstants_1.ZERO, amm.totalFeeMinusDistributions.sub(totalFeeLB));
25
+ if (budget.lt(prePegCost)) {
26
+ const maxPriceSpread = new anchor_1.BN(amm.maxSpread)
27
+ .mul(targetPrice)
28
+ .div(numericConstants_1.BID_ASK_SPREAD_PRECISION);
29
+ let newTargetPrice;
30
+ let newOptimalPeg;
31
+ let newBudget;
32
+ const targetPriceGap = markPriceBefore.sub(targetPrice);
33
+ if (targetPriceGap.abs().gt(maxPriceSpread)) {
34
+ const markAdj = targetPriceGap.abs().sub(maxPriceSpread);
35
+ if (targetPriceGap.lt(new anchor_1.BN(0))) {
36
+ newTargetPrice = markPriceBefore.add(markAdj);
37
+ }
38
+ else {
39
+ newTargetPrice = markPriceBefore.sub(markAdj);
40
+ }
41
+ newOptimalPeg = calculatePegFromTargetPrice(newTargetPrice, amm.baseAssetReserve, amm.quoteAssetReserve);
42
+ newBudget = repeg_1.calculateRepegCost(amm, newOptimalPeg);
43
+ return [newTargetPrice, newOptimalPeg, newBudget, false];
44
+ }
45
+ }
46
+ return [targetPrice, newPeg, budget, true];
47
+ }
48
+ exports.calculateOptimalPegAndBudget = calculateOptimalPegAndBudget;
49
+ function calculateNewAmm(amm, oraclePriceData) {
50
+ let pKNumer = new anchor_1.BN(1);
51
+ let pKDenom = new anchor_1.BN(1);
52
+ const [targetPrice, _newPeg, budget, checkLowerBound] = calculateOptimalPegAndBudget(amm, oraclePriceData);
53
+ let prePegCost = repeg_1.calculateRepegCost(amm, _newPeg);
54
+ let newPeg = _newPeg;
55
+ if (prePegCost.gt(budget) && checkLowerBound) {
56
+ [pKNumer, pKDenom] = [new anchor_1.BN(999), new anchor_1.BN(1000)];
57
+ const deficitMadeup = repeg_1.calculateAdjustKCost(amm, pKNumer, pKDenom);
58
+ assert_1.assert(deficitMadeup.lte(new anchor_1.BN(0)));
59
+ prePegCost = budget.add(deficitMadeup.abs());
60
+ const newAmm = Object.assign({}, amm);
61
+ newAmm.baseAssetReserve = newAmm.baseAssetReserve.mul(pKNumer).div(pKDenom);
62
+ newAmm.sqrtK = newAmm.sqrtK.mul(pKNumer).div(pKDenom);
63
+ const invariant = newAmm.sqrtK.mul(newAmm.sqrtK);
64
+ newAmm.quoteAssetReserve = invariant.div(newAmm.baseAssetReserve);
65
+ const directionToClose = amm.netBaseAssetAmount.gt(numericConstants_1.ZERO)
66
+ ? types_1.PositionDirection.SHORT
67
+ : types_1.PositionDirection.LONG;
68
+ const [newQuoteAssetReserve, _newBaseAssetReserve] = calculateAmmReservesAfterSwap(newAmm, 'base', amm.netBaseAssetAmount.abs(), getSwapDirection('base', directionToClose));
69
+ newAmm.terminalQuoteAssetReserve = newQuoteAssetReserve;
70
+ newPeg = repeg_1.calculateBudgetedPeg(newAmm, prePegCost, targetPrice);
71
+ prePegCost = repeg_1.calculateRepegCost(newAmm, newPeg);
72
+ }
73
+ return [prePegCost, pKNumer, pKDenom, newPeg];
74
+ }
75
+ exports.calculateNewAmm = calculateNewAmm;
76
+ function calculateUpdatedAMM(amm, oraclePriceData) {
77
+ if (amm.curveUpdateIntensity == 0) {
78
+ return amm;
79
+ }
80
+ const newAmm = Object.assign({}, amm);
81
+ const [prepegCost, pKNumer, pKDenom, newPeg] = calculateNewAmm(amm, oraclePriceData);
82
+ newAmm.baseAssetReserve = newAmm.baseAssetReserve.mul(pKNumer).div(pKDenom);
83
+ newAmm.sqrtK = newAmm.sqrtK.mul(pKNumer).div(pKDenom);
84
+ const invariant = newAmm.sqrtK.mul(newAmm.sqrtK);
85
+ newAmm.quoteAssetReserve = invariant.div(newAmm.baseAssetReserve);
86
+ newAmm.pegMultiplier = newPeg;
87
+ const directionToClose = amm.netBaseAssetAmount.gt(numericConstants_1.ZERO)
88
+ ? types_1.PositionDirection.SHORT
89
+ : types_1.PositionDirection.LONG;
90
+ const [newQuoteAssetReserve, _newBaseAssetReserve] = calculateAmmReservesAfterSwap(newAmm, 'base', amm.netBaseAssetAmount.abs(), getSwapDirection('base', directionToClose));
91
+ newAmm.terminalQuoteAssetReserve = newQuoteAssetReserve;
92
+ newAmm.totalFeeMinusDistributions =
93
+ newAmm.totalFeeMinusDistributions.sub(prepegCost);
94
+ return newAmm;
95
+ }
96
+ exports.calculateUpdatedAMM = calculateUpdatedAMM;
97
+ function calculateUpdatedAMMSpreadReserves(amm, direction, oraclePriceData) {
98
+ const newAmm = calculateUpdatedAMM(amm, oraclePriceData);
99
+ const dirReserves = calculateSpreadReserves(newAmm, direction, oraclePriceData);
100
+ const result = {
101
+ baseAssetReserve: dirReserves.baseAssetReserve,
102
+ quoteAssetReserve: dirReserves.quoteAssetReserve,
103
+ sqrtK: newAmm.sqrtK,
104
+ newPeg: newAmm.pegMultiplier,
105
+ };
106
+ return result;
107
+ }
108
+ exports.calculateUpdatedAMMSpreadReserves = calculateUpdatedAMMSpreadReserves;
109
+ function calculateBidAskPrice(amm, oraclePriceData, withUpdate = true) {
110
+ let newAmm;
111
+ if (withUpdate) {
112
+ newAmm = calculateUpdatedAMM(amm, oraclePriceData);
113
+ }
114
+ else {
115
+ newAmm = amm;
116
+ }
117
+ const askReserves = calculateSpreadReserves(newAmm, types_1.PositionDirection.LONG, oraclePriceData);
118
+ const bidReserves = calculateSpreadReserves(newAmm, types_1.PositionDirection.SHORT, oraclePriceData);
119
+ const askPrice = calculatePrice(askReserves.baseAssetReserve, askReserves.quoteAssetReserve, newAmm.pegMultiplier);
120
+ const bidPrice = calculatePrice(bidReserves.baseAssetReserve, bidReserves.quoteAssetReserve, newAmm.pegMultiplier);
121
+ return [bidPrice, askPrice];
122
+ }
123
+ exports.calculateBidAskPrice = calculateBidAskPrice;
124
+ /**
125
+ * Calculates a price given an arbitrary base and quote amount (they must have the same precision)
126
+ *
127
+ * @param baseAssetReserves
128
+ * @param quoteAssetReserves
129
+ * @param pegMultiplier
130
+ * @returns price : Precision MARK_PRICE_PRECISION
131
+ */
132
+ function calculatePrice(baseAssetReserves, quoteAssetReserves, pegMultiplier) {
133
+ if (baseAssetReserves.abs().lte(numericConstants_1.ZERO)) {
134
+ return new anchor_1.BN(0);
135
+ }
136
+ return quoteAssetReserves
137
+ .mul(numericConstants_1.MARK_PRICE_PRECISION)
138
+ .mul(pegMultiplier)
139
+ .div(numericConstants_1.PEG_PRECISION)
140
+ .div(baseAssetReserves);
141
+ }
142
+ exports.calculatePrice = calculatePrice;
143
+ /**
144
+ * Calculates what the amm reserves would be after swapping a quote or base asset amount.
145
+ *
146
+ * @param amm
147
+ * @param inputAssetType
148
+ * @param swapAmount
149
+ * @param swapDirection
150
+ * @returns quoteAssetReserve and baseAssetReserve after swap. : Precision AMM_RESERVE_PRECISION
151
+ */
152
+ function calculateAmmReservesAfterSwap(amm, inputAssetType, swapAmount, swapDirection) {
153
+ assert_1.assert(swapAmount.gte(numericConstants_1.ZERO), 'swapAmount must be greater than 0');
154
+ let newQuoteAssetReserve;
155
+ let newBaseAssetReserve;
156
+ if (inputAssetType === 'quote') {
157
+ swapAmount = swapAmount
158
+ .mul(numericConstants_1.AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO)
159
+ .div(amm.pegMultiplier);
160
+ [newQuoteAssetReserve, newBaseAssetReserve] = calculateSwapOutput(amm.quoteAssetReserve, swapAmount, swapDirection, amm.sqrtK.mul(amm.sqrtK));
161
+ }
162
+ else {
163
+ [newBaseAssetReserve, newQuoteAssetReserve] = calculateSwapOutput(amm.baseAssetReserve, swapAmount, swapDirection, amm.sqrtK.mul(amm.sqrtK));
164
+ }
165
+ return [newQuoteAssetReserve, newBaseAssetReserve];
166
+ }
167
+ exports.calculateAmmReservesAfterSwap = calculateAmmReservesAfterSwap;
168
+ function calculateEffectiveLeverage(baseSpread, quoteAssetReserve, terminalQuoteAssetReserve, pegMultiplier, netBaseAssetAmount, markPrice, totalFeeMinusDistributions) {
169
+ // inventory skew
170
+ const netBaseAssetValue = quoteAssetReserve
171
+ .sub(terminalQuoteAssetReserve)
172
+ .mul(pegMultiplier)
173
+ .div(numericConstants_1.AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO);
174
+ const localBaseAssetValue = netBaseAssetAmount
175
+ .mul(markPrice)
176
+ .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO.mul(numericConstants_1.MARK_PRICE_PRECISION));
177
+ const effectiveLeverage = localBaseAssetValue.sub(netBaseAssetValue).toNumber() /
178
+ (Math.max(0, totalFeeMinusDistributions.toNumber()) + 1) +
179
+ 1 / numericConstants_1.QUOTE_PRECISION.toNumber();
180
+ return effectiveLeverage;
181
+ }
182
+ exports.calculateEffectiveLeverage = calculateEffectiveLeverage;
183
+ function calculateMaxSpread(marginRatioInitial) {
184
+ const maxTargetSpread = new anchor_1.BN(marginRatioInitial)
185
+ .mul(numericConstants_1.BID_ASK_SPREAD_PRECISION.div(numericConstants_1.MARGIN_PRECISION))
186
+ .toNumber();
187
+ return maxTargetSpread;
188
+ }
189
+ exports.calculateMaxSpread = calculateMaxSpread;
190
+ function calculateSpreadBN(baseSpread, lastOracleMarkSpreadPct, lastOracleConfPct, maxSpread, quoteAssetReserve, terminalQuoteAssetReserve, pegMultiplier, netBaseAssetAmount, markPrice, totalFeeMinusDistributions) {
191
+ let longSpread = baseSpread / 2;
192
+ let shortSpread = baseSpread / 2;
193
+ if (lastOracleMarkSpreadPct.gt(numericConstants_1.ZERO)) {
194
+ shortSpread = Math.max(shortSpread, lastOracleMarkSpreadPct.abs().toNumber() + lastOracleConfPct.toNumber());
195
+ }
196
+ else if (lastOracleMarkSpreadPct.lt(numericConstants_1.ZERO)) {
197
+ longSpread = Math.max(longSpread, lastOracleMarkSpreadPct.abs().toNumber() + lastOracleConfPct.toNumber());
198
+ }
199
+ const maxTargetSpread = maxSpread;
200
+ const MAX_INVENTORY_SKEW = 5;
201
+ const effectiveLeverage = calculateEffectiveLeverage(baseSpread, quoteAssetReserve, terminalQuoteAssetReserve, pegMultiplier, netBaseAssetAmount, markPrice, totalFeeMinusDistributions);
202
+ if (totalFeeMinusDistributions.gt(numericConstants_1.ZERO)) {
203
+ const spreadScale = Math.min(MAX_INVENTORY_SKEW, 1 + effectiveLeverage);
204
+ if (netBaseAssetAmount.gt(numericConstants_1.ZERO)) {
205
+ longSpread *= spreadScale;
206
+ }
207
+ else {
208
+ shortSpread *= spreadScale;
209
+ }
210
+ }
211
+ else {
212
+ longSpread *= MAX_INVENTORY_SKEW;
213
+ shortSpread *= MAX_INVENTORY_SKEW;
214
+ }
215
+ const totalSpread = longSpread + shortSpread;
216
+ if (totalSpread > maxTargetSpread) {
217
+ if (longSpread > shortSpread) {
218
+ longSpread = Math.min(longSpread, maxTargetSpread);
219
+ shortSpread = maxTargetSpread - longSpread;
220
+ }
221
+ else {
222
+ shortSpread = Math.min(shortSpread, maxTargetSpread);
223
+ longSpread = maxTargetSpread - shortSpread;
224
+ }
225
+ }
226
+ return [longSpread, shortSpread];
227
+ }
228
+ exports.calculateSpreadBN = calculateSpreadBN;
229
+ function calculateSpread(amm, direction, oraclePriceData) {
230
+ if (amm.baseSpread == 0 || amm.curveUpdateIntensity == 0) {
231
+ return amm.baseSpread / 2;
232
+ }
233
+ const markPrice = calculatePrice(amm.baseAssetReserve, amm.quoteAssetReserve, amm.pegMultiplier);
234
+ const targetPrice = (oraclePriceData === null || oraclePriceData === void 0 ? void 0 : oraclePriceData.price) || markPrice;
235
+ const confInterval = oraclePriceData.confidence || numericConstants_1.ZERO;
236
+ const targetMarkSpreadPct = markPrice
237
+ .sub(targetPrice)
238
+ .mul(numericConstants_1.BID_ASK_SPREAD_PRECISION)
239
+ .div(markPrice);
240
+ const confIntervalPct = confInterval
241
+ .mul(numericConstants_1.BID_ASK_SPREAD_PRECISION)
242
+ .div(markPrice);
243
+ const [longSpread, shortSpread] = calculateSpreadBN(amm.baseSpread, targetMarkSpreadPct, confIntervalPct, amm.maxSpread, amm.quoteAssetReserve, amm.terminalQuoteAssetReserve, amm.pegMultiplier, amm.netBaseAssetAmount, markPrice, amm.totalFeeMinusDistributions);
244
+ let spread;
245
+ if (types_1.isVariant(direction, 'long')) {
246
+ spread = longSpread;
247
+ }
248
+ else {
249
+ spread = shortSpread;
250
+ }
251
+ return spread;
252
+ }
253
+ exports.calculateSpread = calculateSpread;
254
+ function calculateSpreadReserves(amm, direction, oraclePriceData) {
255
+ const spread = calculateSpread(amm, direction, oraclePriceData);
256
+ if (spread === 0) {
257
+ return {
258
+ baseAssetReserve: amm.baseAssetReserve,
259
+ quoteAssetReserve: amm.quoteAssetReserve,
260
+ };
261
+ }
262
+ const quoteAsserReserveDelta = amm.quoteAssetReserve.div(numericConstants_1.BID_ASK_SPREAD_PRECISION.div(new anchor_1.BN(spread / 2)));
263
+ let quoteAssetReserve;
264
+ if (types_1.isVariant(direction, 'long')) {
265
+ quoteAssetReserve = amm.quoteAssetReserve.add(quoteAsserReserveDelta);
266
+ }
267
+ else {
268
+ quoteAssetReserve = amm.quoteAssetReserve.sub(quoteAsserReserveDelta);
269
+ }
270
+ const baseAssetReserve = amm.sqrtK.mul(amm.sqrtK).div(quoteAssetReserve);
271
+ return {
272
+ baseAssetReserve,
273
+ quoteAssetReserve,
274
+ };
275
+ }
276
+ exports.calculateSpreadReserves = calculateSpreadReserves;
277
+ /**
278
+ * Helper function calculating constant product curve output. Agnostic to whether input asset is quote or base
279
+ *
280
+ * @param inputAssetReserve
281
+ * @param swapAmount
282
+ * @param swapDirection
283
+ * @param invariant
284
+ * @returns newInputAssetReserve and newOutputAssetReserve after swap. : Precision AMM_RESERVE_PRECISION
285
+ */
286
+ function calculateSwapOutput(inputAssetReserve, swapAmount, swapDirection, invariant) {
287
+ let newInputAssetReserve;
288
+ if (swapDirection === types_1.SwapDirection.ADD) {
289
+ newInputAssetReserve = inputAssetReserve.add(swapAmount);
290
+ }
291
+ else {
292
+ newInputAssetReserve = inputAssetReserve.sub(swapAmount);
293
+ }
294
+ const newOutputAssetReserve = invariant.div(newInputAssetReserve);
295
+ return [newInputAssetReserve, newOutputAssetReserve];
296
+ }
297
+ exports.calculateSwapOutput = calculateSwapOutput;
298
+ /**
299
+ * Translate long/shorting quote/base asset into amm operation
300
+ *
301
+ * @param inputAssetType
302
+ * @param positionDirection
303
+ */
304
+ function getSwapDirection(inputAssetType, positionDirection) {
305
+ if (types_1.isVariant(positionDirection, 'long') && inputAssetType === 'base') {
306
+ return types_1.SwapDirection.REMOVE;
307
+ }
308
+ if (types_1.isVariant(positionDirection, 'short') && inputAssetType === 'quote') {
309
+ return types_1.SwapDirection.REMOVE;
310
+ }
311
+ return types_1.SwapDirection.ADD;
312
+ }
313
+ exports.getSwapDirection = getSwapDirection;
314
+ /**
315
+ * Helper function calculating terminal price of amm
316
+ *
317
+ * @param market
318
+ * @returns cost : Precision MARK_PRICE_PRECISION
319
+ */
320
+ function calculateTerminalPrice(market) {
321
+ const directionToClose = market.amm.netBaseAssetAmount.gt(numericConstants_1.ZERO)
322
+ ? types_1.PositionDirection.SHORT
323
+ : types_1.PositionDirection.LONG;
324
+ const [newQuoteAssetReserve, newBaseAssetReserve] = calculateAmmReservesAfterSwap(market.amm, 'base', market.amm.netBaseAssetAmount.abs(), getSwapDirection('base', directionToClose));
325
+ const terminalPrice = newQuoteAssetReserve
326
+ .mul(numericConstants_1.MARK_PRICE_PRECISION)
327
+ .mul(market.amm.pegMultiplier)
328
+ .div(numericConstants_1.PEG_PRECISION)
329
+ .div(newBaseAssetReserve);
330
+ return terminalPrice;
331
+ }
332
+ exports.calculateTerminalPrice = calculateTerminalPrice;
333
+ function calculateMaxBaseAssetAmountToTrade(amm, limit_price, direction, oraclePriceData) {
334
+ const invariant = amm.sqrtK.mul(amm.sqrtK);
335
+ const newBaseAssetReserveSquared = invariant
336
+ .mul(numericConstants_1.MARK_PRICE_PRECISION)
337
+ .mul(amm.pegMultiplier)
338
+ .div(limit_price)
339
+ .div(numericConstants_1.PEG_PRECISION);
340
+ const newBaseAssetReserve = __1.squareRootBN(newBaseAssetReserveSquared);
341
+ const baseAssetReserveBefore = calculateSpreadReserves(amm, direction, oraclePriceData).baseAssetReserve;
342
+ if (newBaseAssetReserve.gt(baseAssetReserveBefore)) {
343
+ return [
344
+ newBaseAssetReserve.sub(baseAssetReserveBefore),
345
+ types_1.PositionDirection.SHORT,
346
+ ];
347
+ }
348
+ else if (newBaseAssetReserve.lt(baseAssetReserveBefore)) {
349
+ return [
350
+ baseAssetReserveBefore.sub(newBaseAssetReserve),
351
+ types_1.PositionDirection.LONG,
352
+ ];
353
+ }
354
+ else {
355
+ console.log('tradeSize Too Small');
356
+ return [new anchor_1.BN(0), types_1.PositionDirection.LONG];
357
+ }
358
+ }
359
+ exports.calculateMaxBaseAssetAmountToTrade = calculateMaxBaseAssetAmountToTrade;
360
+ function calculateQuoteAssetAmountSwapped(quoteAssetReserves, pegMultiplier, swapDirection) {
361
+ let quoteAssetAmount = quoteAssetReserves
362
+ .mul(pegMultiplier)
363
+ .div(numericConstants_1.AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO);
364
+ if (types_1.isVariant(swapDirection, 'remove')) {
365
+ quoteAssetAmount = quoteAssetAmount.add(numericConstants_1.ONE);
366
+ }
367
+ return quoteAssetAmount;
368
+ }
369
+ exports.calculateQuoteAssetAmountSwapped = calculateQuoteAssetAmountSwapped;
package/src/math/amm.ts CHANGED
@@ -6,8 +6,10 @@ import {
6
6
  ZERO,
7
7
  BID_ASK_SPREAD_PRECISION,
8
8
  ONE,
9
- // QUOTE_PRECISION,
10
9
  AMM_TO_QUOTE_PRECISION_RATIO,
10
+ QUOTE_PRECISION,
11
+ MARGIN_PRECISION,
12
+ PRICE_DIV_PEG,
11
13
  } from '../constants/numericConstants';
12
14
  import {
13
15
  AMM,
@@ -25,6 +27,71 @@ import {
25
27
  calculateAdjustKCost,
26
28
  calculateBudgetedPeg,
27
29
  } from './repeg';
30
+
31
+ export function calculatePegFromTargetPrice(
32
+ targetPrice: BN,
33
+ baseAssetReserve: BN,
34
+ quoteAssetReserve: BN
35
+ ): BN {
36
+ return targetPrice
37
+ .mul(baseAssetReserve)
38
+ .div(quoteAssetReserve)
39
+ .add(PRICE_DIV_PEG.div(new BN(2)))
40
+ .div(PRICE_DIV_PEG);
41
+ }
42
+
43
+ export function calculateOptimalPegAndBudget(
44
+ amm: AMM,
45
+ oraclePriceData: OraclePriceData
46
+ ): [BN, BN, BN, boolean] {
47
+ const markPriceBefore = calculatePrice(
48
+ amm.baseAssetReserve,
49
+ amm.quoteAssetReserve,
50
+ amm.pegMultiplier
51
+ );
52
+ const targetPrice = oraclePriceData.price;
53
+ const newPeg = calculatePegFromTargetPrice(
54
+ targetPrice,
55
+ amm.baseAssetReserve,
56
+ amm.quoteAssetReserve
57
+ );
58
+ const prePegCost = calculateRepegCost(amm, newPeg);
59
+
60
+ const totalFeeLB = amm.totalExchangeFee.div(new BN(2));
61
+ const budget = BN.max(ZERO, amm.totalFeeMinusDistributions.sub(totalFeeLB));
62
+ if (budget.lt(prePegCost)) {
63
+ const maxPriceSpread = new BN(amm.maxSpread)
64
+ .mul(targetPrice)
65
+ .div(BID_ASK_SPREAD_PRECISION);
66
+
67
+ let newTargetPrice: BN;
68
+ let newOptimalPeg: BN;
69
+ let newBudget: BN;
70
+ const targetPriceGap = markPriceBefore.sub(targetPrice);
71
+
72
+ if (targetPriceGap.abs().gt(maxPriceSpread)) {
73
+ const markAdj = targetPriceGap.abs().sub(maxPriceSpread);
74
+
75
+ if (targetPriceGap.lt(new BN(0))) {
76
+ newTargetPrice = markPriceBefore.add(markAdj);
77
+ } else {
78
+ newTargetPrice = markPriceBefore.sub(markAdj);
79
+ }
80
+
81
+ newOptimalPeg = calculatePegFromTargetPrice(
82
+ newTargetPrice,
83
+ amm.baseAssetReserve,
84
+ amm.quoteAssetReserve
85
+ );
86
+
87
+ newBudget = calculateRepegCost(amm, newOptimalPeg);
88
+ return [newTargetPrice, newOptimalPeg, newBudget, false];
89
+ }
90
+ }
91
+
92
+ return [targetPrice, newPeg, budget, true];
93
+ }
94
+
28
95
  export function calculateNewAmm(
29
96
  amm: AMM,
30
97
  oraclePriceData: OraclePriceData
@@ -32,18 +99,12 @@ export function calculateNewAmm(
32
99
  let pKNumer = new BN(1);
33
100
  let pKDenom = new BN(1);
34
101
 
35
- const targetPrice = oraclePriceData.price;
36
- let newPeg = targetPrice
37
- .mul(amm.baseAssetReserve)
38
- .div(amm.quoteAssetReserve)
39
- .add(MARK_PRICE_PRECISION.div(PEG_PRECISION).div(new BN(2)))
40
- .div(MARK_PRICE_PRECISION.div(PEG_PRECISION));
41
- let prePegCost = calculateRepegCost(amm, newPeg);
42
-
43
- const totalFeeLB = amm.totalExchangeFee.div(new BN(2));
44
- const budget = BN.max(ZERO, amm.totalFeeMinusDistributions.sub(totalFeeLB));
102
+ const [targetPrice, _newPeg, budget, checkLowerBound] =
103
+ calculateOptimalPegAndBudget(amm, oraclePriceData);
104
+ let prePegCost = calculateRepegCost(amm, _newPeg);
105
+ let newPeg = _newPeg;
45
106
 
46
- if (prePegCost.gt(budget)) {
107
+ if (prePegCost.gt(budget) && checkLowerBound) {
47
108
  [pKNumer, pKDenom] = [new BN(999), new BN(1000)];
48
109
  const deficitMadeup = calculateAdjustKCost(amm, pKNumer, pKDenom);
49
110
  assert(deficitMadeup.lte(new BN(0)));
@@ -136,9 +197,16 @@ export function calculateUpdatedAMMSpreadReserves(
136
197
 
137
198
  export function calculateBidAskPrice(
138
199
  amm: AMM,
139
- oraclePriceData: OraclePriceData
200
+ oraclePriceData: OraclePriceData,
201
+ withUpdate = true
140
202
  ): [BN, BN] {
141
- const newAmm = calculateUpdatedAMM(amm, oraclePriceData);
203
+ let newAmm: AMM;
204
+ if (withUpdate) {
205
+ newAmm = calculateUpdatedAMM(amm, oraclePriceData);
206
+ } else {
207
+ newAmm = amm;
208
+ }
209
+
142
210
  const askReserves = calculateSpreadReserves(
143
211
  newAmm,
144
212
  PositionDirection.LONG,
@@ -237,15 +305,115 @@ export function calculateAmmReservesAfterSwap(
237
305
  return [newQuoteAssetReserve, newBaseAssetReserve];
238
306
  }
239
307
 
308
+ export function calculateEffectiveLeverage(
309
+ baseSpread: number,
310
+ quoteAssetReserve: BN,
311
+ terminalQuoteAssetReserve: BN,
312
+ pegMultiplier: BN,
313
+ netBaseAssetAmount: BN,
314
+ markPrice: BN,
315
+ totalFeeMinusDistributions: BN
316
+ ): number {
317
+ // inventory skew
318
+ const netBaseAssetValue = quoteAssetReserve
319
+ .sub(terminalQuoteAssetReserve)
320
+ .mul(pegMultiplier)
321
+ .div(AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO);
322
+
323
+ const localBaseAssetValue = netBaseAssetAmount
324
+ .mul(markPrice)
325
+ .div(AMM_TO_QUOTE_PRECISION_RATIO.mul(MARK_PRICE_PRECISION));
326
+
327
+ const effectiveLeverage =
328
+ localBaseAssetValue.sub(netBaseAssetValue).toNumber() /
329
+ (Math.max(0, totalFeeMinusDistributions.toNumber()) + 1) +
330
+ 1 / QUOTE_PRECISION.toNumber();
331
+
332
+ return effectiveLeverage;
333
+ }
334
+
335
+ export function calculateMaxSpread(marginRatioInitial: number): number {
336
+ const maxTargetSpread: number = new BN(marginRatioInitial)
337
+ .mul(BID_ASK_SPREAD_PRECISION.div(MARGIN_PRECISION))
338
+ .toNumber();
339
+
340
+ return maxTargetSpread;
341
+ }
342
+
343
+ export function calculateSpreadBN(
344
+ baseSpread: number,
345
+ lastOracleMarkSpreadPct: BN,
346
+ lastOracleConfPct: BN,
347
+ maxSpread: number,
348
+ quoteAssetReserve: BN,
349
+ terminalQuoteAssetReserve: BN,
350
+ pegMultiplier: BN,
351
+ netBaseAssetAmount: BN,
352
+ markPrice: BN,
353
+ totalFeeMinusDistributions: BN
354
+ ): [number, number] {
355
+ let longSpread = baseSpread / 2;
356
+ let shortSpread = baseSpread / 2;
357
+
358
+ if (lastOracleMarkSpreadPct.gt(ZERO)) {
359
+ shortSpread = Math.max(
360
+ shortSpread,
361
+ lastOracleMarkSpreadPct.abs().toNumber() + lastOracleConfPct.toNumber()
362
+ );
363
+ } else if (lastOracleMarkSpreadPct.lt(ZERO)) {
364
+ longSpread = Math.max(
365
+ longSpread,
366
+ lastOracleMarkSpreadPct.abs().toNumber() + lastOracleConfPct.toNumber()
367
+ );
368
+ }
369
+
370
+ const maxTargetSpread: number = maxSpread;
371
+
372
+ const MAX_INVENTORY_SKEW = 5;
373
+
374
+ const effectiveLeverage = calculateEffectiveLeverage(
375
+ baseSpread,
376
+ quoteAssetReserve,
377
+ terminalQuoteAssetReserve,
378
+ pegMultiplier,
379
+ netBaseAssetAmount,
380
+ markPrice,
381
+ totalFeeMinusDistributions
382
+ );
383
+
384
+ if (totalFeeMinusDistributions.gt(ZERO)) {
385
+ const spreadScale = Math.min(MAX_INVENTORY_SKEW, 1 + effectiveLeverage);
386
+ if (netBaseAssetAmount.gt(ZERO)) {
387
+ longSpread *= spreadScale;
388
+ } else {
389
+ shortSpread *= spreadScale;
390
+ }
391
+ } else {
392
+ longSpread *= MAX_INVENTORY_SKEW;
393
+ shortSpread *= MAX_INVENTORY_SKEW;
394
+ }
395
+
396
+ const totalSpread = longSpread + shortSpread;
397
+ if (totalSpread > maxTargetSpread) {
398
+ if (longSpread > shortSpread) {
399
+ longSpread = Math.min(longSpread, maxTargetSpread);
400
+ shortSpread = maxTargetSpread - longSpread;
401
+ } else {
402
+ shortSpread = Math.min(shortSpread, maxTargetSpread);
403
+ longSpread = maxTargetSpread - shortSpread;
404
+ }
405
+ }
406
+
407
+ return [longSpread, shortSpread];
408
+ }
409
+
240
410
  export function calculateSpread(
241
411
  amm: AMM,
242
412
  direction: PositionDirection,
243
413
  oraclePriceData: OraclePriceData
244
414
  ): number {
245
- let spread = amm.baseSpread / 2;
246
-
247
415
  if (amm.baseSpread == 0 || amm.curveUpdateIntensity == 0) {
248
- return spread;
416
+ return amm.baseSpread / 2;
249
417
  }
250
418
 
251
419
  const markPrice = calculatePrice(
@@ -255,49 +423,36 @@ export function calculateSpread(
255
423
  );
256
424
 
257
425
  const targetPrice = oraclePriceData?.price || markPrice;
426
+ const confInterval = oraclePriceData.confidence || ZERO;
258
427
 
259
428
  const targetMarkSpreadPct = markPrice
260
429
  .sub(targetPrice)
261
430
  .mul(BID_ASK_SPREAD_PRECISION)
262
431
  .div(markPrice);
263
432
 
264
- // oracle retreat
265
- if (
266
- (isVariant(direction, 'long') && targetMarkSpreadPct.lt(ZERO)) ||
267
- (isVariant(direction, 'short') && targetMarkSpreadPct.gt(ZERO))
268
- ) {
269
- spread = Math.max(spread, targetMarkSpreadPct.abs().toNumber());
270
- }
433
+ const confIntervalPct = confInterval
434
+ .mul(BID_ASK_SPREAD_PRECISION)
435
+ .div(markPrice);
271
436
 
272
- // inventory skew
273
- const MAX_INVENTORY_SKEW = 5;
274
- if (
275
- (amm.netBaseAssetAmount.gt(ZERO) && isVariant(direction, 'long')) ||
276
- (amm.netBaseAssetAmount.lt(ZERO) && isVariant(direction, 'short')) ||
277
- amm.totalFeeMinusDistributions.eq(ZERO)
278
- ) {
279
- const netCostBasis = amm.quoteAssetAmountLong.sub(
280
- amm.quoteAssetAmountShort
281
- );
282
- const netBaseAssetValue = amm.quoteAssetReserve
283
- .sub(amm.terminalQuoteAssetReserve)
284
- .mul(amm.pegMultiplier)
285
- .div(AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO);
286
-
287
- const localBaseAssetValue = amm.netBaseAssetAmount
288
- .mul(markPrice)
289
- .div(AMM_TO_QUOTE_PRECISION_RATIO.mul(MARK_PRICE_PRECISION));
290
- const netPnl = netBaseAssetValue.sub(netCostBasis);
291
- const localPnl = localBaseAssetValue.sub(netCostBasis);
292
-
293
- let effectiveLeverage = MAX_INVENTORY_SKEW;
294
- if (amm.totalFeeMinusDistributions.gt(ZERO)) {
295
- effectiveLeverage =
296
- localPnl.sub(netPnl).toNumber() /
297
- amm.totalFeeMinusDistributions.toNumber();
298
- }
437
+ const [longSpread, shortSpread] = calculateSpreadBN(
438
+ amm.baseSpread,
439
+ targetMarkSpreadPct,
440
+ confIntervalPct,
441
+ amm.maxSpread,
442
+ amm.quoteAssetReserve,
443
+ amm.terminalQuoteAssetReserve,
444
+ amm.pegMultiplier,
445
+ amm.netBaseAssetAmount,
446
+ markPrice,
447
+ amm.totalFeeMinusDistributions
448
+ );
449
+
450
+ let spread: number;
299
451
 
300
- spread *= Math.min(MAX_INVENTORY_SKEW, 1 + effectiveLeverage);
452
+ if (isVariant(direction, 'long')) {
453
+ spread = longSpread;
454
+ } else {
455
+ spread = shortSpread;
301
456
  }
302
457
 
303
458
  return spread;