@lifi/perps-types 0.0.0-preview-a5f5e3b → 0.0.0-preview-c903f1e
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 +6 -30
- package/dist/cjs/market.d.ts +5 -5
- package/dist/cjs/market.d.ts.map +1 -1
- package/dist/esm/market.d.ts +11 -6
- package/dist/esm/market.d.ts.map +1 -1
- package/dist/types/market.d.ts +11 -6
- package/dist/types/market.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/market.ts +11 -6
package/README.md
CHANGED
|
@@ -1,48 +1,24 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
[](/LICENSE)
|
|
4
4
|
[](https://www.npmjs.com/package/@lifi/perps-types)
|
|
5
5
|
[](https://www.npmjs.com/package/@lifi/perps-types)
|
|
6
6
|
[](https://twitter.com/lifiprotocol)
|
|
7
7
|
|
|
8
8
|
</div>
|
|
9
9
|
|
|
10
|
-
#
|
|
10
|
+
# `@lifi/perps-types`
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Types for the LI.FI Perps SDK.
|
|
13
13
|
|
|
14
14
|
## Summary
|
|
15
15
|
|
|
16
|
-
This package contains
|
|
17
|
-
|
|
18
|
-
Check out the [Changelog](./CHANGELOG.md) to see what changed in the last releases.
|
|
16
|
+
This package contains the shared, zero-dependency types for the [LI.FI Perps SDK](https://www.npmjs.com/package/@lifi/perps-sdk) and its provider plugins — a workspace package of the `perps-sdk` monorepo. You rarely install it directly; it arrives transitively with `@lifi/perps-sdk`.
|
|
19
17
|
|
|
20
18
|
## Installation
|
|
21
19
|
|
|
22
20
|
```bash
|
|
23
21
|
pnpm add @lifi/perps-types
|
|
22
|
+
# or
|
|
23
|
+
npm install @lifi/perps-types
|
|
24
24
|
```
|
|
25
|
-
|
|
26
|
-
or
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npm install --save @lifi/perps-types
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Release
|
|
33
|
-
|
|
34
|
-
The package uses `standard-version` to generate a changelog based on semantic commit history. The `standard-version` package also handles version numbering.
|
|
35
|
-
|
|
36
|
-
Once main is up to date with the changes to be released execute the following command on the main branch to invoke `standard-version`:
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
pnpm release
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
Then to release:
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
git push --follow-tags origin main
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
This will push a newly created git tag to the remote repository, which will trigger a github action which will publish the new version to npm.
|
package/dist/cjs/market.d.ts
CHANGED
|
@@ -11,15 +11,10 @@ export interface BaseMarket {
|
|
|
11
11
|
quoteAsset: Asset;
|
|
12
12
|
szDecimals: number;
|
|
13
13
|
priceDecimals?: number;
|
|
14
|
-
markPrice: string;
|
|
15
|
-
volume24h?: string;
|
|
16
|
-
prevDayPrice?: string;
|
|
17
14
|
}
|
|
18
15
|
export interface PerpsMarket extends BaseMarket {
|
|
19
16
|
maxLeverage: number;
|
|
20
17
|
onlyIsolated: boolean;
|
|
21
|
-
funding: FundingInfo;
|
|
22
|
-
openInterest?: string;
|
|
23
18
|
maintenanceMarginRate?: number;
|
|
24
19
|
}
|
|
25
20
|
export interface SpotMarket extends BaseMarket {
|
|
@@ -36,6 +31,11 @@ export interface MarketsResponse {
|
|
|
36
31
|
export interface MarketPrice {
|
|
37
32
|
marketId: string;
|
|
38
33
|
price: string;
|
|
34
|
+
markPrice: string;
|
|
35
|
+
prevDayPrice?: string;
|
|
36
|
+
volume24h?: string;
|
|
37
|
+
openInterest?: string;
|
|
38
|
+
funding?: FundingInfo;
|
|
39
39
|
}
|
|
40
40
|
export interface PricesResponse {
|
|
41
41
|
prices: MarketPrice[];
|
package/dist/cjs/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;AAGvC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAGD,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAElB,EAAE,EAAE,MAAM,CAAA;IAEV,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAOlB,aAAa,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAGvC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAGD,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAElB,EAAE,EAAE,MAAM,CAAA;IAEV,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAOlB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAGD,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IAMrB,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAGD,MAAM,WAAW,UAAW,SAAQ,UAAU;CAAG;AAGjD,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAG7C,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAChE,CAAA;AAQD,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAGD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAQD,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAGD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB;AAGD,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;AAGD,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;AAGD,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;AAGR,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAGD,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"}
|
package/dist/esm/market.d.ts
CHANGED
|
@@ -21,16 +21,11 @@ export interface BaseMarket {
|
|
|
21
21
|
* `formatOrderPrice` rather than applying this field directly.
|
|
22
22
|
*/
|
|
23
23
|
priceDecimals?: number;
|
|
24
|
-
markPrice: string;
|
|
25
|
-
volume24h?: string;
|
|
26
|
-
prevDayPrice?: string;
|
|
27
24
|
}
|
|
28
25
|
/** @public */
|
|
29
26
|
export interface PerpsMarket extends BaseMarket {
|
|
30
27
|
maxLeverage: number;
|
|
31
28
|
onlyIsolated: boolean;
|
|
32
|
-
funding: FundingInfo;
|
|
33
|
-
openInterest?: string;
|
|
34
29
|
/**
|
|
35
30
|
* Venue maintenance margin rate for this market as a fraction (e.g. `0.012`
|
|
36
31
|
* = 1.2%). Feeds client-side liquidation-price estimates via the provider's
|
|
@@ -59,10 +54,20 @@ export interface MarketRef {
|
|
|
59
54
|
export interface MarketsResponse {
|
|
60
55
|
markets: Market[];
|
|
61
56
|
}
|
|
62
|
-
/**
|
|
57
|
+
/**
|
|
58
|
+
* Live per-market data for the `/prices` endpoint. `price` is the mid;
|
|
59
|
+
* `markPrice`, `prevDayPrice` and `volume24h` apply to every market type,
|
|
60
|
+
* while `openInterest` and `funding` are perp-only and absent for spot.
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
63
|
export interface MarketPrice {
|
|
64
64
|
marketId: string;
|
|
65
65
|
price: string;
|
|
66
|
+
markPrice: string;
|
|
67
|
+
prevDayPrice?: string;
|
|
68
|
+
volume24h?: string;
|
|
69
|
+
openInterest?: string;
|
|
70
|
+
funding?: FundingInfo;
|
|
66
71
|
}
|
|
67
72
|
/** @public */
|
|
68
73
|
export interface PricesResponse {
|
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;AAEvC,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED,cAAc;AACd,MAAM,WAAW,UAAW,SAAQ,UAAU;CAAG;AAEjD,cAAc;AACd,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAChE,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB;AAED,cAAc;AACd,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,cAAc;AACd,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,cAAc;AACd,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,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,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"}
|
package/dist/types/market.d.ts
CHANGED
|
@@ -21,16 +21,11 @@ export interface BaseMarket {
|
|
|
21
21
|
* `formatOrderPrice` rather than applying this field directly.
|
|
22
22
|
*/
|
|
23
23
|
priceDecimals?: number;
|
|
24
|
-
markPrice: string;
|
|
25
|
-
volume24h?: string;
|
|
26
|
-
prevDayPrice?: string;
|
|
27
24
|
}
|
|
28
25
|
/** @public */
|
|
29
26
|
export interface PerpsMarket extends BaseMarket {
|
|
30
27
|
maxLeverage: number;
|
|
31
28
|
onlyIsolated: boolean;
|
|
32
|
-
funding: FundingInfo;
|
|
33
|
-
openInterest?: string;
|
|
34
29
|
/**
|
|
35
30
|
* Venue maintenance margin rate for this market as a fraction (e.g. `0.012`
|
|
36
31
|
* = 1.2%). Feeds client-side liquidation-price estimates via the provider's
|
|
@@ -59,10 +54,20 @@ export interface MarketRef {
|
|
|
59
54
|
export interface MarketsResponse {
|
|
60
55
|
markets: Market[];
|
|
61
56
|
}
|
|
62
|
-
/**
|
|
57
|
+
/**
|
|
58
|
+
* Live per-market data for the `/prices` endpoint. `price` is the mid;
|
|
59
|
+
* `markPrice`, `prevDayPrice` and `volume24h` apply to every market type,
|
|
60
|
+
* while `openInterest` and `funding` are perp-only and absent for spot.
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
63
|
export interface MarketPrice {
|
|
64
64
|
marketId: string;
|
|
65
65
|
price: string;
|
|
66
|
+
markPrice: string;
|
|
67
|
+
prevDayPrice?: string;
|
|
68
|
+
volume24h?: string;
|
|
69
|
+
openInterest?: string;
|
|
70
|
+
funding?: FundingInfo;
|
|
66
71
|
}
|
|
67
72
|
/** @public */
|
|
68
73
|
export interface PricesResponse {
|
|
@@ -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;AAEvC,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,cAAc;AACd,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,cAAc;AACd,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED,cAAc;AACd,MAAM,WAAW,UAAW,SAAQ,UAAU;CAAG;AAEjD,cAAc;AACd,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAChE,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB;AAED,cAAc;AACd,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,cAAc;AACd,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,cAAc;AACd,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,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,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"}
|
package/package.json
CHANGED
package/src/market.ts
CHANGED
|
@@ -23,17 +23,12 @@ export interface BaseMarket {
|
|
|
23
23
|
* `formatOrderPrice` rather than applying this field directly.
|
|
24
24
|
*/
|
|
25
25
|
priceDecimals?: number
|
|
26
|
-
markPrice: string
|
|
27
|
-
volume24h?: string
|
|
28
|
-
prevDayPrice?: string
|
|
29
26
|
}
|
|
30
27
|
|
|
31
28
|
/** @public */
|
|
32
29
|
export interface PerpsMarket extends BaseMarket {
|
|
33
30
|
maxLeverage: number
|
|
34
31
|
onlyIsolated: boolean
|
|
35
|
-
funding: FundingInfo
|
|
36
|
-
openInterest?: string
|
|
37
32
|
/**
|
|
38
33
|
* Venue maintenance margin rate for this market as a fraction (e.g. `0.012`
|
|
39
34
|
* = 1.2%). Feeds client-side liquidation-price estimates via the provider's
|
|
@@ -70,10 +65,20 @@ export interface MarketsResponse {
|
|
|
70
65
|
markets: Market[]
|
|
71
66
|
}
|
|
72
67
|
|
|
73
|
-
/**
|
|
68
|
+
/**
|
|
69
|
+
* Live per-market data for the `/prices` endpoint. `price` is the mid;
|
|
70
|
+
* `markPrice`, `prevDayPrice` and `volume24h` apply to every market type,
|
|
71
|
+
* while `openInterest` and `funding` are perp-only and absent for spot.
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
74
|
export interface MarketPrice {
|
|
75
75
|
marketId: string
|
|
76
76
|
price: string
|
|
77
|
+
markPrice: string
|
|
78
|
+
prevDayPrice?: string
|
|
79
|
+
volume24h?: string
|
|
80
|
+
openInterest?: string
|
|
81
|
+
funding?: FundingInfo
|
|
77
82
|
}
|
|
78
83
|
|
|
79
84
|
/** @public */
|