@lifi/perps-types 3.3.2 → 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 +11 -2
- 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 +5 -0
- package/dist/cjs/enums.d.ts.map +1 -1
- package/dist/cjs/enums.js +7 -1
- package/dist/cjs/enums.js.map +1 -1
- package/dist/cjs/errors.d.ts.map +1 -1
- package/dist/cjs/market.d.ts +4 -0
- 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 +223 -32
- 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 +43 -20
- package/dist/esm/enums.d.ts.map +1 -1
- package/dist/esm/enums.js +43 -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 +57 -15
- 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 +223 -32
- 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 +43 -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 +57 -15
- 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 +225 -37
- package/src/action.ts +205 -37
- package/src/asset.ts +1 -4
- package/src/enums.ts +44 -20
- package/src/errors.ts +6 -1
- package/src/market.ts +69 -16
- 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/esm/enums.d.ts.map
CHANGED
|
@@ -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/esm/enums.js
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/**
|
|
2
|
+
* Numeric error codes returned by the perps API.
|
|
3
|
+
*
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
2
6
|
export var PerpsErrorCode;
|
|
3
7
|
(function (PerpsErrorCode) {
|
|
4
8
|
// Base errors (2000-2009)
|
|
@@ -31,13 +35,13 @@ export var PerpsErrorCode;
|
|
|
31
35
|
// Routing errors (2060-2069)
|
|
32
36
|
PerpsErrorCode[PerpsErrorCode["RouteNotFound"] = 2060] = "RouteNotFound";
|
|
33
37
|
})(PerpsErrorCode || (PerpsErrorCode = {}));
|
|
34
|
-
/** @public */
|
|
38
|
+
/** Side of an order or execution, using provider wire values. @public */
|
|
35
39
|
export var OrderSide;
|
|
36
40
|
(function (OrderSide) {
|
|
37
41
|
OrderSide["BUY"] = "BUY";
|
|
38
42
|
OrderSide["SELL"] = "SELL";
|
|
39
43
|
})(OrderSide || (OrderSide = {}));
|
|
40
|
-
/** @public */
|
|
44
|
+
/** Supported regular and trigger order kinds, using provider wire values. @public */
|
|
41
45
|
export var OrderType;
|
|
42
46
|
(function (OrderType) {
|
|
43
47
|
OrderType["MARKET"] = "MARKET";
|
|
@@ -48,19 +52,29 @@ export var OrderType;
|
|
|
48
52
|
OrderType["TAKE_PROFIT_LIMIT"] = "TAKE_PROFIT_LIMIT";
|
|
49
53
|
OrderType["TRIGGER_ONLY"] = "TRIGGER_ONLY";
|
|
50
54
|
})(OrderType || (OrderType = {}));
|
|
51
|
-
/** @public */
|
|
55
|
+
/** Direction of an open position. @public */
|
|
52
56
|
export var PositionSide;
|
|
53
57
|
(function (PositionSide) {
|
|
54
58
|
PositionSide["LONG"] = "LONG";
|
|
55
59
|
PositionSide["SHORT"] = "SHORT";
|
|
56
60
|
})(PositionSide || (PositionSide = {}));
|
|
57
|
-
/** @public */
|
|
61
|
+
/** Margin allocation mode for a position. @public */
|
|
58
62
|
export var MarginMode;
|
|
59
63
|
(function (MarginMode) {
|
|
60
64
|
MarginMode["ISOLATED"] = "ISOLATED";
|
|
61
65
|
MarginMode["CROSS"] = "CROSS";
|
|
62
66
|
})(MarginMode || (MarginMode = {}));
|
|
63
|
-
/** @public */
|
|
67
|
+
/** Per-market support for changing an open position's dedicated margin. @public */
|
|
68
|
+
export var PositionMarginAdjustment;
|
|
69
|
+
(function (PositionMarginAdjustment) {
|
|
70
|
+
/** The venue does not expose individual position margin. */
|
|
71
|
+
PositionMarginAdjustment["NONE"] = "NONE";
|
|
72
|
+
/** Margin can be added but cannot be removed. */
|
|
73
|
+
PositionMarginAdjustment["ADD_ONLY"] = "ADD_ONLY";
|
|
74
|
+
/** Margin can be added and removed. */
|
|
75
|
+
PositionMarginAdjustment["ADD_AND_REMOVE"] = "ADD_AND_REMOVE";
|
|
76
|
+
})(PositionMarginAdjustment || (PositionMarginAdjustment = {}));
|
|
77
|
+
/** Provider order time-in-force policies. @public */
|
|
64
78
|
export var TimeInForce;
|
|
65
79
|
(function (TimeInForce) {
|
|
66
80
|
TimeInForce["GTC"] = "GTC";
|
|
@@ -68,7 +82,7 @@ export var TimeInForce;
|
|
|
68
82
|
TimeInForce["POST_ONLY"] = "POST_ONLY";
|
|
69
83
|
TimeInForce["GTT"] = "GTT";
|
|
70
84
|
})(TimeInForce || (TimeInForce = {}));
|
|
71
|
-
/** @public */
|
|
85
|
+
/** Lifecycle status of a provider order. @public */
|
|
72
86
|
export var OrderStatus;
|
|
73
87
|
(function (OrderStatus) {
|
|
74
88
|
OrderStatus["PENDING"] = "PENDING";
|
|
@@ -80,7 +94,7 @@ export var OrderStatus;
|
|
|
80
94
|
OrderStatus["EXPIRED"] = "EXPIRED";
|
|
81
95
|
OrderStatus["TRIGGERED"] = "TRIGGERED";
|
|
82
96
|
})(OrderStatus || (OrderStatus = {}));
|
|
83
|
-
/** @public */
|
|
97
|
+
/** Lifecycle status of an execution/fill. @public */
|
|
84
98
|
export var FillStatus;
|
|
85
99
|
(function (FillStatus) {
|
|
86
100
|
FillStatus["FILLED"] = "FILLED";
|
|
@@ -88,13 +102,18 @@ export var FillStatus;
|
|
|
88
102
|
FillStatus["CANCELLED"] = "CANCELLED";
|
|
89
103
|
FillStatus["REJECTED"] = "REJECTED";
|
|
90
104
|
})(FillStatus || (FillStatus = {}));
|
|
91
|
-
/** @public */
|
|
105
|
+
/** Whether a fill supplied maker or taker liquidity. @public */
|
|
92
106
|
export var LiquidityRole;
|
|
93
107
|
(function (LiquidityRole) {
|
|
94
108
|
LiquidityRole["MAKER"] = "maker";
|
|
95
109
|
LiquidityRole["TAKER"] = "taker";
|
|
96
110
|
})(LiquidityRole || (LiquidityRole = {}));
|
|
97
|
-
/**
|
|
111
|
+
/**
|
|
112
|
+
* Action identifiers used in setup, create-action, and execute-action
|
|
113
|
+
* requests. Values are the backend wire strings.
|
|
114
|
+
*
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
98
117
|
export var ActionType;
|
|
99
118
|
(function (ActionType) {
|
|
100
119
|
ActionType["APPROVE_AGENT"] = "approveAgent";
|
|
@@ -126,26 +145,26 @@ export var ActionType;
|
|
|
126
145
|
/** Provider-independent: sent with the `META_PROVIDER` sentinel, not a real provider key. */
|
|
127
146
|
ActionType["META_ACCEPT_TERMS"] = "metaAcceptTerms";
|
|
128
147
|
})(ActionType || (ActionType = {}));
|
|
129
|
-
/** @public */
|
|
148
|
+
/** Price relation that activates a trigger order. @public */
|
|
130
149
|
export var TriggerCondition;
|
|
131
150
|
(function (TriggerCondition) {
|
|
132
151
|
TriggerCondition["ABOVE"] = "ABOVE";
|
|
133
152
|
TriggerCondition["BELOW"] = "BELOW";
|
|
134
153
|
})(TriggerCondition || (TriggerCondition = {}));
|
|
135
|
-
/** @public */
|
|
154
|
+
/** Take-profit or stop-loss trigger order classification. @public */
|
|
136
155
|
export var TriggerOrderType;
|
|
137
156
|
(function (TriggerOrderType) {
|
|
138
157
|
TriggerOrderType["TAKE_PROFIT"] = "TAKE_PROFIT";
|
|
139
158
|
TriggerOrderType["STOP_LOSS"] = "STOP_LOSS";
|
|
140
159
|
})(TriggerOrderType || (TriggerOrderType = {}));
|
|
141
|
-
/** @public */
|
|
160
|
+
/** Lifecycle status of a trigger order. @public */
|
|
142
161
|
export var TriggerOrderStatus;
|
|
143
162
|
(function (TriggerOrderStatus) {
|
|
144
163
|
TriggerOrderStatus["WAITING"] = "WAITING";
|
|
145
164
|
TriggerOrderStatus["TRIGGERED"] = "TRIGGERED";
|
|
146
165
|
TriggerOrderStatus["CANCELLED"] = "CANCELLED";
|
|
147
166
|
})(TriggerOrderStatus || (TriggerOrderStatus = {}));
|
|
148
|
-
/** @public */
|
|
167
|
+
/** Account activity record categories. @public */
|
|
149
168
|
export var ActivityType;
|
|
150
169
|
(function (ActivityType) {
|
|
151
170
|
ActivityType["DEPOSIT"] = "DEPOSIT";
|
|
@@ -154,7 +173,7 @@ export var ActivityType;
|
|
|
154
173
|
ActivityType["FUNDING"] = "FUNDING";
|
|
155
174
|
ActivityType["TRANSFER"] = "TRANSFER";
|
|
156
175
|
})(ActivityType || (ActivityType = {}));
|
|
157
|
-
/** @public */
|
|
176
|
+
/** Human-readable classification of how a fill changed a position. @public */
|
|
158
177
|
export var FillClassification;
|
|
159
178
|
(function (FillClassification) {
|
|
160
179
|
FillClassification["OPENED_LONG"] = "Opened Long";
|
|
@@ -170,17 +189,17 @@ export var FillClassification;
|
|
|
170
189
|
FillClassification["SPOT_BUY"] = "Spot Buy";
|
|
171
190
|
FillClassification["SPOT_SELL"] = "Spot Sell";
|
|
172
191
|
})(FillClassification || (FillClassification = {}));
|
|
173
|
-
/** @public */
|
|
192
|
+
/** Classification emitted for a liquidation activity. @public */
|
|
174
193
|
export var LiquidationClassification;
|
|
175
194
|
(function (LiquidationClassification) {
|
|
176
195
|
LiquidationClassification["LIQUIDATED"] = "Liquidated";
|
|
177
196
|
})(LiquidationClassification || (LiquidationClassification = {}));
|
|
178
|
-
/** @public */
|
|
197
|
+
/** Classification emitted for a funding activity. @public */
|
|
179
198
|
export var FundingClassification;
|
|
180
199
|
(function (FundingClassification) {
|
|
181
200
|
FundingClassification["FUNDING"] = "Funding";
|
|
182
201
|
})(FundingClassification || (FundingClassification = {}));
|
|
183
|
-
/** @public */
|
|
202
|
+
/** Classification emitted for an inbound, outbound, or internal transfer. @public */
|
|
184
203
|
export var TransferClassification;
|
|
185
204
|
(function (TransferClassification) {
|
|
186
205
|
TransferClassification["DEPOSIT"] = "Deposit";
|
|
@@ -201,7 +220,12 @@ export var PerpsSigner;
|
|
|
201
220
|
PerpsSigner["USER"] = "USER";
|
|
202
221
|
PerpsSigner["SDK"] = "SDK";
|
|
203
222
|
})(PerpsSigner || (PerpsSigner = {}));
|
|
204
|
-
/**
|
|
223
|
+
/**
|
|
224
|
+
* Signing mechanisms supported by action steps. Values are serialized in
|
|
225
|
+
* provider metadata and action responses.
|
|
226
|
+
*
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
205
229
|
export var SigningMethod;
|
|
206
230
|
(function (SigningMethod) {
|
|
207
231
|
SigningMethod["EIP712"] = "eip712";
|
package/dist/esm/enums.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAN,IAAY,cAmCX;AAnCD,WAAY,cAAc;IACxB,0BAA0B;IAC1B,sEAAmB,CAAA;IACnB,oEAAkB,CAAA;IAClB,4EAAsB,CAAA;IACtB,sEAAmB,CAAA;IACnB,4EAAsB,CAAA;IACtB,8DAAe,CAAA;IAEf,0BAA0B;IAC1B,8EAAuB,CAAA;IACvB,gFAAwB,CAAA;IACxB,8EAAuB,CAAA;IACvB,8EAA8E;IAC9E,sEAAmB,CAAA;IAEnB,6BAA6B;IAC7B,8EAAuB,CAAA;IACvB,kFAAyB,CAAA;IACzB,oFAA0B,CAAA;IAC1B,0EAAqB,CAAA;IACrB,wEAAoB,CAAA;IACpB,8EAAuB,CAAA;IACvB,4EAAsB,CAAA;IAEtB,2BAA2B;IAC3B,sEAAmB,CAAA;IACnB,8EAAuB,CAAA;IACvB,sEAAmB,CAAA;IAEnB,6BAA6B;IAC7B,4EAAsB,CAAA;IAEtB,6BAA6B;IAC7B,wEAAoB,CAAA;AACtB,CAAC,EAnCW,cAAc,KAAd,cAAc,QAmCzB;AAED,yEAAyE;AACzE,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED,qFAAqF;AACrF,MAAM,CAAN,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,wCAA2B,CAAA;IAC3B,sCAAyB,CAAA;IACzB,sDAAyC,CAAA;IACzC,oDAAuC,CAAA;IACvC,0CAA6B,CAAA;AAC/B,CAAC,EARW,SAAS,KAAT,SAAS,QAQpB;AAED,6CAA6C;AAC7C,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,+BAAe,CAAA;AACjB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED,qDAAqD;AACrD,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,6BAAe,CAAA;AACjB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,mFAAmF;AACnF,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,4DAA4D;IAC5D,yCAAa,CAAA;IACb,iDAAiD;IACjD,iDAAqB,CAAA;IACrB,uCAAuC;IACvC,6DAAiC,CAAA;AACnC,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AAED,qDAAqD;AACrD,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,sCAAuB,CAAA;IACvB,0BAAW,CAAA;AACb,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED,oDAAoD;AACpD,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,4BAAa,CAAA;IACb,oDAAqC,CAAA;IACrC,gCAAiB,CAAA;IACjB,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;AACzB,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAED,qDAAqD;AACrD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,mDAAqC,CAAA;IACrC,qCAAuB,CAAA;IACvB,mCAAqB,CAAA;AACvB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAED,gEAAgE;AAChE,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED;;;;;GAKG;AACH,MAAM,CAAN,IAAY,UA6BX;AA7BD,WAAY,UAAU;IACpB,4CAA8B,CAAA;IAC9B,uDAAyC,CAAA;IACzC,sDAAwC,CAAA;IACxC,0CAA4B,CAAA;IAC5B,0CAA4B,CAAA;IAC5B,0CAA4B,CAAA;IAC5B,sCAAwB,CAAA;IACxB,uCAAyB,CAAA;IACzB,mCAAqB,CAAA;IACrB,wCAA0B,CAAA;IAC1B,uDAAyC,CAAA;IACzC,0CAA4B,CAAA;IAC5B,mDAAqC,CAAA;IACrC,0CAA4B,CAAA;IAC5B,gDAAkC,CAAA;IAClC,6DAA+C,CAAA;IAC/C,+DAAiD,CAAA;IACjD,iDAAmC,CAAA;IACnC,8DAAgD,CAAA;IAChD,sCAAwB,CAAA;IACxB,6DAA+C,CAAA;IAC/C,sLAAsL;IACtL,2DAA6C,CAAA;IAC7C,iCAAmB,CAAA;IACnB,6FAA6F;IAC7F,oCAAsB,CAAA;IACtB,6FAA6F;IAC7F,mDAAqC,CAAA;AACvC,CAAC,EA7BW,UAAU,KAAV,UAAU,QA6BrB;AAED,6DAA6D;AAC7D,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,mCAAe,CAAA;AACjB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B;AAED,qEAAqE;AACrE,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;AACzB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B;AAED,mDAAmD;AACnD,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,6CAAuB,CAAA;AACzB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAED,kDAAkD;AAClD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,yCAAyB,CAAA;IACzB,2CAA2B,CAAA;IAC3B,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACvB,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,8EAA8E;AAC9E,MAAM,CAAN,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,iDAA2B,CAAA;IAC3B,mDAA6B,CAAA;IAC7B,uDAAiC,CAAA;IACjC,yDAAmC,CAAA;IACnC,mDAA6B,CAAA;IAC7B,qDAA+B,CAAA;IAC/B,iDAA2B,CAAA;IAC3B,mDAA6B,CAAA;IAC7B,qDAA+B,CAAA;IAC/B,uDAAiC,CAAA;IACjC,2CAAqB,CAAA;IACrB,6CAAuB,CAAA;AACzB,CAAC,EAbW,kBAAkB,KAAlB,kBAAkB,QAa7B;AAED,iEAAiE;AACjE,MAAM,CAAN,IAAY,yBAEX;AAFD,WAAY,yBAAyB;IACnC,sDAAyB,CAAA;AAC3B,CAAC,EAFW,yBAAyB,KAAzB,yBAAyB,QAEpC;AAED,6DAA6D;AAC7D,MAAM,CAAN,IAAY,qBAEX;AAFD,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;AACrB,CAAC,EAFW,qBAAqB,KAArB,qBAAqB,QAEhC;AAED,qFAAqF;AACrF,MAAM,CAAN,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,mDAAyB,CAAA;IACzB,+CAAqB,CAAA;AACvB,CAAC,EAJW,sBAAsB,KAAtB,sBAAsB,QAIjC;AASD;;;;;;;;GAQG;AACH,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,0BAAW,CAAA;AACb,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED;;;;;GAKG;AACH,MAAM,CAAN,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,uCAAsB,CAAA;IACtB,iCAAgB,CAAA;IAChB,sIAAsI;IACtI,8BAAa,CAAA;IACb,qEAAqE;IACrE,8BAAa,CAAA;IACb,gJAAgJ;IAChJ,oCAAmB,CAAA;AACrB,CAAC,EAVW,aAAa,KAAb,aAAa,QAUxB"}
|
package/dist/esm/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;
|
package/dist/esm/errors.d.ts.map
CHANGED
|
@@ -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/esm/market.d.ts
CHANGED
|
@@ -1,20 +1,32 @@
|
|
|
1
1
|
import type { Asset } from './asset.js';
|
|
2
|
-
|
|
2
|
+
import type { PositionMarginAdjustment } from './enums.js';
|
|
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
|
+
*/
|
|
3
9
|
export interface FundingInfo {
|
|
10
|
+
/** Funding rate as a decimal fraction. */
|
|
4
11
|
rate: string;
|
|
12
|
+
/** Next funding timestamp in Unix milliseconds. */
|
|
5
13
|
nextFundingTime: number;
|
|
6
14
|
}
|
|
7
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Shared market metadata for perpetual and spot instruments.
|
|
17
|
+
*
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
8
20
|
export interface BaseMarket {
|
|
9
21
|
providerId: string;
|
|
10
22
|
/** Opaque provider market id; referenced elsewhere as `marketId`. */
|
|
11
23
|
id: string;
|
|
12
|
-
/** Whether the venue has delisted this market. */
|
|
13
24
|
isDelisted?: boolean;
|
|
14
25
|
/** References a {@link ProviderCategory} by id. */
|
|
15
26
|
categoryId: string;
|
|
16
27
|
baseAsset: Asset;
|
|
17
28
|
quoteAsset: Asset;
|
|
29
|
+
/** Maximum fractional precision accepted for order sizes. */
|
|
18
30
|
szDecimals: number;
|
|
19
31
|
/**
|
|
20
32
|
* Maximum decimal places the venue accepts for order prices on this market.
|
|
@@ -38,10 +50,16 @@ export interface BaseMarket {
|
|
|
38
50
|
*/
|
|
39
51
|
sizeIncrement?: string;
|
|
40
52
|
}
|
|
41
|
-
/**
|
|
53
|
+
/**
|
|
54
|
+
* Perpetual market metadata, including leverage and margin constraints.
|
|
55
|
+
*
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
42
58
|
export interface PerpsMarket extends BaseMarket {
|
|
43
59
|
maxLeverage: number;
|
|
44
60
|
onlyIsolated: boolean;
|
|
61
|
+
/** Whether individual position margin can be added and/or removed. */
|
|
62
|
+
positionMarginAdjustment: PositionMarginAdjustment;
|
|
45
63
|
/**
|
|
46
64
|
* Venue maintenance margin rate for this market as a fraction (e.g. `0.012`
|
|
47
65
|
* = 1.2%). Feeds client-side liquidation-price estimates via the provider's
|
|
@@ -49,13 +67,24 @@ export interface PerpsMarket extends BaseMarket {
|
|
|
49
67
|
*/
|
|
50
68
|
maintenanceMarginRate?: number;
|
|
51
69
|
}
|
|
52
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* Spot markets cannot expose perpetual-position margin capabilities.
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
53
74
|
export interface SpotMarket extends BaseMarket {
|
|
75
|
+
positionMarginAdjustment?: never;
|
|
54
76
|
}
|
|
55
|
-
/** @public */
|
|
77
|
+
/** Union of perpetual and spot market representations. @public */
|
|
56
78
|
export type Market = PerpsMarket | SpotMarket;
|
|
57
|
-
/**
|
|
79
|
+
/**
|
|
80
|
+
* UI-safe market projection containing identity, category, assets, and
|
|
81
|
+
* delisting state without provider-specific trading constraints.
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
58
85
|
export type MarketDisplay = Pick<BaseMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset' | 'isDelisted'>;
|
|
86
|
+
/** Perpetual-market identity embedded on an open {@link Position}. @public */
|
|
87
|
+
export type PerpsMarketDisplay = Pick<PerpsMarket, 'providerId' | 'id' | 'categoryId' | 'baseAsset' | 'quoteAsset' | 'isDelisted' | 'positionMarginAdjustment'>;
|
|
59
88
|
/**
|
|
60
89
|
* Minimal market reference for write-action params: identifies a market by
|
|
61
90
|
* its opaque `marketId` within a `categoryId`. Embeds no Assets — write
|
|
@@ -66,7 +95,7 @@ export interface MarketRef {
|
|
|
66
95
|
marketId: string;
|
|
67
96
|
categoryId: string;
|
|
68
97
|
}
|
|
69
|
-
/** @public */
|
|
98
|
+
/** Response containing all markets returned for a provider. @public */
|
|
70
99
|
export interface MarketsResponse {
|
|
71
100
|
markets: Market[];
|
|
72
101
|
}
|
|
@@ -80,8 +109,11 @@ export interface MarketsResponse {
|
|
|
80
109
|
* @public
|
|
81
110
|
*/
|
|
82
111
|
export interface MarketContext {
|
|
112
|
+
/** Opaque provider market identifier for this context frame. */
|
|
83
113
|
marketId: string;
|
|
114
|
+
/** Current order-book midpoint, as a decimal quote string. */
|
|
84
115
|
midPrice: string;
|
|
116
|
+
/** Provider mark price, as a decimal quote string. */
|
|
85
117
|
markPrice: string;
|
|
86
118
|
oraclePrice?: string;
|
|
87
119
|
prevDayPrice?: string;
|
|
@@ -91,11 +123,16 @@ export interface MarketContext {
|
|
|
91
123
|
openInterest?: string;
|
|
92
124
|
funding?: FundingInfo;
|
|
93
125
|
}
|
|
94
|
-
/** @public */
|
|
126
|
+
/** Response containing live context for requested markets. @public */
|
|
95
127
|
export interface PricesResponse {
|
|
96
128
|
prices: MarketContext[];
|
|
97
129
|
}
|
|
98
|
-
/**
|
|
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
|
+
*/
|
|
99
136
|
export interface Candle {
|
|
100
137
|
t: number;
|
|
101
138
|
o: string;
|
|
@@ -104,21 +141,26 @@ export interface Candle {
|
|
|
104
141
|
c: string;
|
|
105
142
|
v: string;
|
|
106
143
|
}
|
|
107
|
-
/** @public */
|
|
144
|
+
/** Response containing candles for one provider market and interval. @public */
|
|
108
145
|
export interface OhlcvResponse {
|
|
109
146
|
provider: string;
|
|
110
147
|
marketId: string;
|
|
111
148
|
interval: string;
|
|
112
149
|
candles: Candle[];
|
|
113
150
|
}
|
|
114
|
-
/**
|
|
151
|
+
/**
|
|
152
|
+
* Supported OHLCV intervals. Values are wire interval strings (`1M` is one
|
|
153
|
+
* month; lowercase `m` values are minutes).
|
|
154
|
+
*
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
115
157
|
export type OhlcvInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
|
|
116
|
-
/** @public */
|
|
158
|
+
/** One price/size level in an order book; both values are decimal strings. @public */
|
|
117
159
|
export interface OrderbookLevel {
|
|
118
160
|
price: string;
|
|
119
161
|
size: string;
|
|
120
162
|
}
|
|
121
|
-
/** @public */
|
|
163
|
+
/** Snapshot of bids and asks for one market. `timestamp` is Unix milliseconds. @public */
|
|
122
164
|
export interface OrderbookResponse {
|
|
123
165
|
provider: string;
|
|
124
166
|
marketId: string;
|
|
@@ -126,7 +168,7 @@ export interface OrderbookResponse {
|
|
|
126
168
|
asks: OrderbookLevel[];
|
|
127
169
|
timestamp: number;
|
|
128
170
|
}
|
|
129
|
-
/** @public */
|
|
171
|
+
/** Recent trade normalized for a market; `timestamp` is Unix milliseconds. @public */
|
|
130
172
|
export interface Trade {
|
|
131
173
|
provider: string;
|
|
132
174
|
marketId: string;
|
package/dist/esm/market.d.ts.map
CHANGED
|
@@ -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;
|
|
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"}
|
package/dist/esm/primitives.d.ts
CHANGED
|
@@ -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"}
|
package/dist/esm/providers.d.ts
CHANGED
|
@@ -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/esm/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
|
package/dist/esm/quote.d.ts.map
CHANGED
|
@@ -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"}
|