@lifi/perps-sdk 0.0.0-preview-142c251 → 0.0.0-preview-1edeff0
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/README.md +42 -2
- package/dist/cjs/client/PerpsClient.d.ts +10 -5
- package/dist/cjs/client/PerpsClient.d.ts.map +1 -1
- package/dist/cjs/client/PerpsClient.js +89 -55
- package/dist/cjs/client/PerpsClient.js.map +1 -1
- package/dist/cjs/index.d.ts +13 -8
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +20 -5
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/registry/marketRegistry.d.ts +3 -0
- package/dist/cjs/registry/marketRegistry.d.ts.map +1 -1
- package/dist/cjs/registry/marketRegistry.js +16 -1
- package/dist/cjs/registry/marketRegistry.js.map +1 -1
- package/dist/cjs/registry/referenceDataRegistry.d.ts.map +1 -1
- package/dist/cjs/registry/referenceDataRegistry.js +0 -1
- package/dist/cjs/registry/referenceDataRegistry.js.map +1 -1
- package/dist/cjs/services/getGasRecommendation.d.ts +9 -0
- package/dist/cjs/services/getGasRecommendation.d.ts.map +1 -0
- package/dist/cjs/services/getGasRecommendation.js +10 -0
- package/dist/cjs/services/getGasRecommendation.js.map +1 -0
- package/dist/cjs/services/getMarket.d.ts.map +1 -1
- package/dist/cjs/services/getMarket.js +2 -1
- package/dist/cjs/services/getMarket.js.map +1 -1
- package/dist/cjs/services/getMarkets.d.ts.map +1 -1
- package/dist/cjs/services/getMarkets.js +3 -1
- package/dist/cjs/services/getMarkets.js.map +1 -1
- package/dist/cjs/types/api.d.ts +4 -0
- package/dist/cjs/types/api.d.ts.map +1 -1
- package/dist/cjs/types/config.d.ts.map +1 -1
- package/dist/cjs/types/deposit.d.ts +25 -0
- package/dist/cjs/types/deposit.d.ts.map +1 -0
- package/dist/cjs/types/deposit.js +3 -0
- package/dist/cjs/types/deposit.js.map +1 -0
- package/dist/cjs/types/provider.d.ts +16 -5
- package/dist/cjs/types/provider.d.ts.map +1 -1
- package/dist/cjs/utils/accountSummary.d.ts.map +1 -1
- package/dist/cjs/utils/accountSummary.js +10 -4
- package/dist/cjs/utils/accountSummary.js.map +1 -1
- package/dist/cjs/utils/depositAssets.d.ts +8 -0
- package/dist/cjs/utils/depositAssets.d.ts.map +1 -0
- package/dist/cjs/utils/depositAssets.js +36 -0
- package/dist/cjs/utils/depositAssets.js.map +1 -0
- package/dist/cjs/utils/explorer.d.ts +1 -0
- package/dist/cjs/utils/explorer.d.ts.map +1 -1
- package/dist/cjs/utils/explorer.js +7 -3
- package/dist/cjs/utils/explorer.js.map +1 -1
- package/dist/cjs/utils/format.d.ts +3 -0
- package/dist/cjs/utils/format.d.ts.map +1 -1
- package/dist/cjs/utils/format.js +31 -24
- package/dist/cjs/utils/format.js.map +1 -1
- package/dist/cjs/utils/scaleToInteger.d.ts +3 -0
- package/dist/cjs/utils/scaleToInteger.d.ts.map +1 -0
- package/dist/cjs/utils/scaleToInteger.js +30 -0
- package/dist/cjs/utils/scaleToInteger.js.map +1 -0
- package/dist/cjs/utils/setupActions.d.ts +3 -0
- package/dist/cjs/utils/setupActions.d.ts.map +1 -0
- package/dist/cjs/utils/setupActions.js +8 -0
- package/dist/cjs/utils/setupActions.js.map +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/client/PerpsClient.d.ts +41 -14
- package/dist/esm/client/PerpsClient.d.ts.map +1 -1
- package/dist/esm/client/PerpsClient.js +128 -73
- package/dist/esm/client/PerpsClient.js.map +1 -1
- package/dist/esm/index.d.ts +14 -9
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +8 -5
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/registry/marketRegistry.d.ts +15 -2
- package/dist/esm/registry/marketRegistry.d.ts.map +1 -1
- package/dist/esm/registry/marketRegistry.js +26 -2
- package/dist/esm/registry/marketRegistry.js.map +1 -1
- package/dist/esm/registry/referenceDataRegistry.d.ts +2 -1
- package/dist/esm/registry/referenceDataRegistry.d.ts.map +1 -1
- package/dist/esm/registry/referenceDataRegistry.js +2 -2
- package/dist/esm/registry/referenceDataRegistry.js.map +1 -1
- package/dist/esm/services/getGasRecommendation.d.ts +31 -0
- package/dist/esm/services/getGasRecommendation.d.ts.map +1 -0
- package/dist/esm/services/getGasRecommendation.js +22 -0
- package/dist/esm/services/getGasRecommendation.js.map +1 -0
- package/dist/esm/services/getMarket.d.ts +5 -4
- package/dist/esm/services/getMarket.d.ts.map +1 -1
- package/dist/esm/services/getMarket.js +7 -5
- package/dist/esm/services/getMarket.js.map +1 -1
- package/dist/esm/services/getMarkets.d.ts +6 -3
- package/dist/esm/services/getMarkets.d.ts.map +1 -1
- package/dist/esm/services/getMarkets.js +9 -4
- package/dist/esm/services/getMarkets.js.map +1 -1
- package/dist/esm/types/api.d.ts +9 -0
- package/dist/esm/types/api.d.ts.map +1 -1
- package/dist/esm/types/config.d.ts +4 -1
- package/dist/esm/types/config.d.ts.map +1 -1
- package/dist/esm/types/deposit.d.ts +68 -0
- package/dist/esm/types/deposit.d.ts.map +1 -0
- package/dist/esm/types/deposit.js +2 -0
- package/dist/esm/types/deposit.js.map +1 -0
- package/dist/esm/types/provider.d.ts +53 -17
- package/dist/esm/types/provider.d.ts.map +1 -1
- package/dist/esm/utils/accountSummary.d.ts.map +1 -1
- package/dist/esm/utils/accountSummary.js +13 -4
- package/dist/esm/utils/accountSummary.js.map +1 -1
- package/dist/esm/utils/depositAssets.d.ts +46 -0
- package/dist/esm/utils/depositAssets.d.ts.map +1 -0
- package/dist/esm/utils/depositAssets.js +71 -0
- package/dist/esm/utils/depositAssets.js.map +1 -0
- package/dist/esm/utils/explorer.d.ts +10 -0
- package/dist/esm/utils/explorer.d.ts.map +1 -1
- package/dist/esm/utils/explorer.js +16 -4
- package/dist/esm/utils/explorer.js.map +1 -1
- package/dist/esm/utils/format.d.ts +22 -0
- package/dist/esm/utils/format.d.ts.map +1 -1
- package/dist/esm/utils/format.js +57 -27
- package/dist/esm/utils/format.js.map +1 -1
- package/dist/esm/utils/scaleToInteger.d.ts +22 -0
- package/dist/esm/utils/scaleToInteger.d.ts.map +1 -0
- package/dist/esm/utils/scaleToInteger.js +34 -0
- package/dist/esm/utils/scaleToInteger.js.map +1 -0
- package/dist/esm/utils/setupActions.d.ts +17 -0
- package/dist/esm/utils/setupActions.d.ts.map +1 -0
- package/dist/esm/utils/setupActions.js +19 -0
- package/dist/esm/utils/setupActions.js.map +1 -0
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/types/client/PerpsClient.d.ts +41 -14
- package/dist/types/client/PerpsClient.d.ts.map +1 -1
- package/dist/types/index.d.ts +14 -9
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/registry/marketRegistry.d.ts +15 -2
- package/dist/types/registry/marketRegistry.d.ts.map +1 -1
- package/dist/types/registry/referenceDataRegistry.d.ts +2 -1
- package/dist/types/registry/referenceDataRegistry.d.ts.map +1 -1
- package/dist/types/services/getGasRecommendation.d.ts +31 -0
- package/dist/types/services/getGasRecommendation.d.ts.map +1 -0
- package/dist/types/services/getMarket.d.ts +5 -4
- package/dist/types/services/getMarket.d.ts.map +1 -1
- package/dist/types/services/getMarkets.d.ts +6 -3
- package/dist/types/services/getMarkets.d.ts.map +1 -1
- package/dist/types/types/api.d.ts +9 -0
- package/dist/types/types/api.d.ts.map +1 -1
- package/dist/types/types/config.d.ts +4 -1
- package/dist/types/types/config.d.ts.map +1 -1
- package/dist/types/types/deposit.d.ts +68 -0
- package/dist/types/types/deposit.d.ts.map +1 -0
- package/dist/types/types/provider.d.ts +53 -17
- package/dist/types/types/provider.d.ts.map +1 -1
- package/dist/types/utils/accountSummary.d.ts.map +1 -1
- package/dist/types/utils/depositAssets.d.ts +46 -0
- package/dist/types/utils/depositAssets.d.ts.map +1 -0
- package/dist/types/utils/explorer.d.ts +10 -0
- package/dist/types/utils/explorer.d.ts.map +1 -1
- package/dist/types/utils/format.d.ts +22 -0
- package/dist/types/utils/format.d.ts.map +1 -1
- package/dist/types/utils/scaleToInteger.d.ts +22 -0
- package/dist/types/utils/scaleToInteger.d.ts.map +1 -0
- package/dist/types/utils/setupActions.d.ts +17 -0
- package/dist/types/utils/setupActions.d.ts.map +1 -0
- package/dist/types/version.d.ts +1 -1
- package/package.json +4 -3
- package/src/client/PerpsClient.ts +206 -106
- package/src/index.ts +34 -8
- package/src/registry/marketRegistry.ts +33 -2
- package/src/registry/referenceDataRegistry.ts +2 -2
- package/src/services/getGasRecommendation.ts +45 -0
- package/src/services/getMarket.ts +7 -5
- package/src/services/getMarkets.ts +14 -4
- package/src/types/api.ts +10 -0
- package/src/types/config.ts +4 -1
- package/src/types/deposit.ts +75 -0
- package/src/types/provider.ts +56 -25
- package/src/utils/accountSummary.ts +18 -5
- package/src/utils/depositAssets.ts +77 -0
- package/src/utils/explorer.ts +20 -4
- package/src/utils/format.ts +108 -28
- package/src/utils/scaleToInteger.ts +56 -0
- package/src/utils/setupActions.ts +24 -0
- package/src/version.ts +1 -1
- package/dist/cjs/client/clientLog.d.ts +0 -4
- package/dist/cjs/client/clientLog.d.ts.map +0 -1
- package/dist/cjs/client/clientLog.js +0 -9
- package/dist/cjs/client/clientLog.js.map +0 -1
- package/dist/cjs/utils/depositChain.d.ts +0 -6
- package/dist/cjs/utils/depositChain.d.ts.map +0 -1
- package/dist/cjs/utils/depositChain.js +0 -13
- package/dist/cjs/utils/depositChain.js.map +0 -1
- package/dist/esm/client/clientLog.d.ts +0 -16
- package/dist/esm/client/clientLog.d.ts.map +0 -1
- package/dist/esm/client/clientLog.js +0 -18
- package/dist/esm/client/clientLog.js.map +0 -1
- package/dist/esm/utils/depositChain.d.ts +0 -27
- package/dist/esm/utils/depositChain.d.ts.map +0 -1
- package/dist/esm/utils/depositChain.js +0 -23
- package/dist/esm/utils/depositChain.js.map +0 -1
- package/dist/types/client/clientLog.d.ts +0 -16
- package/dist/types/client/clientLog.d.ts.map +0 -1
- package/dist/types/utils/depositChain.d.ts +0 -27
- package/dist/types/utils/depositChain.d.ts.map +0 -1
- package/src/client/clientLog.ts +0 -20
- package/src/utils/depositChain.ts +0 -38
package/dist/esm/utils/format.js
CHANGED
|
@@ -1,4 +1,10 @@
|
|
|
1
1
|
const DEFAULT_PLACEHOLDER = '—';
|
|
2
|
+
/**
|
|
3
|
+
* Extra decimal places used to normalise IEEE-754 representation noise before
|
|
4
|
+
* truncating. `toFixed` at this higher precision cleans values like
|
|
5
|
+
* `0.28999999…` back to `0.29`; truncation then chops the guard digits.
|
|
6
|
+
*/
|
|
7
|
+
const FLOAT_GUARD_DIGITS = 9;
|
|
2
8
|
/**
|
|
3
9
|
* Tolerantly coerce a display input to a finite number.
|
|
4
10
|
*
|
|
@@ -24,14 +30,29 @@ function toFiniteNumber(value) {
|
|
|
24
30
|
return Number.isFinite(n) ? n : null;
|
|
25
31
|
}
|
|
26
32
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
33
|
+
* Truncate a non-negative value toward zero to `decimals` places using its
|
|
34
|
+
* decimal string, never float scaling. Representation noise is first
|
|
35
|
+
* normalised by `toFixed` at {@link FLOAT_GUARD_DIGITS} extra precision, then
|
|
36
|
+
* the guard digits are chopped: `99.999` at 2dp → `99.99`, `0.29` → `0.29`.
|
|
37
|
+
*/
|
|
38
|
+
function truncateAbs(abs, decimals) {
|
|
39
|
+
const s = abs.toFixed(Math.min(decimals + FLOAT_GUARD_DIGITS, 100));
|
|
40
|
+
const dot = s.indexOf('.');
|
|
41
|
+
const cut = decimals === 0 ? dot : dot + 1 + decimals;
|
|
42
|
+
return Number(s.slice(0, cut));
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Reduce `n` to `decimals` places then split into a sign and the
|
|
46
|
+
* locale-formatted absolute body. The sign is derived from the reduced value
|
|
47
|
+
* so magnitudes that collapse to zero render without a spurious `-`/`+`.
|
|
48
|
+
* `signed` emits `+` for positives; `rounding` selects half-up or truncation.
|
|
30
49
|
*/
|
|
31
|
-
function signAndBody(n, decimals, locale, grouping) {
|
|
32
|
-
const
|
|
33
|
-
|
|
34
|
-
|
|
50
|
+
function signAndBody(n, decimals, locale, grouping, rounding, signed) {
|
|
51
|
+
const reduced = rounding === 'floor'
|
|
52
|
+
? (n < 0 ? -1 : 1) * truncateAbs(Math.abs(n), decimals)
|
|
53
|
+
: Number(n.toFixed(decimals));
|
|
54
|
+
const sign = reduced < 0 ? '-' : signed && reduced > 0 ? '+' : '';
|
|
55
|
+
const body = Math.abs(reduced).toLocaleString(locale, {
|
|
35
56
|
minimumFractionDigits: decimals,
|
|
36
57
|
maximumFractionDigits: decimals,
|
|
37
58
|
useGrouping: grouping,
|
|
@@ -54,6 +75,27 @@ function autoDecimals(abs) {
|
|
|
54
75
|
}
|
|
55
76
|
return 6;
|
|
56
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Format a bare number, unsigned, with no currency symbol: `1,234.50`,
|
|
80
|
+
* `-1,500.00`, `0.00`. The core the `$`/`%` formatters wrap; use it for
|
|
81
|
+
* balance labels and symbol-suffixed amounts (`12.5 LIT`).
|
|
82
|
+
*
|
|
83
|
+
* Two decimal places with locale digit grouping by default. Negatives keep a
|
|
84
|
+
* leading `-`. `rounding: 'floor'` truncates toward zero so the rendered
|
|
85
|
+
* magnitude never exceeds the source (`99.999` at 2dp → `99.99`, `-99.999` →
|
|
86
|
+
* `-99.99`). Null/undefined/non-finite input renders the placeholder.
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export function formatNumber(value, options = {}) {
|
|
91
|
+
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale, rounding = 'halfUp', } = options;
|
|
92
|
+
const n = toFiniteNumber(value);
|
|
93
|
+
if (n === null) {
|
|
94
|
+
return placeholder;
|
|
95
|
+
}
|
|
96
|
+
const { sign, body } = signAndBody(n, decimals, locale, true, rounding, false);
|
|
97
|
+
return `${sign}${body}`;
|
|
98
|
+
}
|
|
57
99
|
/**
|
|
58
100
|
* Format a USD value, unsigned: `$1,234.50`, `-$1,500.00`, `$0.00`.
|
|
59
101
|
*
|
|
@@ -63,12 +105,12 @@ function autoDecimals(abs) {
|
|
|
63
105
|
* @public
|
|
64
106
|
*/
|
|
65
107
|
export function formatUsd(value, options = {}) {
|
|
66
|
-
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale } = options;
|
|
108
|
+
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale, rounding = 'halfUp', } = options;
|
|
67
109
|
const n = toFiniteNumber(value);
|
|
68
110
|
if (n === null) {
|
|
69
111
|
return placeholder;
|
|
70
112
|
}
|
|
71
|
-
const { sign, body } = signAndBody(n, decimals, locale, true);
|
|
113
|
+
const { sign, body } = signAndBody(n, decimals, locale, true, rounding, false);
|
|
72
114
|
return `${sign}$${body}`;
|
|
73
115
|
}
|
|
74
116
|
/**
|
|
@@ -81,18 +123,12 @@ export function formatUsd(value, options = {}) {
|
|
|
81
123
|
* @public
|
|
82
124
|
*/
|
|
83
125
|
export function formatSignedUsd(value, options = {}) {
|
|
84
|
-
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale } = options;
|
|
126
|
+
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale, rounding = 'halfUp', } = options;
|
|
85
127
|
const n = toFiniteNumber(value);
|
|
86
128
|
if (n === null) {
|
|
87
129
|
return placeholder;
|
|
88
130
|
}
|
|
89
|
-
const
|
|
90
|
-
const sign = rounded > 0 ? '+' : rounded < 0 ? '-' : '';
|
|
91
|
-
const body = Math.abs(rounded).toLocaleString(locale, {
|
|
92
|
-
minimumFractionDigits: decimals,
|
|
93
|
-
maximumFractionDigits: decimals,
|
|
94
|
-
useGrouping: true,
|
|
95
|
-
});
|
|
131
|
+
const { sign, body } = signAndBody(n, decimals, locale, true, rounding, true);
|
|
96
132
|
return `${sign}$${body}`;
|
|
97
133
|
}
|
|
98
134
|
/**
|
|
@@ -105,18 +141,12 @@ export function formatSignedUsd(value, options = {}) {
|
|
|
105
141
|
* @public
|
|
106
142
|
*/
|
|
107
143
|
export function formatSignedPercent(value, options = {}) {
|
|
108
|
-
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale } = options;
|
|
144
|
+
const { decimals = 2, placeholder = DEFAULT_PLACEHOLDER, locale, rounding = 'halfUp', } = options;
|
|
109
145
|
const n = toFiniteNumber(value);
|
|
110
146
|
if (n === null) {
|
|
111
147
|
return placeholder;
|
|
112
148
|
}
|
|
113
|
-
const
|
|
114
|
-
const sign = rounded > 0 ? '+' : rounded < 0 ? '-' : '';
|
|
115
|
-
const body = Math.abs(rounded).toLocaleString(locale, {
|
|
116
|
-
minimumFractionDigits: decimals,
|
|
117
|
-
maximumFractionDigits: decimals,
|
|
118
|
-
useGrouping: false,
|
|
119
|
-
});
|
|
149
|
+
const { sign, body } = signAndBody(n, decimals, locale, false, rounding, true);
|
|
120
150
|
return `${sign}${body}%`;
|
|
121
151
|
}
|
|
122
152
|
/**
|
|
@@ -130,14 +160,14 @@ export function formatSignedPercent(value, options = {}) {
|
|
|
130
160
|
* @public
|
|
131
161
|
*/
|
|
132
162
|
export function formatPrice(value, options = {}) {
|
|
133
|
-
const { placeholder = DEFAULT_PLACEHOLDER, locale } = options;
|
|
163
|
+
const { placeholder = DEFAULT_PLACEHOLDER, locale, rounding = 'halfUp', } = options;
|
|
134
164
|
const n = toFiniteNumber(value);
|
|
135
165
|
if (n === null) {
|
|
136
166
|
return placeholder;
|
|
137
167
|
}
|
|
138
168
|
const abs = Math.abs(n);
|
|
139
169
|
const decimals = options.decimals ?? autoDecimals(abs);
|
|
140
|
-
const { sign, body } = signAndBody(n, decimals, locale, abs >= 1000);
|
|
170
|
+
const { sign, body } = signAndBody(n, decimals, locale, abs >= 1000, rounding, false);
|
|
141
171
|
return `${sign}$${body}`;
|
|
142
172
|
}
|
|
143
173
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/utils/format.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/utils/format.ts"],"names":[],"mappings":"AAwBA,MAAM,mBAAmB,GAAG,GAAG,CAAA;AAI/B;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAA;AAE5B;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,KAAkB;IACxC,IAAI,CAAS,CAAA;IACb,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;QAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,IAAI,CAAA;QACb,CAAC;QACD,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;IACrB,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,CAAC,GAAG,KAAK,CAAA;IACX,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AACtC,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,GAAW,EAAE,QAAgB;IAChD,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,kBAAkB,EAAE,GAAG,CAAC,CAAC,CAAA;IACnE,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1B,MAAM,GAAG,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,QAAQ,CAAA;IACrD,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;AAChC,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAClB,CAAS,EACT,QAAgB,EAChB,MAA0B,EAC1B,QAAiB,EACjB,QAAsB,EACtB,MAAe;IAEf,MAAM,OAAO,GACX,QAAQ,KAAK,OAAO;QAClB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;QACvD,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;IACjC,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACjE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE;QACpD,qBAAqB,EAAE,QAAQ;QAC/B,qBAAqB,EAAE,QAAQ;QAC/B,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAA;IACF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AACvB,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QACb,OAAO,CAAC,CAAA;IACV,CAAC;IACD,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACf,OAAO,CAAC,CAAA;IACV,CAAC;IACD,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,CAAA;IACV,CAAC;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EACJ,QAAQ,GAAG,CAAC,EACZ,WAAW,GAAG,mBAAmB,EACjC,MAAM,EACN,QAAQ,GAAG,QAAQ,GACpB,GAAG,OAAO,CAAA;IACX,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC9E,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,CAAA;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CACvB,KAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EACJ,QAAQ,GAAG,CAAC,EACZ,WAAW,GAAG,mBAAmB,EACjC,MAAM,EACN,QAAQ,GAAG,QAAQ,GACpB,GAAG,OAAO,CAAA;IACX,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC9E,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EACJ,QAAQ,GAAG,CAAC,EACZ,WAAW,GAAG,mBAAmB,EACjC,MAAM,EACN,QAAQ,GAAG,QAAQ,GACpB,GAAG,OAAO,CAAA;IACX,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC7E,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EACJ,QAAQ,GAAG,CAAC,EACZ,WAAW,GAAG,mBAAmB,EACjC,MAAM,EACN,QAAQ,GAAG,QAAQ,GACpB,GAAG,OAAO,CAAA;IACX,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC9E,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,CAAA;AAC1B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CACzB,KAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EACJ,WAAW,GAAG,mBAAmB,EACjC,MAAM,EACN,QAAQ,GAAG,QAAQ,GACpB,GAAG,OAAO,CAAA;IACX,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC,GAAG,CAAC,CAAA;IACtD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,WAAW,CAChC,CAAC,EACD,QAAQ,EACR,MAAM,EACN,GAAG,IAAI,IAAI,EACX,QAAQ,EACR,KAAK,CACN,CAAA;IACD,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EAAE,QAAQ,GAAG,CAAC,EAAE,WAAW,GAAG,mBAAmB,EAAE,GAAG,OAAO,CAAA;IACnE,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACvB,IAAI,GAAG,IAAI,aAAa,EAAE,CAAC;QACzB,OAAO,GAAG,IAAI,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAA;IAC9D,CAAC;IACD,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;QACrB,OAAO,GAAG,IAAI,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAA;IAC1D,CAAC;IACD,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;QACjB,OAAO,GAAG,IAAI,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAA;IACtD,CAAC;IACD,OAAO,GAAG,IAAI,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAA;AAC3C,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Off-grid resolution for {@link scaleToInteger}:
|
|
3
|
+
* - `truncate` — toward zero, for sizes and collateral amounts. The wire
|
|
4
|
+
* value never exceeds the caller's intent.
|
|
5
|
+
* - `round` — half away from zero, for prices, which snap to the nearest
|
|
6
|
+
* tick.
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type ScaleToIntegerPolicy = 'truncate' | 'round';
|
|
10
|
+
/**
|
|
11
|
+
* Scale a human-readable decimal string to a scaled integer in exact decimal
|
|
12
|
+
* arithmetic — an on-grid input maps to its exact scaled integer with no
|
|
13
|
+
* binary float artifacts (`'0.29'` at 2 decimals is 29, never 28).
|
|
14
|
+
* Off-grid input resolves per `policy`; there is no silent default.
|
|
15
|
+
*
|
|
16
|
+
* @throws {PerpsError} `ValidationError` when `value` is not a decimal
|
|
17
|
+
* numeric string, `decimals` is not a non-negative integer, or the scaled
|
|
18
|
+
* result's magnitude exceeds `Number.MAX_SAFE_INTEGER`.
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
export declare const scaleToInteger: (value: string, decimals: number, policy: ScaleToIntegerPolicy) => number;
|
|
22
|
+
//# sourceMappingURL=scaleToInteger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scaleToInteger.d.ts","sourceRoot":"","sources":["../../../src/utils/scaleToInteger.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAAG,OAAO,CAAA;AAEvD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GACzB,OAAO,MAAM,EACb,UAAU,MAAM,EAChB,QAAQ,oBAAoB,KAC3B,MA0BF,CAAA"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { PerpsErrorCode } from '@lifi/perps-types';
|
|
2
|
+
import Big from 'big.js';
|
|
3
|
+
import { PerpsError } from '../errors/PerpsError.js';
|
|
4
|
+
/**
|
|
5
|
+
* Scale a human-readable decimal string to a scaled integer in exact decimal
|
|
6
|
+
* arithmetic — an on-grid input maps to its exact scaled integer with no
|
|
7
|
+
* binary float artifacts (`'0.29'` at 2 decimals is 29, never 28).
|
|
8
|
+
* Off-grid input resolves per `policy`; there is no silent default.
|
|
9
|
+
*
|
|
10
|
+
* @throws {PerpsError} `ValidationError` when `value` is not a decimal
|
|
11
|
+
* numeric string, `decimals` is not a non-negative integer, or the scaled
|
|
12
|
+
* result's magnitude exceeds `Number.MAX_SAFE_INTEGER`.
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
export const scaleToInteger = (value, decimals, policy) => {
|
|
16
|
+
if (!Number.isInteger(decimals) || decimals < 0) {
|
|
17
|
+
throw new PerpsError(PerpsErrorCode.ValidationError, `Invalid decimals for integer scaling: ${decimals}`);
|
|
18
|
+
}
|
|
19
|
+
let parsed;
|
|
20
|
+
try {
|
|
21
|
+
parsed = new Big(value);
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
throw new PerpsError(PerpsErrorCode.ValidationError, `Invalid decimal string for integer scaling: '${value}'`);
|
|
25
|
+
}
|
|
26
|
+
const scaled = parsed
|
|
27
|
+
.times(new Big(10).pow(decimals))
|
|
28
|
+
.round(0, policy === 'truncate' ? Big.roundDown : Big.roundHalfUp);
|
|
29
|
+
if (scaled.abs().gt(Number.MAX_SAFE_INTEGER)) {
|
|
30
|
+
throw new PerpsError(PerpsErrorCode.ValidationError, `Scaled value ${scaled.toFixed()} exceeds Number.MAX_SAFE_INTEGER and cannot be encoded exactly.`);
|
|
31
|
+
}
|
|
32
|
+
return scaled.toNumber();
|
|
33
|
+
};
|
|
34
|
+
//# sourceMappingURL=scaleToInteger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scaleToInteger.js","sourceRoot":"","sources":["../../../src/utils/scaleToInteger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,GAAG,MAAM,QAAQ,CAAA;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAYpD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,KAAa,EACb,QAAgB,EAChB,MAA4B,EACpB,EAAE;IACV,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,UAAU,CAClB,cAAc,CAAC,eAAe,EAC9B,yCAAyC,QAAQ,EAAE,CACpD,CAAA;IACH,CAAC;IACD,IAAI,MAAW,CAAA;IACf,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,UAAU,CAClB,cAAc,CAAC,eAAe,EAC9B,gDAAgD,KAAK,GAAG,CACzD,CAAA;IACH,CAAC;IACD,MAAM,MAAM,GAAG,MAAM;SAClB,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SAChC,KAAK,CAAC,CAAC,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACpE,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,UAAU,CAClB,cAAc,CAAC,eAAe,EAC9B,gBAAgB,MAAM,CAAC,OAAO,EAAE,iEAAiE,CAClG,CAAA;IACH,CAAC;IACD,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC,CAAA"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { ProviderAction } from '@lifi/perps-types';
|
|
2
|
+
/**
|
|
3
|
+
* Select the `Provider.setup` descriptors a user is responsible for satisfying:
|
|
4
|
+
* those whose `signers` include {@link PerpsSigner.USER}. Descriptors the SDK
|
|
5
|
+
* signs on its own (no `USER` signer) are held back — `checkSetup` completes
|
|
6
|
+
* them inline, so surfacing them would render inert cards the user can't act on.
|
|
7
|
+
*
|
|
8
|
+
* Membership is a property of the descriptor's `signers` alone, independent of
|
|
9
|
+
* any account: use this to build the onboarding list, then layer each entry's
|
|
10
|
+
* satisfied/unsatisfied state on top from a live `checkSetup` so the tick never
|
|
11
|
+
* goes stale.
|
|
12
|
+
*
|
|
13
|
+
* @param setup The provider's `setup` descriptors, in their declared order.
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export declare function selectUserSetupActions(setup: ProviderAction[]): ProviderAction[];
|
|
17
|
+
//# sourceMappingURL=setupActions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"setupActions.d.ts","sourceRoot":"","sources":["../../../src/utils/setupActions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAGvD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,cAAc,EAAE,GACtB,cAAc,EAAE,CAIlB"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { PerpsSigner } from '@lifi/perps-types';
|
|
2
|
+
/**
|
|
3
|
+
* Select the `Provider.setup` descriptors a user is responsible for satisfying:
|
|
4
|
+
* those whose `signers` include {@link PerpsSigner.USER}. Descriptors the SDK
|
|
5
|
+
* signs on its own (no `USER` signer) are held back — `checkSetup` completes
|
|
6
|
+
* them inline, so surfacing them would render inert cards the user can't act on.
|
|
7
|
+
*
|
|
8
|
+
* Membership is a property of the descriptor's `signers` alone, independent of
|
|
9
|
+
* any account: use this to build the onboarding list, then layer each entry's
|
|
10
|
+
* satisfied/unsatisfied state on top from a live `checkSetup` so the tick never
|
|
11
|
+
* goes stale.
|
|
12
|
+
*
|
|
13
|
+
* @param setup The provider's `setup` descriptors, in their declared order.
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export function selectUserSetupActions(setup) {
|
|
17
|
+
return setup.filter((descriptor) => descriptor.signers.includes(PerpsSigner.USER));
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=setupActions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"setupActions.js","sourceRoot":"","sources":["../../../src/utils/setupActions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAuB;IAEvB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CACjC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAC9C,CAAA;AACH,CAAC"}
|
package/dist/esm/version.d.ts
CHANGED
package/dist/esm/version.js
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
import type { AccountResponse, AccountSummary, ActionParamsMap, ActionStep, CreateActionResponse,
|
|
1
|
+
import type { AccountResponse, AccountSummary, ActionParamsMap, ActionStep, CreateActionResponse, ExecuteActionResponse, MarketRef, Position } from '@lifi/perps-types';
|
|
2
2
|
import { ActionType } from '@lifi/perps-types';
|
|
3
3
|
import type { Address } from 'viem';
|
|
4
|
-
import type { BuildProviderSetupParams, CancelOrdersParams, GetAccountResult, GetSetupParams, ModifyOrdersParams, PerpsClientOptions, PlaceOrderParams, PlaceTriggerOrderParams, ProviderSetup, SendAssetActionParams, WithdrawParams } from '../types/api.js';
|
|
4
|
+
import type { BuildProviderSetupParams, CancelOrdersParams, GetAccountResult, GetDepositFlowParams, GetSetupParams, ModifyOrdersParams, PerpsClientOptions, PlaceOrderParams, PlaceTriggerOrderParams, ProviderSetup, SendAssetActionParams, WithdrawParams } from '../types/api.js';
|
|
5
5
|
import type { SwitchChainHook } from '../types/config.js';
|
|
6
|
-
import type {
|
|
6
|
+
import type { DepositFlow } from '../types/deposit.js';
|
|
7
|
+
import type { PerpsSDKClient, SignActionProgress } from '../types/provider.js';
|
|
7
8
|
/**
|
|
8
9
|
* The primary high-level perps API: wraps a {@link PerpsSDKClient} and owns the
|
|
9
10
|
* end-to-end signing pipeline for provider setup, orders, and account-level
|
|
@@ -63,6 +64,12 @@ export declare class PerpsClient {
|
|
|
63
64
|
* arm signs as the user.
|
|
64
65
|
*/
|
|
65
66
|
private delegateSignActions;
|
|
67
|
+
/**
|
|
68
|
+
* Let the plugin observe `/executeAction` per-step results before the core
|
|
69
|
+
* surfaces failures — e.g. to evict a locally stored credential the venue
|
|
70
|
+
* rejected.
|
|
71
|
+
*/
|
|
72
|
+
private notifyExecuteResults;
|
|
66
73
|
/**
|
|
67
74
|
* Resolve the wallet that signs `actions`. For a USER-signed EIP-712 batch,
|
|
68
75
|
* switch the configured wallet to the action's target chain via the
|
|
@@ -146,12 +153,16 @@ export declare class PerpsClient {
|
|
|
146
153
|
*/
|
|
147
154
|
accountExists(provider: string, address: Address): Promise<boolean>;
|
|
148
155
|
/**
|
|
149
|
-
*
|
|
150
|
-
*
|
|
156
|
+
* The deposit flow for `params.address` at `params.provider`, delegated to the
|
|
157
|
+
* provider plugin — every deposit decision (the collateral destination, the
|
|
158
|
+
* account-opening pipeline, an outstanding setup gate) is venue-owned.
|
|
151
159
|
*
|
|
160
|
+
* @returns `undefined` when the registered plugin declares no deposit flow.
|
|
161
|
+
* @throws {PerpsError} When the provider plugin is not registered, or the
|
|
162
|
+
* plugin's flow resolution fails.
|
|
152
163
|
* @public
|
|
153
164
|
*/
|
|
154
|
-
|
|
165
|
+
getDepositFlow(params: GetDepositFlowParams): Promise<DepositFlow | undefined>;
|
|
155
166
|
/**
|
|
156
167
|
* Return the unsatisfied entries on `Provider.setup` for this account as a
|
|
157
168
|
* flat, self-describing list. Trading is gated on `isReady === true`.
|
|
@@ -163,6 +174,27 @@ export declare class PerpsClient {
|
|
|
163
174
|
* @public
|
|
164
175
|
*/
|
|
165
176
|
checkSetup(params: GetSetupParams): Promise<ProviderSetup>;
|
|
177
|
+
/**
|
|
178
|
+
* Resolve setup descriptors already satisfied from the provider's own typed
|
|
179
|
+
* account config projection. This catches client-held auth state (e.g. Ondo
|
|
180
|
+
* SIWE/JWT) that the backend cannot observe.
|
|
181
|
+
*/
|
|
182
|
+
private resolveSatisfiedSetup;
|
|
183
|
+
/**
|
|
184
|
+
* Drain the pending setup steps the provider declares as internal via
|
|
185
|
+
* `PerpsProviderPlugin.internalSetupActions`, returning the set of action
|
|
186
|
+
* types to omit from the caller-facing setup list. Each such step is built,
|
|
187
|
+
* signed, and executed in place with the provider's own credentials. A
|
|
188
|
+
* descriptor whose `signers` include {@link PerpsSigner.USER} is left to
|
|
189
|
+
* render as a normal step. A drain failure is swallowed so it never blocks
|
|
190
|
+
* setup — the step stays unsatisfied and is retried on a later `checkSetup`.
|
|
191
|
+
*/
|
|
192
|
+
private resolveInternalSetup;
|
|
193
|
+
/**
|
|
194
|
+
* Build unsigned setup steps for the supplied descriptor subset, preserving
|
|
195
|
+
* provider sequence order with SIWE descriptors prioritized.
|
|
196
|
+
*/
|
|
197
|
+
private buildProviderSetupActions;
|
|
166
198
|
/**
|
|
167
199
|
* Build the unsigned setup `ActionStep`s still outstanding for an account,
|
|
168
200
|
* ordered by descriptor `sequence`. The backend filters already-satisfied
|
|
@@ -326,14 +358,9 @@ export declare class PerpsClient {
|
|
|
326
358
|
address: Address;
|
|
327
359
|
action: T;
|
|
328
360
|
params: ActionParamsMap[T];
|
|
361
|
+
/** Progress sink for on-chain legs (e.g. a native deposit's approve then
|
|
362
|
+
* deposit); called as each leg is submitted and confirmed. */
|
|
363
|
+
onProgress?: (progress: SignActionProgress) => void;
|
|
329
364
|
}): Promise<ExecuteActionResponse>;
|
|
330
|
-
/**
|
|
331
|
-
* The `AUTH_TOKEN` arm of {@link execute}: the venue call runs client-side
|
|
332
|
-
* via the plugin's `executeRestCallActions` because the credential headers
|
|
333
|
-
* must never transit the LI.FI backend. The venue's results are what the
|
|
334
|
-
* caller gets; the backend `executeAction` submission that follows is
|
|
335
|
-
* bookkeeping only, sent with `headers` stripped.
|
|
336
|
-
*/
|
|
337
|
-
private executeAuthTokenActions;
|
|
338
365
|
}
|
|
339
366
|
//# sourceMappingURL=PerpsClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PerpsClient.d.ts","sourceRoot":"","sources":["../../../src/client/PerpsClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,eAAe,
|
|
1
|
+
{"version":3,"file":"PerpsClient.d.ts","sourceRoot":"","sources":["../../../src/client/PerpsClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,eAAe,EAEf,UAAU,EACV,oBAAoB,EACpB,qBAAqB,EACrB,SAAS,EACT,QAAQ,EAIT,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,UAAU,EAIX,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAMnC,OAAO,KAAK,EACV,wBAAwB,EACxB,kBAAkB,EAGlB,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,aAAa,EACb,qBAAqB,EACrB,cAAc,EACf,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAqB,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAGV,cAAc,EACd,kBAAkB,EAEnB,MAAM,sBAAsB,CAAA;AA8B7B;;;;;;;GAOG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,qBAAqB,CAAmC;IAChE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,YAAY,CAA6B;gBAErC,OAAO,EAAE,kBAAkB;IAUvC;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI;IAQ7D;;;;;;OAMG;IACH,cAAc,CAAC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,IAAI;IAI9D;;;;;OAKG;IACH,IAAI,MAAM,IAAI,cAAc,CAE3B;YAEa,mBAAmB;IAuBjC;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAIvB;;;;;;;OAOG;YACW,oBAAoB;IAgBlC;;;;;OAKG;YACW,mBAAmB;IAwBjC;;;;OAIG;YACW,oBAAoB;IAWlC;;;;;;OAMG;YACW,oBAAoB;IAelC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;;;;;;;;;;OAWG;YACW,uBAAuB;IAgBrC;;;;;OAKG;IACG,WAAW,CAAC,CAAC,SAAS,UAAU,EACpC,MAAM,EAAE,CAAC,EACT,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;KAAE,GACzE,OAAO,CAAC,oBAAoB,CAAC;IAqBhC;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE;QACvB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;KACjB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAc7B;;;;OAIG;IACH,iBAAiB,CACf,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,GACpB,cAAc;IAOjB;;;;;;;;;OASG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzE;;;;;;;;;OASG;IACG,cAAc,CAClB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAKnC;;;;;;;;;OASG;IACG,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IA+ChE;;;;OAIG;YACW,qBAAqB;IAyBnC;;;;;;;;OAQG;YACW,oBAAoB;IAiDlC;;;OAGG;YACW,yBAAyB;IAuCvC;;;;;;;OAOG;IACG,kBAAkB,CACtB,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAYhC;;;;;OAKG;YACW,oBAAoB;IAsClC;;;;;;;;;;;;;;;OAeG;IACG,0BAA0B,CAAC,MAAM,EAAE;QACvC,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,IAAI,EAAE,UAAU,CAAA;KACjB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BjB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,qBAAqB,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE;QACxD,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,CAAC,CAAA;QACT,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;KAC3B,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjB;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI1E;;;;;;;OAOG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;;;;;OAOG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;;;;;OAOG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,SAAS,CAAA;QACjB,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAA;QACxB,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAQlC;;;;;;;OAOG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAStE;;;;;;;;;OASG;IACG,SAAS,CACb,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,qBAAqB,CAAC;IAUjC;;;;;;;;;OASG;IACG,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE;QAC1C,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,CAAC,CAAA;QACT,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;QAC1B;sEAC8D;QAC9D,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAA;KACpD,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAgDnC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* `@lifi/perps-sdk` — the public entry point. Exports `createPerpsClient` and
|
|
3
|
-
* `PerpsClient` (the primary API), the
|
|
3
|
+
* `PerpsClient` (the primary API), the WebSocket `PerpsWsClient`, the pure
|
|
4
4
|
* calculation/parsing/order helpers, and re-exports the shared `@lifi/perps-types`.
|
|
5
5
|
*
|
|
6
6
|
* @packageDocumentation
|
|
@@ -12,7 +12,7 @@ export { PerpsClient } from './client/PerpsClient.js';
|
|
|
12
12
|
export { PerpsErrorMessage } from './errors/constants.js';
|
|
13
13
|
export { PerpsError } from './errors/PerpsError.js';
|
|
14
14
|
export { AssetRegistry, getAssetRegistry } from './registry/assetRegistry.js';
|
|
15
|
-
export { getMarketRegistry, MarketRegistry, toMarketDisplay, } from './registry/marketRegistry.js';
|
|
15
|
+
export { getMarketRegistry, isActiveMarket, MarketRegistry, toMarketDisplay, } from './registry/marketRegistry.js';
|
|
16
16
|
export type { CreateActionParams } from './services/createAction.js';
|
|
17
17
|
export { createAction } from './services/createAction.js';
|
|
18
18
|
export type { ExecuteActionParams } from './services/executeAction.js';
|
|
@@ -25,6 +25,8 @@ export type { GetAssetsParams } from './services/getAssets.js';
|
|
|
25
25
|
export { getAssets } from './services/getAssets.js';
|
|
26
26
|
export type { GetFillsParams } from './services/getFills.js';
|
|
27
27
|
export { getFills } from './services/getFills.js';
|
|
28
|
+
export type { GetGasRecommendationParams } from './services/getGasRecommendation.js';
|
|
29
|
+
export { getGasRecommendation, LIFI_API_URL, } from './services/getGasRecommendation.js';
|
|
28
30
|
export type { GetMarketParams } from './services/getMarket.js';
|
|
29
31
|
export { getMarket } from './services/getMarket.js';
|
|
30
32
|
export type { GetMarketsParams } from './services/getMarkets.js';
|
|
@@ -56,22 +58,25 @@ export type { FetchWithRetryOptions } from './transport/fetchWithRetry.js';
|
|
|
56
58
|
export { fetchWithRetry } from './transport/fetchWithRetry.js';
|
|
57
59
|
export type { ProviderRetryConfig, ResolvedRetryPolicy, RetryAttemptContext, RetryClassification, RetryClassifyContext, RetryConfig, RetryPolicy, } from './transport/retryPolicy.js';
|
|
58
60
|
export { DISABLED_RETRY, LIFI_REQUEST_KEY, LIFI_RETRY_DEFAULTS, resolveRetryPolicy, } from './transport/retryPolicy.js';
|
|
59
|
-
export type { BuildProviderSetupParams, CancelOrdersParams, GetAccountResult, GetSetupParams, ModifyOrdersParams, PerpsClientOptions, PerpsConfig, PlaceOrderParams as ClientPlaceOrderParams, PlaceTriggerOrderParams as ClientPlaceTriggerOrderParams, ProviderSetup, SendAssetActionParams, WithdrawParams, } from './types/api.js';
|
|
61
|
+
export type { BuildProviderSetupParams, CancelOrdersParams, GetAccountResult, GetDepositFlowParams, GetSetupParams, ModifyOrdersParams, PerpsClientOptions, PerpsConfig, PlaceOrderParams as ClientPlaceOrderParams, PlaceTriggerOrderParams as ClientPlaceTriggerOrderParams, ProviderSetup, SendAssetActionParams, WithdrawParams, } from './types/api.js';
|
|
60
62
|
export type { HyperliquidConfig, PerpsBaseConfig, PerpsClientSigner, ProviderConfig, ProviderConfigs, RequestInterceptor, SDKRequestOptions, SwitchChainHook, } from './types/config.js';
|
|
61
|
-
export type {
|
|
63
|
+
export type { DeclaredDepositAsset, DepositFlow, DepositFlowFirstDepositPipeline, DepositFlowLifiSwap, DepositFlowSetupRequired, } from './types/deposit.js';
|
|
64
|
+
export type { ActionSignerContribution, LiquidationEstimateParams, PerpsProvider, PerpsProviderPlugin, PerpsSDKClient, ProviderAccountExistsParams, ProviderGetAccountParams, ProviderGetActivityParams, ProviderGetDepositFlowParams, ProviderGetFillsParams, ProviderGetOrderParams, ProviderGetOrdersParams, ProviderGetPositionsParams, ProviderGetQuoteParams, QuoteListener, SignActionProgress, SignActionsContext, } from './types/provider.js';
|
|
62
65
|
export { type CollateralSemantics, summarizeAccount, } from './utils/accountSummary.js';
|
|
63
66
|
export type { ExpectedPnl } from './utils/calculations.js';
|
|
64
67
|
export { applySlippage, buildQuote, calculateExpectedPnl, calculateNotionalValue, calculatePositionSize, calculateRealizedPnlPercent, calculateRequiredMargin, calculateRoe, calculateUnrealizedPnl, effectiveLeverage, estimateFees, liquidationDistancePercent, percentFromPrice, priceFromPercent, removableMargin, walkOrderbook, } from './utils/calculations.js';
|
|
65
|
-
export
|
|
66
|
-
export {
|
|
67
|
-
export { ExplorerChainId, explorerTxUrl } from './utils/explorer.js';
|
|
68
|
+
export { ETHEREUM_NATIVE_GAS, ETHEREUM_USDC, HYPERLIQUID_USDC, LIGHTER_USDC, ROBINHOOD_NATIVE_GAS, ROBINHOOD_USDG, } from './utils/depositAssets.js';
|
|
69
|
+
export { ExplorerChainId, explorerTxUrl, explorerTxUrlFromBase, } from './utils/explorer.js';
|
|
68
70
|
export { classifyFillFromPosition } from './utils/fillClassification.js';
|
|
69
|
-
export type { FormatOptions } from './utils/format.js';
|
|
70
|
-
export { formatCompactUsd, formatPrice, formatSignedPercent, formatSignedUsd, formatUsd, } from './utils/format.js';
|
|
71
|
+
export type { FormatOptions, RoundingMode } from './utils/format.js';
|
|
72
|
+
export { formatCompactUsd, formatNumber, formatPrice, formatSignedPercent, formatSignedUsd, formatUsd, } from './utils/format.js';
|
|
71
73
|
export { ACTIVE_ORDER_STATUSES, classifyFill, FillClassification, isActiveOrderStatus, isStopLossOrder, isTakeProfitOrder, isTpSlOrder, } from './utils/orderClassification.js';
|
|
72
74
|
export { expectedRealizedPnlForOpenOrder, expectedRealizedPnlForTriggerOrder, findMatchingPosition, resolveCloseSize, } from './utils/orderMath.js';
|
|
73
75
|
export { stringToFloat } from './utils/parse.js';
|
|
74
76
|
export { directionSign, estimateIsolatedLiquidationPrice, predictAverageEntryPrice, predictNewLeverage, predictUnrealizedPnl, realizedPnlOnClose, } from './utils/positionMath.js';
|
|
77
|
+
export type { ScaleToIntegerPolicy } from './utils/scaleToInteger.js';
|
|
78
|
+
export { scaleToInteger } from './utils/scaleToInteger.js';
|
|
79
|
+
export { selectUserSetupActions } from './utils/setupActions.js';
|
|
75
80
|
export { signTypedData, signTypedDataWithSigner, } from './utils/signTypedData.js';
|
|
76
81
|
export { fromBaseUnits, fromBaseUnitsNumber } from './utils/units.js';
|
|
77
82
|
export { validateMargin } from './utils/validation.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,cAAc,mBAAmB,CAAA;AACjC,OAAO,EACL,iBAAiB,EACjB,eAAe,GAChB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAEnD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,8BAA8B,CAAA;AAErC,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,YAAY,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,YAAY,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AACvD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,YAAY,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AAC9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AACrE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC7E,OAAO,EACL,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EACL,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,YAAY,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAC9D,YAAY,EACV,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,WAAW,GACZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,4BAA4B,CAAA;AACnC,YAAY,EACV,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,IAAI,sBAAsB,EAC1C,uBAAuB,IAAI,6BAA6B,EACxD,aAAa,EACb,qBAAqB,EACrB,cAAc,GACf,MAAM,gBAAgB,CAAA;AACvB,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,GAChB,MAAM,mBAAmB,CAAA;AAC1B,YAAY,EACV,wBAAwB,EACxB,yBAAyB,EACzB,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,cAAc,mBAAmB,CAAA;AACjC,OAAO,EACL,iBAAiB,EACjB,eAAe,GAChB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAEnD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,eAAe,GAChB,MAAM,8BAA8B,CAAA;AAErC,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,YAAY,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,YAAY,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AACvD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,YAAY,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AACpF,OAAO,EACL,oBAAoB,EACpB,YAAY,GACb,MAAM,oCAAoC,CAAA;AAC3C,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,YAAY,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AAC9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AACrE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC7E,OAAO,EACL,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EACL,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,YAAY,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAC9D,YAAY,EACV,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,WAAW,GACZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,4BAA4B,CAAA;AACnC,YAAY,EACV,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,IAAI,sBAAsB,EAC1C,uBAAuB,IAAI,6BAA6B,EACxD,aAAa,EACb,qBAAqB,EACrB,cAAc,GACf,MAAM,gBAAgB,CAAA;AACvB,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,GAChB,MAAM,mBAAmB,CAAA;AAC1B,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,+BAA+B,EAC/B,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,oBAAoB,CAAA;AAC3B,YAAY,EACV,wBAAwB,EACxB,yBAAyB,EACzB,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAC1B,sBAAsB,EACtB,aAAa,EACb,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,KAAK,mBAAmB,EACxB,gBAAgB,GACjB,MAAM,2BAA2B,CAAA;AAClC,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EACL,aAAa,EACb,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,YAAY,EACZ,sBAAsB,EACtB,iBAAiB,EACjB,YAAY,EACZ,0BAA0B,EAC1B,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,aAAa,GACd,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,cAAc,GACf,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,eAAe,EACf,aAAa,EACb,qBAAqB,GACtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAA;AACxE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACpE,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,WAAW,EACX,mBAAmB,EACnB,eAAe,EACf,SAAS,GACV,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,WAAW,GACZ,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,+BAA+B,EAC/B,kCAAkC,EAClC,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EACL,aAAa,EACb,gCAAgC,EAChC,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,yBAAyB,CAAA;AAChC,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,EACL,aAAa,EACb,uBAAuB,GACxB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,YAAY,EACV,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAC5D,YAAY,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAA;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA;AAC5E,YAAY,EACV,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,UAAU,EACV,gBAAgB,GACjB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACL,6BAA6B,EAC7B,cAAc,GACf,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA"}
|
|
@@ -13,18 +13,31 @@ export declare class MarketRegistry extends ReferenceDataRegistry<Market> {
|
|
|
13
13
|
constructor(client: PerpsSDKClient, provider: string);
|
|
14
14
|
/** The most recently synced market list. Empty before the first {@link sync}. */
|
|
15
15
|
get markets(): readonly Market[];
|
|
16
|
+
/** The synced markets that are available for live and write operations. */
|
|
17
|
+
get activeMarkets(): readonly Market[];
|
|
16
18
|
/**
|
|
17
19
|
* Lookup by `Market.id`, throwing when the backend list does not know the
|
|
18
|
-
* id. The list is the source of truth for
|
|
19
|
-
* the venue references but the backend does not
|
|
20
|
+
* id. The list is the source of truth for enriched historical and live
|
|
21
|
+
* market metadata, so an id the venue references but the backend does not
|
|
22
|
+
* know is a hard error —
|
|
20
23
|
* never a silent fallback to an unenriched stand-in.
|
|
21
24
|
*
|
|
22
25
|
* @throws {PerpsError} `MarketNotFound`.
|
|
23
26
|
*/
|
|
24
27
|
require(marketId: string): Market;
|
|
28
|
+
/**
|
|
29
|
+
* Lookup a market for live or write use. Delisted markets remain resolvable
|
|
30
|
+
* through {@link require} for historical display mapping, but this method
|
|
31
|
+
* rejects them.
|
|
32
|
+
*
|
|
33
|
+
* @throws {PerpsError} `MarketNotFound` when the market is absent or delisted.
|
|
34
|
+
*/
|
|
35
|
+
requireActive(marketId: string): Market;
|
|
25
36
|
protected fetchItems(): Promise<Market[]>;
|
|
26
37
|
protected keyOf(market: Market): string;
|
|
27
38
|
}
|
|
39
|
+
/** A market is active unless the provider explicitly marks it delisted. */
|
|
40
|
+
export declare const isActiveMarket: (market: Market) => boolean;
|
|
28
41
|
/**
|
|
29
42
|
* The stable {@link MarketRegistry} for `(client, provider)`.
|
|
30
43
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"marketRegistry.d.ts","sourceRoot":"","sources":["../../../src/registry/marketRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAmB,MAAM,mBAAmB,CAAA;AAI/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAElE;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,qBAAqB,CAAC,MAAM,CAAC;gBACnD,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM;IAIpD,iFAAiF;IACjF,IAAI,OAAO,IAAI,SAAS,MAAM,EAAE,CAE/B;IAED
|
|
1
|
+
{"version":3,"file":"marketRegistry.d.ts","sourceRoot":"","sources":["../../../src/registry/marketRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAmB,MAAM,mBAAmB,CAAA;AAI/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAElE;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,qBAAqB,CAAC,MAAM,CAAC;gBACnD,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM;IAIpD,iFAAiF;IACjF,IAAI,OAAO,IAAI,SAAS,MAAM,EAAE,CAE/B;IAED,2EAA2E;IAC3E,IAAI,aAAa,IAAI,SAAS,MAAM,EAAE,CAErC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAajC;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAavC,SAAS,CAAC,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IASzC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CAGxC;AAID,2EAA2E;AAC3E,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,KAAG,OACpB,CAAA;AAE5B;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,MAAM,GACf,cAAc,CAYhB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,aAO/C,CAAA"}
|
|
@@ -6,7 +6,8 @@ import type { PerpsSDKClient } from '../types/provider.js';
|
|
|
6
6
|
* NOT a cache: it holds no freshness policy of its own. Every {@link sync}
|
|
7
7
|
* refetches through the HTTP layer, whose `cache-control` headers decide
|
|
8
8
|
* whether the response comes from disk or the network. A lookup miss warns
|
|
9
|
-
* once and returns `undefined`;
|
|
9
|
+
* once per id and returns `undefined`; subsequent syncs reconcile the index
|
|
10
|
+
* without replaying the warning for an id that remains absent.
|
|
10
11
|
*
|
|
11
12
|
* @internal
|
|
12
13
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"referenceDataRegistry.d.ts","sourceRoot":"","sources":["../../../src/registry/referenceDataRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D
|
|
1
|
+
{"version":3,"file":"referenceDataRegistry.d.ts","sourceRoot":"","sources":["../../../src/registry/referenceDataRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;;;;;;;;GAWG;AACH,8BAAsB,qBAAqB,CAAC,CAAC;IAOzC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc;IACzC,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,OAAO,CAAC,QAAQ,CAAC,IAAI;IARvB,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,SAAS,CAAoB;IAErC,SAAS,aACY,MAAM,EAAE,cAAc,EAChC,QAAQ,EAAE,MAAM,EACR,IAAI,EAAE,MAAM;IAG/B,6DAA6D;IAC7D,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAE7C,6DAA6D;IAC7D,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM;IAEzC;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;IAS7B,0EAA0E;IAC1E,SAAS,KAAK,KAAK,IAAI,SAAS,CAAC,EAAE,CAElC;IAED,4DAA4D;IAC5D,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;YAYhB,IAAI;CAMnB"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { GasRecommendationResponse } from '@lifi/types';
|
|
2
|
+
import type { SDKRequestOptions } from '../types/config.js';
|
|
3
|
+
import type { PerpsSDKClient } from '../types/provider.js';
|
|
4
|
+
/**
|
|
5
|
+
* LI.FI API base URL for reads the user's client makes directly, without the
|
|
6
|
+
* perps backend in the path.
|
|
7
|
+
*
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export declare const LIFI_API_URL = "https://li.quest/v1";
|
|
11
|
+
/**
|
|
12
|
+
* Parameters for {@link getGasRecommendation}.
|
|
13
|
+
*
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export interface GetGasRecommendationParams {
|
|
17
|
+
/** Chain to hold native gas on — a `firstDepositPipeline` flow's `chainId`. */
|
|
18
|
+
chainId: number;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* How much native gas LI.FI suggests holding on `params.chainId` to transact
|
|
22
|
+
* there, for seeding the gas leg of a first-deposit pipeline. Read straight
|
|
23
|
+
* from the LI.FI API by the user's client.
|
|
24
|
+
*
|
|
25
|
+
* @returns The suggestion, with `available: false` and no amounts on a chain
|
|
26
|
+
* LI.FI cannot source gas for.
|
|
27
|
+
* @throws {PerpsError} On API error responses, or network/parsing errors.
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export declare function getGasRecommendation(client: PerpsSDKClient, params: GetGasRecommendationParams, options?: SDKRequestOptions): Promise<GasRecommendationResponse>;
|
|
31
|
+
//# sourceMappingURL=getGasRecommendation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getGasRecommendation.d.ts","sourceRoot":"","sources":["../../../src/services/getGasRecommendation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AAE5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,YAAY,wBAAwB,CAAA;AAEjD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,yBAAyB,CAAC,CAOpC"}
|
|
@@ -16,10 +16,11 @@ export interface GetMarketParams {
|
|
|
16
16
|
marketId: string;
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* Get a specific market by its opaque marketId. Requests the single
|
|
20
|
-
* from the backend `/markets` route (filtered by `marketIds`) and
|
|
21
|
-
* first match; throws a `MarketNotFound` {@link PerpsError}
|
|
22
|
-
* backend responds 404
|
|
19
|
+
* Get a specific active market by its opaque marketId. Requests the single
|
|
20
|
+
* market from the backend `/markets` route (filtered by `marketIds`) and
|
|
21
|
+
* returns the first active match; throws a `MarketNotFound` {@link PerpsError}
|
|
22
|
+
* when the backend responds 404, returns an empty list, or returns a
|
|
23
|
+
* delisted market, matching
|
|
23
24
|
* `MarketRegistry.require`'s miss behaviour.
|
|
24
25
|
*
|
|
25
26
|
* @throws {PerpsError} On backend (e.g. 404 or empty match), network, or parsing errors.
|