@lifi/perps-types 14.1.0 → 16.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 +34 -6
- package/dist/cjs/account.d.ts.map +1 -1
- package/dist/cjs/asset.d.ts +1 -0
- package/dist/cjs/asset.d.ts.map +1 -1
- package/dist/cjs/subscriptions.d.ts +13 -3
- package/dist/cjs/subscriptions.d.ts.map +1 -1
- package/dist/esm/account.d.ts +92 -21
- package/dist/esm/account.d.ts.map +1 -1
- package/dist/esm/asset.d.ts +7 -0
- package/dist/esm/asset.d.ts.map +1 -1
- package/dist/esm/subscriptions.d.ts +19 -3
- package/dist/esm/subscriptions.d.ts.map +1 -1
- package/dist/types/account.d.ts +92 -21
- package/dist/types/account.d.ts.map +1 -1
- package/dist/types/asset.d.ts +7 -0
- package/dist/types/asset.d.ts.map +1 -1
- package/dist/types/subscriptions.d.ts +19 -3
- package/dist/types/subscriptions.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/account.ts +96 -22
- package/src/asset.ts +11 -0
- package/src/subscriptions.ts +21 -0
package/dist/cjs/account.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Asset } from './asset.js';
|
|
1
|
+
import type { Asset, AssetDisplay } from './asset.js';
|
|
2
2
|
import type { ActionType, ActivityType, FillClassification, LiquidityRole, MarginMode, OrderSide, OrderStatus, OrderType, PositionSide, TimeInForce, TriggerCondition } from './enums.js';
|
|
3
3
|
import type { MarketDisplay, PerpsMarketDisplay } from './market.js';
|
|
4
4
|
import type { Address, ProviderId } from './primitives.js';
|
|
@@ -20,10 +20,6 @@ export interface Position {
|
|
|
20
20
|
initialMarginRequirement: string;
|
|
21
21
|
marginMode: MarginMode;
|
|
22
22
|
}
|
|
23
|
-
export interface PositionMarginConstraints {
|
|
24
|
-
minimumMarginRequirement: string;
|
|
25
|
-
amountIncrement: string;
|
|
26
|
-
}
|
|
27
23
|
export interface OrderBase {
|
|
28
24
|
orderId: string;
|
|
29
25
|
clientOrderId?: string;
|
|
@@ -65,7 +61,6 @@ export interface Balance {
|
|
|
65
61
|
units: string;
|
|
66
62
|
valueUsd: string;
|
|
67
63
|
price?: string;
|
|
68
|
-
collateralWeight?: number;
|
|
69
64
|
}
|
|
70
65
|
export interface AccountResponse {
|
|
71
66
|
provider: string;
|
|
@@ -84,6 +79,13 @@ export interface AccountSummary {
|
|
|
84
79
|
marginUsed: string;
|
|
85
80
|
unrealizedPnl: string;
|
|
86
81
|
}
|
|
82
|
+
export interface AvailableToTrade {
|
|
83
|
+
providerId: string;
|
|
84
|
+
marketId: string;
|
|
85
|
+
asset: AssetDisplay;
|
|
86
|
+
buy: string;
|
|
87
|
+
sell: string;
|
|
88
|
+
}
|
|
87
89
|
export interface MarketSettings {
|
|
88
90
|
marginMode: MarginMode;
|
|
89
91
|
leverage: number;
|
|
@@ -197,11 +199,26 @@ export interface HyperliquidBuilderFeeApproval {
|
|
|
197
199
|
maxFeeRate: string;
|
|
198
200
|
approved: boolean;
|
|
199
201
|
}
|
|
202
|
+
export interface HyperliquidMarginSummary {
|
|
203
|
+
accountValue: string;
|
|
204
|
+
totalNtlPos: string;
|
|
205
|
+
totalRawUsd: string;
|
|
206
|
+
totalMarginUsed: string;
|
|
207
|
+
}
|
|
208
|
+
export interface HyperliquidDexAccountState {
|
|
209
|
+
dex: string;
|
|
210
|
+
marginSummary: HyperliquidMarginSummary;
|
|
211
|
+
crossMarginSummary: HyperliquidMarginSummary;
|
|
212
|
+
crossMaintenanceMarginUsed: string;
|
|
213
|
+
withdrawable: string;
|
|
214
|
+
}
|
|
200
215
|
export interface HyperliquidAccountConfig {
|
|
201
216
|
provider: 'hyperliquid';
|
|
202
217
|
abstractionMode: string | null;
|
|
203
218
|
agents: HyperliquidAgent[];
|
|
204
219
|
builderFeeApproval?: HyperliquidBuilderFeeApproval;
|
|
220
|
+
dexStates: HyperliquidDexAccountState[];
|
|
221
|
+
availableAfterMaintenance?: string;
|
|
205
222
|
}
|
|
206
223
|
export interface LighterAssetCollateral {
|
|
207
224
|
assetId: string;
|
|
@@ -214,6 +231,8 @@ export interface LighterAccountConfig {
|
|
|
214
231
|
apiKeyIndex?: number;
|
|
215
232
|
apiKeyRegistered: boolean;
|
|
216
233
|
accountType: number;
|
|
234
|
+
availableBalance: string;
|
|
235
|
+
totalAssetValue: string;
|
|
217
236
|
userTierName?: string;
|
|
218
237
|
accountTradingMode: number;
|
|
219
238
|
assetCollateral: LighterAssetCollateral[];
|
|
@@ -222,9 +241,18 @@ export interface LighterAccountConfig {
|
|
|
222
241
|
readOnlyTokenScope?: 'single' | 'all';
|
|
223
242
|
referralPresent: boolean;
|
|
224
243
|
}
|
|
244
|
+
export interface OndoAccountBalance {
|
|
245
|
+
walletBalance: string;
|
|
246
|
+
unrealizedPnl: string;
|
|
247
|
+
marginBalance: string;
|
|
248
|
+
usedMargin: string;
|
|
249
|
+
availableMargin: string;
|
|
250
|
+
withdrawableMargin: string;
|
|
251
|
+
}
|
|
225
252
|
export interface OndoAccountConfig {
|
|
226
253
|
provider: 'ondo';
|
|
227
254
|
loggedIn: boolean;
|
|
255
|
+
balance?: OndoAccountBalance;
|
|
228
256
|
authTokenExpiry?: number;
|
|
229
257
|
termsAccepted: boolean;
|
|
230
258
|
apiKeyRegistered: boolean;
|
|
@@ -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;
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,gBAAgB,EACjB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAQ1D,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;IAOhB,UAAU,EAAE,MAAM,CAAA;IAKlB,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAGD,MAAM,WAAW,SAAS;IAExB,OAAO,EAAE,MAAM,CAAA;IAEf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;IAEnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,OAAO,CAAA;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,CAAA;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAGD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EACA,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,iBAAiB,CAAA;IAC/B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAGD,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,IAAI,EAAE,SAAS,CAAC,IAAI,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,MAAM,KAAK,GAAG,YAAY,GAAG,YAAY,GAAG,SAAS,CAAA;AAQ3D,MAAM,WAAW,OAAO;IAEtB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IAEb,QAAQ,EAAE,MAAM,CAAA;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAQD,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB,QAAQ,EAAE,OAAO,EAAE,CAAA;IAKnB,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;AASD,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAA;IAElB,QAAQ,EAAE,MAAM,CAAA;IAEhB,KAAK,EAAE,YAAY,CAAA;IAEnB,GAAG,EAAE,MAAM,CAAA;IAEX,IAAI,EAAE,MAAM,CAAA;CACb;AAQD,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAOD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAGD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,UAAU,CAAA;IACpB,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,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,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,GAAG,CAAC,EAAE,GAAG,CAAA;IAKT,UAAU,CAAC,EAAE,GAAG,CAAA;IAKhB,aAAa,CAAC,EAAE,MAAM,CAAA;IAQtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,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;IAC1B,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IAKd,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAQD,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAC7B,KAAK,EAAE,KAAK,CAAA;IACZ,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;AAUD,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;IAKrB,mBAAmB,EAAE,CAAC,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,CAAC,CAAA;CACnE;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,KAAK,CAAA;IACZ,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;AAQD,MAAM,WAAW,wBAAwB;IAEvC,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,MAAM,CAAA;CACxB;AAOD,MAAM,WAAW,0BAA0B;IAEzC,GAAG,EAAE,MAAM,CAAA;IAEX,aAAa,EAAE,wBAAwB,CAAA;IAEvC,kBAAkB,EAAE,wBAAwB,CAAA;IAC5C,0BAA0B,EAAE,MAAM,CAAA;IAClC,YAAY,EAAE,MAAM,CAAA;CACrB;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;IAElD,SAAS,EAAE,0BAA0B,EAAE,CAAA;IAMvC,yBAAyB,CAAC,EAAE,MAAM,CAAA;CACnC;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;IAOzB,WAAW,EAAE,MAAM,CAAA;IAKnB,gBAAgB,EAAE,MAAM,CAAA;IAMxB,eAAe,EAAE,MAAM,CAAA;IAMvB,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,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;IAOrC,eAAe,EAAE,OAAO,CAAA;CACzB;AAUD,MAAM,WAAW,kBAAkB;IAEjC,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IAErB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAElB,eAAe,EAAE,MAAM,CAAA;IAEvB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAQD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IAEjB,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAE5B,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/cjs/asset.d.ts
CHANGED
package/dist/cjs/asset.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAQlB,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAMlB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAGD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
|
|
1
|
+
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAQlB,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAMlB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAQD,MAAM,MAAM,YAAY,GAAG,IAAI,CAC7B,KAAK,EACL,YAAY,GAAG,IAAI,GAAG,eAAe,GAAG,SAAS,GAAG,aAAa,CAClE,CAAA;AAGD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AccountSummary, Balance, Fill, Order, Position } from './account.js';
|
|
1
|
+
import type { AccountSummary, AvailableToTrade, Balance, Fill, Order, Position } from './account.js';
|
|
2
2
|
import type { Candle, MarketContext, OhlcvInterval, OrderbookResponse, Trade } from './market.js';
|
|
3
3
|
import type { Address } from './primitives.js';
|
|
4
4
|
export type MarketsContextSubscription = {
|
|
@@ -53,7 +53,13 @@ export type AccountSummarySubscription = {
|
|
|
53
53
|
dex: string;
|
|
54
54
|
address: Address;
|
|
55
55
|
};
|
|
56
|
-
export type
|
|
56
|
+
export type AvailableToTradeSubscription = {
|
|
57
|
+
channel: 'availableToTrade';
|
|
58
|
+
dex: string;
|
|
59
|
+
address: Address;
|
|
60
|
+
marketId: string;
|
|
61
|
+
};
|
|
62
|
+
export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription | AvailableToTradeSubscription;
|
|
57
63
|
export type MarketsContextEvent = {
|
|
58
64
|
channel: 'marketsContext';
|
|
59
65
|
data: Record<string, MarketContext>;
|
|
@@ -99,5 +105,9 @@ export type AccountSummaryEvent = {
|
|
|
99
105
|
channel: 'accountSummary';
|
|
100
106
|
data: AccountSummary;
|
|
101
107
|
};
|
|
102
|
-
export type
|
|
108
|
+
export type AvailableToTradeEvent = {
|
|
109
|
+
channel: 'availableToTrade';
|
|
110
|
+
data: AvailableToTrade;
|
|
111
|
+
};
|
|
112
|
+
export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent | AvailableToTradeEvent;
|
|
103
113
|
//# sourceMappingURL=subscriptions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAG9C,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IAOd,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAOD,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;
|
|
1
|
+
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAG9C,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IAOd,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAGD,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAOD,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,GAC1B,4BAA4B,CAAA;AAGhC,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAE9E,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAE7D,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAE9D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,MAAM,EAAE,KAAK,EAAE,CAAA;QAEf,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAQ3D,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AAMvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAQD,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAOD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,IAAI,EAAE,gBAAgB,CAAA;CACvB,CAAA;AAOD,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,CAAA"}
|
package/dist/esm/account.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Asset } from './asset.js';
|
|
1
|
+
import type { Asset, AssetDisplay } from './asset.js';
|
|
2
2
|
import type { ActionType, ActivityType, FillClassification, LiquidityRole, MarginMode, OrderSide, OrderStatus, OrderType, PositionSide, TimeInForce, TriggerCondition } from './enums.js';
|
|
3
3
|
import type { MarketDisplay, PerpsMarketDisplay } from './market.js';
|
|
4
4
|
import type { Address, ProviderId } from './primitives.js';
|
|
@@ -43,8 +43,10 @@ export interface Position {
|
|
|
43
43
|
/** Position leverage as a numeric multiple. */
|
|
44
44
|
leverage: number;
|
|
45
45
|
/**
|
|
46
|
-
* Margin
|
|
47
|
-
*
|
|
46
|
+
* Margin reserved by this position as a decimal string: the venue figure of
|
|
47
|
+
* each provider, unchanged. Its unrealized-PnL treatment differs by venue.
|
|
48
|
+
* Hyperliquid isolated `marginUsed` includes the unrealized PnL of the
|
|
49
|
+
* position; Lighter `allocated_margin` excludes it.
|
|
48
50
|
*/
|
|
49
51
|
marginUsed: string;
|
|
50
52
|
/**
|
|
@@ -54,18 +56,6 @@ export interface Position {
|
|
|
54
56
|
initialMarginRequirement: string;
|
|
55
57
|
marginMode: MarginMode;
|
|
56
58
|
}
|
|
57
|
-
/**
|
|
58
|
-
* Exact provider-owned inputs for changing one position's dedicated margin.
|
|
59
|
-
* `undefined` from the provider means the position has no individual margin
|
|
60
|
-
* adjustment.
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
|
-
export interface PositionMarginConstraints {
|
|
64
|
-
/** Exact margin the venue requires this position to retain. */
|
|
65
|
-
minimumMarginRequirement: string;
|
|
66
|
-
/** Smallest accepted margin amount, as an exact decimal string. */
|
|
67
|
-
amountIncrement: string;
|
|
68
|
-
}
|
|
69
59
|
/** Shared identity, quantities, and lifecycle of a venue order. */
|
|
70
60
|
export interface OrderBase {
|
|
71
61
|
/** Venue-assigned id: Hyperliquid `oid`, Lighter `order_index`, Ondo `orderId`. */
|
|
@@ -126,12 +116,6 @@ export interface Balance {
|
|
|
126
116
|
valueUsd: string;
|
|
127
117
|
/** USD price of one unit. Absent when the provider holds no price for the asset. */
|
|
128
118
|
price?: string;
|
|
129
|
-
/**
|
|
130
|
-
* Fraction of `valueUsd` that backs available margin (a loan-to-value
|
|
131
|
-
* ratio). Absent means 1 — full value. Set below 1 for collateral the
|
|
132
|
-
* venue haircuts; ignored on non-collateral balances.
|
|
133
|
-
*/
|
|
134
|
-
collateralWeight?: number;
|
|
135
119
|
}
|
|
136
120
|
/**
|
|
137
121
|
* Account snapshot returned by a provider, including balances, positions,
|
|
@@ -174,6 +158,24 @@ export interface AccountSummary {
|
|
|
174
158
|
/** Aggregate unrealized PnL in USD. */
|
|
175
159
|
unrealizedPnl: string;
|
|
176
160
|
}
|
|
161
|
+
/**
|
|
162
|
+
* The amount an account can still buy or sell on one market, in that market's
|
|
163
|
+
* margin asset. The order panel reads this per-market figure. It differs from
|
|
164
|
+
* {@link AccountSummary.availableMargin}, which stays account-scoped.
|
|
165
|
+
*
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
export interface AvailableToTrade {
|
|
169
|
+
providerId: string;
|
|
170
|
+
/** The market this figure applies to, equal to `Market.id`. */
|
|
171
|
+
marketId: string;
|
|
172
|
+
/** The market's margin asset, which both amounts are denominated in. */
|
|
173
|
+
asset: AssetDisplay;
|
|
174
|
+
/** Amount the account can still buy, represented as a decimal string. */
|
|
175
|
+
buy: string;
|
|
176
|
+
/** Amount the account can still sell, represented as a decimal string. */
|
|
177
|
+
sell: string;
|
|
178
|
+
}
|
|
177
179
|
/**
|
|
178
180
|
* The user's complete venue-side settings for one market: the margin mode
|
|
179
181
|
* and display leverage the next order on it will use. A provider returns
|
|
@@ -451,6 +453,34 @@ export interface HyperliquidBuilderFeeApproval {
|
|
|
451
453
|
maxFeeRate: string;
|
|
452
454
|
approved: boolean;
|
|
453
455
|
}
|
|
456
|
+
/**
|
|
457
|
+
* Hyperliquid `marginSummary` block, copied from the venue wire response.
|
|
458
|
+
* Every member is a decimal string in quote-asset units.
|
|
459
|
+
*
|
|
460
|
+
* @public
|
|
461
|
+
*/
|
|
462
|
+
export interface HyperliquidMarginSummary {
|
|
463
|
+
/** Total equity: locked margin and unrealized PnL included. */
|
|
464
|
+
accountValue: string;
|
|
465
|
+
totalNtlPos: string;
|
|
466
|
+
totalRawUsd: string;
|
|
467
|
+
totalMarginUsed: string;
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* Venue account figures for one Hyperliquid perps sub-dex.
|
|
471
|
+
*
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
export interface HyperliquidDexAccountState {
|
|
475
|
+
/** Sub-dex name; the empty string is the main perps dex. */
|
|
476
|
+
dex: string;
|
|
477
|
+
/** Whole account, cross and isolated positions together. */
|
|
478
|
+
marginSummary: HyperliquidMarginSummary;
|
|
479
|
+
/** Cross-margin subset of {@link HyperliquidDexAccountState.marginSummary}. */
|
|
480
|
+
crossMarginSummary: HyperliquidMarginSummary;
|
|
481
|
+
crossMaintenanceMarginUsed: string;
|
|
482
|
+
withdrawable: string;
|
|
483
|
+
}
|
|
454
484
|
/**
|
|
455
485
|
* Hyperliquid account configuration returned in {@link AccountResponse.config}.
|
|
456
486
|
*
|
|
@@ -462,6 +492,14 @@ export interface HyperliquidAccountConfig {
|
|
|
462
492
|
abstractionMode: string | null;
|
|
463
493
|
agents: HyperliquidAgent[];
|
|
464
494
|
builderFeeApproval?: HyperliquidBuilderFeeApproval;
|
|
495
|
+
/** One entry per perps sub-dex that still has a live market. */
|
|
496
|
+
dexStates: HyperliquidDexAccountState[];
|
|
497
|
+
/**
|
|
498
|
+
* Venue buying power: the quote-asset entry of the spot
|
|
499
|
+
* `tokenToAvailableAfterMaintenance` list. Unified and portfolio-margin
|
|
500
|
+
* accounts only; other modes derive buying power from `marginSummary`.
|
|
501
|
+
*/
|
|
502
|
+
availableAfterMaintenance?: string;
|
|
465
503
|
}
|
|
466
504
|
/**
|
|
467
505
|
* Lighter spot-asset collateral setting for a single asset.
|
|
@@ -505,6 +543,17 @@ export interface LighterAccountConfig {
|
|
|
505
543
|
* {@link LighterAccountConfig.userTierName}.
|
|
506
544
|
*/
|
|
507
545
|
accountType: number;
|
|
546
|
+
/**
|
|
547
|
+
* Lighter `available_balance`: venue buying power for the whole account,
|
|
548
|
+
* already marked to market. A decimal string in quote-asset units.
|
|
549
|
+
*/
|
|
550
|
+
availableBalance: string;
|
|
551
|
+
/**
|
|
552
|
+
* Lighter `total_asset_value`: perps-route equity, isolated allocations and
|
|
553
|
+
* unrealized PnL included. It excludes the spot-route balances. A decimal
|
|
554
|
+
* string in quote-asset units.
|
|
555
|
+
*/
|
|
556
|
+
totalAssetValue: string;
|
|
508
557
|
/**
|
|
509
558
|
* Lighter `user_tier_name` from `/accountLimits`, in the tier vocabulary
|
|
510
559
|
* `changeAccountTier` accepts. Absent on an unauthenticated read, which
|
|
@@ -532,6 +581,26 @@ export interface LighterAccountConfig {
|
|
|
532
581
|
*/
|
|
533
582
|
referralPresent: boolean;
|
|
534
583
|
}
|
|
584
|
+
/**
|
|
585
|
+
* Ondo `MarginAccountBalanceSummary` figures, copied from the venue wire
|
|
586
|
+
* response. Every member is a decimal string in quote-asset units. Ondo
|
|
587
|
+
* publishes two invariants: `marginBalance = walletBalance + unrealizedPnl`
|
|
588
|
+
* and `availableMargin = marginBalance - usedMargin`.
|
|
589
|
+
*
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
export interface OndoAccountBalance {
|
|
593
|
+
/** Collateral only: locked margin included, unrealized PnL excluded. */
|
|
594
|
+
walletBalance: string;
|
|
595
|
+
unrealizedPnl: string;
|
|
596
|
+
/** Total equity. */
|
|
597
|
+
marginBalance: string;
|
|
598
|
+
usedMargin: string;
|
|
599
|
+
/** Venue buying power. */
|
|
600
|
+
availableMargin: string;
|
|
601
|
+
/** Venue withdrawable figure, at or below {@link OndoAccountBalance.availableMargin}. */
|
|
602
|
+
withdrawableMargin: string;
|
|
603
|
+
}
|
|
535
604
|
/**
|
|
536
605
|
* Ondo account/session configuration returned in {@link AccountResponse.config}.
|
|
537
606
|
* Expiry values are Unix timestamps in seconds.
|
|
@@ -541,6 +610,8 @@ export interface LighterAccountConfig {
|
|
|
541
610
|
export interface OndoAccountConfig {
|
|
542
611
|
provider: 'ondo';
|
|
543
612
|
loggedIn: boolean;
|
|
613
|
+
/** Venue balance figures. Absent when logged out, which reads no balance. */
|
|
614
|
+
balance?: OndoAccountBalance;
|
|
544
615
|
/** Unix seconds. Present iff `loggedIn === true`. The token itself never appears here. */
|
|
545
616
|
authTokenExpiry?: number;
|
|
546
617
|
/** Venue terms accepted, inferred from the login token's `newAccount` flag. Always `false` when logged out. */
|
|
@@ -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;
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,gBAAgB,EACjB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE1D;;;;;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;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,mEAAmE;AACnE,MAAM,WAAW,SAAS;IACxB,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;IACnB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,OAAO,CAAA;IACnB,wFAAwF;IACxF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,yDAAyD;AACzD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,CAAA;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EACA,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,iBAAiB,CAAA;IAC/B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,IAAI,EAAE,SAAS,CAAC,IAAI,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,4DAA4D;AAC5D,MAAM,MAAM,KAAK,GAAG,YAAY,GAAG,YAAY,GAAG,SAAS,CAAA;AAE3D;;;;;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,oFAAoF;IACpF,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,2DAA2D;IAC3D,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB;;;OAGG;IACH,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;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAA;IAChB,wEAAwE;IACxE,KAAK,EAAE,YAAY,CAAA;IACnB,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAA;IACX,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,qEAAqE;AACrE,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,UAAU,CAAA;IACpB,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,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,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,yDAAyD;IACzD,GAAG,CAAC,EAAE,GAAG,CAAA;IACT;;;OAGG;IACH,UAAU,CAAC,EAAE,GAAG,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,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,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAC7B,KAAK,EAAE,KAAK,CAAA;IACZ,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;;;;;;;GAOG;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;;;OAGG;IACH,mBAAmB,EAAE,CAAC,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,CAAC,CAAA;CACnE;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,KAAK,CAAA;IACZ,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;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,+DAA+D;IAC/D,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,4DAA4D;IAC5D,GAAG,EAAE,MAAM,CAAA;IACX,4DAA4D;IAC5D,aAAa,EAAE,wBAAwB,CAAA;IACvC,+EAA+E;IAC/E,kBAAkB,EAAE,wBAAwB,CAAA;IAC5C,0BAA0B,EAAE,MAAM,CAAA;IAClC,YAAY,EAAE,MAAM,CAAA;CACrB;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;IAClD,gEAAgE;IAChE,SAAS,EAAE,0BAA0B,EAAE,CAAA;IACvC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;CACnC;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;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,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;;;;;OAKG;IACH,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,oBAAoB;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,yFAAyF;IACzF,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,6EAA6E;IAC7E,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAC5B,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/esm/asset.d.ts
CHANGED
|
@@ -34,6 +34,13 @@ export interface Asset {
|
|
|
34
34
|
/** Venue minimum for a single withdrawal, denominated in this asset — not USD. */
|
|
35
35
|
minWithdrawalAmount?: string;
|
|
36
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* The subset of {@link Asset} a consumer needs to label an amount: identity
|
|
39
|
+
* plus the symbol, name and logo a display shows.
|
|
40
|
+
*
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export type AssetDisplay = Pick<Asset, 'providerId' | 'id' | 'displaySymbol' | 'logoURI' | 'displayName'>;
|
|
37
44
|
/** Response containing the provider's normalized asset registry. @public */
|
|
38
45
|
export interface AssetsResponse {
|
|
39
46
|
assets: Asset[];
|
package/dist/esm/asset.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,iHAAiH;IACjH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
|
|
1
|
+
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,iHAAiH;IACjH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAC7B,KAAK,EACL,YAAY,GAAG,IAAI,GAAG,eAAe,GAAG,SAAS,GAAG,aAAa,CAClE,CAAA;AAED,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AccountSummary, Balance, Fill, Order, Position } from './account.js';
|
|
1
|
+
import type { AccountSummary, AvailableToTrade, Balance, Fill, Order, Position } from './account.js';
|
|
2
2
|
import type { Candle, MarketContext, OhlcvInterval, OrderbookResponse, Trade } from './market.js';
|
|
3
3
|
import type { Address } from './primitives.js';
|
|
4
4
|
/** Subscription for the provider's aggregate market-context stream. @public */
|
|
@@ -69,12 +69,19 @@ export type AccountSummarySubscription = {
|
|
|
69
69
|
dex: string;
|
|
70
70
|
address: Address;
|
|
71
71
|
};
|
|
72
|
+
/** Subscription for per-market available-to-trade updates for one account. @public */
|
|
73
|
+
export type AvailableToTradeSubscription = {
|
|
74
|
+
channel: 'availableToTrade';
|
|
75
|
+
dex: string;
|
|
76
|
+
address: Address;
|
|
77
|
+
marketId: string;
|
|
78
|
+
};
|
|
72
79
|
/**
|
|
73
80
|
* Union of all websocket subscription request shapes.
|
|
74
81
|
*
|
|
75
82
|
* @public
|
|
76
83
|
*/
|
|
77
|
-
export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription;
|
|
84
|
+
export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription | AvailableToTradeSubscription;
|
|
78
85
|
/** Event containing the provider's aggregate market contexts. @public */
|
|
79
86
|
export type MarketsContextEvent = {
|
|
80
87
|
channel: 'marketsContext';
|
|
@@ -146,10 +153,19 @@ export type AccountSummaryEvent = {
|
|
|
146
153
|
channel: 'accountSummary';
|
|
147
154
|
data: AccountSummary;
|
|
148
155
|
};
|
|
156
|
+
/**
|
|
157
|
+
* Per-market available-to-trade frame for the subscribed market. The venue
|
|
158
|
+
* recomputes both sides when the account's margin or position changes.
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export type AvailableToTradeEvent = {
|
|
162
|
+
channel: 'availableToTrade';
|
|
163
|
+
data: AvailableToTrade;
|
|
164
|
+
};
|
|
149
165
|
/**
|
|
150
166
|
* Union of all websocket event frame shapes emitted for subscriptions.
|
|
151
167
|
*
|
|
152
168
|
* @public
|
|
153
169
|
*/
|
|
154
|
-
export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent;
|
|
170
|
+
export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent | AvailableToTradeEvent;
|
|
155
171
|
//# sourceMappingURL=subscriptions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,uEAAuE;AACvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,kFAAkF;AAClF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;
|
|
1
|
+
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,uEAAuE;AACvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,kFAAkF;AAClF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,GAC1B,4BAA4B,CAAA;AAEhC,yEAAyE;AACzE,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AACD,0DAA0D;AAC1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAC9E,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC7D,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAC9D,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,MAAM,EAAE,KAAK,EAAE,CAAA;QACf,8DAA8D;QAC9D,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AACD,gEAAgE;AAChE,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAC3D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AACvE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,IAAI,EAAE,gBAAgB,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,CAAA"}
|
package/dist/types/account.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Asset } from './asset.js';
|
|
1
|
+
import type { Asset, AssetDisplay } from './asset.js';
|
|
2
2
|
import type { ActionType, ActivityType, FillClassification, LiquidityRole, MarginMode, OrderSide, OrderStatus, OrderType, PositionSide, TimeInForce, TriggerCondition } from './enums.js';
|
|
3
3
|
import type { MarketDisplay, PerpsMarketDisplay } from './market.js';
|
|
4
4
|
import type { Address, ProviderId } from './primitives.js';
|
|
@@ -43,8 +43,10 @@ export interface Position {
|
|
|
43
43
|
/** Position leverage as a numeric multiple. */
|
|
44
44
|
leverage: number;
|
|
45
45
|
/**
|
|
46
|
-
* Margin
|
|
47
|
-
*
|
|
46
|
+
* Margin reserved by this position as a decimal string: the venue figure of
|
|
47
|
+
* each provider, unchanged. Its unrealized-PnL treatment differs by venue.
|
|
48
|
+
* Hyperliquid isolated `marginUsed` includes the unrealized PnL of the
|
|
49
|
+
* position; Lighter `allocated_margin` excludes it.
|
|
48
50
|
*/
|
|
49
51
|
marginUsed: string;
|
|
50
52
|
/**
|
|
@@ -54,18 +56,6 @@ export interface Position {
|
|
|
54
56
|
initialMarginRequirement: string;
|
|
55
57
|
marginMode: MarginMode;
|
|
56
58
|
}
|
|
57
|
-
/**
|
|
58
|
-
* Exact provider-owned inputs for changing one position's dedicated margin.
|
|
59
|
-
* `undefined` from the provider means the position has no individual margin
|
|
60
|
-
* adjustment.
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
|
-
export interface PositionMarginConstraints {
|
|
64
|
-
/** Exact margin the venue requires this position to retain. */
|
|
65
|
-
minimumMarginRequirement: string;
|
|
66
|
-
/** Smallest accepted margin amount, as an exact decimal string. */
|
|
67
|
-
amountIncrement: string;
|
|
68
|
-
}
|
|
69
59
|
/** Shared identity, quantities, and lifecycle of a venue order. */
|
|
70
60
|
export interface OrderBase {
|
|
71
61
|
/** Venue-assigned id: Hyperliquid `oid`, Lighter `order_index`, Ondo `orderId`. */
|
|
@@ -126,12 +116,6 @@ export interface Balance {
|
|
|
126
116
|
valueUsd: string;
|
|
127
117
|
/** USD price of one unit. Absent when the provider holds no price for the asset. */
|
|
128
118
|
price?: string;
|
|
129
|
-
/**
|
|
130
|
-
* Fraction of `valueUsd` that backs available margin (a loan-to-value
|
|
131
|
-
* ratio). Absent means 1 — full value. Set below 1 for collateral the
|
|
132
|
-
* venue haircuts; ignored on non-collateral balances.
|
|
133
|
-
*/
|
|
134
|
-
collateralWeight?: number;
|
|
135
119
|
}
|
|
136
120
|
/**
|
|
137
121
|
* Account snapshot returned by a provider, including balances, positions,
|
|
@@ -174,6 +158,24 @@ export interface AccountSummary {
|
|
|
174
158
|
/** Aggregate unrealized PnL in USD. */
|
|
175
159
|
unrealizedPnl: string;
|
|
176
160
|
}
|
|
161
|
+
/**
|
|
162
|
+
* The amount an account can still buy or sell on one market, in that market's
|
|
163
|
+
* margin asset. The order panel reads this per-market figure. It differs from
|
|
164
|
+
* {@link AccountSummary.availableMargin}, which stays account-scoped.
|
|
165
|
+
*
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
export interface AvailableToTrade {
|
|
169
|
+
providerId: string;
|
|
170
|
+
/** The market this figure applies to, equal to `Market.id`. */
|
|
171
|
+
marketId: string;
|
|
172
|
+
/** The market's margin asset, which both amounts are denominated in. */
|
|
173
|
+
asset: AssetDisplay;
|
|
174
|
+
/** Amount the account can still buy, represented as a decimal string. */
|
|
175
|
+
buy: string;
|
|
176
|
+
/** Amount the account can still sell, represented as a decimal string. */
|
|
177
|
+
sell: string;
|
|
178
|
+
}
|
|
177
179
|
/**
|
|
178
180
|
* The user's complete venue-side settings for one market: the margin mode
|
|
179
181
|
* and display leverage the next order on it will use. A provider returns
|
|
@@ -451,6 +453,34 @@ export interface HyperliquidBuilderFeeApproval {
|
|
|
451
453
|
maxFeeRate: string;
|
|
452
454
|
approved: boolean;
|
|
453
455
|
}
|
|
456
|
+
/**
|
|
457
|
+
* Hyperliquid `marginSummary` block, copied from the venue wire response.
|
|
458
|
+
* Every member is a decimal string in quote-asset units.
|
|
459
|
+
*
|
|
460
|
+
* @public
|
|
461
|
+
*/
|
|
462
|
+
export interface HyperliquidMarginSummary {
|
|
463
|
+
/** Total equity: locked margin and unrealized PnL included. */
|
|
464
|
+
accountValue: string;
|
|
465
|
+
totalNtlPos: string;
|
|
466
|
+
totalRawUsd: string;
|
|
467
|
+
totalMarginUsed: string;
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* Venue account figures for one Hyperliquid perps sub-dex.
|
|
471
|
+
*
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
export interface HyperliquidDexAccountState {
|
|
475
|
+
/** Sub-dex name; the empty string is the main perps dex. */
|
|
476
|
+
dex: string;
|
|
477
|
+
/** Whole account, cross and isolated positions together. */
|
|
478
|
+
marginSummary: HyperliquidMarginSummary;
|
|
479
|
+
/** Cross-margin subset of {@link HyperliquidDexAccountState.marginSummary}. */
|
|
480
|
+
crossMarginSummary: HyperliquidMarginSummary;
|
|
481
|
+
crossMaintenanceMarginUsed: string;
|
|
482
|
+
withdrawable: string;
|
|
483
|
+
}
|
|
454
484
|
/**
|
|
455
485
|
* Hyperliquid account configuration returned in {@link AccountResponse.config}.
|
|
456
486
|
*
|
|
@@ -462,6 +492,14 @@ export interface HyperliquidAccountConfig {
|
|
|
462
492
|
abstractionMode: string | null;
|
|
463
493
|
agents: HyperliquidAgent[];
|
|
464
494
|
builderFeeApproval?: HyperliquidBuilderFeeApproval;
|
|
495
|
+
/** One entry per perps sub-dex that still has a live market. */
|
|
496
|
+
dexStates: HyperliquidDexAccountState[];
|
|
497
|
+
/**
|
|
498
|
+
* Venue buying power: the quote-asset entry of the spot
|
|
499
|
+
* `tokenToAvailableAfterMaintenance` list. Unified and portfolio-margin
|
|
500
|
+
* accounts only; other modes derive buying power from `marginSummary`.
|
|
501
|
+
*/
|
|
502
|
+
availableAfterMaintenance?: string;
|
|
465
503
|
}
|
|
466
504
|
/**
|
|
467
505
|
* Lighter spot-asset collateral setting for a single asset.
|
|
@@ -505,6 +543,17 @@ export interface LighterAccountConfig {
|
|
|
505
543
|
* {@link LighterAccountConfig.userTierName}.
|
|
506
544
|
*/
|
|
507
545
|
accountType: number;
|
|
546
|
+
/**
|
|
547
|
+
* Lighter `available_balance`: venue buying power for the whole account,
|
|
548
|
+
* already marked to market. A decimal string in quote-asset units.
|
|
549
|
+
*/
|
|
550
|
+
availableBalance: string;
|
|
551
|
+
/**
|
|
552
|
+
* Lighter `total_asset_value`: perps-route equity, isolated allocations and
|
|
553
|
+
* unrealized PnL included. It excludes the spot-route balances. A decimal
|
|
554
|
+
* string in quote-asset units.
|
|
555
|
+
*/
|
|
556
|
+
totalAssetValue: string;
|
|
508
557
|
/**
|
|
509
558
|
* Lighter `user_tier_name` from `/accountLimits`, in the tier vocabulary
|
|
510
559
|
* `changeAccountTier` accepts. Absent on an unauthenticated read, which
|
|
@@ -532,6 +581,26 @@ export interface LighterAccountConfig {
|
|
|
532
581
|
*/
|
|
533
582
|
referralPresent: boolean;
|
|
534
583
|
}
|
|
584
|
+
/**
|
|
585
|
+
* Ondo `MarginAccountBalanceSummary` figures, copied from the venue wire
|
|
586
|
+
* response. Every member is a decimal string in quote-asset units. Ondo
|
|
587
|
+
* publishes two invariants: `marginBalance = walletBalance + unrealizedPnl`
|
|
588
|
+
* and `availableMargin = marginBalance - usedMargin`.
|
|
589
|
+
*
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
export interface OndoAccountBalance {
|
|
593
|
+
/** Collateral only: locked margin included, unrealized PnL excluded. */
|
|
594
|
+
walletBalance: string;
|
|
595
|
+
unrealizedPnl: string;
|
|
596
|
+
/** Total equity. */
|
|
597
|
+
marginBalance: string;
|
|
598
|
+
usedMargin: string;
|
|
599
|
+
/** Venue buying power. */
|
|
600
|
+
availableMargin: string;
|
|
601
|
+
/** Venue withdrawable figure, at or below {@link OndoAccountBalance.availableMargin}. */
|
|
602
|
+
withdrawableMargin: string;
|
|
603
|
+
}
|
|
535
604
|
/**
|
|
536
605
|
* Ondo account/session configuration returned in {@link AccountResponse.config}.
|
|
537
606
|
* Expiry values are Unix timestamps in seconds.
|
|
@@ -541,6 +610,8 @@ export interface LighterAccountConfig {
|
|
|
541
610
|
export interface OndoAccountConfig {
|
|
542
611
|
provider: 'ondo';
|
|
543
612
|
loggedIn: boolean;
|
|
613
|
+
/** Venue balance figures. Absent when logged out, which reads no balance. */
|
|
614
|
+
balance?: OndoAccountBalance;
|
|
544
615
|
/** Unix seconds. Present iff `loggedIn === true`. The token itself never appears here. */
|
|
545
616
|
authTokenExpiry?: number;
|
|
546
617
|
/** Venue terms accepted, inferred from the login token's `newAccount` flag. Always `false` when logged out. */
|
|
@@ -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;
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/account.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,gBAAgB,EACjB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE1D;;;;;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;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,mEAAmE;AACnE,MAAM,WAAW,SAAS;IACxB,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;IACnB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,OAAO,CAAA;IACnB,wFAAwF;IACxF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,yDAAyD;AACzD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,CAAA;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,IAAI,EACA,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,iBAAiB,CAAA;IAC/B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,IAAI,EAAE,SAAS,CAAC,IAAI,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,4DAA4D;AAC5D,MAAM,MAAM,KAAK,GAAG,YAAY,GAAG,YAAY,GAAG,SAAS,CAAA;AAE3D;;;;;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,oFAAoF;IACpF,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,2DAA2D;IAC3D,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB;;;OAGG;IACH,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;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAA;IAChB,wEAAwE;IACxE,KAAK,EAAE,YAAY,CAAA;IACnB,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAA;IACX,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,qEAAqE;AACrE,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,UAAU,CAAA;IACpB,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,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,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,yDAAyD;IACzD,GAAG,CAAC,EAAE,GAAG,CAAA;IACT;;;OAGG;IACH,UAAU,CAAC,EAAE,GAAG,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,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,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC,UAAU,CAAA;IAC7B,KAAK,EAAE,KAAK,CAAA;IACZ,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;;;;;;;GAOG;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;;;OAGG;IACH,mBAAmB,EAAE,CAAC,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,CAAC,CAAA;CACnE;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,KAAK,CAAA;IACZ,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;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,+DAA+D;IAC/D,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,4DAA4D;IAC5D,GAAG,EAAE,MAAM,CAAA;IACX,4DAA4D;IAC5D,aAAa,EAAE,wBAAwB,CAAA;IACvC,+EAA+E;IAC/E,kBAAkB,EAAE,wBAAwB,CAAA;IAC5C,0BAA0B,EAAE,MAAM,CAAA;IAClC,YAAY,EAAE,MAAM,CAAA;CACrB;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;IAClD,gEAAgE;IAChE,SAAS,EAAE,0BAA0B,EAAE,CAAA;IACvC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;CACnC;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;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,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;;;;;OAKG;IACH,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,oBAAoB;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,yFAAyF;IACzF,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,6EAA6E;IAC7E,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAC5B,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/asset.d.ts
CHANGED
|
@@ -34,6 +34,13 @@ export interface Asset {
|
|
|
34
34
|
/** Venue minimum for a single withdrawal, denominated in this asset — not USD. */
|
|
35
35
|
minWithdrawalAmount?: string;
|
|
36
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* The subset of {@link Asset} a consumer needs to label an amount: identity
|
|
39
|
+
* plus the symbol, name and logo a display shows.
|
|
40
|
+
*
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export type AssetDisplay = Pick<Asset, 'providerId' | 'id' | 'displaySymbol' | 'logoURI' | 'displayName'>;
|
|
37
44
|
/** Response containing the provider's normalized asset registry. @public */
|
|
38
45
|
export interface AssetsResponse {
|
|
39
46
|
assets: Asset[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,iHAAiH;IACjH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
|
|
1
|
+
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kGAAkG;IAClG,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,iHAAiH;IACjH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAC7B,KAAK,EACL,YAAY,GAAG,IAAI,GAAG,eAAe,GAAG,SAAS,GAAG,aAAa,CAClE,CAAA;AAED,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AccountSummary, Balance, Fill, Order, Position } from './account.js';
|
|
1
|
+
import type { AccountSummary, AvailableToTrade, Balance, Fill, Order, Position } from './account.js';
|
|
2
2
|
import type { Candle, MarketContext, OhlcvInterval, OrderbookResponse, Trade } from './market.js';
|
|
3
3
|
import type { Address } from './primitives.js';
|
|
4
4
|
/** Subscription for the provider's aggregate market-context stream. @public */
|
|
@@ -69,12 +69,19 @@ export type AccountSummarySubscription = {
|
|
|
69
69
|
dex: string;
|
|
70
70
|
address: Address;
|
|
71
71
|
};
|
|
72
|
+
/** Subscription for per-market available-to-trade updates for one account. @public */
|
|
73
|
+
export type AvailableToTradeSubscription = {
|
|
74
|
+
channel: 'availableToTrade';
|
|
75
|
+
dex: string;
|
|
76
|
+
address: Address;
|
|
77
|
+
marketId: string;
|
|
78
|
+
};
|
|
72
79
|
/**
|
|
73
80
|
* Union of all websocket subscription request shapes.
|
|
74
81
|
*
|
|
75
82
|
* @public
|
|
76
83
|
*/
|
|
77
|
-
export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription;
|
|
84
|
+
export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription | AvailableToTradeSubscription;
|
|
78
85
|
/** Event containing the provider's aggregate market contexts. @public */
|
|
79
86
|
export type MarketsContextEvent = {
|
|
80
87
|
channel: 'marketsContext';
|
|
@@ -146,10 +153,19 @@ export type AccountSummaryEvent = {
|
|
|
146
153
|
channel: 'accountSummary';
|
|
147
154
|
data: AccountSummary;
|
|
148
155
|
};
|
|
156
|
+
/**
|
|
157
|
+
* Per-market available-to-trade frame for the subscribed market. The venue
|
|
158
|
+
* recomputes both sides when the account's margin or position changes.
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export type AvailableToTradeEvent = {
|
|
162
|
+
channel: 'availableToTrade';
|
|
163
|
+
data: AvailableToTrade;
|
|
164
|
+
};
|
|
149
165
|
/**
|
|
150
166
|
* Union of all websocket event frame shapes emitted for subscriptions.
|
|
151
167
|
*
|
|
152
168
|
* @public
|
|
153
169
|
*/
|
|
154
|
-
export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent;
|
|
170
|
+
export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent | AvailableToTradeEvent;
|
|
155
171
|
//# sourceMappingURL=subscriptions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,uEAAuE;AACvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,kFAAkF;AAClF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;
|
|
1
|
+
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,uEAAuE;AACvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,kFAAkF;AAClF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,GAC1B,4BAA4B,CAAA;AAEhC,yEAAyE;AACzE,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AACD,0DAA0D;AAC1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAC9E,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC7D,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAC9D,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,MAAM,EAAE,KAAK,EAAE,CAAA;QACf,8DAA8D;QAC9D,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AACD,gEAAgE;AAChE,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAC3D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AACvE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,IAAI,EAAE,gBAAgB,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,CAAA"}
|
package/package.json
CHANGED
package/src/account.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Asset } from './asset.js'
|
|
1
|
+
import type { Asset, AssetDisplay } from './asset.js'
|
|
2
2
|
import type {
|
|
3
3
|
ActionType,
|
|
4
4
|
ActivityType,
|
|
@@ -57,8 +57,10 @@ export interface Position {
|
|
|
57
57
|
/** Position leverage as a numeric multiple. */
|
|
58
58
|
leverage: number
|
|
59
59
|
/**
|
|
60
|
-
* Margin
|
|
61
|
-
*
|
|
60
|
+
* Margin reserved by this position as a decimal string: the venue figure of
|
|
61
|
+
* each provider, unchanged. Its unrealized-PnL treatment differs by venue.
|
|
62
|
+
* Hyperliquid isolated `marginUsed` includes the unrealized PnL of the
|
|
63
|
+
* position; Lighter `allocated_margin` excludes it.
|
|
62
64
|
*/
|
|
63
65
|
marginUsed: string
|
|
64
66
|
/**
|
|
@@ -69,19 +71,6 @@ export interface Position {
|
|
|
69
71
|
marginMode: MarginMode
|
|
70
72
|
}
|
|
71
73
|
|
|
72
|
-
/**
|
|
73
|
-
* Exact provider-owned inputs for changing one position's dedicated margin.
|
|
74
|
-
* `undefined` from the provider means the position has no individual margin
|
|
75
|
-
* adjustment.
|
|
76
|
-
* @public
|
|
77
|
-
*/
|
|
78
|
-
export interface PositionMarginConstraints {
|
|
79
|
-
/** Exact margin the venue requires this position to retain. */
|
|
80
|
-
minimumMarginRequirement: string
|
|
81
|
-
/** Smallest accepted margin amount, as an exact decimal string. */
|
|
82
|
-
amountIncrement: string
|
|
83
|
-
}
|
|
84
|
-
|
|
85
74
|
/** Shared identity, quantities, and lifecycle of a venue order. */
|
|
86
75
|
export interface OrderBase {
|
|
87
76
|
/** Venue-assigned id: Hyperliquid `oid`, Lighter `order_index`, Ondo `orderId`. */
|
|
@@ -151,12 +140,6 @@ export interface Balance {
|
|
|
151
140
|
valueUsd: string
|
|
152
141
|
/** USD price of one unit. Absent when the provider holds no price for the asset. */
|
|
153
142
|
price?: string
|
|
154
|
-
/**
|
|
155
|
-
* Fraction of `valueUsd` that backs available margin (a loan-to-value
|
|
156
|
-
* ratio). Absent means 1 — full value. Set below 1 for collateral the
|
|
157
|
-
* venue haircuts; ignored on non-collateral balances.
|
|
158
|
-
*/
|
|
159
|
-
collateralWeight?: number
|
|
160
143
|
}
|
|
161
144
|
|
|
162
145
|
/**
|
|
@@ -202,6 +185,25 @@ export interface AccountSummary {
|
|
|
202
185
|
unrealizedPnl: string
|
|
203
186
|
}
|
|
204
187
|
|
|
188
|
+
/**
|
|
189
|
+
* The amount an account can still buy or sell on one market, in that market's
|
|
190
|
+
* margin asset. The order panel reads this per-market figure. It differs from
|
|
191
|
+
* {@link AccountSummary.availableMargin}, which stays account-scoped.
|
|
192
|
+
*
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
export interface AvailableToTrade {
|
|
196
|
+
providerId: string
|
|
197
|
+
/** The market this figure applies to, equal to `Market.id`. */
|
|
198
|
+
marketId: string
|
|
199
|
+
/** The market's margin asset, which both amounts are denominated in. */
|
|
200
|
+
asset: AssetDisplay
|
|
201
|
+
/** Amount the account can still buy, represented as a decimal string. */
|
|
202
|
+
buy: string
|
|
203
|
+
/** Amount the account can still sell, represented as a decimal string. */
|
|
204
|
+
sell: string
|
|
205
|
+
}
|
|
206
|
+
|
|
205
207
|
/**
|
|
206
208
|
* The user's complete venue-side settings for one market: the margin mode
|
|
207
209
|
* and display leverage the next order on it will use. A provider returns
|
|
@@ -503,6 +505,36 @@ export interface HyperliquidBuilderFeeApproval {
|
|
|
503
505
|
approved: boolean
|
|
504
506
|
}
|
|
505
507
|
|
|
508
|
+
/**
|
|
509
|
+
* Hyperliquid `marginSummary` block, copied from the venue wire response.
|
|
510
|
+
* Every member is a decimal string in quote-asset units.
|
|
511
|
+
*
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
export interface HyperliquidMarginSummary {
|
|
515
|
+
/** Total equity: locked margin and unrealized PnL included. */
|
|
516
|
+
accountValue: string
|
|
517
|
+
totalNtlPos: string
|
|
518
|
+
totalRawUsd: string
|
|
519
|
+
totalMarginUsed: string
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* Venue account figures for one Hyperliquid perps sub-dex.
|
|
524
|
+
*
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
export interface HyperliquidDexAccountState {
|
|
528
|
+
/** Sub-dex name; the empty string is the main perps dex. */
|
|
529
|
+
dex: string
|
|
530
|
+
/** Whole account, cross and isolated positions together. */
|
|
531
|
+
marginSummary: HyperliquidMarginSummary
|
|
532
|
+
/** Cross-margin subset of {@link HyperliquidDexAccountState.marginSummary}. */
|
|
533
|
+
crossMarginSummary: HyperliquidMarginSummary
|
|
534
|
+
crossMaintenanceMarginUsed: string
|
|
535
|
+
withdrawable: string
|
|
536
|
+
}
|
|
537
|
+
|
|
506
538
|
/**
|
|
507
539
|
* Hyperliquid account configuration returned in {@link AccountResponse.config}.
|
|
508
540
|
*
|
|
@@ -514,6 +546,14 @@ export interface HyperliquidAccountConfig {
|
|
|
514
546
|
abstractionMode: string | null
|
|
515
547
|
agents: HyperliquidAgent[]
|
|
516
548
|
builderFeeApproval?: HyperliquidBuilderFeeApproval
|
|
549
|
+
/** One entry per perps sub-dex that still has a live market. */
|
|
550
|
+
dexStates: HyperliquidDexAccountState[]
|
|
551
|
+
/**
|
|
552
|
+
* Venue buying power: the quote-asset entry of the spot
|
|
553
|
+
* `tokenToAvailableAfterMaintenance` list. Unified and portfolio-margin
|
|
554
|
+
* accounts only; other modes derive buying power from `marginSummary`.
|
|
555
|
+
*/
|
|
556
|
+
availableAfterMaintenance?: string
|
|
517
557
|
}
|
|
518
558
|
|
|
519
559
|
/**
|
|
@@ -560,6 +600,17 @@ export interface LighterAccountConfig {
|
|
|
560
600
|
* {@link LighterAccountConfig.userTierName}.
|
|
561
601
|
*/
|
|
562
602
|
accountType: number
|
|
603
|
+
/**
|
|
604
|
+
* Lighter `available_balance`: venue buying power for the whole account,
|
|
605
|
+
* already marked to market. A decimal string in quote-asset units.
|
|
606
|
+
*/
|
|
607
|
+
availableBalance: string
|
|
608
|
+
/**
|
|
609
|
+
* Lighter `total_asset_value`: perps-route equity, isolated allocations and
|
|
610
|
+
* unrealized PnL included. It excludes the spot-route balances. A decimal
|
|
611
|
+
* string in quote-asset units.
|
|
612
|
+
*/
|
|
613
|
+
totalAssetValue: string
|
|
563
614
|
/**
|
|
564
615
|
* Lighter `user_tier_name` from `/accountLimits`, in the tier vocabulary
|
|
565
616
|
* `changeAccountTier` accepts. Absent on an unauthenticated read, which
|
|
@@ -588,6 +639,27 @@ export interface LighterAccountConfig {
|
|
|
588
639
|
referralPresent: boolean
|
|
589
640
|
}
|
|
590
641
|
|
|
642
|
+
/**
|
|
643
|
+
* Ondo `MarginAccountBalanceSummary` figures, copied from the venue wire
|
|
644
|
+
* response. Every member is a decimal string in quote-asset units. Ondo
|
|
645
|
+
* publishes two invariants: `marginBalance = walletBalance + unrealizedPnl`
|
|
646
|
+
* and `availableMargin = marginBalance - usedMargin`.
|
|
647
|
+
*
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
export interface OndoAccountBalance {
|
|
651
|
+
/** Collateral only: locked margin included, unrealized PnL excluded. */
|
|
652
|
+
walletBalance: string
|
|
653
|
+
unrealizedPnl: string
|
|
654
|
+
/** Total equity. */
|
|
655
|
+
marginBalance: string
|
|
656
|
+
usedMargin: string
|
|
657
|
+
/** Venue buying power. */
|
|
658
|
+
availableMargin: string
|
|
659
|
+
/** Venue withdrawable figure, at or below {@link OndoAccountBalance.availableMargin}. */
|
|
660
|
+
withdrawableMargin: string
|
|
661
|
+
}
|
|
662
|
+
|
|
591
663
|
/**
|
|
592
664
|
* Ondo account/session configuration returned in {@link AccountResponse.config}.
|
|
593
665
|
* Expiry values are Unix timestamps in seconds.
|
|
@@ -597,6 +669,8 @@ export interface LighterAccountConfig {
|
|
|
597
669
|
export interface OndoAccountConfig {
|
|
598
670
|
provider: 'ondo'
|
|
599
671
|
loggedIn: boolean
|
|
672
|
+
/** Venue balance figures. Absent when logged out, which reads no balance. */
|
|
673
|
+
balance?: OndoAccountBalance
|
|
600
674
|
/** Unix seconds. Present iff `loggedIn === true`. The token itself never appears here. */
|
|
601
675
|
authTokenExpiry?: number
|
|
602
676
|
/** Venue terms accepted, inferred from the login token's `newAccount` flag. Always `false` when logged out. */
|
package/src/asset.ts
CHANGED
|
@@ -35,6 +35,17 @@ export interface Asset {
|
|
|
35
35
|
minWithdrawalAmount?: string
|
|
36
36
|
}
|
|
37
37
|
|
|
38
|
+
/**
|
|
39
|
+
* The subset of {@link Asset} a consumer needs to label an amount: identity
|
|
40
|
+
* plus the symbol, name and logo a display shows.
|
|
41
|
+
*
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export type AssetDisplay = Pick<
|
|
45
|
+
Asset,
|
|
46
|
+
'providerId' | 'id' | 'displaySymbol' | 'logoURI' | 'displayName'
|
|
47
|
+
>
|
|
48
|
+
|
|
38
49
|
/** Response containing the provider's normalized asset registry. @public */
|
|
39
50
|
export interface AssetsResponse {
|
|
40
51
|
assets: Asset[]
|
package/src/subscriptions.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type {
|
|
2
2
|
AccountSummary,
|
|
3
|
+
AvailableToTrade,
|
|
3
4
|
Balance,
|
|
4
5
|
Fill,
|
|
5
6
|
Order,
|
|
@@ -83,6 +84,14 @@ export type AccountSummarySubscription = {
|
|
|
83
84
|
address: Address
|
|
84
85
|
}
|
|
85
86
|
|
|
87
|
+
/** Subscription for per-market available-to-trade updates for one account. @public */
|
|
88
|
+
export type AvailableToTradeSubscription = {
|
|
89
|
+
channel: 'availableToTrade'
|
|
90
|
+
dex: string
|
|
91
|
+
address: Address
|
|
92
|
+
marketId: string
|
|
93
|
+
}
|
|
94
|
+
|
|
86
95
|
/**
|
|
87
96
|
* Union of all websocket subscription request shapes.
|
|
88
97
|
*
|
|
@@ -99,6 +108,7 @@ export type Subscription =
|
|
|
99
108
|
| PositionsSubscription
|
|
100
109
|
| SpotBalancesSubscription
|
|
101
110
|
| AccountSummarySubscription
|
|
111
|
+
| AvailableToTradeSubscription
|
|
102
112
|
|
|
103
113
|
/** Event containing the provider's aggregate market contexts. @public */
|
|
104
114
|
export type MarketsContextEvent = {
|
|
@@ -156,6 +166,16 @@ export type AccountSummaryEvent = {
|
|
|
156
166
|
data: AccountSummary
|
|
157
167
|
}
|
|
158
168
|
|
|
169
|
+
/**
|
|
170
|
+
* Per-market available-to-trade frame for the subscribed market. The venue
|
|
171
|
+
* recomputes both sides when the account's margin or position changes.
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
export type AvailableToTradeEvent = {
|
|
175
|
+
channel: 'availableToTrade'
|
|
176
|
+
data: AvailableToTrade
|
|
177
|
+
}
|
|
178
|
+
|
|
159
179
|
/**
|
|
160
180
|
* Union of all websocket event frame shapes emitted for subscriptions.
|
|
161
181
|
*
|
|
@@ -172,3 +192,4 @@ export type SubscriptionEvent =
|
|
|
172
192
|
| PositionsEvent
|
|
173
193
|
| SpotBalancesEvent
|
|
174
194
|
| AccountSummaryEvent
|
|
195
|
+
| AvailableToTradeEvent
|