@lifi/perps-types 9.0.0 → 10.0.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/dist/cjs/account.d.ts +15 -7
- package/dist/cjs/account.d.ts.map +1 -1
- package/dist/esm/account.d.ts +74 -14
- package/dist/esm/account.d.ts.map +1 -1
- package/dist/types/account.d.ts +74 -14
- package/dist/types/account.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/account.ts +75 -14
package/dist/cjs/account.d.ts
CHANGED
|
@@ -29,7 +29,8 @@ export interface OpenOrder {
|
|
|
29
29
|
market: MarketDisplay;
|
|
30
30
|
side: OrderSide;
|
|
31
31
|
type: OrderType;
|
|
32
|
-
|
|
32
|
+
originalSize: string;
|
|
33
|
+
remainingSize: string;
|
|
33
34
|
price: string;
|
|
34
35
|
filledSize: string;
|
|
35
36
|
reduceOnly: boolean;
|
|
@@ -85,6 +86,10 @@ export interface OrdersResponse {
|
|
|
85
86
|
triggerOrders: TriggerOrder[];
|
|
86
87
|
pagination: Pagination;
|
|
87
88
|
}
|
|
89
|
+
export interface Fee {
|
|
90
|
+
amount: string;
|
|
91
|
+
asset: string;
|
|
92
|
+
}
|
|
88
93
|
export interface Fill {
|
|
89
94
|
id: string;
|
|
90
95
|
orderId: string;
|
|
@@ -96,7 +101,7 @@ export interface Fill {
|
|
|
96
101
|
status: FillStatus;
|
|
97
102
|
liquidity: LiquidityRole;
|
|
98
103
|
filledSize?: string;
|
|
99
|
-
fee?:
|
|
104
|
+
fee?: Fee;
|
|
100
105
|
realizedPnl?: string | null;
|
|
101
106
|
startPosition?: string;
|
|
102
107
|
classification: FillClassification;
|
|
@@ -121,24 +126,26 @@ export interface BaseActivity {
|
|
|
121
126
|
}
|
|
122
127
|
export interface DepositActivity extends BaseActivity {
|
|
123
128
|
type: ActivityType.DEPOSIT;
|
|
129
|
+
asset: string;
|
|
124
130
|
amount: string;
|
|
125
131
|
explorerLink?: string;
|
|
126
132
|
}
|
|
127
133
|
export interface WithdrawalActivity extends BaseActivity {
|
|
128
134
|
type: ActivityType.WITHDRAWAL;
|
|
135
|
+
asset: string;
|
|
129
136
|
amount: string;
|
|
130
|
-
fee
|
|
137
|
+
fee?: Fee;
|
|
131
138
|
explorerLink?: string;
|
|
132
139
|
}
|
|
133
140
|
export interface LiquidatedPosition {
|
|
134
141
|
market: MarketDisplay;
|
|
135
|
-
size
|
|
142
|
+
size?: string;
|
|
136
143
|
}
|
|
137
144
|
export interface LiquidationActivity extends BaseActivity {
|
|
138
145
|
type: ActivityType.LIQUIDATION;
|
|
139
|
-
liquidatedNotionalPosition
|
|
140
|
-
accountValue
|
|
141
|
-
leverageType
|
|
146
|
+
liquidatedNotionalPosition?: string;
|
|
147
|
+
accountValue?: string;
|
|
148
|
+
leverageType?: string;
|
|
142
149
|
liquidatedPositions: LiquidatedPosition[];
|
|
143
150
|
}
|
|
144
151
|
export interface FundingActivity extends BaseActivity {
|
|
@@ -153,6 +160,7 @@ export type TransferActivity = BaseActivity & {
|
|
|
153
160
|
direction: 'IN' | 'OUT';
|
|
154
161
|
asset: string;
|
|
155
162
|
amount: string;
|
|
163
|
+
fees?: Fee[];
|
|
156
164
|
meta?: Record<string, unknown>;
|
|
157
165
|
explorerLink?: string;
|
|
158
166
|
} & ({
|
|
@@ -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;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,
|
|
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;AAUD,MAAM,WAAW,GAAG;IAElB,MAAM,EAAE,MAAM,CAAA;IAMd,KAAK,EAAE,MAAM,CAAA;CACd;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;IAEnB,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,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;AAQD,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,GAAG,CAAA;IAET,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;IAQd,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,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
|
@@ -76,8 +76,10 @@ export interface OpenOrder {
|
|
|
76
76
|
market: MarketDisplay;
|
|
77
77
|
side: OrderSide;
|
|
78
78
|
type: OrderType;
|
|
79
|
-
/**
|
|
80
|
-
|
|
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;
|
|
81
83
|
/** Limit/order price in quote-asset units. */
|
|
82
84
|
price: string;
|
|
83
85
|
/** Quantity already filled in base-asset units. */
|
|
@@ -194,6 +196,24 @@ export interface OrdersResponse {
|
|
|
194
196
|
triggerOrders: TriggerOrder[];
|
|
195
197
|
pagination: Pagination;
|
|
196
198
|
}
|
|
199
|
+
/**
|
|
200
|
+
* Fee a venue charged, in the asset the venue charged it in. A venue does not
|
|
201
|
+
* always charge a fee in the asset the record is otherwise denominated in, so
|
|
202
|
+
* a consumer must format the amount against `asset` and never against the
|
|
203
|
+
* fill's quote asset or the activity's own `asset`.
|
|
204
|
+
*
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
export interface Fee {
|
|
208
|
+
/** Decimal string in `asset`'s units. */
|
|
209
|
+
amount: string;
|
|
210
|
+
/**
|
|
211
|
+
* Display symbol the fee is denominated in, resolved by the provider
|
|
212
|
+
* adapter. Falls back to the venue's own asset id when the registry knows no
|
|
213
|
+
* symbol.
|
|
214
|
+
*/
|
|
215
|
+
asset: string;
|
|
216
|
+
}
|
|
197
217
|
/**
|
|
198
218
|
* Normalized execution/fill record for an order.
|
|
199
219
|
*
|
|
@@ -215,7 +235,8 @@ export interface Fill {
|
|
|
215
235
|
status: FillStatus;
|
|
216
236
|
liquidity: LiquidityRole;
|
|
217
237
|
filledSize?: string;
|
|
218
|
-
fee
|
|
238
|
+
/** Absent when the venue reports no fee for the fill. */
|
|
239
|
+
fee?: Fee;
|
|
219
240
|
realizedPnl?: string | null;
|
|
220
241
|
startPosition?: string;
|
|
221
242
|
classification: FillClassification;
|
|
@@ -258,26 +279,38 @@ export interface BaseActivity {
|
|
|
258
279
|
timestamp: string;
|
|
259
280
|
}
|
|
260
281
|
/**
|
|
261
|
-
* Account activity representing a completed deposit.
|
|
282
|
+
* Account activity representing a completed deposit. `amount` is a decimal
|
|
283
|
+
* string in `asset`'s units.
|
|
262
284
|
*
|
|
263
285
|
* @public
|
|
264
286
|
*/
|
|
265
287
|
export interface DepositActivity extends BaseActivity {
|
|
266
288
|
type: ActivityType.DEPOSIT;
|
|
289
|
+
/**
|
|
290
|
+
* Display symbol of the deposited asset, resolved by the provider adapter.
|
|
291
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
292
|
+
*/
|
|
293
|
+
asset: string;
|
|
267
294
|
amount: string;
|
|
268
295
|
/** Fully-resolved block-explorer URL for the on-chain deposit tx. */
|
|
269
296
|
explorerLink?: string;
|
|
270
297
|
}
|
|
271
298
|
/**
|
|
272
|
-
* Account activity representing a completed withdrawal. `amount`
|
|
273
|
-
*
|
|
299
|
+
* Account activity representing a completed withdrawal. `amount` is a decimal
|
|
300
|
+
* string in `asset`'s units.
|
|
274
301
|
*
|
|
275
302
|
* @public
|
|
276
303
|
*/
|
|
277
304
|
export interface WithdrawalActivity extends BaseActivity {
|
|
278
305
|
type: ActivityType.WITHDRAWAL;
|
|
306
|
+
/**
|
|
307
|
+
* Display symbol of the withdrawn asset, resolved by the provider adapter.
|
|
308
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
309
|
+
*/
|
|
310
|
+
asset: string;
|
|
279
311
|
amount: string;
|
|
280
|
-
fee
|
|
312
|
+
/** Absent when the venue reports no fee for the withdrawal. */
|
|
313
|
+
fee?: Fee;
|
|
281
314
|
/** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
|
|
282
315
|
explorerLink?: string;
|
|
283
316
|
}
|
|
@@ -288,18 +321,31 @@ export interface WithdrawalActivity extends BaseActivity {
|
|
|
288
321
|
*/
|
|
289
322
|
export interface LiquidatedPosition {
|
|
290
323
|
market: MarketDisplay;
|
|
291
|
-
size
|
|
324
|
+
/** Absent when the venue reports no liquidated size for the position. */
|
|
325
|
+
size?: string;
|
|
292
326
|
}
|
|
293
327
|
/**
|
|
294
|
-
* Account activity representing a liquidation event.
|
|
328
|
+
* Account activity representing a liquidation event. `liquidatedPositions` is
|
|
329
|
+
* never empty: a provider adapter drops any record whose positions it cannot
|
|
330
|
+
* identify. A venue that liquidates several cross-margin positions in one
|
|
331
|
+
* cascade reports them as one activity with several entries, so consumers
|
|
332
|
+
* must never group activities by timestamp.
|
|
295
333
|
*
|
|
296
334
|
* @public
|
|
297
335
|
*/
|
|
298
336
|
export interface LiquidationActivity extends BaseActivity {
|
|
299
337
|
type: ActivityType.LIQUIDATION;
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
338
|
+
/** Absent when the venue reports no liquidated notional. */
|
|
339
|
+
liquidatedNotionalPosition?: string;
|
|
340
|
+
/** Absent when the venue reports no account value at liquidation time. */
|
|
341
|
+
accountValue?: string;
|
|
342
|
+
/**
|
|
343
|
+
* Margin mode the liquidated account ran under, in the venue's own
|
|
344
|
+
* vocabulary — typically `cross` or `isolated`, but the venue may report
|
|
345
|
+
* any string. Absent when the venue reports no margin mode on a
|
|
346
|
+
* liquidation row.
|
|
347
|
+
*/
|
|
348
|
+
leverageType?: string;
|
|
303
349
|
liquidatedPositions: LiquidatedPosition[];
|
|
304
350
|
}
|
|
305
351
|
/**
|
|
@@ -311,13 +357,19 @@ export interface LiquidationActivity extends BaseActivity {
|
|
|
311
357
|
export interface FundingActivity extends BaseActivity {
|
|
312
358
|
type: ActivityType.FUNDING;
|
|
313
359
|
market: MarketDisplay;
|
|
360
|
+
/**
|
|
361
|
+
* Signed, in quote-currency units. Positive means the account received
|
|
362
|
+
* funding; negative means the account paid it.
|
|
363
|
+
*/
|
|
314
364
|
amount: string;
|
|
315
365
|
positionSize: string;
|
|
316
366
|
fundingRate: string;
|
|
317
367
|
}
|
|
318
368
|
/**
|
|
319
|
-
* Account activity representing an inbound or outbound transfer
|
|
320
|
-
* counterparty identifier is required by the
|
|
369
|
+
* Account activity representing an inbound or outbound transfer between two
|
|
370
|
+
* distinct accounts. At least one counterparty identifier is required by the
|
|
371
|
+
* type-level union below. Same-account movements — a venue's own route or
|
|
372
|
+
* margin-location moves — are never reported as transfers.
|
|
321
373
|
*
|
|
322
374
|
* @public
|
|
323
375
|
*/
|
|
@@ -326,6 +378,14 @@ export type TransferActivity = BaseActivity & {
|
|
|
326
378
|
direction: 'IN' | 'OUT';
|
|
327
379
|
asset: string;
|
|
328
380
|
amount: string;
|
|
381
|
+
/**
|
|
382
|
+
* Every fee the venue charged for the transfer, in the order the venue
|
|
383
|
+
* reports them. A venue may charge several fees for one transfer, each in a
|
|
384
|
+
* different asset — a transfer fee plus a separate gas fee in the chain's
|
|
385
|
+
* native token — so this is a list and not a single amount. Absent when the
|
|
386
|
+
* venue reports no fee.
|
|
387
|
+
*/
|
|
388
|
+
fees?: Fee[];
|
|
329
389
|
meta?: Record<string, unknown>;
|
|
330
390
|
/** Fully-resolved block-explorer URL for the on-chain transfer tx. */
|
|
331
391
|
explorerLink?: string;
|
|
@@ -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;;;;;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,
|
|
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;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG;IAClB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;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,yDAAyD;IACzD,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,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;;;;;GAKG;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,GAAG,CAAA;IACT,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;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,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
|
@@ -76,8 +76,10 @@ export interface OpenOrder {
|
|
|
76
76
|
market: MarketDisplay;
|
|
77
77
|
side: OrderSide;
|
|
78
78
|
type: OrderType;
|
|
79
|
-
/**
|
|
80
|
-
|
|
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;
|
|
81
83
|
/** Limit/order price in quote-asset units. */
|
|
82
84
|
price: string;
|
|
83
85
|
/** Quantity already filled in base-asset units. */
|
|
@@ -194,6 +196,24 @@ export interface OrdersResponse {
|
|
|
194
196
|
triggerOrders: TriggerOrder[];
|
|
195
197
|
pagination: Pagination;
|
|
196
198
|
}
|
|
199
|
+
/**
|
|
200
|
+
* Fee a venue charged, in the asset the venue charged it in. A venue does not
|
|
201
|
+
* always charge a fee in the asset the record is otherwise denominated in, so
|
|
202
|
+
* a consumer must format the amount against `asset` and never against the
|
|
203
|
+
* fill's quote asset or the activity's own `asset`.
|
|
204
|
+
*
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
export interface Fee {
|
|
208
|
+
/** Decimal string in `asset`'s units. */
|
|
209
|
+
amount: string;
|
|
210
|
+
/**
|
|
211
|
+
* Display symbol the fee is denominated in, resolved by the provider
|
|
212
|
+
* adapter. Falls back to the venue's own asset id when the registry knows no
|
|
213
|
+
* symbol.
|
|
214
|
+
*/
|
|
215
|
+
asset: string;
|
|
216
|
+
}
|
|
197
217
|
/**
|
|
198
218
|
* Normalized execution/fill record for an order.
|
|
199
219
|
*
|
|
@@ -215,7 +235,8 @@ export interface Fill {
|
|
|
215
235
|
status: FillStatus;
|
|
216
236
|
liquidity: LiquidityRole;
|
|
217
237
|
filledSize?: string;
|
|
218
|
-
fee
|
|
238
|
+
/** Absent when the venue reports no fee for the fill. */
|
|
239
|
+
fee?: Fee;
|
|
219
240
|
realizedPnl?: string | null;
|
|
220
241
|
startPosition?: string;
|
|
221
242
|
classification: FillClassification;
|
|
@@ -258,26 +279,38 @@ export interface BaseActivity {
|
|
|
258
279
|
timestamp: string;
|
|
259
280
|
}
|
|
260
281
|
/**
|
|
261
|
-
* Account activity representing a completed deposit.
|
|
282
|
+
* Account activity representing a completed deposit. `amount` is a decimal
|
|
283
|
+
* string in `asset`'s units.
|
|
262
284
|
*
|
|
263
285
|
* @public
|
|
264
286
|
*/
|
|
265
287
|
export interface DepositActivity extends BaseActivity {
|
|
266
288
|
type: ActivityType.DEPOSIT;
|
|
289
|
+
/**
|
|
290
|
+
* Display symbol of the deposited asset, resolved by the provider adapter.
|
|
291
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
292
|
+
*/
|
|
293
|
+
asset: string;
|
|
267
294
|
amount: string;
|
|
268
295
|
/** Fully-resolved block-explorer URL for the on-chain deposit tx. */
|
|
269
296
|
explorerLink?: string;
|
|
270
297
|
}
|
|
271
298
|
/**
|
|
272
|
-
* Account activity representing a completed withdrawal. `amount`
|
|
273
|
-
*
|
|
299
|
+
* Account activity representing a completed withdrawal. `amount` is a decimal
|
|
300
|
+
* string in `asset`'s units.
|
|
274
301
|
*
|
|
275
302
|
* @public
|
|
276
303
|
*/
|
|
277
304
|
export interface WithdrawalActivity extends BaseActivity {
|
|
278
305
|
type: ActivityType.WITHDRAWAL;
|
|
306
|
+
/**
|
|
307
|
+
* Display symbol of the withdrawn asset, resolved by the provider adapter.
|
|
308
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
309
|
+
*/
|
|
310
|
+
asset: string;
|
|
279
311
|
amount: string;
|
|
280
|
-
fee
|
|
312
|
+
/** Absent when the venue reports no fee for the withdrawal. */
|
|
313
|
+
fee?: Fee;
|
|
281
314
|
/** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
|
|
282
315
|
explorerLink?: string;
|
|
283
316
|
}
|
|
@@ -288,18 +321,31 @@ export interface WithdrawalActivity extends BaseActivity {
|
|
|
288
321
|
*/
|
|
289
322
|
export interface LiquidatedPosition {
|
|
290
323
|
market: MarketDisplay;
|
|
291
|
-
size
|
|
324
|
+
/** Absent when the venue reports no liquidated size for the position. */
|
|
325
|
+
size?: string;
|
|
292
326
|
}
|
|
293
327
|
/**
|
|
294
|
-
* Account activity representing a liquidation event.
|
|
328
|
+
* Account activity representing a liquidation event. `liquidatedPositions` is
|
|
329
|
+
* never empty: a provider adapter drops any record whose positions it cannot
|
|
330
|
+
* identify. A venue that liquidates several cross-margin positions in one
|
|
331
|
+
* cascade reports them as one activity with several entries, so consumers
|
|
332
|
+
* must never group activities by timestamp.
|
|
295
333
|
*
|
|
296
334
|
* @public
|
|
297
335
|
*/
|
|
298
336
|
export interface LiquidationActivity extends BaseActivity {
|
|
299
337
|
type: ActivityType.LIQUIDATION;
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
338
|
+
/** Absent when the venue reports no liquidated notional. */
|
|
339
|
+
liquidatedNotionalPosition?: string;
|
|
340
|
+
/** Absent when the venue reports no account value at liquidation time. */
|
|
341
|
+
accountValue?: string;
|
|
342
|
+
/**
|
|
343
|
+
* Margin mode the liquidated account ran under, in the venue's own
|
|
344
|
+
* vocabulary — typically `cross` or `isolated`, but the venue may report
|
|
345
|
+
* any string. Absent when the venue reports no margin mode on a
|
|
346
|
+
* liquidation row.
|
|
347
|
+
*/
|
|
348
|
+
leverageType?: string;
|
|
303
349
|
liquidatedPositions: LiquidatedPosition[];
|
|
304
350
|
}
|
|
305
351
|
/**
|
|
@@ -311,13 +357,19 @@ export interface LiquidationActivity extends BaseActivity {
|
|
|
311
357
|
export interface FundingActivity extends BaseActivity {
|
|
312
358
|
type: ActivityType.FUNDING;
|
|
313
359
|
market: MarketDisplay;
|
|
360
|
+
/**
|
|
361
|
+
* Signed, in quote-currency units. Positive means the account received
|
|
362
|
+
* funding; negative means the account paid it.
|
|
363
|
+
*/
|
|
314
364
|
amount: string;
|
|
315
365
|
positionSize: string;
|
|
316
366
|
fundingRate: string;
|
|
317
367
|
}
|
|
318
368
|
/**
|
|
319
|
-
* Account activity representing an inbound or outbound transfer
|
|
320
|
-
* counterparty identifier is required by the
|
|
369
|
+
* Account activity representing an inbound or outbound transfer between two
|
|
370
|
+
* distinct accounts. At least one counterparty identifier is required by the
|
|
371
|
+
* type-level union below. Same-account movements — a venue's own route or
|
|
372
|
+
* margin-location moves — are never reported as transfers.
|
|
321
373
|
*
|
|
322
374
|
* @public
|
|
323
375
|
*/
|
|
@@ -326,6 +378,14 @@ export type TransferActivity = BaseActivity & {
|
|
|
326
378
|
direction: 'IN' | 'OUT';
|
|
327
379
|
asset: string;
|
|
328
380
|
amount: string;
|
|
381
|
+
/**
|
|
382
|
+
* Every fee the venue charged for the transfer, in the order the venue
|
|
383
|
+
* reports them. A venue may charge several fees for one transfer, each in a
|
|
384
|
+
* different asset — a transfer fee plus a separate gas fee in the chain's
|
|
385
|
+
* native token — so this is a list and not a single amount. Absent when the
|
|
386
|
+
* venue reports no fee.
|
|
387
|
+
*/
|
|
388
|
+
fees?: Fee[];
|
|
329
389
|
meta?: Record<string, unknown>;
|
|
330
390
|
/** Fully-resolved block-explorer URL for the on-chain transfer tx. */
|
|
331
391
|
explorerLink?: string;
|
|
@@ -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;;;;;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,
|
|
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;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG;IAClB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;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,yDAAyD;IACzD,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,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;;;;;GAKG;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,GAAG,CAAA;IACT,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;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,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
|
@@ -90,8 +90,10 @@ export interface OpenOrder {
|
|
|
90
90
|
market: MarketDisplay
|
|
91
91
|
side: OrderSide
|
|
92
92
|
type: OrderType
|
|
93
|
-
/**
|
|
94
|
-
|
|
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
|
|
95
97
|
/** Limit/order price in quote-asset units. */
|
|
96
98
|
price: string
|
|
97
99
|
/** Quantity already filled in base-asset units. */
|
|
@@ -216,6 +218,25 @@ export interface OrdersResponse {
|
|
|
216
218
|
pagination: Pagination
|
|
217
219
|
}
|
|
218
220
|
|
|
221
|
+
/**
|
|
222
|
+
* Fee a venue charged, in the asset the venue charged it in. A venue does not
|
|
223
|
+
* always charge a fee in the asset the record is otherwise denominated in, so
|
|
224
|
+
* a consumer must format the amount against `asset` and never against the
|
|
225
|
+
* fill's quote asset or the activity's own `asset`.
|
|
226
|
+
*
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
export interface Fee {
|
|
230
|
+
/** Decimal string in `asset`'s units. */
|
|
231
|
+
amount: string
|
|
232
|
+
/**
|
|
233
|
+
* Display symbol the fee is denominated in, resolved by the provider
|
|
234
|
+
* adapter. Falls back to the venue's own asset id when the registry knows no
|
|
235
|
+
* symbol.
|
|
236
|
+
*/
|
|
237
|
+
asset: string
|
|
238
|
+
}
|
|
239
|
+
|
|
219
240
|
/**
|
|
220
241
|
* Normalized execution/fill record for an order.
|
|
221
242
|
*
|
|
@@ -237,7 +258,8 @@ export interface Fill {
|
|
|
237
258
|
status: FillStatus
|
|
238
259
|
liquidity: LiquidityRole
|
|
239
260
|
filledSize?: string
|
|
240
|
-
fee
|
|
261
|
+
/** Absent when the venue reports no fee for the fill. */
|
|
262
|
+
fee?: Fee
|
|
241
263
|
realizedPnl?: string | null
|
|
242
264
|
startPosition?: string
|
|
243
265
|
classification: FillClassification
|
|
@@ -284,27 +306,39 @@ export interface BaseActivity {
|
|
|
284
306
|
}
|
|
285
307
|
|
|
286
308
|
/**
|
|
287
|
-
* Account activity representing a completed deposit.
|
|
309
|
+
* Account activity representing a completed deposit. `amount` is a decimal
|
|
310
|
+
* string in `asset`'s units.
|
|
288
311
|
*
|
|
289
312
|
* @public
|
|
290
313
|
*/
|
|
291
314
|
export interface DepositActivity extends BaseActivity {
|
|
292
315
|
type: ActivityType.DEPOSIT
|
|
316
|
+
/**
|
|
317
|
+
* Display symbol of the deposited asset, resolved by the provider adapter.
|
|
318
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
319
|
+
*/
|
|
320
|
+
asset: string
|
|
293
321
|
amount: string
|
|
294
322
|
/** Fully-resolved block-explorer URL for the on-chain deposit tx. */
|
|
295
323
|
explorerLink?: string
|
|
296
324
|
}
|
|
297
325
|
|
|
298
326
|
/**
|
|
299
|
-
* Account activity representing a completed withdrawal. `amount`
|
|
300
|
-
*
|
|
327
|
+
* Account activity representing a completed withdrawal. `amount` is a decimal
|
|
328
|
+
* string in `asset`'s units.
|
|
301
329
|
*
|
|
302
330
|
* @public
|
|
303
331
|
*/
|
|
304
332
|
export interface WithdrawalActivity extends BaseActivity {
|
|
305
333
|
type: ActivityType.WITHDRAWAL
|
|
334
|
+
/**
|
|
335
|
+
* Display symbol of the withdrawn asset, resolved by the provider adapter.
|
|
336
|
+
* Falls back to the venue's own asset id when the registry knows no symbol.
|
|
337
|
+
*/
|
|
338
|
+
asset: string
|
|
306
339
|
amount: string
|
|
307
|
-
fee
|
|
340
|
+
/** Absent when the venue reports no fee for the withdrawal. */
|
|
341
|
+
fee?: Fee
|
|
308
342
|
/** Fully-resolved block-explorer URL for the on-chain withdrawal tx. */
|
|
309
343
|
explorerLink?: string
|
|
310
344
|
}
|
|
@@ -316,19 +350,32 @@ export interface WithdrawalActivity extends BaseActivity {
|
|
|
316
350
|
*/
|
|
317
351
|
export interface LiquidatedPosition {
|
|
318
352
|
market: MarketDisplay
|
|
319
|
-
size
|
|
353
|
+
/** Absent when the venue reports no liquidated size for the position. */
|
|
354
|
+
size?: string
|
|
320
355
|
}
|
|
321
356
|
|
|
322
357
|
/**
|
|
323
|
-
* Account activity representing a liquidation event.
|
|
358
|
+
* Account activity representing a liquidation event. `liquidatedPositions` is
|
|
359
|
+
* never empty: a provider adapter drops any record whose positions it cannot
|
|
360
|
+
* identify. A venue that liquidates several cross-margin positions in one
|
|
361
|
+
* cascade reports them as one activity with several entries, so consumers
|
|
362
|
+
* must never group activities by timestamp.
|
|
324
363
|
*
|
|
325
364
|
* @public
|
|
326
365
|
*/
|
|
327
366
|
export interface LiquidationActivity extends BaseActivity {
|
|
328
367
|
type: ActivityType.LIQUIDATION
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
368
|
+
/** Absent when the venue reports no liquidated notional. */
|
|
369
|
+
liquidatedNotionalPosition?: string
|
|
370
|
+
/** Absent when the venue reports no account value at liquidation time. */
|
|
371
|
+
accountValue?: string
|
|
372
|
+
/**
|
|
373
|
+
* Margin mode the liquidated account ran under, in the venue's own
|
|
374
|
+
* vocabulary — typically `cross` or `isolated`, but the venue may report
|
|
375
|
+
* any string. Absent when the venue reports no margin mode on a
|
|
376
|
+
* liquidation row.
|
|
377
|
+
*/
|
|
378
|
+
leverageType?: string
|
|
332
379
|
liquidatedPositions: LiquidatedPosition[]
|
|
333
380
|
}
|
|
334
381
|
|
|
@@ -341,6 +388,10 @@ export interface LiquidationActivity extends BaseActivity {
|
|
|
341
388
|
export interface FundingActivity extends BaseActivity {
|
|
342
389
|
type: ActivityType.FUNDING
|
|
343
390
|
market: MarketDisplay
|
|
391
|
+
/**
|
|
392
|
+
* Signed, in quote-currency units. Positive means the account received
|
|
393
|
+
* funding; negative means the account paid it.
|
|
394
|
+
*/
|
|
344
395
|
amount: string
|
|
345
396
|
positionSize: string
|
|
346
397
|
fundingRate: string
|
|
@@ -349,8 +400,10 @@ export interface FundingActivity extends BaseActivity {
|
|
|
349
400
|
// At least one of `counterpartyAccountIndex` / `counterpartyAddress` is always
|
|
350
401
|
// present; both may appear together.
|
|
351
402
|
/**
|
|
352
|
-
* Account activity representing an inbound or outbound transfer
|
|
353
|
-
* counterparty identifier is required by the
|
|
403
|
+
* Account activity representing an inbound or outbound transfer between two
|
|
404
|
+
* distinct accounts. At least one counterparty identifier is required by the
|
|
405
|
+
* type-level union below. Same-account movements — a venue's own route or
|
|
406
|
+
* margin-location moves — are never reported as transfers.
|
|
354
407
|
*
|
|
355
408
|
* @public
|
|
356
409
|
*/
|
|
@@ -359,6 +412,14 @@ export type TransferActivity = BaseActivity & {
|
|
|
359
412
|
direction: 'IN' | 'OUT'
|
|
360
413
|
asset: string
|
|
361
414
|
amount: string
|
|
415
|
+
/**
|
|
416
|
+
* Every fee the venue charged for the transfer, in the order the venue
|
|
417
|
+
* reports them. A venue may charge several fees for one transfer, each in a
|
|
418
|
+
* different asset — a transfer fee plus a separate gas fee in the chain's
|
|
419
|
+
* native token — so this is a list and not a single amount. Absent when the
|
|
420
|
+
* venue reports no fee.
|
|
421
|
+
*/
|
|
422
|
+
fees?: Fee[]
|
|
362
423
|
meta?: Record<string, unknown>
|
|
363
424
|
/** Fully-resolved block-explorer URL for the on-chain transfer tx. */
|
|
364
425
|
explorerLink?: string
|