@lifi/perps-sdk 28.1.0 → 29.1.0
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/README.md +13 -0
- package/dist/cjs/index.d.ts +2 -2
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +5 -3
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/math/position.d.ts +20 -0
- package/dist/cjs/math/position.d.ts.map +1 -1
- package/dist/cjs/math/position.js +63 -8
- package/dist/cjs/math/position.js.map +1 -1
- package/dist/cjs/types/deposit.d.ts +3 -3
- package/dist/cjs/types/deposit.d.ts.map +1 -1
- package/dist/cjs/types/provider.d.ts +4 -1
- package/dist/cjs/types/provider.d.ts.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/math/position.d.ts +62 -10
- package/dist/esm/math/position.d.ts.map +1 -1
- package/dist/esm/math/position.js +104 -18
- package/dist/esm/math/position.js.map +1 -1
- package/dist/esm/services/getGasRecommendation.d.ts +2 -2
- package/dist/esm/services/getGasRecommendation.js +1 -1
- package/dist/esm/types/deposit.d.ts +9 -8
- package/dist/esm/types/deposit.d.ts.map +1 -1
- package/dist/esm/types/provider.d.ts +20 -7
- package/dist/esm/types/provider.d.ts.map +1 -1
- package/dist/esm/utils/depositAssets.d.ts +3 -3
- package/dist/esm/utils/depositAssets.js +3 -3
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/types/index.d.ts +2 -2
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/math/position.d.ts +62 -10
- package/dist/types/math/position.d.ts.map +1 -1
- package/dist/types/services/getGasRecommendation.d.ts +2 -2
- package/dist/types/types/deposit.d.ts +9 -8
- package/dist/types/types/deposit.d.ts.map +1 -1
- package/dist/types/types/provider.d.ts +20 -7
- package/dist/types/types/provider.d.ts.map +1 -1
- package/dist/types/utils/depositAssets.d.ts +3 -3
- package/dist/types/version.d.ts +1 -1
- package/package.json +2 -2
- package/src/index.ts +3 -1
- package/src/math/position.ts +123 -19
- package/src/services/getGasRecommendation.ts +2 -2
- package/src/types/deposit.ts +9 -8
- package/src/types/provider.ts +20 -6
- package/src/utils/depositAssets.ts +3 -3
- package/src/version.ts +1 -1
|
@@ -91,16 +91,27 @@ export declare const safeCalculateEffectiveLeverage: (params: {
|
|
|
91
91
|
* margin_available = entryPrice × (1 / leverage - mmr)
|
|
92
92
|
* liq_price = entryPrice - side × margin_available / (1 - mmr × side)
|
|
93
93
|
*
|
|
94
|
+
* With `current`, the order of `size` adds to that position on the same side.
|
|
95
|
+
* The equity of the blended position at `entryPrice` is `current.margin`, the
|
|
96
|
+
* PnL of `current` at `entryPrice`, and the margin of the order. The margin
|
|
97
|
+
* available is that equity minus the maintenance margin of the blended size,
|
|
98
|
+
* and the formula above divides it by the blended size.
|
|
99
|
+
*
|
|
94
100
|
* For existing positions, prefer `Position.liquidationPrice` from the venue.
|
|
95
101
|
*
|
|
96
102
|
* @param maintenanceMarginRate - Venue maintenance margin rate as a fraction
|
|
97
103
|
* (`'0.01'` = 1%).
|
|
98
|
-
* @
|
|
99
|
-
* `
|
|
100
|
-
*
|
|
104
|
+
* @param size - Order size as a non-negative magnitude. Read only with
|
|
105
|
+
* `current`.
|
|
106
|
+
* @param current - Open isolated position on the same side that the order
|
|
107
|
+
* adds to. `margin` is its collateral net of unrealized PnL.
|
|
108
|
+
* @returns The estimate, or `undefined` when the margin above the
|
|
109
|
+
* maintenance requirement is not positive: the position opens at or past
|
|
110
|
+
* liquidation, so the model has no price on the correct side of entry.
|
|
101
111
|
* @throws {PerpsError} `ValidationError` when an input does not match the
|
|
102
|
-
* decimal pattern, `leverage` is zero,
|
|
103
|
-
* zero denominator (`1` for a long, `-1` for a short)
|
|
112
|
+
* decimal pattern, `leverage` is zero, `maintenanceMarginRate` gives a
|
|
113
|
+
* zero denominator (`1` for a long, `-1` for a short), `current` comes
|
|
114
|
+
* without `size`, or `current.size + size` is not positive.
|
|
104
115
|
* @public
|
|
105
116
|
*/
|
|
106
117
|
export declare function estimateLiquidationPrice(params: {
|
|
@@ -108,6 +119,12 @@ export declare function estimateLiquidationPrice(params: {
|
|
|
108
119
|
leverage: string;
|
|
109
120
|
isLong: boolean;
|
|
110
121
|
maintenanceMarginRate: string;
|
|
122
|
+
size?: string;
|
|
123
|
+
current?: {
|
|
124
|
+
size: string;
|
|
125
|
+
entryPrice: string;
|
|
126
|
+
margin: string;
|
|
127
|
+
};
|
|
111
128
|
}): string | undefined;
|
|
112
129
|
/** @public */
|
|
113
130
|
export declare const safeEstimateLiquidationPrice: (params: {
|
|
@@ -115,18 +132,53 @@ export declare const safeEstimateLiquidationPrice: (params: {
|
|
|
115
132
|
leverage: string;
|
|
116
133
|
isLong: boolean;
|
|
117
134
|
maintenanceMarginRate: string;
|
|
135
|
+
size?: string;
|
|
136
|
+
current?: {
|
|
137
|
+
size: string;
|
|
138
|
+
entryPrice: string;
|
|
139
|
+
margin: string;
|
|
140
|
+
};
|
|
118
141
|
}) => string | undefined;
|
|
119
142
|
/**
|
|
120
|
-
* Estimate the liquidation price of
|
|
121
|
-
* `
|
|
143
|
+
* Estimate the liquidation price of the isolated position that an order
|
|
144
|
+
* leaves: a new position, or the blend of the order into `params.position`.
|
|
145
|
+
* The venue callbacks run only after the margin-mode and side checks pass.
|
|
122
146
|
*
|
|
123
|
-
* @
|
|
124
|
-
* `
|
|
147
|
+
* @param venue.maintenanceMarginRate - Venue maintenance margin rate as a
|
|
148
|
+
* fraction (`'0.01'` = 1%).
|
|
149
|
+
* @param venue.positionCollateral - Collateral of `position`, net of
|
|
150
|
+
* unrealized PnL. It depends on the venue meaning of `Position.marginUsed`.
|
|
151
|
+
* @returns The estimate, or `undefined` when the order or the position is
|
|
152
|
+
* cross (the liquidation depends on the whole account), when the order
|
|
153
|
+
* reduces the position, or when {@link estimateLiquidationPrice} gives
|
|
125
154
|
* `undefined`.
|
|
126
|
-
* @throws {PerpsError} `ValidationError`
|
|
155
|
+
* @throws {PerpsError} `ValidationError` when `params.position` comes
|
|
156
|
+
* without `params.size`, or on an input that
|
|
127
157
|
* {@link estimateLiquidationPrice} rejects.
|
|
128
158
|
* @public
|
|
129
159
|
*/
|
|
160
|
+
export declare function estimateOrderLiquidationPrice(params: LiquidationEstimateParams, venue: {
|
|
161
|
+
maintenanceMarginRate: () => string;
|
|
162
|
+
positionCollateral: (position: Position) => string;
|
|
163
|
+
}): string | undefined;
|
|
164
|
+
/** @public */
|
|
165
|
+
export declare const safeEstimateOrderLiquidationPrice: (params: LiquidationEstimateParams, venue: {
|
|
166
|
+
maintenanceMarginRate: () => string;
|
|
167
|
+
positionCollateral: (position: Position) => string;
|
|
168
|
+
}) => string | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* Estimate the liquidation price of the isolated position that an order
|
|
171
|
+
* leaves, from the flat `market.maintenanceMarginRate`. The collateral of the
|
|
172
|
+
* position is `position.marginUsed`, so the venue `marginUsed` must exclude
|
|
173
|
+
* the unrealized PnL, as Lighter `allocated_margin` does.
|
|
174
|
+
*
|
|
175
|
+
* @returns The estimate, or `undefined` when the market carries no
|
|
176
|
+
* `maintenanceMarginRate`, or as {@link estimateOrderLiquidationPrice}
|
|
177
|
+
* documents.
|
|
178
|
+
* @throws {PerpsError} `ValidationError` as {@link estimateOrderLiquidationPrice}
|
|
179
|
+
* documents.
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
130
182
|
export declare function estimateLiquidationPriceAtMarketRate(market: PerpsMarket, params: LiquidationEstimateParams): string | undefined;
|
|
131
183
|
/** @public */
|
|
132
184
|
export declare const safeEstimateLiquidationPriceAtMarketRate: (market: PerpsMarket, params: LiquidationEstimateParams) => string | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../../src/math/position.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,QAAQ,
|
|
1
|
+
{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../../src/math/position.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,QAAQ,EAGd,MAAM,mBAAmB,CAAA;AAQ1B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAGrE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAI1E;AAED,cAAc;AACd,eAAO,MAAM,0BAA0B,qDAGtC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,GACX,MAAM,CAMR;AAED,cAAc;AACd,eAAO,MAAM,0BAA0B,gFAGtC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOhE;AAED,cAAc;AACd,eAAO,MAAM,gBAAgB,qDAAmD,CAAA;AAEhF;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACf,MAAM,CAOR;AAED,cAAc;AACd,eAAO,MAAM,2BAA2B,iEAGvC,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE;IACnD,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;CACrB,GAAG,MAAM,CAST;AAED,cAAc;AACd,eAAO,MAAM,gCAAgC;sBAdzB,MAAM;kBACV,MAAM;wBAgBrB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE;IACjD,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,MAAM,CAOT;AAED,cAAc;AACd,eAAO,MAAM,8BAA8B;sBAZvB,MAAM;eACb,MAAM;wBAclB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,qBAAqB,EAAE,MAAM,CAAA;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAC/D,GAAG,MAAM,GAAG,SAAS,CAgDrB;AAED,cAAc;AACd,eAAO,MAAM,4BAA4B;gBAzD3B,MAAM;cACR,MAAM;YACR,OAAO;2BACQ,MAAM;WACtB,MAAM;cACH;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;wBAuD/D,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,yBAAyB,EACjC,KAAK,EAAE;IACL,qBAAqB,EAAE,MAAM,MAAM,CAAA;IACnC,kBAAkB,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAA;CACnD,GACA,MAAM,GAAG,SAAS,CAgCpB;AAED,cAAc;AACd,eAAO,MAAM,iCAAiC;2BAtCnB,MAAM,MAAM;wBACf,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM;wBAwCrD,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,yBAAyB,GAChC,MAAM,GAAG,SAAS,CASpB;AAED,cAAc;AACd,eAAO,MAAM,wCAAwC,gFAGpD,CAAA;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE;IAChD,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,OAAO,CASV;AAED,cAAc;AACd,eAAO,MAAM,6BAA6B;sBAftB,MAAM;kBACV,MAAM;YACZ,OAAO;yBAgBhB,CAAA;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE;IAChD,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,MAAM,CAeT;AAED,cAAc;AACd,eAAO,MAAM,6BAA6B;iBAtB3B,MAAM;kBACL,MAAM;aACX,MAAM;eACJ,MAAM;wBAsBlB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE;IAC1C,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,MAAM,CAWT;AAED,cAAc;AACd,eAAO,MAAM,uBAAuB;qBAlBjB,MAAM;mBACR,MAAM;iBACR,MAAM;eACR,MAAM;wBAkBlB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE;IAC5C,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,MAAM,CAOT;AAED,cAAc;AACd,eAAO,MAAM,yBAAyB;gBAdxB,MAAM;eACP,MAAM;UACX,MAAM;YACJ,OAAO;wBAchB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE;IAC3C,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,MAAM,CAOT;AAED,cAAc;AACd,eAAO,MAAM,wBAAwB;gBAdvB,MAAM;gBACN,MAAM;eACP,MAAM;YACT,OAAO;wBAchB,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMrE"}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* helpers are always non-negative magnitudes; direction is carried by
|
|
10
10
|
* `isLong`.
|
|
11
11
|
*/
|
|
12
|
-
import { MarginMode, PositionMarginAdjustment, } from '@lifi/perps-types';
|
|
12
|
+
import { MarginMode, PositionMarginAdjustment, PositionSide, } from '@lifi/perps-types';
|
|
13
13
|
import { DivBig } from '../decimal/big.js';
|
|
14
14
|
import { bigToDecimalString, decimalStringToBig, decimalStringToDivBig, } from '../decimal/decimalStringToBig.js';
|
|
15
15
|
import { invalidInput } from '../errors/invalidInput.js';
|
|
@@ -116,16 +116,27 @@ export const safeCalculateEffectiveLeverage = createSafeFunction('calculateEffec
|
|
|
116
116
|
* margin_available = entryPrice × (1 / leverage - mmr)
|
|
117
117
|
* liq_price = entryPrice - side × margin_available / (1 - mmr × side)
|
|
118
118
|
*
|
|
119
|
+
* With `current`, the order of `size` adds to that position on the same side.
|
|
120
|
+
* The equity of the blended position at `entryPrice` is `current.margin`, the
|
|
121
|
+
* PnL of `current` at `entryPrice`, and the margin of the order. The margin
|
|
122
|
+
* available is that equity minus the maintenance margin of the blended size,
|
|
123
|
+
* and the formula above divides it by the blended size.
|
|
124
|
+
*
|
|
119
125
|
* For existing positions, prefer `Position.liquidationPrice` from the venue.
|
|
120
126
|
*
|
|
121
127
|
* @param maintenanceMarginRate - Venue maintenance margin rate as a fraction
|
|
122
128
|
* (`'0.01'` = 1%).
|
|
123
|
-
* @
|
|
124
|
-
* `
|
|
125
|
-
*
|
|
129
|
+
* @param size - Order size as a non-negative magnitude. Read only with
|
|
130
|
+
* `current`.
|
|
131
|
+
* @param current - Open isolated position on the same side that the order
|
|
132
|
+
* adds to. `margin` is its collateral net of unrealized PnL.
|
|
133
|
+
* @returns The estimate, or `undefined` when the margin above the
|
|
134
|
+
* maintenance requirement is not positive: the position opens at or past
|
|
135
|
+
* liquidation, so the model has no price on the correct side of entry.
|
|
126
136
|
* @throws {PerpsError} `ValidationError` when an input does not match the
|
|
127
|
-
* decimal pattern, `leverage` is zero,
|
|
128
|
-
* zero denominator (`1` for a long, `-1` for a short)
|
|
137
|
+
* decimal pattern, `leverage` is zero, `maintenanceMarginRate` gives a
|
|
138
|
+
* zero denominator (`1` for a long, `-1` for a short), `current` comes
|
|
139
|
+
* without `size`, or `current.size + size` is not positive.
|
|
129
140
|
* @public
|
|
130
141
|
*/
|
|
131
142
|
export function estimateLiquidationPrice(params) {
|
|
@@ -140,35 +151,110 @@ export function estimateLiquidationPrice(params) {
|
|
|
140
151
|
if (denominator.eq(0)) {
|
|
141
152
|
throw invalidInput('maintenanceMarginRate', `must not be ${params.isLong ? '1' : '-1'} for this side`);
|
|
142
153
|
}
|
|
143
|
-
|
|
144
|
-
|
|
154
|
+
if (params.current === undefined) {
|
|
155
|
+
const marginFractionAvailable = new DivBig(1).div(leverage).minus(mmr);
|
|
156
|
+
if (marginFractionAvailable.lte(0)) {
|
|
157
|
+
return undefined;
|
|
158
|
+
}
|
|
159
|
+
const marginAvailable = marginFractionAvailable.times(entryPrice);
|
|
160
|
+
return bigToDecimalString(entryPrice.minus(marginAvailable.times(side).div(denominator)));
|
|
161
|
+
}
|
|
162
|
+
if (params.size === undefined) {
|
|
163
|
+
throw invalidInput('size', 'is required with `current`');
|
|
164
|
+
}
|
|
165
|
+
const addSize = decimalStringToBig(params.size);
|
|
166
|
+
const currentSize = decimalStringToBig(params.current.size);
|
|
167
|
+
const currentEntry = decimalStringToBig(params.current.entryPrice);
|
|
168
|
+
const currentMargin = decimalStringToBig(params.current.margin);
|
|
169
|
+
const totalSize = currentSize.plus(addSize);
|
|
170
|
+
if (totalSize.lte(0)) {
|
|
171
|
+
throw invalidInput('size + current.size', 'must be positive');
|
|
172
|
+
}
|
|
173
|
+
const equity = currentMargin
|
|
174
|
+
.plus(currentSize.times(entryPrice.minus(currentEntry)).times(side))
|
|
175
|
+
.plus(new DivBig(entryPrice).times(addSize).div(leverage));
|
|
176
|
+
const marginAvailablePerUnit = new DivBig(equity)
|
|
177
|
+
.minus(mmr.times(totalSize).times(entryPrice))
|
|
178
|
+
.div(totalSize);
|
|
179
|
+
if (marginAvailablePerUnit.lte(0)) {
|
|
145
180
|
return undefined;
|
|
146
181
|
}
|
|
147
|
-
|
|
148
|
-
return bigToDecimalString(entryPrice.minus(marginAvailable.times(side).div(denominator)));
|
|
182
|
+
return bigToDecimalString(entryPrice.minus(marginAvailablePerUnit.times(side).div(denominator)));
|
|
149
183
|
}
|
|
150
184
|
/** @public */
|
|
151
185
|
export const safeEstimateLiquidationPrice = createSafeFunction('estimateLiquidationPrice', estimateLiquidationPrice);
|
|
152
186
|
/**
|
|
153
|
-
* Estimate the liquidation price of
|
|
154
|
-
* `
|
|
187
|
+
* Estimate the liquidation price of the isolated position that an order
|
|
188
|
+
* leaves: a new position, or the blend of the order into `params.position`.
|
|
189
|
+
* The venue callbacks run only after the margin-mode and side checks pass.
|
|
155
190
|
*
|
|
156
|
-
* @
|
|
157
|
-
* `
|
|
191
|
+
* @param venue.maintenanceMarginRate - Venue maintenance margin rate as a
|
|
192
|
+
* fraction (`'0.01'` = 1%).
|
|
193
|
+
* @param venue.positionCollateral - Collateral of `position`, net of
|
|
194
|
+
* unrealized PnL. It depends on the venue meaning of `Position.marginUsed`.
|
|
195
|
+
* @returns The estimate, or `undefined` when the order or the position is
|
|
196
|
+
* cross (the liquidation depends on the whole account), when the order
|
|
197
|
+
* reduces the position, or when {@link estimateLiquidationPrice} gives
|
|
158
198
|
* `undefined`.
|
|
159
|
-
* @throws {PerpsError} `ValidationError`
|
|
199
|
+
* @throws {PerpsError} `ValidationError` when `params.position` comes
|
|
200
|
+
* without `params.size`, or on an input that
|
|
160
201
|
* {@link estimateLiquidationPrice} rejects.
|
|
161
202
|
* @public
|
|
162
203
|
*/
|
|
163
|
-
export function
|
|
164
|
-
|
|
204
|
+
export function estimateOrderLiquidationPrice(params, venue) {
|
|
205
|
+
const { position } = params;
|
|
206
|
+
if (params.marginMode === MarginMode.CROSS ||
|
|
207
|
+
position?.marginMode === MarginMode.CROSS ||
|
|
208
|
+
(position !== undefined &&
|
|
209
|
+
(position.side === PositionSide.LONG) !== params.isLong)) {
|
|
165
210
|
return undefined;
|
|
166
211
|
}
|
|
212
|
+
const maintenanceMarginRate = venue.maintenanceMarginRate();
|
|
213
|
+
if (position === undefined) {
|
|
214
|
+
return estimateLiquidationPrice({
|
|
215
|
+
entryPrice: params.entryPrice,
|
|
216
|
+
leverage: params.leverage,
|
|
217
|
+
isLong: params.isLong,
|
|
218
|
+
maintenanceMarginRate,
|
|
219
|
+
size: params.size,
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
const margin = venue.positionCollateral(position);
|
|
223
|
+
if (params.size === undefined) {
|
|
224
|
+
throw invalidInput('size', 'is required with `position`');
|
|
225
|
+
}
|
|
167
226
|
return estimateLiquidationPrice({
|
|
168
227
|
entryPrice: params.entryPrice,
|
|
169
228
|
leverage: params.leverage,
|
|
170
229
|
isLong: params.isLong,
|
|
171
|
-
maintenanceMarginRate
|
|
230
|
+
maintenanceMarginRate,
|
|
231
|
+
size: params.size,
|
|
232
|
+
current: { size: position.size, entryPrice: position.entryPrice, margin },
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
/** @public */
|
|
236
|
+
export const safeEstimateOrderLiquidationPrice = createSafeFunction('estimateOrderLiquidationPrice', estimateOrderLiquidationPrice);
|
|
237
|
+
/**
|
|
238
|
+
* Estimate the liquidation price of the isolated position that an order
|
|
239
|
+
* leaves, from the flat `market.maintenanceMarginRate`. The collateral of the
|
|
240
|
+
* position is `position.marginUsed`, so the venue `marginUsed` must exclude
|
|
241
|
+
* the unrealized PnL, as Lighter `allocated_margin` does.
|
|
242
|
+
*
|
|
243
|
+
* @returns The estimate, or `undefined` when the market carries no
|
|
244
|
+
* `maintenanceMarginRate`, or as {@link estimateOrderLiquidationPrice}
|
|
245
|
+
* documents.
|
|
246
|
+
* @throws {PerpsError} `ValidationError` as {@link estimateOrderLiquidationPrice}
|
|
247
|
+
* documents.
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
export function estimateLiquidationPriceAtMarketRate(market, params) {
|
|
251
|
+
const { maintenanceMarginRate } = market;
|
|
252
|
+
if (maintenanceMarginRate === undefined) {
|
|
253
|
+
return undefined;
|
|
254
|
+
}
|
|
255
|
+
return estimateOrderLiquidationPrice(params, {
|
|
256
|
+
maintenanceMarginRate: () => maintenanceMarginRate,
|
|
257
|
+
positionCollateral: (position) => position.marginUsed,
|
|
172
258
|
});
|
|
173
259
|
}
|
|
174
260
|
/** @public */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../src/math/position.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,UAAU,EAGV,wBAAwB,
|
|
1
|
+
{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../src/math/position.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EACL,UAAU,EAGV,wBAAwB,EACxB,YAAY,GACb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAEnE;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAY,EAAE,KAAa;IAChE,OAAO,kBAAkB,CACvB,kBAAkB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAChE,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAAkB,CAC1D,wBAAwB,EACxB,sBAAsB,CACvB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,UAAkB,EAClB,YAAoB,EACpB,IAAY;IAEZ,OAAO,kBAAkB,CACvB,kBAAkB,CAAC,YAAY,CAAC;SAC7B,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;SACrC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CACnC,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAAkB,CAC1D,wBAAwB,EACxB,sBAAsB,CACvB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,MAAc;IACtD,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;IAC5C,MAAM,MAAM,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAA;IACzC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpB,MAAM,YAAY,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAA;IAClD,CAAC;IACD,OAAO,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;AAEhF;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,aAAqB,EACrB,QAAgB;IAEhB,MAAM,WAAW,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAA;IACxD,MAAM,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IAChD,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtB,MAAM,YAAY,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;IACpD,CAAC;IACD,OAAO,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAA;AACzD,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,2BAA2B,GAAG,kBAAkB,CAC3D,yBAAyB,EACzB,uBAAuB,CACxB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAG5C;IACC,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACvE,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAC5D,IAAI,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,MAAM,YAAY,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAA;IACxD,CAAC;IACD,OAAO,kBAAkB,CACvB,gBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CACxE,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,gCAAgC,GAAG,kBAAkB,CAChE,8BAA8B,EAC9B,4BAA4B,CAC7B,CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAG1C;IACC,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACpE,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACnD,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjB,MAAM,YAAY,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;IACrD,CAAC;IACD,OAAO,kBAAkB,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;AACtD,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,8BAA8B,GAAG,kBAAkB,CAC9D,4BAA4B,EAC5B,0BAA0B,CAC3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAOxC;IACC,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IACxD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpD,MAAM,GAAG,GAAG,kBAAkB,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAA;IAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACnC,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC5C,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnB,MAAM,YAAY,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;IACpD,CAAC;IACD,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtB,MAAM,YAAY,CAChB,uBAAuB,EACvB,eAAe,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAC1D,CAAA;IACH,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,uBAAuB,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACtE,IAAI,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACnC,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,eAAe,GAAG,uBAAuB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QACjE,OAAO,kBAAkB,CACvB,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAC/D,CAAA;IACH,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,YAAY,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAA;IAC1D,CAAC;IACD,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC/C,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3D,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAClE,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC/D,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,YAAY,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAA;IAC/D,CAAC;IACD,MAAM,MAAM,GAAG,aAAa;SACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACnE,IAAI,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC5D,MAAM,sBAAsB,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC;SAC9C,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;SAC7C,GAAG,CAAC,SAAS,CAAC,CAAA;IACjB,IAAI,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,kBAAkB,CACvB,UAAU,CAAC,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CACtE,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,4BAA4B,GAAG,kBAAkB,CAC5D,0BAA0B,EAC1B,wBAAwB,CACzB,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAAiC,EACjC,KAGC;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAA;IAC3B,IACE,MAAM,CAAC,UAAU,KAAK,UAAU,CAAC,KAAK;QACtC,QAAQ,EAAE,UAAU,KAAK,UAAU,CAAC,KAAK;QACzC,CAAC,QAAQ,KAAK,SAAS;YACrB,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,EAC1D,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,EAAE,CAAA;IAC3D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,wBAAwB,CAAC;YAC9B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,qBAAqB;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI;SAClB,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IACjD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,YAAY,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAA;IAC3D,CAAC;IACD,OAAO,wBAAwB,CAAC;QAC9B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,qBAAqB;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;KAC1E,CAAC,CAAA;AACJ,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,iCAAiC,GAAG,kBAAkB,CACjE,+BAA+B,EAC/B,6BAA6B,CAC9B,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,oCAAoC,CAClD,MAAmB,EACnB,MAAiC;IAEjC,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAA;IACxC,IAAI,qBAAqB,KAAK,SAAS,EAAE,CAAC;QACxC,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,6BAA6B,CAAC,MAAM,EAAE;QAC3C,qBAAqB,EAAE,GAAG,EAAE,CAAC,qBAAqB;QAClD,kBAAkB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU;KACtD,CAAC,CAAA;AACJ,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,wCAAwC,GAAG,kBAAkB,CACxE,sCAAsC,EACtC,oCAAoC,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAIzC;IACC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACpE,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAC5D,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,MAAM,CAAC,MAAM;QAClB,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC;QACpC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;AACxC,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAC7D,2BAA2B,EAC3B,yBAAyB,CAC1B,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAKzC;IACC,MAAM,WAAW,GAAG,qBAAqB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAC5D,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACtD,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,YAAY,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAA;IACjE,CAAC;IACD,OAAO,kBAAkB,CACvB,WAAW;SACR,KAAK,CAAC,YAAY,CAAC;SACnB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;SAC9B,GAAG,CAAC,SAAS,CAAC,CAClB,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAC7D,2BAA2B,EAC3B,yBAAyB,CAC1B,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAKnC;IACC,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,IAAI,CACtE,kBAAkB,CAAC,MAAM,CAAC,WAAW,CAAC,CACvC,CAAA;IACD,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAC/D,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CACrC,CAAA;IACD,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,MAAM,YAAY,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAAA;IACrE,CAAC;IACD,OAAO,kBAAkB,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAA;AAC3D,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CACvD,qBAAqB,EACrB,mBAAmB,CACpB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAKrC;IACC,OAAO,kBAAkB,CACvB,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC;SACjC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;SAC5C,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACtC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACjC,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,yBAAyB,GAAG,kBAAkB,CACzD,uBAAuB,EACvB,qBAAqB,CACtB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAKpC;IACC,OAAO,kBAAkB,CACvB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC;SAClC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;SAC5C,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SAC3C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACjC,CAAA;AACH,CAAC;AAED,cAAc;AACd,MAAM,CAAC,MAAM,wBAAwB,GAAG,kBAAkB,CACxD,sBAAsB,EACtB,oBAAoB,CACrB,CAAA;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,QAAkB;IAC3D,OAAO,CACL,QAAQ,CAAC,UAAU,KAAK,UAAU,CAAC,QAAQ;QAC3C,QAAQ,CAAC,MAAM,CAAC,wBAAwB,KAAK,wBAAwB,CAAC,IAAI,CAC3E,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,QAAkB;IAC1D,OAAO,CACL,0BAA0B,CAAC,QAAQ,CAAC;QACpC,QAAQ,CAAC,MAAM,CAAC,wBAAwB;YACtC,wBAAwB,CAAC,cAAc,CAC1C,CAAA;AACH,CAAC"}
|
|
@@ -14,12 +14,12 @@ export declare const LIFI_API_URL = "https://li.quest/v1";
|
|
|
14
14
|
* @public
|
|
15
15
|
*/
|
|
16
16
|
export interface GetGasRecommendationParams {
|
|
17
|
-
/** Chain to hold native gas on — a `
|
|
17
|
+
/** Chain to hold native gas on — a `venueDepositPipeline` flow's `chainId`. */
|
|
18
18
|
chainId: number;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* How much native gas LI.FI suggests holding on `params.chainId` to transact
|
|
22
|
-
* there, for seeding the gas leg of a
|
|
22
|
+
* there, for seeding the gas leg of a venue-deposit pipeline. Read straight
|
|
23
23
|
* from the LI.FI API by the user's client.
|
|
24
24
|
*
|
|
25
25
|
* @returns The suggestion, with `available: false` and no amounts on a chain
|
|
@@ -8,7 +8,7 @@ import { request } from '../transport/request.js';
|
|
|
8
8
|
export const LIFI_API_URL = 'https://li.quest/v1';
|
|
9
9
|
/**
|
|
10
10
|
* How much native gas LI.FI suggests holding on `params.chainId` to transact
|
|
11
|
-
* there, for seeding the gas leg of a
|
|
11
|
+
* there, for seeding the gas leg of a venue-deposit pipeline. Read straight
|
|
12
12
|
* from the LI.FI API by the user's client.
|
|
13
13
|
*
|
|
14
14
|
* @returns The suggestion, with `available: false` and no amounts on a chain
|
|
@@ -34,20 +34,21 @@ export interface DepositFlowLifiSwap {
|
|
|
34
34
|
toAddress?: Address;
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* Fund an address that has no venue account yet
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
37
|
+
* Fund an address that has no venue account yet, or an existing account on a
|
|
38
|
+
* venue whose collateral no LI.FI route credits directly. Collateral and the
|
|
39
|
+
* native gas to broadcast with are both needed on `chainId`, where the venue's
|
|
40
|
+
* {@link ActionType.DEPOSIT} action stages the on-chain legs that credit the
|
|
41
|
+
* account and open it when none exists.
|
|
41
42
|
*
|
|
42
43
|
* @public
|
|
43
44
|
*/
|
|
44
|
-
export interface
|
|
45
|
-
kind: '
|
|
45
|
+
export interface DepositFlowVenueDepositPipeline {
|
|
46
|
+
kind: 'venueDepositPipeline';
|
|
46
47
|
/** Chain on which the deposit legs broadcast; the wallet must be switched here. */
|
|
47
48
|
chainId: number;
|
|
48
49
|
/** Native gas asset needed to broadcast the deposit legs. */
|
|
49
50
|
gasAsset: DeclaredDepositAsset;
|
|
50
|
-
/** Collateral asset
|
|
51
|
+
/** Collateral asset the venue deposit credits. */
|
|
51
52
|
collateral: DeclaredDepositAsset;
|
|
52
53
|
/** Action type used to stage the deposit pipeline. */
|
|
53
54
|
bridgeAction: ActionType.DEPOSIT;
|
|
@@ -70,5 +71,5 @@ export interface DepositFlowSetupRequired {
|
|
|
70
71
|
*
|
|
71
72
|
* @public
|
|
72
73
|
*/
|
|
73
|
-
export type DepositFlow = DepositFlowLifiSwap |
|
|
74
|
+
export type DepositFlow = DepositFlowLifiSwap | DepositFlowVenueDepositPipeline | DepositFlowSetupRequired;
|
|
74
75
|
//# sourceMappingURL=deposit.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deposit.d.ts","sourceRoot":"","sources":["../../../src/types/deposit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAA;IACf,uEAAuE;IACvE,OAAO,EAAE,OAAO,CAAA;IAChB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,UAAU,CAAA;IAChB,gEAAgE;IAChE,WAAW,EAAE,oBAAoB,CAAA;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED
|
|
1
|
+
{"version":3,"file":"deposit.d.ts","sourceRoot":"","sources":["../../../src/types/deposit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAA;IACf,uEAAuE;IACvE,OAAO,EAAE,OAAO,CAAA;IAChB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,UAAU,CAAA;IAChB,gEAAgE;IAChE,WAAW,EAAE,oBAAoB,CAAA;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,sBAAsB,CAAA;IAC5B,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,kDAAkD;IAClD,UAAU,EAAE,oBAAoB,CAAA;IAChC,sDAAsD;IACtD,YAAY,EAAE,UAAU,CAAC,OAAO,CAAA;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,eAAe,CAAA;IACrB,qEAAqE;IACrE,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GACnB,mBAAmB,GACnB,+BAA+B,GAC/B,wBAAwB,CAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AccountConfig, AccountConfigSetting, AccountResponse, AccountSummary, ActionResult, ActionStep, ActionType, ActivitiesResponse, ActivityType, AvailableToTrade, DecimalString, FillsResponse, Market, MarketRef, MarketSettings, Order, OrderStatus, OrdersResponse, PerpsMarket, PerpsSigner, PortfolioHistoryRange, PortfolioHistoryResponse, Position, PositionsResponse, Quote, QuoteSide, SetupAction, SignedActionStep, SigningMethod, TradeType } from '@lifi/perps-types';
|
|
1
|
+
import type { AccountConfig, AccountConfigSetting, AccountResponse, AccountSummary, ActionResult, ActionStep, ActionType, ActivitiesResponse, ActivityType, AvailableToTrade, DecimalString, FillsResponse, MarginMode, Market, MarketRef, MarketSettings, Order, OrderStatus, OrdersResponse, PerpsMarket, PerpsSigner, PortfolioHistoryRange, PortfolioHistoryResponse, Position, PositionsResponse, Quote, QuoteSide, SetupAction, SignedActionStep, SigningMethod, TradeType } from '@lifi/perps-types';
|
|
2
2
|
import type { Address } from 'viem';
|
|
3
3
|
import type { PerpsBaseConfig, PerpsClientSigner, SDKRequestOptions } from './config.js';
|
|
4
4
|
import type { DepositFlow } from './deposit.js';
|
|
@@ -115,7 +115,8 @@ export interface ActionSignerContribution {
|
|
|
115
115
|
params?: Record<string, unknown>;
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Inputs for {@link PerpsProviderPlugin.estimateLiquidationPrice}:
|
|
118
|
+
* Inputs for {@link PerpsProviderPlugin.estimateLiquidationPrice}: the order
|
|
119
|
+
* and, when the order adds to one, the open position on the market.
|
|
119
120
|
* `leverage` is the user-selected leverage for the new position, `isLong`
|
|
120
121
|
* carries direction.
|
|
121
122
|
*
|
|
@@ -127,6 +128,14 @@ export interface LiquidationEstimateParams {
|
|
|
127
128
|
leverage: string;
|
|
128
129
|
/** `true` for long, `false` for short. */
|
|
129
130
|
isLong: boolean;
|
|
131
|
+
marginMode: MarginMode;
|
|
132
|
+
/**
|
|
133
|
+
* Order size in base-asset units. The estimate reads it only with
|
|
134
|
+
* `position`, to blend the order into that position.
|
|
135
|
+
*/
|
|
136
|
+
size?: DecimalString;
|
|
137
|
+
/** Open position on the market that the order joins. */
|
|
138
|
+
position?: Position;
|
|
130
139
|
}
|
|
131
140
|
/**
|
|
132
141
|
* Read-side params for {@link PerpsProvider.getAccount}. The `provider`
|
|
@@ -501,16 +510,20 @@ export interface PerpsProviderPlugin {
|
|
|
501
510
|
};
|
|
502
511
|
};
|
|
503
512
|
/**
|
|
504
|
-
* Estimate the liquidation price of
|
|
505
|
-
* using the venue's margin model
|
|
513
|
+
* Estimate the liquidation price of the position that the order leaves on
|
|
514
|
+
* `market` using the venue's margin model: a new position, or the blend of
|
|
515
|
+
* the order into `params.position`. A preview helper — for existing
|
|
506
516
|
* positions, prefer `Position.liquidationPrice` from the venue. Pure —
|
|
507
517
|
* does no I/O.
|
|
508
518
|
*
|
|
509
519
|
* @returns The estimated liquidation price, or `undefined` when `market`
|
|
510
|
-
* lacks the margin metadata the model needs
|
|
511
|
-
* margin above the maintenance requirement
|
|
520
|
+
* lacks the margin metadata the model needs, `leverage` leaves no
|
|
521
|
+
* margin above the maintenance requirement, or the venue model cannot
|
|
522
|
+
* give a correct price for the margin mode and position, such as a cross
|
|
523
|
+
* position whose liquidation depends on the whole account.
|
|
512
524
|
* @throws {PerpsError} `ValidationError` when an input does not match the
|
|
513
|
-
* decimal pattern or is degenerate, such as a zero leverage
|
|
525
|
+
* decimal pattern or is degenerate, such as a zero leverage or a
|
|
526
|
+
* `position` without a `size`.
|
|
514
527
|
*/
|
|
515
528
|
estimateLiquidationPrice(market: PerpsMarket, params: LiquidationEstimateParams): string | undefined;
|
|
516
529
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/types/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,MAAM,EACN,SAAS,EACT,cAAc,EACd,KAAK,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,SAAS,EACV,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACnC,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,KAAK,EACV,2BAA2B,EAC3B,qBAAqB,EACrB,YAAY,EACb,MAAM,iBAAiB,CAAA;AAExB;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IACvC,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,CAAA;IACnC,uDAAuD;IACvD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;CACpD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,oEAAoE;IACpE,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC/D;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAA;CACpD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/types/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,UAAU,EACV,MAAM,EACN,SAAS,EACT,cAAc,EACd,KAAK,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,wBAAwB,EACxB,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,SAAS,EACV,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACnC,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,KAAK,EACV,2BAA2B,EAC3B,qBAAqB,EACrB,YAAY,EACb,MAAM,iBAAiB,CAAA;AAExB;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IACvC,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,CAAA;IACnC,uDAAuD;IACvD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;CACpD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,oEAAoE;IACpE,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC/D;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAA;CACpD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,UAAU,CAAA;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,OAAO,CAAA;IAChB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,OAAO,CAAA;IAChB;uDACmD;IACnD,MAAM,EAAE,SAAS,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD,OAAO,EAAE,OAAO,CAAA;IAChB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,YAAY,EAAE,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,qBAAqB,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,IAAI,EAAE,SAAS,CAAA;IACf,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,sEAAsE;IACtE,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;;;;;;OAOG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,SAAS,UAAU,EAAE,CAAA;IAExD;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAElC,UAAU,CACR,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;OAMG;IACH,aAAa,CACX,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,OAAO,CAAC,CAAA;IAEnB;;;;;;;;OAQG;IACH,cAAc,CAAC,CACb,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,CACd,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,CACtB,MAAM,EAAE,qCAAqC,EAC7C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAA;IAEzC;;;;;;OAMG;IACH,kBAAkB,CAAC,CACjB,MAAM,EAAE,gCAAgC,EACxC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAA;IAEnC,YAAY,CACV,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B;;;;;;;OAOG;IACH,iBAAiB,CACf,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAAA;IAE1B;;;;;;;OAOG;IACH,mBAAmB,CAAC,CAClB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAA;IAExC,SAAS,CACP,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAAA;IAE1B,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAAA;IAEjB,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,aAAa,CAAC,CAAA;IAEzB,WAAW,CACT,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAE9B;;;OAGG;IACH,mBAAmB,CAAC,CAClB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,CAAA;IAEpC;;;;;;OAMG;IACH,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAAA;IAEjB;;;;;;;;OAQG;IACH,iBAAiB,CACf,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,GACpB,cAAc,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,aAAa,CAAA;IAEnE;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,aAAa,CAAA;IAEjE;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE;QACd,mBAAmB,EAAE,OAAO,CAAA;QAC5B,cAAc,CAAC,EAAE;YACf,GAAG,EAAE,aAAa,CAAA;YAClB,GAAG,EAAE,aAAa,CAAA;YAClB,IAAI,EAAE,aAAa,CAAA;YACnB,OAAO,EAAE,aAAa,CAAA;SACvB,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CACtB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,yBAAyB,GAChC,MAAM,GAAG,SAAS,CAAA;IAErB;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,CAAA;IAEtE;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,WAAW,EAAE,GACnB,oBAAoB,EAAE,CAAA;IAEzB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,CACjB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAEnC;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAAC,CACnB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,wBAAwB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,CACV,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,UAAU,EAAE,EACnB,OAAO,EAAE,OAAO,EAChB,GAAG,CAAC,EAAE,kBAAkB,GACvB,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3E;;;;;;;;OAQG;IACH,mBAAmB,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CACzD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA"}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import type { DeclaredDepositAsset } from '../types/deposit.js';
|
|
2
2
|
/**
|
|
3
|
-
* USDC on Ethereum mainnet — the collateral leg of Lighter's
|
|
3
|
+
* USDC on Ethereum mainnet — the collateral leg of Lighter's venue-deposit
|
|
4
4
|
* pipeline, and the token Ondo's provisioned deposit address is funded in.
|
|
5
5
|
*
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
8
8
|
export declare const ETHEREUM_USDC: DeclaredDepositAsset;
|
|
9
9
|
/**
|
|
10
|
-
* Ether on Ethereum mainnet, to broadcast the
|
|
10
|
+
* Ether on Ethereum mainnet, to broadcast the venue-deposit pipeline's legs
|
|
11
11
|
* with.
|
|
12
12
|
*
|
|
13
13
|
* @public
|
|
@@ -37,7 +37,7 @@ export declare const LIGHTER_USDC: DeclaredDepositAsset;
|
|
|
37
37
|
*/
|
|
38
38
|
export declare const ROBINHOOD_USDG: DeclaredDepositAsset;
|
|
39
39
|
/**
|
|
40
|
-
* Ether on Robinhood Chain, to broadcast the Robinhood
|
|
40
|
+
* Ether on Robinhood Chain, to broadcast the Robinhood venue-deposit pipeline's
|
|
41
41
|
* legs with.
|
|
42
42
|
*
|
|
43
43
|
* @public
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ChainId } from '@lifi/types';
|
|
2
2
|
import { zeroAddress } from 'viem';
|
|
3
3
|
/**
|
|
4
|
-
* USDC on Ethereum mainnet — the collateral leg of Lighter's
|
|
4
|
+
* USDC on Ethereum mainnet — the collateral leg of Lighter's venue-deposit
|
|
5
5
|
* pipeline, and the token Ondo's provisioned deposit address is funded in.
|
|
6
6
|
*
|
|
7
7
|
* @public
|
|
@@ -12,7 +12,7 @@ export const ETHEREUM_USDC = {
|
|
|
12
12
|
decimals: 6,
|
|
13
13
|
};
|
|
14
14
|
/**
|
|
15
|
-
* Ether on Ethereum mainnet, to broadcast the
|
|
15
|
+
* Ether on Ethereum mainnet, to broadcast the venue-deposit pipeline's legs
|
|
16
16
|
* with.
|
|
17
17
|
*
|
|
18
18
|
* @public
|
|
@@ -58,7 +58,7 @@ export const ROBINHOOD_USDG = {
|
|
|
58
58
|
decimals: 6,
|
|
59
59
|
};
|
|
60
60
|
/**
|
|
61
|
-
* Ether on Robinhood Chain, to broadcast the Robinhood
|
|
61
|
+
* Ether on Robinhood Chain, to broadcast the Robinhood venue-deposit pipeline's
|
|
62
62
|
* legs with.
|
|
63
63
|
*
|
|
64
64
|
* @public
|
package/dist/esm/version.d.ts
CHANGED
package/dist/esm/version.js
CHANGED
package/dist/types/index.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ export { PerpsExecutionError, rethrowWithKnownResults, } from './errors/PerpsExe
|
|
|
23
23
|
export { calculateAverageFillPrice, classifyFillFromPosition, FillClassification, } from './math/fills.js';
|
|
24
24
|
export type { ExpectedPnl } from './math/order.js';
|
|
25
25
|
export { buildQuote, calculateExpectedPnl, calculateOrderbookWalk, calculateRealizedPnlPercent, calculateSize, calculateSlippagePrice, calculateTriggerPercent, calculateTriggerPrice, estimateFees, estimateRealizedPnl, resolveCloseSize, resolveMatchingPosition, safeBuildQuote, safeCalculateExpectedPnl, safeCalculateOrderbookWalk, safeCalculateRealizedPnlPercent, safeCalculateSize, safeCalculateSlippagePrice, safeCalculateTriggerPercent, safeCalculateTriggerPrice, safeEstimateFees, safeEstimateRealizedPnl, safeResolveCloseSize, } from './math/order.js';
|
|
26
|
-
export { calculateEffectiveLeverage, calculateLiquidationDistance, calculateNotionalValue, calculateRealizedPnl, calculateRequiredMargin, calculateRoe, calculateUnrealizedPnl, estimateAverageEntryPrice, estimateLiquidationPrice, estimateLiquidationPriceAtMarketRate, estimateNewLeverage, estimateUnrealizedPnl, isPositionMarginAdjustable, isPositionMarginRemovable, safeCalculateEffectiveLeverage, safeCalculateLiquidationDistance, safeCalculateNotionalValue, safeCalculateRealizedPnl, safeCalculateRequiredMargin, safeCalculateRoe, safeCalculateUnrealizedPnl, safeEstimateAverageEntryPrice, safeEstimateLiquidationPrice, safeEstimateLiquidationPriceAtMarketRate, safeEstimateNewLeverage, safeEstimateUnrealizedPnl, safeWouldImmediatelyLiquidate, wouldImmediatelyLiquidate, } from './math/position.js';
|
|
26
|
+
export { calculateEffectiveLeverage, calculateLiquidationDistance, calculateNotionalValue, calculateRealizedPnl, calculateRequiredMargin, calculateRoe, calculateUnrealizedPnl, estimateAverageEntryPrice, estimateLiquidationPrice, estimateLiquidationPriceAtMarketRate, estimateNewLeverage, estimateOrderLiquidationPrice, estimateUnrealizedPnl, isPositionMarginAdjustable, isPositionMarginRemovable, safeCalculateEffectiveLeverage, safeCalculateLiquidationDistance, safeCalculateNotionalValue, safeCalculateRealizedPnl, safeCalculateRequiredMargin, safeCalculateRoe, safeCalculateUnrealizedPnl, safeEstimateAverageEntryPrice, safeEstimateLiquidationPrice, safeEstimateLiquidationPriceAtMarketRate, safeEstimateNewLeverage, safeEstimateOrderLiquidationPrice, safeEstimateUnrealizedPnl, safeWouldImmediatelyLiquidate, wouldImmediatelyLiquidate, } from './math/position.js';
|
|
27
27
|
export { AssetRegistry, getAssetRegistry, toAssetDisplay, } from './registry/assetRegistry.js';
|
|
28
28
|
export type { DefaultMarketProvider } from './registry/marketRegistry.js';
|
|
29
29
|
export { DEFAULT_MARKET_ID, getDefaultMarketId, getMarketRegistry, isActiveMarket, MarketRegistry, toMarketDisplay, toPerpsMarketDisplay, } from './registry/marketRegistry.js';
|
|
@@ -79,7 +79,7 @@ export type { ProviderRetryConfig, ResolvedRetryPolicy, RetryAttemptContext, Ret
|
|
|
79
79
|
export { DISABLED_RETRY, LIFI_REQUEST_KEY, LIFI_RETRY_DEFAULTS, resolveRetryPolicy, } from './transport/retryPolicy.js';
|
|
80
80
|
export type { BuildProviderSetupParams, CancelOrdersParams, CancelTwapOrderParams as ClientCancelTwapOrderParams, CreateReferralCodeActionParams, ExecuteMetaActionParams, GetAccountResult, GetDepositFlowParams, GetPortfolioHistoryParams, GetSetupParams, GetWithdrawableBalancesParams, GetWithdrawalTypesParams, GetWithdrawFlowParams, ModifyOrdersParams, PerpsClientOptions, PerpsConfig, PlaceOrderParams as ClientPlaceOrderParams, PlaceTriggerOrderParams as ClientPlaceTriggerOrderParams, PlaceTwapOrderParams as ClientPlaceTwapOrderParams, ProviderSetup, SendAssetActionParams, SetupChecklistItem, SubmitOnboardingParams, WithdrawParams, } from './types/api.js';
|
|
81
81
|
export type { PerpsBaseConfig, PerpsClientSigner, RequestInterceptor, SDKRequestOptions, SwitchChainHook, } from './types/config.js';
|
|
82
|
-
export type { DeclaredDepositAsset, DepositFlow,
|
|
82
|
+
export type { DeclaredDepositAsset, DepositFlow, DepositFlowLifiSwap, DepositFlowSetupRequired, DepositFlowVenueDepositPipeline, } from './types/deposit.js';
|
|
83
83
|
export type { ActionSignerContribution, LiquidationEstimateParams, PerpsProvider, PerpsProviderPlugin, PerpsSDKClient, ProviderAccountExistsParams, ProviderGetAccountParams, ProviderGetActivityParams, ProviderGetAvailableToTradeParams, ProviderGetDepositFlowParams, ProviderGetFillsParams, ProviderGetMarketSettingsParams, ProviderGetOrderParams, ProviderGetOrdersParams, ProviderGetPortfolioHistoryParams, ProviderGetPositionsParams, ProviderGetQuoteParams, ProviderGetWithdrawableBalancesParams, ProviderGetWithdrawalTypesParams, ProviderGetWithdrawFlowParams, QuoteListener, SignActionProgress, SignActionsContext, SignActionsResult, } from './types/provider.js';
|
|
84
84
|
export type { ProviderWithdrawableBalance, WithdrawableBalance, WithdrawalSourceTypes, WithdrawalTypeOption, WithdrawFlow, WithdrawFlowReady, WithdrawFlowSetupRequired, } from './types/withdrawal.js';
|
|
85
85
|
export { isSubmittedOrAccepted } from './utils/actionResult.js';
|