@lifi/perps-types 0.0.0-preview-cbbc415 → 0.0.0-preview-e0d34a1
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/dist/cjs/account.d.ts +9 -5
- package/dist/cjs/account.d.ts.map +1 -1
- package/dist/esm/account.d.ts +49 -13
- package/dist/esm/account.d.ts.map +1 -1
- package/dist/types/account.d.ts +49 -13
- package/dist/types/account.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/account.ts +49 -13
package/dist/cjs/account.d.ts
CHANGED
|
@@ -14,6 +14,7 @@ export interface Position {
|
|
|
14
14
|
markPrice: string;
|
|
15
15
|
liquidationPrice: string;
|
|
16
16
|
unrealizedPnl: string;
|
|
17
|
+
accruedFunding: string;
|
|
17
18
|
leverage: number;
|
|
18
19
|
marginUsed: string;
|
|
19
20
|
initialMarginRequirement: string;
|
|
@@ -28,7 +29,8 @@ export interface OpenOrder {
|
|
|
28
29
|
market: MarketDisplay;
|
|
29
30
|
side: OrderSide;
|
|
30
31
|
type: OrderType;
|
|
31
|
-
|
|
32
|
+
originalSize: string;
|
|
33
|
+
remainingSize: string;
|
|
32
34
|
price: string;
|
|
33
35
|
filledSize: string;
|
|
34
36
|
reduceOnly: boolean;
|
|
@@ -120,23 +122,25 @@ export interface BaseActivity {
|
|
|
120
122
|
}
|
|
121
123
|
export interface DepositActivity extends BaseActivity {
|
|
122
124
|
type: ActivityType.DEPOSIT;
|
|
125
|
+
asset: string;
|
|
123
126
|
amount: string;
|
|
124
127
|
explorerLink?: string;
|
|
125
128
|
}
|
|
126
129
|
export interface WithdrawalActivity extends BaseActivity {
|
|
127
130
|
type: ActivityType.WITHDRAWAL;
|
|
131
|
+
asset: string;
|
|
128
132
|
amount: string;
|
|
129
|
-
fee
|
|
133
|
+
fee?: string;
|
|
130
134
|
explorerLink?: string;
|
|
131
135
|
}
|
|
132
136
|
export interface LiquidatedPosition {
|
|
133
137
|
market: MarketDisplay;
|
|
134
|
-
size
|
|
138
|
+
size?: string;
|
|
135
139
|
}
|
|
136
140
|
export interface LiquidationActivity extends BaseActivity {
|
|
137
141
|
type: ActivityType.LIQUIDATION;
|
|
138
|
-
liquidatedNotionalPosition
|
|
139
|
-
accountValue
|
|
142
|
+
liquidatedNotionalPosition?: string;
|
|
143
|
+
accountValue?: string;
|
|
140
144
|
leverageType?: string;
|
|
141
145
|
liquidatedPositions: LiquidatedPosition[];
|
|
142
146
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAQ9C,MAAM,WAAW,OAAO;IAEtB,KAAK,EAAE,MAAM,CAAA;IAEb,KAAK,EAAE,MAAM,CAAA;CACd;AAQD,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAElB,IAAI,EAAE,MAAM,CAAA;IAEZ,UAAU,EAAE,MAAM,CAAA;IAElB,SAAS,EAAE,MAAM,CAAA;IAEjB,gBAAgB,EAAE,MAAM,CAAA;IAExB,aAAa,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAQ9C,MAAM,WAAW,OAAO;IAEtB,KAAK,EAAE,MAAM,CAAA;IAEb,KAAK,EAAE,MAAM,CAAA;CACd;AAQD,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAElB,IAAI,EAAE,MAAM,CAAA;IAEZ,UAAU,EAAE,MAAM,CAAA;IAElB,SAAS,EAAE,MAAM,CAAA;IAEjB,gBAAgB,EAAE,MAAM,CAAA;IAExB,aAAa,EAAE,MAAM,CAAA;IAOrB,cAAc,EAAE,MAAM,CAAA;IAEtB,QAAQ,EAAE,MAAM,CAAA;IAKhB,UAAU,EAAE,MAAM,CAAA;IAKlB,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAQD,MAAM,WAAW,yBAAyB;IAExC,wBAAwB,EAAE,MAAM,CAAA;IAEhC,eAAe,EAAE,MAAM,CAAA;CACxB;AAOD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IAEf,YAAY,EAAE,MAAM,CAAA;IAEpB,aAAa,EAAE,MAAM,CAAA;IAErB,KAAK,EAAE,MAAM,CAAA;IAEb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,SAAS,EAAE,MAAM,CAAA;CAClB;AAQD,MAAM,WAAW,OAAO;IAEtB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IAEb,QAAQ,EAAE,MAAM,CAAA;IAMhB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAQD,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,QAAQ,EAAE,OAAO,EAAE,CAAA;IAEnB,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAE7B,SAAS,EAAE,QAAQ,EAAE,CAAA;IAErB,UAAU,EAAE,MAAM,CAAA;IAElB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,aAAa,CAAA;CACtB;AAQD,MAAM,WAAW,cAAc;IAE7B,cAAc,EAAE,MAAM,CAAA;IAEtB,eAAe,EAAE,MAAM,CAAA;IAEvB,UAAU,EAAE,MAAM,CAAA;IAElB,aAAa,EAAE,MAAM,CAAA;CACtB;AAQD,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAOD,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IAEf,IAAI,EAAE,MAAM,CAAA;IAEZ,YAAY,EAAE,MAAM,CAAA;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAOD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAOD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,aAAa,EAAE,YAAY,EAAE,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB;AAOD,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IAMf,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,kBAAkB,CAAA;IAClC,SAAS,EAAE,MAAM,CAAA;IAGjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAQD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAOD,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,UAAU,EAAE,UAAU,CAAA;CACvB;AAQD,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAQD,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAK1B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IAEd,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AASD,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAK7B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IAEd,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAOD,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAA;IAErB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAWD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,YAAY,CAAC,WAAW,CAAA;IAE9B,0BAA0B,CAAC,EAAE,MAAM,CAAA;IAEnC,YAAY,CAAC,EAAE,MAAM,CAAA;IAOrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC1C;AAQD,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B,MAAM,EAAE,aAAa,CAAA;IAKrB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB;AAYD,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC5C,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAA;IAC3B,SAAS,EAAE,IAAI,GAAG,KAAK,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CACE;IAAE,wBAAwB,EAAE,MAAM,CAAC;IAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAAE,GAClE;IAAE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CACrE,CAAA;AAOH,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,gBAAgB,CAAA;AAOpB,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,YAAY,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAUD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAOtD,MAAM,WAAW,6BAA6B;IAC5C,cAAc,EAAE,MAAM,CAAA;IAEtB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAOD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,aAAa,CAAA;IAEvB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,kBAAkB,CAAC,EAAE,6BAA6B,CAAA;CACnD;AAOD,MAAM,WAAW,sBAAsB;IAErC,OAAO,EAAE,MAAM,CAAA;IAEf,OAAO,EAAE,OAAO,CAAA;CACjB;AAUD,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,YAAY,CAAA;AAQzD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;IAKpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IAEnB,kBAAkB,EAAE,MAAM,CAAA;IAM1B,eAAe,EAAE,sBAAsB,EAAE,CAAA;IACzC,qBAAqB,EAAE,OAAO,CAAA;IAE9B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,kBAAkB,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;IASrC,eAAe,EAAE,OAAO,CAAA;CACzB;AAQD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IAEjB,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB,aAAa,EAAE,OAAO,CAAA;IAEtB,gBAAgB,EAAE,OAAO,CAAA;IAEzB,WAAW,EAAE,OAAO,CAAA;IAEpB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAOD,MAAM,MAAM,aAAa,GACrB,wBAAwB,GACxB,oBAAoB,GACpB,iBAAiB,CAAA;AAOrB,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IAEZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;CACxC;AAQD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAA;IAE5B,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB"}
|
package/dist/esm/account.d.ts
CHANGED
|
@@ -33,6 +33,13 @@ export interface Position {
|
|
|
33
33
|
liquidationPrice: string;
|
|
34
34
|
/** Unrealized PnL in quote-currency units. */
|
|
35
35
|
unrealizedPnl: string;
|
|
36
|
+
/**
|
|
37
|
+
* Funding this position accrued since it opened, in quote-currency units.
|
|
38
|
+
* Positive means the account received funding and negative means the account
|
|
39
|
+
* paid it, matching {@link FundingActivity} amounts. Every venue resets the
|
|
40
|
+
* value when the position returns to flat.
|
|
41
|
+
*/
|
|
42
|
+
accruedFunding: string;
|
|
36
43
|
/** Position leverage as a numeric multiple. */
|
|
37
44
|
leverage: number;
|
|
38
45
|
/**
|
|
@@ -69,8 +76,10 @@ export interface OpenOrder {
|
|
|
69
76
|
market: MarketDisplay;
|
|
70
77
|
side: OrderSide;
|
|
71
78
|
type: OrderType;
|
|
72
|
-
/**
|
|
73
|
-
|
|
79
|
+
/** Quantity the order was submitted for, in base-asset units. */
|
|
80
|
+
originalSize: string;
|
|
81
|
+
/** Quantity still resting on the book, in base-asset units. */
|
|
82
|
+
remainingSize: string;
|
|
74
83
|
/** Limit/order price in quote-asset units. */
|
|
75
84
|
price: string;
|
|
76
85
|
/** Quantity already filled in base-asset units. */
|
|
@@ -251,26 +260,39 @@ export interface BaseActivity {
|
|
|
251
260
|
timestamp: string;
|
|
252
261
|
}
|
|
253
262
|
/**
|
|
254
|
-
* Account activity representing a completed deposit.
|
|
263
|
+
* Account activity representing a completed deposit. `amount` is a decimal
|
|
264
|
+
* string in `asset`'s units.
|
|
255
265
|
*
|
|
256
266
|
* @public
|
|
257
267
|
*/
|
|
258
268
|
export interface DepositActivity extends BaseActivity {
|
|
259
269
|
type: ActivityType.DEPOSIT;
|
|
270
|
+
/**
|
|
271
|
+
* Display symbol of the deposited asset, resolved by the provider adapter.
|
|
272
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
273
|
+
*/
|
|
274
|
+
asset: string;
|
|
260
275
|
amount: string;
|
|
261
276
|
/** Fully-resolved block-explorer URL for the on-chain deposit tx. */
|
|
262
277
|
explorerLink?: string;
|
|
263
278
|
}
|
|
264
279
|
/**
|
|
265
280
|
* Account activity representing a completed withdrawal. `amount` and `fee`
|
|
266
|
-
* are decimal strings in
|
|
281
|
+
* are decimal strings in `asset`'s units — a withdrawal fee is always
|
|
282
|
+
* denominated in the withdrawn asset.
|
|
267
283
|
*
|
|
268
284
|
* @public
|
|
269
285
|
*/
|
|
270
286
|
export interface WithdrawalActivity extends BaseActivity {
|
|
271
287
|
type: ActivityType.WITHDRAWAL;
|
|
288
|
+
/**
|
|
289
|
+
* Display symbol of the withdrawn asset, resolved by the provider adapter.
|
|
290
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
291
|
+
*/
|
|
292
|
+
asset: string;
|
|
272
293
|
amount: string;
|
|
273
|
-
fee
|
|
294
|
+
/** Absent when the venue reports no fee for the withdrawal. */
|
|
295
|
+
fee?: string;
|
|
274
296
|
/** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
|
|
275
297
|
explorerLink?: string;
|
|
276
298
|
}
|
|
@@ -281,21 +303,29 @@ export interface WithdrawalActivity extends BaseActivity {
|
|
|
281
303
|
*/
|
|
282
304
|
export interface LiquidatedPosition {
|
|
283
305
|
market: MarketDisplay;
|
|
284
|
-
size
|
|
306
|
+
/** Absent when the venue reports no liquidated size for the position. */
|
|
307
|
+
size?: string;
|
|
285
308
|
}
|
|
286
309
|
/**
|
|
287
|
-
* Account activity representing a liquidation event.
|
|
310
|
+
* Account activity representing a liquidation event. `liquidatedPositions` is
|
|
311
|
+
* never empty: a provider adapter drops any record whose positions it cannot
|
|
312
|
+
* identify. A venue that liquidates several cross-margin positions in one
|
|
313
|
+
* cascade reports them as one activity with several entries, so consumers
|
|
314
|
+
* must never group activities by timestamp.
|
|
288
315
|
*
|
|
289
316
|
* @public
|
|
290
317
|
*/
|
|
291
318
|
export interface LiquidationActivity extends BaseActivity {
|
|
292
319
|
type: ActivityType.LIQUIDATION;
|
|
293
|
-
|
|
294
|
-
|
|
320
|
+
/** Absent when the venue reports no liquidated notional. */
|
|
321
|
+
liquidatedNotionalPosition?: string;
|
|
322
|
+
/** Absent when the venue reports no account value at liquidation time. */
|
|
323
|
+
accountValue?: string;
|
|
295
324
|
/**
|
|
296
325
|
* Margin mode the liquidated account ran under, in the venue's own
|
|
297
|
-
* vocabulary
|
|
298
|
-
* margin mode on a
|
|
326
|
+
* vocabulary — typically `cross` or `isolated`, but the venue may report
|
|
327
|
+
* any string. Absent when the venue reports no margin mode on a
|
|
328
|
+
* liquidation row.
|
|
299
329
|
*/
|
|
300
330
|
leverageType?: string;
|
|
301
331
|
liquidatedPositions: LiquidatedPosition[];
|
|
@@ -309,13 +339,19 @@ export interface LiquidationActivity extends BaseActivity {
|
|
|
309
339
|
export interface FundingActivity extends BaseActivity {
|
|
310
340
|
type: ActivityType.FUNDING;
|
|
311
341
|
market: MarketDisplay;
|
|
342
|
+
/**
|
|
343
|
+
* Signed, in quote-currency units. Positive means the account received
|
|
344
|
+
* funding; negative means the account paid it.
|
|
345
|
+
*/
|
|
312
346
|
amount: string;
|
|
313
347
|
positionSize: string;
|
|
314
348
|
fundingRate: string;
|
|
315
349
|
}
|
|
316
350
|
/**
|
|
317
|
-
* Account activity representing an inbound or outbound transfer
|
|
318
|
-
* counterparty identifier is required by the
|
|
351
|
+
* Account activity representing an inbound or outbound transfer between two
|
|
352
|
+
* distinct accounts. At least one counterparty identifier is required by the
|
|
353
|
+
* type-level union below. Same-account movements — a venue's own route or
|
|
354
|
+
* margin-location moves — are never reported as transfers.
|
|
319
355
|
*
|
|
320
356
|
* @public
|
|
321
357
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAClB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAA;IACxB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAA;IACrB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,+DAA+D;IAC/D,wBAAwB,EAAE,MAAM,CAAA;IAChC,mEAAmE;IACnE,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAClB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAA;IACxB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAA;IACtB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,+DAA+D;IAC/D,wBAAwB,EAAE,MAAM,CAAA;IAChC,mEAAmE;IACnE,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,iEAAiE;IACjE,YAAY,EAAE,MAAM,CAAA;IACpB,+DAA+D;IAC/D,aAAa,EAAE,MAAM,CAAA;IACrB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAA;IACb,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,yFAAyF;IACzF,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,oFAAoF;IACpF,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,qCAAqC;IACrC,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,mFAAmF;IACnF,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAC7B,iGAAiG;IACjG,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,aAAa,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAA;IACtB,wDAAwD;IACxD,eAAe,EAAE,MAAM,CAAA;IACvB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;IAClB,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,YAAY,EAAE,MAAM,CAAA;IACpB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,aAAa,EAAE,YAAY,EAAE,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,kBAAkB,CAAA;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB;iDAC6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAC7B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAA;IACrB,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,YAAY,CAAC,WAAW,CAAA;IAC9B,4DAA4D;IAC5D,0BAA0B,CAAC,EAAE,MAAM,CAAA;IACnC,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB;AAID;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC5C,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAA;IAC3B,SAAS,EAAE,IAAI,GAAG,KAAK,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,sEAAsE;IACtE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CACE;IAAE,wBAAwB,EAAE,MAAM,CAAC;IAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAAE,GAClE;IAAE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CACrE,CAAA;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,gBAAgB,CAAA;AAEpB;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,YAAY,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAID;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEtD;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,cAAc,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,aAAa,CAAA;IACvB,mDAAmD;IACnD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,kBAAkB,CAAC,EAAE,6BAA6B,CAAA;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAA;IACf,mFAAmF;IACnF,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,YAAY,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,uEAAuE;IACvE,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,eAAe,EAAE,sBAAsB,EAAE,CAAA;IACzC,qBAAqB,EAAE,OAAO,CAAA;IAC9B,6EAA6E;IAC7E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,+DAA+D;IAC/D,kBAAkB,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;IACrC;;;;;;;OAOG;IACH,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,0FAA0F;IAC1F,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,+GAA+G;IAC/G,aAAa,EAAE,OAAO,CAAA;IACtB,8GAA8G;IAC9G,gBAAgB,EAAE,OAAO,CAAA;IACzB,0GAA0G;IAC1G,WAAW,EAAE,OAAO,CAAA;IACpB,mFAAmF;IACnF,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,wBAAwB,GACxB,oBAAoB,GACpB,iBAAiB,CAAA;AAErB;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,qFAAqF;IACrF,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAA;IAC5B,qGAAqG;IACrG,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB"}
|
package/dist/types/account.d.ts
CHANGED
|
@@ -33,6 +33,13 @@ export interface Position {
|
|
|
33
33
|
liquidationPrice: string;
|
|
34
34
|
/** Unrealized PnL in quote-currency units. */
|
|
35
35
|
unrealizedPnl: string;
|
|
36
|
+
/**
|
|
37
|
+
* Funding this position accrued since it opened, in quote-currency units.
|
|
38
|
+
* Positive means the account received funding and negative means the account
|
|
39
|
+
* paid it, matching {@link FundingActivity} amounts. Every venue resets the
|
|
40
|
+
* value when the position returns to flat.
|
|
41
|
+
*/
|
|
42
|
+
accruedFunding: string;
|
|
36
43
|
/** Position leverage as a numeric multiple. */
|
|
37
44
|
leverage: number;
|
|
38
45
|
/**
|
|
@@ -69,8 +76,10 @@ export interface OpenOrder {
|
|
|
69
76
|
market: MarketDisplay;
|
|
70
77
|
side: OrderSide;
|
|
71
78
|
type: OrderType;
|
|
72
|
-
/**
|
|
73
|
-
|
|
79
|
+
/** Quantity the order was submitted for, in base-asset units. */
|
|
80
|
+
originalSize: string;
|
|
81
|
+
/** Quantity still resting on the book, in base-asset units. */
|
|
82
|
+
remainingSize: string;
|
|
74
83
|
/** Limit/order price in quote-asset units. */
|
|
75
84
|
price: string;
|
|
76
85
|
/** Quantity already filled in base-asset units. */
|
|
@@ -251,26 +260,39 @@ export interface BaseActivity {
|
|
|
251
260
|
timestamp: string;
|
|
252
261
|
}
|
|
253
262
|
/**
|
|
254
|
-
* Account activity representing a completed deposit.
|
|
263
|
+
* Account activity representing a completed deposit. `amount` is a decimal
|
|
264
|
+
* string in `asset`'s units.
|
|
255
265
|
*
|
|
256
266
|
* @public
|
|
257
267
|
*/
|
|
258
268
|
export interface DepositActivity extends BaseActivity {
|
|
259
269
|
type: ActivityType.DEPOSIT;
|
|
270
|
+
/**
|
|
271
|
+
* Display symbol of the deposited asset, resolved by the provider adapter.
|
|
272
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
273
|
+
*/
|
|
274
|
+
asset: string;
|
|
260
275
|
amount: string;
|
|
261
276
|
/** Fully-resolved block-explorer URL for the on-chain deposit tx. */
|
|
262
277
|
explorerLink?: string;
|
|
263
278
|
}
|
|
264
279
|
/**
|
|
265
280
|
* Account activity representing a completed withdrawal. `amount` and `fee`
|
|
266
|
-
* are decimal strings in
|
|
281
|
+
* are decimal strings in `asset`'s units — a withdrawal fee is always
|
|
282
|
+
* denominated in the withdrawn asset.
|
|
267
283
|
*
|
|
268
284
|
* @public
|
|
269
285
|
*/
|
|
270
286
|
export interface WithdrawalActivity extends BaseActivity {
|
|
271
287
|
type: ActivityType.WITHDRAWAL;
|
|
288
|
+
/**
|
|
289
|
+
* Display symbol of the withdrawn asset, resolved by the provider adapter.
|
|
290
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
291
|
+
*/
|
|
292
|
+
asset: string;
|
|
272
293
|
amount: string;
|
|
273
|
-
fee
|
|
294
|
+
/** Absent when the venue reports no fee for the withdrawal. */
|
|
295
|
+
fee?: string;
|
|
274
296
|
/** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
|
|
275
297
|
explorerLink?: string;
|
|
276
298
|
}
|
|
@@ -281,21 +303,29 @@ export interface WithdrawalActivity extends BaseActivity {
|
|
|
281
303
|
*/
|
|
282
304
|
export interface LiquidatedPosition {
|
|
283
305
|
market: MarketDisplay;
|
|
284
|
-
size
|
|
306
|
+
/** Absent when the venue reports no liquidated size for the position. */
|
|
307
|
+
size?: string;
|
|
285
308
|
}
|
|
286
309
|
/**
|
|
287
|
-
* Account activity representing a liquidation event.
|
|
310
|
+
* Account activity representing a liquidation event. `liquidatedPositions` is
|
|
311
|
+
* never empty: a provider adapter drops any record whose positions it cannot
|
|
312
|
+
* identify. A venue that liquidates several cross-margin positions in one
|
|
313
|
+
* cascade reports them as one activity with several entries, so consumers
|
|
314
|
+
* must never group activities by timestamp.
|
|
288
315
|
*
|
|
289
316
|
* @public
|
|
290
317
|
*/
|
|
291
318
|
export interface LiquidationActivity extends BaseActivity {
|
|
292
319
|
type: ActivityType.LIQUIDATION;
|
|
293
|
-
|
|
294
|
-
|
|
320
|
+
/** Absent when the venue reports no liquidated notional. */
|
|
321
|
+
liquidatedNotionalPosition?: string;
|
|
322
|
+
/** Absent when the venue reports no account value at liquidation time. */
|
|
323
|
+
accountValue?: string;
|
|
295
324
|
/**
|
|
296
325
|
* Margin mode the liquidated account ran under, in the venue's own
|
|
297
|
-
* vocabulary
|
|
298
|
-
* margin mode on a
|
|
326
|
+
* vocabulary — typically `cross` or `isolated`, but the venue may report
|
|
327
|
+
* any string. Absent when the venue reports no margin mode on a
|
|
328
|
+
* liquidation row.
|
|
299
329
|
*/
|
|
300
330
|
leverageType?: string;
|
|
301
331
|
liquidatedPositions: LiquidatedPosition[];
|
|
@@ -309,13 +339,19 @@ export interface LiquidationActivity extends BaseActivity {
|
|
|
309
339
|
export interface FundingActivity extends BaseActivity {
|
|
310
340
|
type: ActivityType.FUNDING;
|
|
311
341
|
market: MarketDisplay;
|
|
342
|
+
/**
|
|
343
|
+
* Signed, in quote-currency units. Positive means the account received
|
|
344
|
+
* funding; negative means the account paid it.
|
|
345
|
+
*/
|
|
312
346
|
amount: string;
|
|
313
347
|
positionSize: string;
|
|
314
348
|
fundingRate: string;
|
|
315
349
|
}
|
|
316
350
|
/**
|
|
317
|
-
* Account activity representing an inbound or outbound transfer
|
|
318
|
-
* counterparty identifier is required by the
|
|
351
|
+
* Account activity representing an inbound or outbound transfer between two
|
|
352
|
+
* distinct accounts. At least one counterparty identifier is required by the
|
|
353
|
+
* type-level union below. Same-account movements — a venue's own route or
|
|
354
|
+
* margin-location moves — are never reported as transfers.
|
|
319
355
|
*
|
|
320
356
|
* @public
|
|
321
357
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAClB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAA;IACxB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAA;IACrB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,+DAA+D;IAC/D,wBAAwB,EAAE,MAAM,CAAA;IAChC,mEAAmE;IACnE,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACb,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAClB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAA;IACxB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAA;IACtB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,+DAA+D;IAC/D,wBAAwB,EAAE,MAAM,CAAA;IAChC,mEAAmE;IACnE,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,iEAAiE;IACjE,YAAY,EAAE,MAAM,CAAA;IACpB,+DAA+D;IAC/D,aAAa,EAAE,MAAM,CAAA;IACrB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAA;IACb,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,yFAAyF;IACzF,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,oFAAoF;IACpF,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,qCAAqC;IACrC,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,mFAAmF;IACnF,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAC7B,iGAAiG;IACjG,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,aAAa,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAA;IACtB,wDAAwD;IACxD,eAAe,EAAE,MAAM,CAAA;IACvB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;IAClB,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,YAAY,EAAE,MAAM,CAAA;IACpB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,aAAa,EAAE,YAAY,EAAE,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,kBAAkB,CAAA;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB;iDAC6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAC7B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAA;IACrB,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,YAAY,CAAC,WAAW,CAAA;IAC9B,4DAA4D;IAC5D,0BAA0B,CAAC,EAAE,MAAM,CAAA;IACnC,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,YAAY,CAAC,OAAO,CAAA;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB;AAID;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC5C,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAA;IAC3B,SAAS,EAAE,IAAI,GAAG,KAAK,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,sEAAsE;IACtE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CACE;IAAE,wBAAwB,EAAE,MAAM,CAAC;IAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAAE,GAClE;IAAE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CACrE,CAAA;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,gBAAgB,CAAA;AAEpB;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,YAAY,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAID;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEtD;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,cAAc,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,aAAa,CAAA;IACvB,mDAAmD;IACnD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,kBAAkB,CAAC,EAAE,6BAA6B,CAAA;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAA;IACf,mFAAmF;IACnF,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,YAAY,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,uEAAuE;IACvE,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,eAAe,EAAE,sBAAsB,EAAE,CAAA;IACzC,qBAAqB,EAAE,OAAO,CAAA;IAC9B,6EAA6E;IAC7E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,+DAA+D;IAC/D,kBAAkB,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;IACrC;;;;;;;OAOG;IACH,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,0FAA0F;IAC1F,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,+GAA+G;IAC/G,aAAa,EAAE,OAAO,CAAA;IACtB,8GAA8G;IAC9G,gBAAgB,EAAE,OAAO,CAAA;IACzB,0GAA0G;IAC1G,WAAW,EAAE,OAAO,CAAA;IACpB,mFAAmF;IACnF,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,wBAAwB,GACxB,oBAAoB,GACpB,iBAAiB,CAAA;AAErB;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,qFAAqF;IACrF,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAA;IAC5B,qGAAqG;IACrG,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB"}
|
package/package.json
CHANGED
package/src/account.ts
CHANGED
|
@@ -45,6 +45,13 @@ export interface Position {
|
|
|
45
45
|
liquidationPrice: string
|
|
46
46
|
/** Unrealized PnL in quote-currency units. */
|
|
47
47
|
unrealizedPnl: string
|
|
48
|
+
/**
|
|
49
|
+
* Funding this position accrued since it opened, in quote-currency units.
|
|
50
|
+
* Positive means the account received funding and negative means the account
|
|
51
|
+
* paid it, matching {@link FundingActivity} amounts. Every venue resets the
|
|
52
|
+
* value when the position returns to flat.
|
|
53
|
+
*/
|
|
54
|
+
accruedFunding: string
|
|
48
55
|
/** Position leverage as a numeric multiple. */
|
|
49
56
|
leverage: number
|
|
50
57
|
/**
|
|
@@ -83,8 +90,10 @@ export interface OpenOrder {
|
|
|
83
90
|
market: MarketDisplay
|
|
84
91
|
side: OrderSide
|
|
85
92
|
type: OrderType
|
|
86
|
-
/**
|
|
87
|
-
|
|
93
|
+
/** Quantity the order was submitted for, in base-asset units. */
|
|
94
|
+
originalSize: string
|
|
95
|
+
/** Quantity still resting on the book, in base-asset units. */
|
|
96
|
+
remainingSize: string
|
|
88
97
|
/** Limit/order price in quote-asset units. */
|
|
89
98
|
price: string
|
|
90
99
|
/** Quantity already filled in base-asset units. */
|
|
@@ -277,12 +286,18 @@ export interface BaseActivity {
|
|
|
277
286
|
}
|
|
278
287
|
|
|
279
288
|
/**
|
|
280
|
-
* Account activity representing a completed deposit.
|
|
289
|
+
* Account activity representing a completed deposit. `amount` is a decimal
|
|
290
|
+
* string in `asset`'s units.
|
|
281
291
|
*
|
|
282
292
|
* @public
|
|
283
293
|
*/
|
|
284
294
|
export interface DepositActivity extends BaseActivity {
|
|
285
295
|
type: ActivityType.DEPOSIT
|
|
296
|
+
/**
|
|
297
|
+
* Display symbol of the deposited asset, resolved by the provider adapter.
|
|
298
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
299
|
+
*/
|
|
300
|
+
asset: string
|
|
286
301
|
amount: string
|
|
287
302
|
/** Fully-resolved block-explorer URL for the on-chain deposit tx. */
|
|
288
303
|
explorerLink?: string
|
|
@@ -290,14 +305,21 @@ export interface DepositActivity extends BaseActivity {
|
|
|
290
305
|
|
|
291
306
|
/**
|
|
292
307
|
* Account activity representing a completed withdrawal. `amount` and `fee`
|
|
293
|
-
* are decimal strings in
|
|
308
|
+
* are decimal strings in `asset`'s units — a withdrawal fee is always
|
|
309
|
+
* denominated in the withdrawn asset.
|
|
294
310
|
*
|
|
295
311
|
* @public
|
|
296
312
|
*/
|
|
297
313
|
export interface WithdrawalActivity extends BaseActivity {
|
|
298
314
|
type: ActivityType.WITHDRAWAL
|
|
315
|
+
/**
|
|
316
|
+
* Display symbol of the withdrawn asset, resolved by the provider adapter.
|
|
317
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
318
|
+
*/
|
|
319
|
+
asset: string
|
|
299
320
|
amount: string
|
|
300
|
-
fee
|
|
321
|
+
/** Absent when the venue reports no fee for the withdrawal. */
|
|
322
|
+
fee?: string
|
|
301
323
|
/** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
|
|
302
324
|
explorerLink?: string
|
|
303
325
|
}
|
|
@@ -309,22 +331,30 @@ export interface WithdrawalActivity extends BaseActivity {
|
|
|
309
331
|
*/
|
|
310
332
|
export interface LiquidatedPosition {
|
|
311
333
|
market: MarketDisplay
|
|
312
|
-
size
|
|
334
|
+
/** Absent when the venue reports no liquidated size for the position. */
|
|
335
|
+
size?: string
|
|
313
336
|
}
|
|
314
337
|
|
|
315
338
|
/**
|
|
316
|
-
* Account activity representing a liquidation event.
|
|
339
|
+
* Account activity representing a liquidation event. `liquidatedPositions` is
|
|
340
|
+
* never empty: a provider adapter drops any record whose positions it cannot
|
|
341
|
+
* identify. A venue that liquidates several cross-margin positions in one
|
|
342
|
+
* cascade reports them as one activity with several entries, so consumers
|
|
343
|
+
* must never group activities by timestamp.
|
|
317
344
|
*
|
|
318
345
|
* @public
|
|
319
346
|
*/
|
|
320
347
|
export interface LiquidationActivity extends BaseActivity {
|
|
321
348
|
type: ActivityType.LIQUIDATION
|
|
322
|
-
|
|
323
|
-
|
|
349
|
+
/** Absent when the venue reports no liquidated notional. */
|
|
350
|
+
liquidatedNotionalPosition?: string
|
|
351
|
+
/** Absent when the venue reports no account value at liquidation time. */
|
|
352
|
+
accountValue?: string
|
|
324
353
|
/**
|
|
325
354
|
* Margin mode the liquidated account ran under, in the venue's own
|
|
326
|
-
* vocabulary
|
|
327
|
-
* margin mode on a
|
|
355
|
+
* vocabulary — typically `cross` or `isolated`, but the venue may report
|
|
356
|
+
* any string. Absent when the venue reports no margin mode on a
|
|
357
|
+
* liquidation row.
|
|
328
358
|
*/
|
|
329
359
|
leverageType?: string
|
|
330
360
|
liquidatedPositions: LiquidatedPosition[]
|
|
@@ -339,6 +369,10 @@ export interface LiquidationActivity extends BaseActivity {
|
|
|
339
369
|
export interface FundingActivity extends BaseActivity {
|
|
340
370
|
type: ActivityType.FUNDING
|
|
341
371
|
market: MarketDisplay
|
|
372
|
+
/**
|
|
373
|
+
* Signed, in quote-currency units. Positive means the account received
|
|
374
|
+
* funding; negative means the account paid it.
|
|
375
|
+
*/
|
|
342
376
|
amount: string
|
|
343
377
|
positionSize: string
|
|
344
378
|
fundingRate: string
|
|
@@ -347,8 +381,10 @@ export interface FundingActivity extends BaseActivity {
|
|
|
347
381
|
// At least one of `counterpartyAccountIndex` / `counterpartyAddress` is always
|
|
348
382
|
// present; both may appear together.
|
|
349
383
|
/**
|
|
350
|
-
* Account activity representing an inbound or outbound transfer
|
|
351
|
-
* counterparty identifier is required by the
|
|
384
|
+
* Account activity representing an inbound or outbound transfer between two
|
|
385
|
+
* distinct accounts. At least one counterparty identifier is required by the
|
|
386
|
+
* type-level union below. Same-account movements — a venue's own route or
|
|
387
|
+
* margin-location moves — are never reported as transfers.
|
|
352
388
|
*
|
|
353
389
|
* @public
|
|
354
390
|
*/
|