@lifi/perps-types 4.0.0 → 4.0.1
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.map +1 -1
- package/dist/cjs/action.d.ts +1 -0
- package/dist/cjs/action.d.ts.map +1 -1
- package/dist/cjs/asset.d.ts.map +1 -1
- package/dist/cjs/enums.d.ts.map +1 -1
- package/dist/cjs/enums.js.map +1 -1
- package/dist/cjs/errors.d.ts.map +1 -1
- package/dist/cjs/market.d.ts.map +1 -1
- package/dist/cjs/primitives.d.ts.map +1 -1
- package/dist/cjs/providers.d.ts.map +1 -1
- package/dist/cjs/subscriptions.d.ts.map +1 -1
- package/dist/cjs/typedData.d.ts.map +1 -1
- package/dist/cjs/vote.d.ts.map +1 -1
- package/dist/cjs/vote.js.map +1 -1
- package/dist/esm/account.d.ts +194 -31
- package/dist/esm/account.d.ts.map +1 -1
- package/dist/esm/action.d.ts +205 -37
- package/dist/esm/action.d.ts.map +1 -1
- package/dist/esm/asset.d.ts +1 -4
- package/dist/esm/asset.d.ts.map +1 -1
- package/dist/esm/enums.d.ts +34 -20
- package/dist/esm/enums.d.ts.map +1 -1
- package/dist/esm/enums.js +33 -19
- package/dist/esm/enums.js.map +1 -1
- package/dist/esm/errors.d.ts +6 -1
- package/dist/esm/errors.d.ts.map +1 -1
- package/dist/esm/market.d.ts +47 -14
- package/dist/esm/market.d.ts.map +1 -1
- package/dist/esm/primitives.d.ts +12 -2
- package/dist/esm/primitives.d.ts.map +1 -1
- package/dist/esm/providers.d.ts +19 -6
- package/dist/esm/providers.d.ts.map +1 -1
- package/dist/esm/quote.d.ts +2 -2
- package/dist/esm/quote.d.ts.map +1 -1
- package/dist/esm/subscriptions.d.ts +27 -19
- package/dist/esm/subscriptions.d.ts.map +1 -1
- package/dist/esm/typedData.d.ts +15 -5
- package/dist/esm/typedData.d.ts.map +1 -1
- package/dist/esm/vote.d.ts +1 -3
- package/dist/esm/vote.d.ts.map +1 -1
- package/dist/esm/vote.js.map +1 -1
- package/dist/types/account.d.ts +194 -31
- package/dist/types/account.d.ts.map +1 -1
- package/dist/types/action.d.ts +205 -37
- package/dist/types/action.d.ts.map +1 -1
- package/dist/types/asset.d.ts +1 -4
- package/dist/types/asset.d.ts.map +1 -1
- package/dist/types/enums.d.ts +34 -20
- package/dist/types/enums.d.ts.map +1 -1
- package/dist/types/errors.d.ts +6 -1
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/market.d.ts +47 -14
- package/dist/types/market.d.ts.map +1 -1
- package/dist/types/primitives.d.ts +12 -2
- package/dist/types/primitives.d.ts.map +1 -1
- package/dist/types/providers.d.ts +19 -6
- package/dist/types/providers.d.ts.map +1 -1
- package/dist/types/quote.d.ts +2 -2
- package/dist/types/quote.d.ts.map +1 -1
- package/dist/types/subscriptions.d.ts +27 -19
- package/dist/types/subscriptions.d.ts.map +1 -1
- package/dist/types/typedData.d.ts +15 -5
- package/dist/types/typedData.d.ts.map +1 -1
- package/dist/types/vote.d.ts +1 -3
- package/dist/types/vote.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/account.ts +194 -36
- package/src/action.ts +205 -37
- package/src/asset.ts +1 -4
- package/src/enums.ts +34 -20
- package/src/errors.ts +6 -1
- package/src/market.ts +47 -14
- package/src/primitives.ts +12 -2
- package/src/providers.ts +19 -6
- package/src/quote.ts +2 -2
- package/src/subscriptions.ts +27 -19
- package/src/typedData.ts +15 -5
- package/src/vote.ts +1 -3
package/dist/types/enums.d.ts
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/**
|
|
2
|
+
* Numeric error codes returned by the perps API.
|
|
3
|
+
*
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
2
6
|
export declare enum PerpsErrorCode {
|
|
3
7
|
DefaultError = 2000,
|
|
4
8
|
ServerError = 2001,
|
|
@@ -24,12 +28,12 @@ export declare enum PerpsErrorCode {
|
|
|
24
28
|
PayloadMismatch = 2050,
|
|
25
29
|
RouteNotFound = 2060
|
|
26
30
|
}
|
|
27
|
-
/** @public */
|
|
31
|
+
/** Side of an order or execution, using provider wire values. @public */
|
|
28
32
|
export declare enum OrderSide {
|
|
29
33
|
BUY = "BUY",
|
|
30
34
|
SELL = "SELL"
|
|
31
35
|
}
|
|
32
|
-
/** @public */
|
|
36
|
+
/** Supported regular and trigger order kinds, using provider wire values. @public */
|
|
33
37
|
export declare enum OrderType {
|
|
34
38
|
MARKET = "MARKET",
|
|
35
39
|
LIMIT = "LIMIT",
|
|
@@ -39,12 +43,12 @@ export declare enum OrderType {
|
|
|
39
43
|
TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT",
|
|
40
44
|
TRIGGER_ONLY = "TRIGGER_ONLY"
|
|
41
45
|
}
|
|
42
|
-
/** @public */
|
|
46
|
+
/** Direction of an open position. @public */
|
|
43
47
|
export declare enum PositionSide {
|
|
44
48
|
LONG = "LONG",
|
|
45
49
|
SHORT = "SHORT"
|
|
46
50
|
}
|
|
47
|
-
/** @public */
|
|
51
|
+
/** Margin allocation mode for a position. @public */
|
|
48
52
|
export declare enum MarginMode {
|
|
49
53
|
ISOLATED = "ISOLATED",
|
|
50
54
|
CROSS = "CROSS"
|
|
@@ -58,14 +62,14 @@ export declare enum PositionMarginAdjustment {
|
|
|
58
62
|
/** Margin can be added and removed. */
|
|
59
63
|
ADD_AND_REMOVE = "ADD_AND_REMOVE"
|
|
60
64
|
}
|
|
61
|
-
/** @public */
|
|
65
|
+
/** Provider order time-in-force policies. @public */
|
|
62
66
|
export declare enum TimeInForce {
|
|
63
67
|
GTC = "GTC",
|
|
64
68
|
IOC = "IOC",
|
|
65
69
|
POST_ONLY = "POST_ONLY",
|
|
66
70
|
GTT = "GTT"
|
|
67
71
|
}
|
|
68
|
-
/** @public */
|
|
72
|
+
/** Lifecycle status of a provider order. @public */
|
|
69
73
|
export declare enum OrderStatus {
|
|
70
74
|
PENDING = "PENDING",
|
|
71
75
|
OPEN = "OPEN",
|
|
@@ -76,19 +80,24 @@ export declare enum OrderStatus {
|
|
|
76
80
|
EXPIRED = "EXPIRED",
|
|
77
81
|
TRIGGERED = "TRIGGERED"
|
|
78
82
|
}
|
|
79
|
-
/** @public */
|
|
83
|
+
/** Lifecycle status of an execution/fill. @public */
|
|
80
84
|
export declare enum FillStatus {
|
|
81
85
|
FILLED = "FILLED",
|
|
82
86
|
PARTIALLY_FILLED = "PARTIALLY_FILLED",
|
|
83
87
|
CANCELLED = "CANCELLED",
|
|
84
88
|
REJECTED = "REJECTED"
|
|
85
89
|
}
|
|
86
|
-
/** @public */
|
|
90
|
+
/** Whether a fill supplied maker or taker liquidity. @public */
|
|
87
91
|
export declare enum LiquidityRole {
|
|
88
92
|
MAKER = "maker",
|
|
89
93
|
TAKER = "taker"
|
|
90
94
|
}
|
|
91
|
-
/**
|
|
95
|
+
/**
|
|
96
|
+
* Action identifiers used in setup, create-action, and execute-action
|
|
97
|
+
* requests. Values are the backend wire strings.
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
92
101
|
export declare enum ActionType {
|
|
93
102
|
APPROVE_AGENT = "approveAgent",
|
|
94
103
|
APPROVE_BUILDER_FEE = "approveBuilderFee",
|
|
@@ -119,23 +128,23 @@ export declare enum ActionType {
|
|
|
119
128
|
/** Provider-independent: sent with the `META_PROVIDER` sentinel, not a real provider key. */
|
|
120
129
|
META_ACCEPT_TERMS = "metaAcceptTerms"
|
|
121
130
|
}
|
|
122
|
-
/** @public */
|
|
131
|
+
/** Price relation that activates a trigger order. @public */
|
|
123
132
|
export declare enum TriggerCondition {
|
|
124
133
|
ABOVE = "ABOVE",
|
|
125
134
|
BELOW = "BELOW"
|
|
126
135
|
}
|
|
127
|
-
/** @public */
|
|
136
|
+
/** Take-profit or stop-loss trigger order classification. @public */
|
|
128
137
|
export declare enum TriggerOrderType {
|
|
129
138
|
TAKE_PROFIT = "TAKE_PROFIT",
|
|
130
139
|
STOP_LOSS = "STOP_LOSS"
|
|
131
140
|
}
|
|
132
|
-
/** @public */
|
|
141
|
+
/** Lifecycle status of a trigger order. @public */
|
|
133
142
|
export declare enum TriggerOrderStatus {
|
|
134
143
|
WAITING = "WAITING",
|
|
135
144
|
TRIGGERED = "TRIGGERED",
|
|
136
145
|
CANCELLED = "CANCELLED"
|
|
137
146
|
}
|
|
138
|
-
/** @public */
|
|
147
|
+
/** Account activity record categories. @public */
|
|
139
148
|
export declare enum ActivityType {
|
|
140
149
|
DEPOSIT = "DEPOSIT",
|
|
141
150
|
WITHDRAWAL = "WITHDRAWAL",
|
|
@@ -143,7 +152,7 @@ export declare enum ActivityType {
|
|
|
143
152
|
FUNDING = "FUNDING",
|
|
144
153
|
TRANSFER = "TRANSFER"
|
|
145
154
|
}
|
|
146
|
-
/** @public */
|
|
155
|
+
/** Human-readable classification of how a fill changed a position. @public */
|
|
147
156
|
export declare enum FillClassification {
|
|
148
157
|
OPENED_LONG = "Opened Long",
|
|
149
158
|
OPENED_SHORT = "Opened Short",
|
|
@@ -158,21 +167,21 @@ export declare enum FillClassification {
|
|
|
158
167
|
SPOT_BUY = "Spot Buy",
|
|
159
168
|
SPOT_SELL = "Spot Sell"
|
|
160
169
|
}
|
|
161
|
-
/** @public */
|
|
170
|
+
/** Classification emitted for a liquidation activity. @public */
|
|
162
171
|
export declare enum LiquidationClassification {
|
|
163
172
|
LIQUIDATED = "Liquidated"
|
|
164
173
|
}
|
|
165
|
-
/** @public */
|
|
174
|
+
/** Classification emitted for a funding activity. @public */
|
|
166
175
|
export declare enum FundingClassification {
|
|
167
176
|
FUNDING = "Funding"
|
|
168
177
|
}
|
|
169
|
-
/** @public */
|
|
178
|
+
/** Classification emitted for an inbound, outbound, or internal transfer. @public */
|
|
170
179
|
export declare enum TransferClassification {
|
|
171
180
|
DEPOSIT = "Deposit",
|
|
172
181
|
WITHDRAWAL = "Withdrawal",
|
|
173
182
|
TRANSFER = "Transfer"
|
|
174
183
|
}
|
|
175
|
-
/** @public */
|
|
184
|
+
/** Union of classifications emitted by all activity record categories. @public */
|
|
176
185
|
export type ActivityClassification = FillClassification | LiquidationClassification | FundingClassification | TransferClassification;
|
|
177
186
|
/**
|
|
178
187
|
* Who completes signing for an action.
|
|
@@ -187,7 +196,12 @@ export declare enum PerpsSigner {
|
|
|
187
196
|
USER = "USER",
|
|
188
197
|
SDK = "SDK"
|
|
189
198
|
}
|
|
190
|
-
/**
|
|
199
|
+
/**
|
|
200
|
+
* Signing mechanisms supported by action steps. Values are serialized in
|
|
201
|
+
* provider metadata and action responses.
|
|
202
|
+
*
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
191
205
|
export declare enum SigningMethod {
|
|
192
206
|
EIP712 = "eip712",
|
|
193
207
|
WASM_BLOB = "wasmBlob",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,cAAc;IAExB,YAAY,OAAO;IACnB,WAAW,OAAO;IAClB,eAAe,OAAO;IACtB,YAAY,OAAO;IACnB,eAAe,OAAO;IACtB,QAAQ,OAAO;IAGf,gBAAgB,OAAO;IACvB,iBAAiB,OAAO;IACxB,gBAAgB,OAAO;IACvB,8EAA8E;IAC9E,YAAY,OAAO;IAGnB,gBAAgB,OAAO;IACvB,kBAAkB,OAAO;IACzB,mBAAmB,OAAO;IAC1B,cAAc,OAAO;IACrB,aAAa,OAAO;IACpB,gBAAgB,OAAO;IACvB,eAAe,OAAO;IAGtB,YAAY,OAAO;IACnB,gBAAgB,OAAO;IACvB,YAAY,OAAO;IAGnB,eAAe,OAAO;IAGtB,aAAa,OAAO;CACrB;AAED,yEAAyE;AACzE,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,qFAAqF;AACrF,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,YAAY,iBAAiB;CAC9B;AAED,6CAA6C;AAC7C,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,qDAAqD;AACrD,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,mFAAmF;AACnF,oBAAY,wBAAwB;IAClC,4DAA4D;IAC5D,IAAI,SAAS;IACb,iDAAiD;IACjD,QAAQ,aAAa;IACrB,uCAAuC;IACvC,cAAc,mBAAmB;CAClC;AAED,qDAAqD;AACrD,oBAAY,WAAW;IACrB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,SAAS,cAAc;IACvB,GAAG,QAAQ;CACZ;AAED,oDAAoD;AACpD,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,qDAAqD;AACrD,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,gEAAgE;AAChE,oBAAY,aAAa;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,oBAAY,UAAU;IACpB,aAAa,iBAAiB;IAC9B,mBAAmB,sBAAsB;IACzC,kBAAkB,sBAAsB;IACxC,YAAY,gBAAgB;IAC5B,YAAY,gBAAgB;IAC5B,YAAY,gBAAgB;IAC5B,UAAU,cAAc;IACxB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,WAAW,eAAe;IAC1B,mBAAmB,sBAAsB;IACzC,YAAY,gBAAgB;IAC5B,iBAAiB,oBAAoB;IACrC,YAAY,gBAAgB;IAC5B,eAAe,mBAAmB;IAClC,sBAAsB,yBAAyB;IAC/C,uBAAuB,0BAA0B;IACjD,gBAAgB,mBAAmB;IACnC,uBAAuB,yBAAyB;IAChD,UAAU,cAAc;IACxB,sBAAsB,yBAAyB;IAC/C,sLAAsL;IACtL,qBAAqB,wBAAwB;IAC7C,OAAO,YAAY;IACnB,6FAA6F;IAC7F,SAAS,aAAa;IACtB,6FAA6F;IAC7F,iBAAiB,oBAAoB;CACtC;AAED,6DAA6D;AAC7D,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,qEAAqE;AACrE,oBAAY,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACxB;AAED,mDAAmD;AACnD,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,SAAS,cAAc;CACxB;AAED,kDAAkD;AAClD,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED,8EAA8E;AAC9E,oBAAY,kBAAkB;IAC5B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAED,iEAAiE;AACjE,oBAAY,yBAAyB;IACnC,UAAU,eAAe;CAC1B;AAED,6DAA6D;AAC7D,oBAAY,qBAAqB;IAC/B,OAAO,YAAY;CACpB;AAED,qFAAqF;AACrF,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED,kFAAkF;AAClF,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,yBAAyB,GACzB,qBAAqB,GACrB,sBAAsB,CAAA;AAE1B;;;;;;;;GAQG;AACH,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,GAAG,QAAQ;CACZ;AAED;;;;;GAKG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,SAAS,aAAa;IACtB,MAAM,UAAU;IAChB,sIAAsI;IACtI,IAAI,SAAS;IACb,qEAAqE;IACrE,IAAI,SAAS;IACb,gJAAgJ;IAChJ,OAAO,YAAY;CACpB"}
|
package/dist/types/errors.d.ts
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import type { PerpsErrorCode } from './enums.js';
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Structured perps API error payload. `code` is the stable classification;
|
|
4
|
+
* `tool` identifies the backend tool when the provider supplies one.
|
|
5
|
+
*
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
3
8
|
export interface PerpsErrorBody {
|
|
4
9
|
code: PerpsErrorCode;
|
|
5
10
|
tool?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB"}
|
package/dist/types/market.d.ts
CHANGED
|
@@ -1,21 +1,32 @@
|
|
|
1
1
|
import type { Asset } from './asset.js';
|
|
2
2
|
import type { PositionMarginAdjustment } from './enums.js';
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* Current funding rate and next funding timestamp for a perpetual market.
|
|
5
|
+
* `rate` is a decimal fraction; `nextFundingTime` is Unix milliseconds.
|
|
6
|
+
*
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
4
9
|
export interface FundingInfo {
|
|
10
|
+
/** Funding rate as a decimal fraction. */
|
|
5
11
|
rate: string;
|
|
12
|
+
/** Next funding timestamp in Unix milliseconds. */
|
|
6
13
|
nextFundingTime: number;
|
|
7
14
|
}
|
|
8
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Shared market metadata for perpetual and spot instruments.
|
|
17
|
+
*
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
9
20
|
export interface BaseMarket {
|
|
10
21
|
providerId: string;
|
|
11
22
|
/** Opaque provider market id; referenced elsewhere as `marketId`. */
|
|
12
23
|
id: string;
|
|
13
|
-
/** Whether the venue has delisted this market. */
|
|
14
24
|
isDelisted?: boolean;
|
|
15
25
|
/** References a {@link ProviderCategory} by id. */
|
|
16
26
|
categoryId: string;
|
|
17
27
|
baseAsset: Asset;
|
|
18
28
|
quoteAsset: Asset;
|
|
29
|
+
/** Maximum fractional precision accepted for order sizes. */
|
|
19
30
|
szDecimals: number;
|
|
20
31
|
/**
|
|
21
32
|
* Maximum decimal places the venue accepts for order prices on this market.
|
|
@@ -39,7 +50,11 @@ export interface BaseMarket {
|
|
|
39
50
|
*/
|
|
40
51
|
sizeIncrement?: string;
|
|
41
52
|
}
|
|
42
|
-
/**
|
|
53
|
+
/**
|
|
54
|
+
* Perpetual market metadata, including leverage and margin constraints.
|
|
55
|
+
*
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
43
58
|
export interface PerpsMarket extends BaseMarket {
|
|
44
59
|
maxLeverage: number;
|
|
45
60
|
onlyIsolated: boolean;
|
|
@@ -59,9 +74,14 @@ export interface PerpsMarket extends BaseMarket {
|
|
|
59
74
|
export interface SpotMarket extends BaseMarket {
|
|
60
75
|
positionMarginAdjustment?: never;
|
|
61
76
|
}
|
|
62
|
-
/** @public */
|
|
77
|
+
/** Union of perpetual and spot market representations. @public */
|
|
63
78
|
export type Market = PerpsMarket | SpotMarket;
|
|
64
|
-
/**
|
|
79
|
+
/**
|
|
80
|
+
* UI-safe market projection containing identity, category, assets, and
|
|
81
|
+
* delisting state without provider-specific trading constraints.
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
65
85
|
export type MarketDisplay = Pick<BaseMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset' | 'isDelisted'>;
|
|
66
86
|
/** Perpetual-market identity embedded on an open {@link Position}. @public */
|
|
67
87
|
export type PerpsMarketDisplay = Pick<PerpsMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset' | 'isDelisted' | 'positionMarginAdjustment'>;
|
|
@@ -75,7 +95,7 @@ export interface MarketRef {
|
|
|
75
95
|
marketId: string;
|
|
76
96
|
categoryId: string;
|
|
77
97
|
}
|
|
78
|
-
/** @public */
|
|
98
|
+
/** Response containing all markets returned for a provider. @public */
|
|
79
99
|
export interface MarketsResponse {
|
|
80
100
|
markets: Market[];
|
|
81
101
|
}
|
|
@@ -89,8 +109,11 @@ export interface MarketsResponse {
|
|
|
89
109
|
* @public
|
|
90
110
|
*/
|
|
91
111
|
export interface MarketContext {
|
|
112
|
+
/** Opaque provider market identifier for this context frame. */
|
|
92
113
|
marketId: string;
|
|
114
|
+
/** Current order-book midpoint, as a decimal quote string. */
|
|
93
115
|
midPrice: string;
|
|
116
|
+
/** Provider mark price, as a decimal quote string. */
|
|
94
117
|
markPrice: string;
|
|
95
118
|
oraclePrice?: string;
|
|
96
119
|
prevDayPrice?: string;
|
|
@@ -100,11 +123,16 @@ export interface MarketContext {
|
|
|
100
123
|
openInterest?: string;
|
|
101
124
|
funding?: FundingInfo;
|
|
102
125
|
}
|
|
103
|
-
/** @public */
|
|
126
|
+
/** Response containing live context for requested markets. @public */
|
|
104
127
|
export interface PricesResponse {
|
|
105
128
|
prices: MarketContext[];
|
|
106
129
|
}
|
|
107
|
-
/**
|
|
130
|
+
/**
|
|
131
|
+
* OHLCV candle with Unix-millisecond open time and decimal-string OHLCV
|
|
132
|
+
* values. Field names follow the compact provider response shape.
|
|
133
|
+
*
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
108
136
|
export interface Candle {
|
|
109
137
|
t: number;
|
|
110
138
|
o: string;
|
|
@@ -113,21 +141,26 @@ export interface Candle {
|
|
|
113
141
|
c: string;
|
|
114
142
|
v: string;
|
|
115
143
|
}
|
|
116
|
-
/** @public */
|
|
144
|
+
/** Response containing candles for one provider market and interval. @public */
|
|
117
145
|
export interface OhlcvResponse {
|
|
118
146
|
provider: string;
|
|
119
147
|
marketId: string;
|
|
120
148
|
interval: string;
|
|
121
149
|
candles: Candle[];
|
|
122
150
|
}
|
|
123
|
-
/**
|
|
151
|
+
/**
|
|
152
|
+
* Supported OHLCV intervals. Values are wire interval strings (`1M` is one
|
|
153
|
+
* month; lowercase `m` values are minutes).
|
|
154
|
+
*
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
124
157
|
export type OhlcvInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
|
|
125
|
-
/** @public */
|
|
158
|
+
/** One price/size level in an order book; both values are decimal strings. @public */
|
|
126
159
|
export interface OrderbookLevel {
|
|
127
160
|
price: string;
|
|
128
161
|
size: string;
|
|
129
162
|
}
|
|
130
|
-
/** @public */
|
|
163
|
+
/** Snapshot of bids and asks for one market. `timestamp` is Unix milliseconds. @public */
|
|
131
164
|
export interface OrderbookResponse {
|
|
132
165
|
provider: string;
|
|
133
166
|
marketId: string;
|
|
@@ -135,7 +168,7 @@ export interface OrderbookResponse {
|
|
|
135
168
|
asks: OrderbookLevel[];
|
|
136
169
|
timestamp: number;
|
|
137
170
|
}
|
|
138
|
-
/** @public */
|
|
171
|
+
/** Recent trade normalized for a market; `timestamp` is Unix milliseconds. @public */
|
|
139
172
|
export interface Trade {
|
|
140
173
|
provider: string;
|
|
141
174
|
marketId: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D
|
|
1
|
+
{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,mDAAmD;IACnD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,wBAAwB,EAAE,wBAAwB,CAAA;IAClD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAA;CACjC;AAED,kEAAkE;AAClE,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAC/E,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,WAAW,EACT,YAAY,GACZ,IAAI,GACJ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAA;AAER,sFAAsF;AACtF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0FAA0F;AAC1F,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,sFAAsF;AACtF,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
|
|
@@ -1,5 +1,15 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/**
|
|
2
|
+
* Hex-prefixed EVM address string. The type validates only the `0x` prefix;
|
|
3
|
+
* checksum and byte-length validation remain runtime/provider concerns.
|
|
4
|
+
*
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
2
7
|
export type Address = `0x${string}`;
|
|
3
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Hex-prefixed byte string used for hashes, signatures, salts, and other EVM
|
|
10
|
+
* wire values. The type does not constrain byte length.
|
|
11
|
+
*
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
4
14
|
export type Hex = `0x${string}`;
|
|
5
15
|
//# sourceMappingURL=primitives.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../src/primitives.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../src/primitives.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAA"}
|
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
import type { Asset, DepositAsset } from './asset.js';
|
|
2
2
|
import type { ActionType, PerpsSigner, SigningMethod } from './enums.js';
|
|
3
3
|
import type { OhlcvInterval } from './market.js';
|
|
4
|
-
/** @public */
|
|
4
|
+
/** A fixed option value presented for a provider action parameter. @public */
|
|
5
5
|
export interface ParamOption {
|
|
6
6
|
value: string;
|
|
7
7
|
label: string;
|
|
8
8
|
}
|
|
9
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Metadata describing one provider action parameter and its UI constraints.
|
|
11
|
+
*
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
10
14
|
export interface Param {
|
|
11
15
|
/** Wire key for the action params object: `{ [param.name]: value }`. */
|
|
12
16
|
name: string;
|
|
@@ -55,7 +59,11 @@ export interface TradeNotice {
|
|
|
55
59
|
/** Plaintext; any URL is rendered as text, not a hyperlink. */
|
|
56
60
|
message: string;
|
|
57
61
|
}
|
|
58
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* Provider category metadata, including quote asset and optional market notice.
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
59
67
|
export interface ProviderCategory {
|
|
60
68
|
id: string;
|
|
61
69
|
logoURI?: string;
|
|
@@ -63,14 +71,19 @@ export interface ProviderCategory {
|
|
|
63
71
|
quoteAsset: Asset | null;
|
|
64
72
|
tradeNotice?: TradeNotice;
|
|
65
73
|
}
|
|
66
|
-
/** @public */
|
|
74
|
+
/** Provider-wide funding cadence metadata, expressed in seconds. @public */
|
|
67
75
|
export interface ProviderFunding {
|
|
68
76
|
/** Number of seconds represented by the provider's funding rate. */
|
|
69
77
|
ratePeriodSeconds: number;
|
|
70
78
|
/** Number of seconds between funding payouts. */
|
|
71
79
|
payoutCadenceSeconds: number;
|
|
72
80
|
}
|
|
73
|
-
/**
|
|
81
|
+
/**
|
|
82
|
+
* Provider descriptor containing capabilities, actions, categories, and
|
|
83
|
+
* optional deposit/trading limits.
|
|
84
|
+
*
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
74
87
|
export interface Provider {
|
|
75
88
|
key: string;
|
|
76
89
|
name: string;
|
|
@@ -134,7 +147,7 @@ export interface Provider {
|
|
|
134
147
|
*/
|
|
135
148
|
supportedIntervals: OhlcvInterval[];
|
|
136
149
|
}
|
|
137
|
-
/** @public */
|
|
150
|
+
/** Response containing provider descriptors available to the client. @public */
|
|
138
151
|
export interface ProvidersResponse {
|
|
139
152
|
providers: Provider[];
|
|
140
153
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,
|
|
1
|
+
{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,QAAQ,CAAA;IACd,yFAAyF;IACzF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,aAAa,EAAE,aAAa,CAAA;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,4EAA4E;AAC5E,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,aAAa,CAAA;IAC5B,+EAA+E;IAC/E,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,UAAU,EAAE,gBAAgB,EAAE,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
|
package/dist/types/quote.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { FeeTier } from './account.js';
|
|
2
2
|
import type { FundingInfo } from './market.js';
|
|
3
|
-
/** @public */
|
|
3
|
+
/** Side of the quoted market order, using lowercase wire values. @public */
|
|
4
4
|
export type QuoteSide = 'buy' | 'sell';
|
|
5
|
-
/** @public */
|
|
5
|
+
/** Trade instrument kind represented by the quote. @public */
|
|
6
6
|
export type TradeType = 'perps' | 'spot';
|
|
7
7
|
/**
|
|
8
8
|
* One-shot fill estimate for a market order of `sizeUsd` notional on a single
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/quote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,
|
|
1
|
+
{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/quote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,4EAA4E;AAC5E,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;AAEtC,8DAA8D;AAC9D,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,oGAAoG;IACpG,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,iBAAiB,EAAE,MAAM,CAAA;IACzB,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAA;IAChB,uFAAuF;IACvF,gBAAgB,EAAE,OAAO,CAAA;IACzB,iFAAiF;IACjF,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;IAC3B,4GAA4G;IAC5G,qBAAqB,EAAE,OAAO,CAAA;IAC9B,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAA;CAClB"}
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import type { AccountSummary, Balance, Fill, OpenOrder, Position, TriggerOrder } from './account.js';
|
|
2
2
|
import type { Candle, MarketContext, OhlcvInterval, OrderbookResponse, Trade } from './market.js';
|
|
3
3
|
import type { Address } from './primitives.js';
|
|
4
|
-
/** @public */
|
|
4
|
+
/** Subscription for the provider's aggregate market-context stream. @public */
|
|
5
5
|
export type MarketsContextSubscription = {
|
|
6
6
|
channel: 'marketsContext';
|
|
7
7
|
dex: string;
|
|
8
8
|
};
|
|
9
|
-
/** @public */
|
|
9
|
+
/** Subscription for one market's live context stream. @public */
|
|
10
10
|
export type MarketContextSubscription = {
|
|
11
11
|
channel: 'marketContext';
|
|
12
12
|
dex: string;
|
|
13
13
|
marketId: string;
|
|
14
14
|
};
|
|
15
|
-
/** @public */
|
|
15
|
+
/** Subscription for streamed order-book updates for one market. @public */
|
|
16
16
|
export type OrderbookSubscription = {
|
|
17
17
|
channel: 'orderbook';
|
|
18
18
|
dex: string;
|
|
@@ -26,77 +26,81 @@ export type OrderbookSubscription = {
|
|
|
26
26
|
*/
|
|
27
27
|
priceStep?: number;
|
|
28
28
|
};
|
|
29
|
-
/** @public */
|
|
29
|
+
/** Subscription for OHLCV candle updates for one market and interval. @public */
|
|
30
30
|
export type CandleSubscription = {
|
|
31
31
|
channel: 'candle';
|
|
32
32
|
dex: string;
|
|
33
33
|
marketId: string;
|
|
34
34
|
interval: OhlcvInterval;
|
|
35
35
|
};
|
|
36
|
-
/** @public */
|
|
36
|
+
/** Subscription for recent trade updates for one market. @public */
|
|
37
37
|
export type TradesSubscription = {
|
|
38
38
|
channel: 'trades';
|
|
39
39
|
dex: string;
|
|
40
40
|
marketId: string;
|
|
41
41
|
};
|
|
42
|
-
/** @public */
|
|
42
|
+
/** Subscription for order lifecycle updates for one account. @public */
|
|
43
43
|
export type OrderUpdatesSubscription = {
|
|
44
44
|
channel: 'orderUpdates';
|
|
45
45
|
dex: string;
|
|
46
46
|
address: Address;
|
|
47
47
|
};
|
|
48
|
-
/** @public */
|
|
48
|
+
/** Subscription for execution/fill updates for one account. @public */
|
|
49
49
|
export type FillsSubscription = {
|
|
50
50
|
channel: 'fills';
|
|
51
51
|
dex: string;
|
|
52
52
|
address: Address;
|
|
53
53
|
};
|
|
54
|
-
/** @public */
|
|
54
|
+
/** Subscription for the full open-position set for one account. @public */
|
|
55
55
|
export type PositionsSubscription = {
|
|
56
56
|
channel: 'positions';
|
|
57
57
|
dex: string;
|
|
58
58
|
address: Address;
|
|
59
59
|
};
|
|
60
|
-
/** @public */
|
|
60
|
+
/** Subscription for spot-balance updates for one account. @public */
|
|
61
61
|
export type SpotBalancesSubscription = {
|
|
62
62
|
channel: 'spotBalances';
|
|
63
63
|
dex: string;
|
|
64
64
|
address: Address;
|
|
65
65
|
};
|
|
66
|
-
/** @public */
|
|
66
|
+
/** Subscription for aggregate account-summary updates for one account. @public */
|
|
67
67
|
export type AccountSummarySubscription = {
|
|
68
68
|
channel: 'accountSummary';
|
|
69
69
|
dex: string;
|
|
70
70
|
address: Address;
|
|
71
71
|
};
|
|
72
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* Union of all websocket subscription request shapes.
|
|
74
|
+
*
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
73
77
|
export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription;
|
|
74
|
-
/** @public */
|
|
78
|
+
/** Event containing the provider's aggregate market contexts. @public */
|
|
75
79
|
export type MarketsContextEvent = {
|
|
76
80
|
channel: 'marketsContext';
|
|
77
81
|
data: Record<string, MarketContext>;
|
|
78
82
|
};
|
|
79
|
-
/** @public */
|
|
83
|
+
/** Event containing one market's live context. @public */
|
|
80
84
|
export type MarketContextEvent = {
|
|
81
85
|
channel: 'marketContext';
|
|
82
86
|
data: MarketContext;
|
|
83
87
|
};
|
|
84
|
-
/** @public */
|
|
88
|
+
/** Event containing an order-book snapshot or update. @public */
|
|
85
89
|
export type OrderbookEvent = {
|
|
86
90
|
channel: 'orderbook';
|
|
87
91
|
data: OrderbookResponse;
|
|
88
92
|
};
|
|
89
|
-
/** @public */
|
|
93
|
+
/** Event containing one OHLCV candle. @public */
|
|
90
94
|
export type CandleEvent = {
|
|
91
95
|
channel: 'candle';
|
|
92
96
|
data: Candle;
|
|
93
97
|
};
|
|
94
|
-
/** @public */
|
|
98
|
+
/** Event containing recent trades. @public */
|
|
95
99
|
export type TradesEvent = {
|
|
96
100
|
channel: 'trades';
|
|
97
101
|
data: Trade[];
|
|
98
102
|
};
|
|
99
|
-
/** @public */
|
|
103
|
+
/** Event containing order upserts and terminal order ids. @public */
|
|
100
104
|
export type OrderUpdatesEvent = {
|
|
101
105
|
channel: 'orderUpdates';
|
|
102
106
|
data: {
|
|
@@ -111,7 +115,7 @@ export type OrderUpdatesEvent = {
|
|
|
111
115
|
terminated: string[];
|
|
112
116
|
};
|
|
113
117
|
};
|
|
114
|
-
/** @public */
|
|
118
|
+
/** Event containing newly observed executions/fills. @public */
|
|
115
119
|
export type FillsEvent = {
|
|
116
120
|
channel: 'fills';
|
|
117
121
|
data: Fill[];
|
|
@@ -148,6 +152,10 @@ export type AccountSummaryEvent = {
|
|
|
148
152
|
channel: 'accountSummary';
|
|
149
153
|
data: AccountSummary;
|
|
150
154
|
};
|
|
151
|
-
/**
|
|
155
|
+
/**
|
|
156
|
+
* Union of all websocket event frame shapes emitted for subscriptions.
|
|
157
|
+
*
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
152
160
|
export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent;
|
|
153
161
|
//# 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,SAAS,EACT,QAAQ,EACR,YAAY,EACb,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
|
|
1
|
+
{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,YAAY,EACb,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;AAE9B,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,4CAA4C;QAC5C,UAAU,EAAE,SAAS,EAAE,CAAA;QACvB,8DAA8D;QAC9D,aAAa,EAAE,YAAY,EAAE,CAAA;QAC7B;;;WAGG;QACH,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,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,CAAA"}
|