@drift-labs/sdk 0.2.0-master.29 → 0.2.0-master.30

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 (106) hide show
  1. package/README.md +13 -13
  2. package/lib/accounts/pollingClearingHouseAccountSubscriber.d.ts +10 -11
  3. package/lib/accounts/pollingClearingHouseAccountSubscriber.js +4 -4
  4. package/lib/accounts/types.d.ts +4 -6
  5. package/lib/accounts/webSocketClearingHouseAccountSubscriber.d.ts +10 -11
  6. package/lib/accounts/webSocketClearingHouseAccountSubscriber.js +6 -8
  7. package/lib/addresses/marketAddresses.d.ts +1 -3
  8. package/lib/addresses/pda.d.ts +5 -5
  9. package/lib/addresses/pda.js +5 -5
  10. package/lib/admin.d.ts +27 -28
  11. package/lib/admin.js +12 -37
  12. package/lib/clearingHouse.d.ts +61 -62
  13. package/lib/clearingHouse.js +92 -110
  14. package/lib/clearingHouseConfig.d.ts +2 -4
  15. package/lib/clearingHouseUser.d.ts +16 -16
  16. package/lib/clearingHouseUser.js +16 -16
  17. package/lib/config.d.ts +2 -4
  18. package/lib/config.js +1 -1
  19. package/lib/constants/numericConstants.d.ts +7 -8
  20. package/lib/constants/numericConstants.js +17 -18
  21. package/lib/constants/perpMarkets.d.ts +2 -3
  22. package/lib/constants/perpMarkets.js +3 -3
  23. package/lib/constants/spotMarkets.d.ts +2 -1
  24. package/lib/constants/spotMarkets.js +6 -4
  25. package/lib/dlob/DLOB.d.ts +13 -13
  26. package/lib/dlob/DLOB.js +36 -40
  27. package/lib/dlob/DLOBNode.js +2 -2
  28. package/lib/events/sort.js +1 -1
  29. package/lib/examples/makeTradeExample.js +3 -3
  30. package/lib/idl/clearing_house.json +359 -310
  31. package/lib/math/amm.d.ts +2 -2
  32. package/lib/math/amm.js +10 -10
  33. package/lib/math/conversion.js +1 -1
  34. package/lib/math/funding.js +9 -9
  35. package/lib/math/margin.js +3 -3
  36. package/lib/math/market.d.ts +4 -4
  37. package/lib/math/market.js +7 -7
  38. package/lib/math/oracles.js +6 -8
  39. package/lib/math/position.d.ts +2 -2
  40. package/lib/math/position.js +9 -9
  41. package/lib/math/repeg.js +7 -6
  42. package/lib/math/spotBalance.js +5 -5
  43. package/lib/math/spotPosition.js +2 -2
  44. package/lib/math/trade.d.ts +6 -6
  45. package/lib/math/trade.js +15 -19
  46. package/lib/oracles/pythClient.js +1 -1
  47. package/lib/oracles/quoteAssetOracleClient.js +1 -1
  48. package/lib/oracles/switchboardClient.js +1 -1
  49. package/lib/types.d.ts +63 -51
  50. package/lib/types.js +1 -1
  51. package/package.json +2 -1
  52. package/src/accounts/pollingClearingHouseAccountSubscriber.ts +15 -15
  53. package/src/accounts/types.ts +4 -5
  54. package/src/accounts/webSocketClearingHouseAccountSubscriber.ts +17 -25
  55. package/src/addresses/marketAddresses.ts +1 -2
  56. package/src/addresses/pda.ts +10 -10
  57. package/src/admin.ts +42 -79
  58. package/src/clearingHouse.ts +164 -212
  59. package/src/clearingHouseConfig.ts +2 -3
  60. package/src/clearingHouseUser.ts +35 -35
  61. package/src/config.ts +3 -4
  62. package/src/constants/numericConstants.ts +19 -21
  63. package/src/constants/perpMarkets.ts +5 -5
  64. package/src/constants/spotMarkets.ts +8 -5
  65. package/src/dlob/DLOB.ts +54 -70
  66. package/src/dlob/DLOBNode.ts +5 -6
  67. package/src/events/sort.ts +1 -1
  68. package/src/examples/makeTradeExample.js +2 -2
  69. package/src/examples/makeTradeExample.ts +5 -8
  70. package/src/idl/clearing_house.json +359 -310
  71. package/src/math/amm.ts +14 -11
  72. package/src/math/conversion.ts +2 -2
  73. package/src/math/funding.ts +13 -11
  74. package/src/math/margin.ts +4 -5
  75. package/src/math/market.ts +5 -5
  76. package/src/math/oracles.ts +9 -9
  77. package/src/math/position.ts +11 -19
  78. package/src/math/repeg.ts +8 -7
  79. package/src/math/spotBalance.ts +6 -6
  80. package/src/math/spotPosition.ts +2 -2
  81. package/src/math/trade.ts +17 -21
  82. package/src/oracles/pythClient.ts +2 -2
  83. package/src/oracles/quoteAssetOracleClient.ts +2 -2
  84. package/src/oracles/switchboardClient.ts +2 -2
  85. package/src/types.ts +69 -51
  86. package/tests/dlob/helpers.ts +56 -4
  87. package/src/addresses/marketAddresses.js +0 -26
  88. package/src/constants/banks.js +0 -42
  89. package/src/constants/markets.js +0 -42
  90. package/src/events/txEventCache.js +0 -71
  91. package/src/factory/bigNum.js +0 -390
  92. package/src/factory/oracleClient.js +0 -20
  93. package/src/math/auction.js +0 -42
  94. package/src/math/conversion.js +0 -11
  95. package/src/math/funding.js +0 -248
  96. package/src/math/repeg.js +0 -128
  97. package/src/math/trade.js +0 -253
  98. package/src/math/utils.js +0 -26
  99. package/src/math/utils.js.map +0 -1
  100. package/src/oracles/oracleClientCache.js +0 -19
  101. package/src/oracles/pythClient.js +0 -46
  102. package/src/oracles/quoteAssetOracleClient.js +0 -32
  103. package/src/oracles/switchboardClient.js +0 -69
  104. package/src/oracles/types.js +0 -2
  105. package/src/userName.js +0 -20
  106. package/src/wallet.js +0 -35
@@ -1,248 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.calculateFundingPool = exports.calculateLongShortFundingRateAndLiveTwaps = exports.calculateLongShortFundingRate = exports.calculateEstimatedFundingRate = exports.calculateAllEstimatedFundingRate = void 0;
13
- const anchor_1 = require("@project-serum/anchor");
14
- const numericConstants_1 = require("../constants/numericConstants");
15
- const market_1 = require("./market");
16
- /**
17
- *
18
- * @param market
19
- * @param oraclePriceData
20
- * @param periodAdjustment
21
- * @returns Estimated funding rate. : Precision //TODO-PRECISION
22
- */
23
- function calculateAllEstimatedFundingRate(market, oraclePriceData, periodAdjustment = new anchor_1.BN(1)) {
24
- return __awaiter(this, void 0, void 0, function* () {
25
- // periodAdjustment
26
- // 1: hourly
27
- // 24: daily
28
- // 24 * 365.25: annualized
29
- const secondsInHour = new anchor_1.BN(3600);
30
- const hoursInDay = new anchor_1.BN(24);
31
- const ONE = new anchor_1.BN(1);
32
- if (!market.initialized) {
33
- return [numericConstants_1.ZERO, numericConstants_1.ZERO, numericConstants_1.ZERO, numericConstants_1.ZERO, numericConstants_1.ZERO];
34
- }
35
- const payFreq = new anchor_1.BN(market.amm.fundingPeriod);
36
- // todo: sufficiently differs from blockchain timestamp?
37
- const now = new anchor_1.BN((Date.now() / 1000).toFixed(0));
38
- const timeSinceLastUpdate = now.sub(market.amm.lastFundingRateTs);
39
- // calculate real-time mark twap
40
- const lastMarkTwapWithMantissa = market.amm.lastMarkPriceTwap;
41
- const lastMarkPriceTwapTs = market.amm.lastMarkPriceTwapTs;
42
- const timeSinceLastMarkChange = now.sub(lastMarkPriceTwapTs);
43
- const markTwapTimeSinceLastUpdate = anchor_1.BN.max(secondsInHour, anchor_1.BN.max(numericConstants_1.ZERO, secondsInHour.sub(timeSinceLastMarkChange)));
44
- const baseAssetPriceWithMantissa = market_1.calculateMarkPrice(market, oraclePriceData);
45
- const markTwapWithMantissa = markTwapTimeSinceLastUpdate
46
- .mul(lastMarkTwapWithMantissa)
47
- .add(timeSinceLastMarkChange.mul(baseAssetPriceWithMantissa))
48
- .div(timeSinceLastMarkChange.add(markTwapTimeSinceLastUpdate));
49
- // calculate real-time (predicted) oracle twap
50
- // note: oracle twap depends on `when the chord is struck` (market is trade)
51
- const lastOracleTwapWithMantissa = market.amm.lastOraclePriceTwap;
52
- const lastOraclePriceTwapTs = market.amm.lastOraclePriceTwapTs;
53
- const oracleInvalidDuration = anchor_1.BN.max(numericConstants_1.ZERO, lastMarkPriceTwapTs.sub(lastOraclePriceTwapTs));
54
- const timeSinceLastOracleTwapUpdate = now.sub(lastOraclePriceTwapTs);
55
- const oracleTwapTimeSinceLastUpdate = anchor_1.BN.max(ONE, anchor_1.BN.min(secondsInHour, anchor_1.BN.max(ONE, secondsInHour.sub(timeSinceLastOracleTwapUpdate))));
56
- let oracleTwapWithMantissa = lastOracleTwapWithMantissa;
57
- // if passing live oracle data, improve predicted calc estimate
58
- if (oraclePriceData) {
59
- const oraclePrice = oraclePriceData.price;
60
- const oracleLiveVsTwap = oraclePrice
61
- .sub(lastOracleTwapWithMantissa)
62
- .abs()
63
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
64
- .mul(new anchor_1.BN(100))
65
- .div(lastOracleTwapWithMantissa);
66
- // verify pyth live input is within 10% of last twap for live update
67
- if (oracleLiveVsTwap.lte(numericConstants_1.MARK_PRICE_PRECISION.mul(new anchor_1.BN(10)))) {
68
- oracleTwapWithMantissa = oracleTwapTimeSinceLastUpdate
69
- .mul(lastOracleTwapWithMantissa)
70
- .add(timeSinceLastMarkChange.mul(oraclePrice))
71
- .div(timeSinceLastMarkChange.add(oracleTwapTimeSinceLastUpdate));
72
- }
73
- }
74
- const shrunkLastOracleTwapwithMantissa = oracleTwapTimeSinceLastUpdate
75
- .mul(lastOracleTwapWithMantissa)
76
- .add(oracleInvalidDuration.mul(lastMarkTwapWithMantissa))
77
- .div(oracleTwapTimeSinceLastUpdate.add(oracleInvalidDuration));
78
- const twapSpread = lastMarkTwapWithMantissa.sub(shrunkLastOracleTwapwithMantissa);
79
- const twapSpreadPct = twapSpread
80
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
81
- .mul(new anchor_1.BN(100))
82
- .div(shrunkLastOracleTwapwithMantissa);
83
- const lowerboundEst = twapSpreadPct
84
- .mul(payFreq)
85
- .mul(anchor_1.BN.min(secondsInHour, timeSinceLastUpdate))
86
- .mul(periodAdjustment)
87
- .div(secondsInHour)
88
- .div(secondsInHour)
89
- .div(hoursInDay);
90
- const interpEst = twapSpreadPct.mul(periodAdjustment).div(hoursInDay);
91
- const interpRateQuote = twapSpreadPct
92
- .mul(periodAdjustment)
93
- .div(hoursInDay)
94
- .div(numericConstants_1.MARK_PRICE_PRECISION.div(numericConstants_1.QUOTE_PRECISION));
95
- let feePoolSize = calculateFundingPool(market);
96
- if (interpRateQuote.lt(new anchor_1.BN(0))) {
97
- feePoolSize = feePoolSize.mul(new anchor_1.BN(-1));
98
- }
99
- let cappedAltEst;
100
- let largerSide;
101
- let smallerSide;
102
- if (market.baseAssetAmountLong.gt(market.baseAssetAmountShort.abs())) {
103
- largerSide = market.baseAssetAmountLong.abs();
104
- smallerSide = market.baseAssetAmountShort.abs();
105
- if (twapSpread.gt(new anchor_1.BN(0))) {
106
- return [
107
- markTwapWithMantissa,
108
- oracleTwapWithMantissa,
109
- lowerboundEst,
110
- interpEst,
111
- interpEst,
112
- ];
113
- }
114
- }
115
- else if (market.baseAssetAmountLong.lt(market.baseAssetAmountShort.abs())) {
116
- largerSide = market.baseAssetAmountShort.abs();
117
- smallerSide = market.baseAssetAmountLong.abs();
118
- if (twapSpread.lt(new anchor_1.BN(0))) {
119
- return [
120
- markTwapWithMantissa,
121
- oracleTwapWithMantissa,
122
- lowerboundEst,
123
- interpEst,
124
- interpEst,
125
- ];
126
- }
127
- }
128
- else {
129
- return [
130
- markTwapWithMantissa,
131
- oracleTwapWithMantissa,
132
- lowerboundEst,
133
- interpEst,
134
- interpEst,
135
- ];
136
- }
137
- if (largerSide.gt(numericConstants_1.ZERO)) {
138
- // funding smaller flow
139
- cappedAltEst = smallerSide.mul(twapSpread).div(hoursInDay);
140
- const feePoolTopOff = feePoolSize
141
- .mul(numericConstants_1.MARK_PRICE_PRECISION.div(numericConstants_1.QUOTE_PRECISION))
142
- .mul(numericConstants_1.AMM_RESERVE_PRECISION);
143
- cappedAltEst = cappedAltEst.add(feePoolTopOff).div(largerSide);
144
- cappedAltEst = cappedAltEst
145
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
146
- .mul(new anchor_1.BN(100))
147
- .div(oracleTwapWithMantissa)
148
- .mul(periodAdjustment);
149
- if (cappedAltEst.abs().gte(interpEst.abs())) {
150
- cappedAltEst = interpEst;
151
- }
152
- }
153
- else {
154
- cappedAltEst = interpEst;
155
- }
156
- return [
157
- markTwapWithMantissa,
158
- oracleTwapWithMantissa,
159
- lowerboundEst,
160
- cappedAltEst,
161
- interpEst,
162
- ];
163
- });
164
- }
165
- exports.calculateAllEstimatedFundingRate = calculateAllEstimatedFundingRate;
166
- /**
167
- *
168
- * @param market
169
- * @param oraclePriceData
170
- * @param periodAdjustment
171
- * @param estimationMethod
172
- * @returns Estimated funding rate. : Precision //TODO-PRECISION
173
- */
174
- function calculateEstimatedFundingRate(market, oraclePriceData, periodAdjustment = new anchor_1.BN(1), estimationMethod) {
175
- return __awaiter(this, void 0, void 0, function* () {
176
- const [_1, _2, lowerboundEst, cappedAltEst, interpEst] = yield calculateAllEstimatedFundingRate(market, oraclePriceData, periodAdjustment);
177
- if (estimationMethod == 'lowerbound') {
178
- //assuming remaining funding period has no gap
179
- return lowerboundEst;
180
- }
181
- else if (estimationMethod == 'capped') {
182
- return cappedAltEst;
183
- }
184
- else {
185
- return interpEst;
186
- }
187
- });
188
- }
189
- exports.calculateEstimatedFundingRate = calculateEstimatedFundingRate;
190
- /**
191
- *
192
- * @param market
193
- * @param oraclePriceData
194
- * @param periodAdjustment
195
- * @returns Estimated funding rate. : Precision //TODO-PRECISION
196
- */
197
- function calculateLongShortFundingRate(market, oraclePriceData, periodAdjustment = new anchor_1.BN(1)) {
198
- return __awaiter(this, void 0, void 0, function* () {
199
- const [_1, _2, _, cappedAltEst, interpEst] = yield calculateAllEstimatedFundingRate(market, oraclePriceData, periodAdjustment);
200
- if (market.baseAssetAmountLong.gt(market.baseAssetAmountShort)) {
201
- return [cappedAltEst, interpEst];
202
- }
203
- else if (market.baseAssetAmountLong.lt(market.baseAssetAmountShort)) {
204
- return [interpEst, cappedAltEst];
205
- }
206
- else {
207
- return [interpEst, interpEst];
208
- }
209
- });
210
- }
211
- exports.calculateLongShortFundingRate = calculateLongShortFundingRate;
212
- /**
213
- *
214
- * @param market
215
- * @param oraclePriceData
216
- * @param periodAdjustment
217
- * @returns Estimated funding rate. : Precision //TODO-PRECISION
218
- */
219
- function calculateLongShortFundingRateAndLiveTwaps(market, oraclePriceData, periodAdjustment = new anchor_1.BN(1)) {
220
- return __awaiter(this, void 0, void 0, function* () {
221
- const [markTwapLive, oracleTwapLive, _2, cappedAltEst, interpEst] = yield calculateAllEstimatedFundingRate(market, oraclePriceData, periodAdjustment);
222
- if (market.baseAssetAmountLong.gt(market.baseAssetAmountShort.abs())) {
223
- return [markTwapLive, oracleTwapLive, cappedAltEst, interpEst];
224
- }
225
- else if (market.baseAssetAmountLong.lt(market.baseAssetAmountShort.abs())) {
226
- return [markTwapLive, oracleTwapLive, interpEst, cappedAltEst];
227
- }
228
- else {
229
- return [markTwapLive, oracleTwapLive, interpEst, interpEst];
230
- }
231
- });
232
- }
233
- exports.calculateLongShortFundingRateAndLiveTwaps = calculateLongShortFundingRateAndLiveTwaps;
234
- /**
235
- *
236
- * @param market
237
- * @returns Estimated fee pool size
238
- */
239
- function calculateFundingPool(market) {
240
- // todo
241
- const totalFeeLB = market.amm.totalExchangeFee.div(new anchor_1.BN(2));
242
- const feePool = anchor_1.BN.max(numericConstants_1.ZERO, market.amm.totalFeeMinusDistributions
243
- .sub(totalFeeLB)
244
- .mul(new anchor_1.BN(1))
245
- .div(new anchor_1.BN(3)));
246
- return feePool;
247
- }
248
- exports.calculateFundingPool = calculateFundingPool;
package/src/math/repeg.js DELETED
@@ -1,128 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.calculateBudgetedPeg = exports.calculateBudgetedK = exports.calculateBudgetedKBN = exports.calculateRepegCost = exports.calculateAdjustKCost = void 0;
4
- const anchor_1 = require("@project-serum/anchor");
5
- const assert_1 = require("../assert/assert");
6
- const numericConstants_1 = require("../constants/numericConstants");
7
- /**
8
- * Helper function calculating adjust k cost
9
- * @param amm
10
- * @param numerator
11
- * @param denomenator
12
- * @returns cost : Precision QUOTE_ASSET_PRECISION
13
- */
14
- function calculateAdjustKCost(amm, numerator, denomenator) {
15
- // const k = market.amm.sqrtK.mul(market.amm.sqrtK);
16
- const x = amm.baseAssetReserve;
17
- const y = amm.quoteAssetReserve;
18
- const d = amm.netBaseAssetAmount;
19
- const Q = amm.pegMultiplier;
20
- const quoteScale = y.mul(d).mul(Q); //.div(AMM_RESERVE_PRECISION);
21
- const p = numerator.mul(numericConstants_1.MARK_PRICE_PRECISION).div(denomenator);
22
- const cost = quoteScale
23
- .div(x.add(d))
24
- .sub(quoteScale
25
- .mul(p)
26
- .div(numericConstants_1.MARK_PRICE_PRECISION)
27
- .div(x.mul(p).div(numericConstants_1.MARK_PRICE_PRECISION).add(d)))
28
- .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO)
29
- .div(numericConstants_1.PEG_PRECISION);
30
- return cost.mul(new anchor_1.BN(-1));
31
- }
32
- exports.calculateAdjustKCost = calculateAdjustKCost;
33
- /**
34
- * Helper function calculating adjust pegMultiplier (repeg) cost
35
- *
36
- * @param amm
37
- * @param newPeg
38
- * @returns cost : Precision QUOTE_ASSET_PRECISION
39
- */
40
- function calculateRepegCost(amm, newPeg) {
41
- const dqar = amm.quoteAssetReserve.sub(amm.terminalQuoteAssetReserve);
42
- const cost = dqar
43
- .mul(newPeg.sub(amm.pegMultiplier))
44
- .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO)
45
- .div(numericConstants_1.PEG_PRECISION);
46
- return cost;
47
- }
48
- exports.calculateRepegCost = calculateRepegCost;
49
- function calculateBudgetedKBN(x, y, budget, Q, d) {
50
- assert_1.assert(Q.gt(new anchor_1.BN(0)));
51
- const C = budget.mul(new anchor_1.BN(-1));
52
- let dSign = new anchor_1.BN(1);
53
- if (d.lt(new anchor_1.BN(0))) {
54
- dSign = new anchor_1.BN(-1);
55
- }
56
- const pegged_y_d_d = y
57
- .mul(d)
58
- .mul(d)
59
- .mul(Q)
60
- .div(numericConstants_1.AMM_RESERVE_PRECISION)
61
- .div(numericConstants_1.AMM_RESERVE_PRECISION)
62
- .div(numericConstants_1.PEG_PRECISION);
63
- const numer1 = pegged_y_d_d;
64
- const numer2 = C.mul(d)
65
- .div(numericConstants_1.QUOTE_PRECISION)
66
- .mul(x.add(d))
67
- .div(numericConstants_1.AMM_RESERVE_PRECISION)
68
- .mul(dSign);
69
- const denom1 = C.mul(x)
70
- .mul(x.add(d))
71
- .div(numericConstants_1.AMM_RESERVE_PRECISION)
72
- .div(numericConstants_1.QUOTE_PRECISION);
73
- const denom2 = pegged_y_d_d;
74
- const numerator = numer1.sub(numer2).div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO);
75
- const denominator = denom1.add(denom2).div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO);
76
- return [numerator, denominator];
77
- }
78
- exports.calculateBudgetedKBN = calculateBudgetedKBN;
79
- function calculateBudgetedK(amm, cost) {
80
- // wolframalpha.com
81
- // (1/(x+d) - p/(x*p+d))*y*d*Q = C solve for p
82
- // p = (d(y*d*Q - C(x+d))) / (C*x(x+d) + y*d*d*Q)
83
- // numer
84
- // = y*d*d*Q - Cxd - Cdd
85
- // = y/x*Q*d*d - Cd - Cd/x
86
- // = mark - C/d - C/(x)
87
- // = mark/C - 1/d - 1/x
88
- // denom
89
- // = C*x*x + C*x*d + y*d*d*Q
90
- // = x/d**2 + 1 / d + mark/C
91
- // todo: assumes k = x * y
92
- // otherwise use: (y(1-p) + (kp^2/(x*p+d)) - k/(x+d)) * Q = C solve for p
93
- const x = amm.baseAssetReserve;
94
- const y = amm.quoteAssetReserve;
95
- const d = amm.netBaseAssetAmount;
96
- const Q = amm.pegMultiplier;
97
- const [numerator, denominator] = calculateBudgetedKBN(x, y, cost, Q, d);
98
- return [numerator, denominator];
99
- }
100
- exports.calculateBudgetedK = calculateBudgetedK;
101
- function calculateBudgetedPeg(amm, cost, targetPrice) {
102
- // wolframalpha.com
103
- // (1/(x+d) - p/(x*p+d))*y*d*Q = C solve for p
104
- // p = (d(y*d*Q - C(x+d))) / (C*x(x+d) + y*y*d*Q)
105
- // todo: assumes k = x * y
106
- // otherwise use: (y(1-p) + (kp^2/(x*p+d)) - k/(x+d)) * Q = C solve for p
107
- const targetPeg = targetPrice
108
- .mul(amm.baseAssetReserve)
109
- .div(amm.quoteAssetReserve)
110
- .div(numericConstants_1.PRICE_DIV_PEG);
111
- const k = amm.sqrtK.mul(amm.sqrtK);
112
- const x = amm.baseAssetReserve;
113
- const y = amm.quoteAssetReserve;
114
- const d = amm.netBaseAssetAmount;
115
- const Q = amm.pegMultiplier;
116
- const C = cost.mul(new anchor_1.BN(-1));
117
- const deltaQuoteAssetReserves = y.sub(k.div(x.add(d)));
118
- const pegChangeDirection = targetPeg.sub(Q);
119
- const useTargetPeg = (deltaQuoteAssetReserves.lt(numericConstants_1.ZERO) && pegChangeDirection.gt(numericConstants_1.ZERO)) ||
120
- (deltaQuoteAssetReserves.gt(numericConstants_1.ZERO) && pegChangeDirection.lt(numericConstants_1.ZERO));
121
- if (deltaQuoteAssetReserves.eq(numericConstants_1.ZERO) || useTargetPeg) {
122
- return targetPeg;
123
- }
124
- const deltaPegMultiplier = C.mul(numericConstants_1.MARK_PRICE_PRECISION).div(deltaQuoteAssetReserves.div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO));
125
- const newPeg = Q.sub(deltaPegMultiplier.mul(numericConstants_1.PEG_PRECISION).div(numericConstants_1.MARK_PRICE_PRECISION));
126
- return newPeg;
127
- }
128
- exports.calculateBudgetedPeg = calculateBudgetedPeg;
package/src/math/trade.js DELETED
@@ -1,253 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.calculateTargetPriceTrade = exports.calculateTradeAcquiredAmounts = exports.calculateTradeSlippage = void 0;
4
- const types_1 = require("../types");
5
- const anchor_1 = require("@project-serum/anchor");
6
- const assert_1 = require("../assert/assert");
7
- const numericConstants_1 = require("../constants/numericConstants");
8
- const market_1 = require("./market");
9
- const amm_1 = require("./amm");
10
- const utils_1 = require("./utils");
11
- const types_2 = require("../types");
12
- const MAXPCT = new anchor_1.BN(1000); //percentage units are [0,1000] => [0,1]
13
- /**
14
- * Calculates avg/max slippage (price impact) for candidate trade
15
- * @param direction
16
- * @param amount
17
- * @param market
18
- * @param inputAssetType which asset is being traded
19
- * @param useSpread whether to consider spread with calculating slippage
20
- * @return [pctAvgSlippage, pctMaxSlippage, entryPrice, newPrice]
21
- *
22
- * 'pctAvgSlippage' => the percentage change to entryPrice (average est slippage in execution) : Precision MARK_PRICE_PRECISION
23
- *
24
- * 'pctMaxSlippage' => the percentage change to maxPrice (highest est slippage in execution) : Precision MARK_PRICE_PRECISION
25
- *
26
- * 'entryPrice' => the average price of the trade : Precision MARK_PRICE_PRECISION
27
- *
28
- * 'newPrice' => the price of the asset after the trade : Precision MARK_PRICE_PRECISION
29
- */
30
- function calculateTradeSlippage(direction, amount, market, inputAssetType = 'quote', oraclePriceData, useSpread = true) {
31
- let oldPrice;
32
- if (useSpread && market.amm.baseSpread > 0) {
33
- if (types_2.isVariant(direction, 'long')) {
34
- oldPrice = market_1.calculateAskPrice(market, oraclePriceData);
35
- }
36
- else {
37
- oldPrice = market_1.calculateBidPrice(market, oraclePriceData);
38
- }
39
- }
40
- else {
41
- oldPrice = market_1.calculateMarkPrice(market, oraclePriceData);
42
- }
43
- if (amount.eq(numericConstants_1.ZERO)) {
44
- return [numericConstants_1.ZERO, numericConstants_1.ZERO, oldPrice, oldPrice];
45
- }
46
- const [acquiredBaseReserve, acquiredQuoteReserve, acquiredQuoteAssetAmount] = calculateTradeAcquiredAmounts(direction, amount, market, inputAssetType, oraclePriceData, useSpread);
47
- const entryPrice = acquiredQuoteAssetAmount
48
- .mul(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO)
49
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
50
- .div(acquiredBaseReserve.abs());
51
- let amm;
52
- if (useSpread && market.amm.baseSpread > 0) {
53
- const { baseAssetReserve, quoteAssetReserve, sqrtK, newPeg } = amm_1.calculateUpdatedAMMSpreadReserves(market.amm, direction, oraclePriceData);
54
- amm = {
55
- baseAssetReserve,
56
- quoteAssetReserve,
57
- sqrtK: sqrtK,
58
- pegMultiplier: newPeg,
59
- };
60
- }
61
- else {
62
- amm = market.amm;
63
- }
64
- const newPrice = amm_1.calculatePrice(amm.baseAssetReserve.sub(acquiredBaseReserve), amm.quoteAssetReserve.sub(acquiredQuoteReserve), amm.pegMultiplier);
65
- if (direction == types_1.PositionDirection.SHORT) {
66
- assert_1.assert(newPrice.lte(oldPrice));
67
- }
68
- else {
69
- assert_1.assert(oldPrice.lte(newPrice));
70
- }
71
- const pctMaxSlippage = newPrice
72
- .sub(oldPrice)
73
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
74
- .div(oldPrice)
75
- .abs();
76
- const pctAvgSlippage = entryPrice
77
- .sub(oldPrice)
78
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
79
- .div(oldPrice)
80
- .abs();
81
- return [pctAvgSlippage, pctMaxSlippage, entryPrice, newPrice];
82
- }
83
- exports.calculateTradeSlippage = calculateTradeSlippage;
84
- /**
85
- * Calculates acquired amounts for trade executed
86
- * @param direction
87
- * @param amount
88
- * @param market
89
- * @param inputAssetType
90
- * @param useSpread
91
- * @return
92
- * | 'acquiredBase' => positive/negative change in user's base : BN AMM_RESERVE_PRECISION
93
- * | 'acquiredQuote' => positive/negative change in user's quote : BN TODO-PRECISION
94
- */
95
- function calculateTradeAcquiredAmounts(direction, amount, market, inputAssetType = 'quote', oraclePriceData, useSpread = true) {
96
- if (amount.eq(numericConstants_1.ZERO)) {
97
- return [numericConstants_1.ZERO, numericConstants_1.ZERO, numericConstants_1.ZERO];
98
- }
99
- const swapDirection = amm_1.getSwapDirection(inputAssetType, direction);
100
- let amm;
101
- if (useSpread && market.amm.baseSpread > 0) {
102
- const { baseAssetReserve, quoteAssetReserve, sqrtK, newPeg } = amm_1.calculateUpdatedAMMSpreadReserves(market.amm, direction, oraclePriceData);
103
- amm = {
104
- baseAssetReserve,
105
- quoteAssetReserve,
106
- sqrtK: sqrtK,
107
- pegMultiplier: newPeg,
108
- };
109
- }
110
- else {
111
- amm = market.amm;
112
- }
113
- const [newQuoteAssetReserve, newBaseAssetReserve] = amm_1.calculateAmmReservesAfterSwap(amm, inputAssetType, amount, swapDirection);
114
- const acquiredBase = amm.baseAssetReserve.sub(newBaseAssetReserve);
115
- const acquiredQuote = amm.quoteAssetReserve.sub(newQuoteAssetReserve);
116
- const acquiredQuoteAssetamount = amm_1.calculateQuoteAssetAmountSwapped(acquiredQuote.abs(), amm.pegMultiplier, swapDirection);
117
- return [acquiredBase, acquiredQuote, acquiredQuoteAssetamount];
118
- }
119
- exports.calculateTradeAcquiredAmounts = calculateTradeAcquiredAmounts;
120
- /**
121
- * calculateTargetPriceTrade
122
- * simple function for finding arbitraging trades
123
- * @param market
124
- * @param targetPrice
125
- * @param pct optional default is 100% gap filling, can set smaller.
126
- * @param outputAssetType which asset to trade.
127
- * @param useSpread whether or not to consider the spread when calculating the trade size
128
- * @returns trade direction/size in order to push price to a targetPrice,
129
- *
130
- * [
131
- * direction => direction of trade required, PositionDirection
132
- * tradeSize => size of trade required, TODO-PRECISION
133
- * entryPrice => the entry price for the trade, MARK_PRICE_PRECISION
134
- * targetPrice => the target price MARK_PRICE_PRECISION
135
- * ]
136
- */
137
- function calculateTargetPriceTrade(market, targetPrice, pct = MAXPCT, outputAssetType = 'quote', oraclePriceData, useSpread = true) {
138
- assert_1.assert(market.amm.baseAssetReserve.gt(numericConstants_1.ZERO));
139
- assert_1.assert(targetPrice.gt(numericConstants_1.ZERO));
140
- assert_1.assert(pct.lte(MAXPCT) && pct.gt(numericConstants_1.ZERO));
141
- const markPriceBefore = market_1.calculateMarkPrice(market, oraclePriceData);
142
- const bidPriceBefore = market_1.calculateBidPrice(market, oraclePriceData);
143
- const askPriceBefore = market_1.calculateAskPrice(market, oraclePriceData);
144
- let direction;
145
- if (targetPrice.gt(markPriceBefore)) {
146
- const priceGap = targetPrice.sub(markPriceBefore);
147
- const priceGapScaled = priceGap.mul(pct).div(MAXPCT);
148
- targetPrice = markPriceBefore.add(priceGapScaled);
149
- direction = types_1.PositionDirection.LONG;
150
- }
151
- else {
152
- const priceGap = markPriceBefore.sub(targetPrice);
153
- const priceGapScaled = priceGap.mul(pct).div(MAXPCT);
154
- targetPrice = markPriceBefore.sub(priceGapScaled);
155
- direction = types_1.PositionDirection.SHORT;
156
- }
157
- let tradeSize;
158
- let baseSize;
159
- let baseAssetReserveBefore;
160
- let quoteAssetReserveBefore;
161
- let peg = market.amm.pegMultiplier;
162
- if (useSpread && market.amm.baseSpread > 0) {
163
- const { baseAssetReserve, quoteAssetReserve, newPeg } = amm_1.calculateUpdatedAMMSpreadReserves(market.amm, direction, oraclePriceData);
164
- baseAssetReserveBefore = baseAssetReserve;
165
- quoteAssetReserveBefore = quoteAssetReserve;
166
- peg = newPeg;
167
- }
168
- else {
169
- baseAssetReserveBefore = market.amm.baseAssetReserve;
170
- quoteAssetReserveBefore = market.amm.quoteAssetReserve;
171
- }
172
- const invariant = market.amm.sqrtK.mul(market.amm.sqrtK);
173
- const k = invariant.mul(numericConstants_1.MARK_PRICE_PRECISION);
174
- let baseAssetReserveAfter;
175
- let quoteAssetReserveAfter;
176
- const biasModifier = new anchor_1.BN(1);
177
- let markPriceAfter;
178
- if (useSpread &&
179
- targetPrice.lt(askPriceBefore) &&
180
- targetPrice.gt(bidPriceBefore)) {
181
- // no trade, market is at target
182
- if (markPriceBefore.gt(targetPrice)) {
183
- direction = types_1.PositionDirection.SHORT;
184
- }
185
- else {
186
- direction = types_1.PositionDirection.LONG;
187
- }
188
- tradeSize = numericConstants_1.ZERO;
189
- return [direction, tradeSize, targetPrice, targetPrice];
190
- }
191
- else if (markPriceBefore.gt(targetPrice)) {
192
- // overestimate y2
193
- baseAssetReserveAfter = utils_1.squareRootBN(k.div(targetPrice).mul(peg).div(numericConstants_1.PEG_PRECISION).sub(biasModifier)).sub(new anchor_1.BN(1));
194
- quoteAssetReserveAfter = k
195
- .div(numericConstants_1.MARK_PRICE_PRECISION)
196
- .div(baseAssetReserveAfter);
197
- markPriceAfter = amm_1.calculatePrice(baseAssetReserveAfter, quoteAssetReserveAfter, peg);
198
- direction = types_1.PositionDirection.SHORT;
199
- tradeSize = quoteAssetReserveBefore
200
- .sub(quoteAssetReserveAfter)
201
- .mul(peg)
202
- .div(numericConstants_1.PEG_PRECISION)
203
- .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO);
204
- baseSize = baseAssetReserveAfter.sub(baseAssetReserveBefore);
205
- }
206
- else if (markPriceBefore.lt(targetPrice)) {
207
- // underestimate y2
208
- baseAssetReserveAfter = utils_1.squareRootBN(k.div(targetPrice).mul(peg).div(numericConstants_1.PEG_PRECISION).add(biasModifier)).add(new anchor_1.BN(1));
209
- quoteAssetReserveAfter = k
210
- .div(numericConstants_1.MARK_PRICE_PRECISION)
211
- .div(baseAssetReserveAfter);
212
- markPriceAfter = amm_1.calculatePrice(baseAssetReserveAfter, quoteAssetReserveAfter, peg);
213
- direction = types_1.PositionDirection.LONG;
214
- tradeSize = quoteAssetReserveAfter
215
- .sub(quoteAssetReserveBefore)
216
- .mul(peg)
217
- .div(numericConstants_1.PEG_PRECISION)
218
- .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO);
219
- baseSize = baseAssetReserveBefore.sub(baseAssetReserveAfter);
220
- }
221
- else {
222
- // no trade, market is at target
223
- direction = types_1.PositionDirection.LONG;
224
- tradeSize = numericConstants_1.ZERO;
225
- return [direction, tradeSize, targetPrice, targetPrice];
226
- }
227
- let tp1 = targetPrice;
228
- let tp2 = markPriceAfter;
229
- let originalDiff = targetPrice.sub(markPriceBefore);
230
- if (direction == types_1.PositionDirection.SHORT) {
231
- tp1 = markPriceAfter;
232
- tp2 = targetPrice;
233
- originalDiff = markPriceBefore.sub(targetPrice);
234
- }
235
- const entryPrice = tradeSize
236
- .mul(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO)
237
- .mul(numericConstants_1.MARK_PRICE_PRECISION)
238
- .div(baseSize.abs());
239
- assert_1.assert(tp1.sub(tp2).lte(originalDiff), 'Target Price Calculation incorrect');
240
- assert_1.assert(tp2.lte(tp1) || tp2.sub(tp1).abs() < 100000, 'Target Price Calculation incorrect' +
241
- tp2.toString() +
242
- '>=' +
243
- tp1.toString() +
244
- 'err: ' +
245
- tp2.sub(tp1).abs().toString());
246
- if (outputAssetType == 'quote') {
247
- return [direction, tradeSize, entryPrice, targetPrice];
248
- }
249
- else {
250
- return [direction, baseSize, entryPrice, targetPrice];
251
- }
252
- }
253
- exports.calculateTargetPriceTrade = calculateTargetPriceTrade;
package/src/math/utils.js DELETED
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.squareRootBN = void 0;
4
- const __1 = require("../");
5
- const squareRootBN = (n, closeness = new __1.BN(1)) => {
6
- // Assuming the sqrt of n as n only
7
- let x = n;
8
- // The closed guess will be stored in the root
9
- let root;
10
- // To count the number of iterations
11
- let count = 0;
12
- const TWO = new __1.BN(2);
13
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
14
- while (count < Number.MAX_SAFE_INTEGER) {
15
- count++;
16
- // Calculate more closed x
17
- root = x.add(n.div(x)).div(TWO);
18
- // Check for closeness
19
- if (x.sub(root).abs().lte(closeness))
20
- break;
21
- // Update root
22
- x = root;
23
- }
24
- return root;
25
- };
26
- exports.squareRootBN = squareRootBN;
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["utils.ts"],"names":[],"mappings":";;;AAAA,2BAAyB;AAElB,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI,MAAE,CAAC,CAAC,CAAC,EAAE,EAAE;IACxD,mCAAmC;IACnC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,8CAA8C;IAC9C,IAAI,IAAI,CAAC;IAET,oCAAoC;IACpC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,GAAG,GAAG,IAAI,MAAE,CAAC,CAAC,CAAC,CAAC;IAEtB,6DAA6D;IAC7D,OAAO,KAAK,GAAG,MAAM,CAAC,gBAAgB,EAAE;QACvC,KAAK,EAAE,CAAC;QAER,0BAA0B;QAC1B,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEhC,sBAAsB;QACtB,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,MAAM;QAE5C,cAAc;QACd,CAAC,GAAG,IAAI,CAAC;KACT;IAED,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AA1BW,QAAA,YAAY,gBA0BvB"}
@@ -1,19 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OracleClientCache = void 0;
4
- const oracleClient_1 = require("../factory/oracleClient");
5
- class OracleClientCache {
6
- constructor() {
7
- this.cache = new Map();
8
- }
9
- get(oracleSource, connection) {
10
- const key = Object.keys(oracleSource)[0];
11
- if (this.cache.has(key)) {
12
- return this.cache.get(key);
13
- }
14
- const client = oracleClient_1.getOracleClient(oracleSource, connection);
15
- this.cache.set(key, client);
16
- return client;
17
- }
18
- }
19
- exports.OracleClientCache = OracleClientCache;