@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.
Files changed (82) hide show
  1. package/dist/cjs/account.d.ts +11 -2
  2. package/dist/cjs/account.d.ts.map +1 -1
  3. package/dist/cjs/action.d.ts +1 -0
  4. package/dist/cjs/action.d.ts.map +1 -1
  5. package/dist/cjs/asset.d.ts.map +1 -1
  6. package/dist/cjs/enums.d.ts +5 -0
  7. package/dist/cjs/enums.d.ts.map +1 -1
  8. package/dist/cjs/enums.js +7 -1
  9. package/dist/cjs/enums.js.map +1 -1
  10. package/dist/cjs/errors.d.ts.map +1 -1
  11. package/dist/cjs/market.d.ts +4 -0
  12. package/dist/cjs/market.d.ts.map +1 -1
  13. package/dist/cjs/primitives.d.ts.map +1 -1
  14. package/dist/cjs/providers.d.ts.map +1 -1
  15. package/dist/cjs/subscriptions.d.ts.map +1 -1
  16. package/dist/cjs/typedData.d.ts.map +1 -1
  17. package/dist/cjs/vote.d.ts.map +1 -1
  18. package/dist/cjs/vote.js.map +1 -1
  19. package/dist/esm/account.d.ts +223 -32
  20. package/dist/esm/account.d.ts.map +1 -1
  21. package/dist/esm/action.d.ts +205 -37
  22. package/dist/esm/action.d.ts.map +1 -1
  23. package/dist/esm/asset.d.ts +1 -4
  24. package/dist/esm/asset.d.ts.map +1 -1
  25. package/dist/esm/enums.d.ts +43 -20
  26. package/dist/esm/enums.d.ts.map +1 -1
  27. package/dist/esm/enums.js +43 -19
  28. package/dist/esm/enums.js.map +1 -1
  29. package/dist/esm/errors.d.ts +6 -1
  30. package/dist/esm/errors.d.ts.map +1 -1
  31. package/dist/esm/market.d.ts +57 -15
  32. package/dist/esm/market.d.ts.map +1 -1
  33. package/dist/esm/primitives.d.ts +12 -2
  34. package/dist/esm/primitives.d.ts.map +1 -1
  35. package/dist/esm/providers.d.ts +19 -6
  36. package/dist/esm/providers.d.ts.map +1 -1
  37. package/dist/esm/quote.d.ts +2 -2
  38. package/dist/esm/quote.d.ts.map +1 -1
  39. package/dist/esm/subscriptions.d.ts +27 -19
  40. package/dist/esm/subscriptions.d.ts.map +1 -1
  41. package/dist/esm/typedData.d.ts +15 -5
  42. package/dist/esm/typedData.d.ts.map +1 -1
  43. package/dist/esm/vote.d.ts +1 -3
  44. package/dist/esm/vote.d.ts.map +1 -1
  45. package/dist/esm/vote.js.map +1 -1
  46. package/dist/types/account.d.ts +223 -32
  47. package/dist/types/account.d.ts.map +1 -1
  48. package/dist/types/action.d.ts +205 -37
  49. package/dist/types/action.d.ts.map +1 -1
  50. package/dist/types/asset.d.ts +1 -4
  51. package/dist/types/asset.d.ts.map +1 -1
  52. package/dist/types/enums.d.ts +43 -20
  53. package/dist/types/enums.d.ts.map +1 -1
  54. package/dist/types/errors.d.ts +6 -1
  55. package/dist/types/errors.d.ts.map +1 -1
  56. package/dist/types/market.d.ts +57 -15
  57. package/dist/types/market.d.ts.map +1 -1
  58. package/dist/types/primitives.d.ts +12 -2
  59. package/dist/types/primitives.d.ts.map +1 -1
  60. package/dist/types/providers.d.ts +19 -6
  61. package/dist/types/providers.d.ts.map +1 -1
  62. package/dist/types/quote.d.ts +2 -2
  63. package/dist/types/quote.d.ts.map +1 -1
  64. package/dist/types/subscriptions.d.ts +27 -19
  65. package/dist/types/subscriptions.d.ts.map +1 -1
  66. package/dist/types/typedData.d.ts +15 -5
  67. package/dist/types/typedData.d.ts.map +1 -1
  68. package/dist/types/vote.d.ts +1 -3
  69. package/dist/types/vote.d.ts.map +1 -1
  70. package/package.json +1 -1
  71. package/src/account.ts +225 -37
  72. package/src/action.ts +205 -37
  73. package/src/asset.ts +1 -4
  74. package/src/enums.ts +44 -20
  75. package/src/errors.ts +6 -1
  76. package/src/market.ts +69 -16
  77. package/src/primitives.ts +12 -2
  78. package/src/providers.ts +19 -6
  79. package/src/quote.ts +2 -2
  80. package/src/subscriptions.ts +27 -19
  81. package/src/typedData.ts +15 -5
  82. package/src/vote.ts +1 -3
@@ -1 +1 @@
1
- {"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/enums.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,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,cAAc;AACd,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,cAAc;AACd,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,cAAc;AACd,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,cAAc;AACd,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,cAAc;AACd,oBAAY,WAAW;IACrB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,SAAS,cAAc;IACvB,GAAG,QAAQ;CACZ;AAED,cAAc;AACd,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,cAAc;AACd,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,cAAc;AACd,oBAAY,aAAa;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,cAAc;AACd,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,cAAc;AACd,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,cAAc;AACd,oBAAY,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACxB;AAED,cAAc;AACd,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,SAAS,cAAc;CACxB;AAED,cAAc;AACd,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED,cAAc;AACd,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,cAAc;AACd,oBAAY,yBAAyB;IACnC,UAAU,eAAe;CAC1B;AAED,cAAc;AACd,oBAAY,qBAAqB;IAC/B,OAAO,YAAY;CACpB;AAED,cAAc;AACd,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED,cAAc;AACd,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,cAAc;AACd,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"}
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"}
@@ -1,5 +1,10 @@
1
1
  import type { PerpsErrorCode } from './enums.js';
2
- /** @public */
2
+ /**
3
+ * Structured perps API error payload. `code` is the stable classification;
4
+ * `tool` identifies the backend tool when the provider supplies one.
5
+ *
6
+ * @public
7
+ */
3
8
  export interface PerpsErrorBody {
4
9
  code: PerpsErrorCode;
5
10
  tool?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB"}
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"}
@@ -1,20 +1,32 @@
1
1
  import type { Asset } from './asset.js';
2
- /** @public */
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
- /** @public */
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
- /** @public */
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
- /** @public */
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
- /** @public */
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
- /** @public */
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
- /** @public */
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;
@@ -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,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,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;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;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,GAAG,YAAY,CAC/E,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;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,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,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;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;AAED,cAAc;AACd,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
1
+ {"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,mDAAmD;IACnD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,wBAAwB,EAAE,wBAAwB,CAAA;IAClD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAA;CACjC;AAED,kEAAkE;AAClE,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAC/E,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,WAAW,EACT,YAAY,GACZ,IAAI,GACJ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAA;AAER,sFAAsF;AACtF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0FAA0F;AAC1F,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,sFAAsF;AACtF,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
@@ -1,5 +1,15 @@
1
- /** @public */
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
- /** @public */
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,cAAc;AACd,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC,cAAc;AACd,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAA"}
1
+ {"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../src/primitives.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAA"}
@@ -1,12 +1,16 @@
1
1
  import type { Asset, DepositAsset } from './asset.js';
2
2
  import type { ActionType, PerpsSigner, SigningMethod } from './enums.js';
3
3
  import type { OhlcvInterval } from './market.js';
4
- /** @public */
4
+ /** A fixed option value presented for a provider action parameter. @public */
5
5
  export interface ParamOption {
6
6
  value: string;
7
7
  label: string;
8
8
  }
9
- /** @public */
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
- /** @public */
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
- /** @public */
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,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED,cAAc;AACd,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,cAAc;AACd,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,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED,cAAc;AACd,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,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
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"}
@@ -1,8 +1,8 @@
1
1
  import type { FeeTier } from './account.js';
2
2
  import type { FundingInfo } from './market.js';
3
- /** @public */
3
+ /** Side of the quoted market order, using lowercase wire values. @public */
4
4
  export type QuoteSide = 'buy' | 'sell';
5
- /** @public */
5
+ /** Trade instrument kind represented by the quote. @public */
6
6
  export type TradeType = 'perps' | 'spot';
7
7
  /**
8
8
  * One-shot fill estimate for a market order of `sizeUsd` notional on a single
@@ -1 +1 @@
1
- {"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/quote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,cAAc;AACd,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;AAEtC,cAAc;AACd,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,oGAAoG;IACpG,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,iBAAiB,EAAE,MAAM,CAAA;IACzB,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAA;IAChB,uFAAuF;IACvF,gBAAgB,EAAE,OAAO,CAAA;IACzB,iFAAiF;IACjF,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;IAC3B,4GAA4G;IAC5G,qBAAqB,EAAE,OAAO,CAAA;IAC9B,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAA;CAClB"}
1
+ {"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/quote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,4EAA4E;AAC5E,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;AAEtC,8DAA8D;AAC9D,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,oGAAoG;IACpG,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,iBAAiB,EAAE,MAAM,CAAA;IACzB,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAA;IAChB,uFAAuF;IACvF,gBAAgB,EAAE,OAAO,CAAA;IACzB,iFAAiF;IACjF,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;IAC3B,4GAA4G;IAC5G,qBAAqB,EAAE,OAAO,CAAA;IAC9B,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAA;CAClB"}
@@ -1,18 +1,18 @@
1
1
  import type { AccountSummary, Balance, Fill, OpenOrder, Position, TriggerOrder } from './account.js';
2
2
  import type { Candle, MarketContext, OhlcvInterval, OrderbookResponse, Trade } from './market.js';
3
3
  import type { Address } from './primitives.js';
4
- /** @public */
4
+ /** Subscription for the provider's aggregate market-context stream. @public */
5
5
  export type MarketsContextSubscription = {
6
6
  channel: 'marketsContext';
7
7
  dex: string;
8
8
  };
9
- /** @public */
9
+ /** Subscription for one market's live context stream. @public */
10
10
  export type MarketContextSubscription = {
11
11
  channel: 'marketContext';
12
12
  dex: string;
13
13
  marketId: string;
14
14
  };
15
- /** @public */
15
+ /** Subscription for streamed order-book updates for one market. @public */
16
16
  export type OrderbookSubscription = {
17
17
  channel: 'orderbook';
18
18
  dex: string;
@@ -26,77 +26,81 @@ export type OrderbookSubscription = {
26
26
  */
27
27
  priceStep?: number;
28
28
  };
29
- /** @public */
29
+ /** Subscription for OHLCV candle updates for one market and interval. @public */
30
30
  export type CandleSubscription = {
31
31
  channel: 'candle';
32
32
  dex: string;
33
33
  marketId: string;
34
34
  interval: OhlcvInterval;
35
35
  };
36
- /** @public */
36
+ /** Subscription for recent trade updates for one market. @public */
37
37
  export type TradesSubscription = {
38
38
  channel: 'trades';
39
39
  dex: string;
40
40
  marketId: string;
41
41
  };
42
- /** @public */
42
+ /** Subscription for order lifecycle updates for one account. @public */
43
43
  export type OrderUpdatesSubscription = {
44
44
  channel: 'orderUpdates';
45
45
  dex: string;
46
46
  address: Address;
47
47
  };
48
- /** @public */
48
+ /** Subscription for execution/fill updates for one account. @public */
49
49
  export type FillsSubscription = {
50
50
  channel: 'fills';
51
51
  dex: string;
52
52
  address: Address;
53
53
  };
54
- /** @public */
54
+ /** Subscription for the full open-position set for one account. @public */
55
55
  export type PositionsSubscription = {
56
56
  channel: 'positions';
57
57
  dex: string;
58
58
  address: Address;
59
59
  };
60
- /** @public */
60
+ /** Subscription for spot-balance updates for one account. @public */
61
61
  export type SpotBalancesSubscription = {
62
62
  channel: 'spotBalances';
63
63
  dex: string;
64
64
  address: Address;
65
65
  };
66
- /** @public */
66
+ /** Subscription for aggregate account-summary updates for one account. @public */
67
67
  export type AccountSummarySubscription = {
68
68
  channel: 'accountSummary';
69
69
  dex: string;
70
70
  address: Address;
71
71
  };
72
- /** @public */
72
+ /**
73
+ * Union of all websocket subscription request shapes.
74
+ *
75
+ * @public
76
+ */
73
77
  export type Subscription = MarketsContextSubscription | MarketContextSubscription | OrderbookSubscription | CandleSubscription | TradesSubscription | OrderUpdatesSubscription | FillsSubscription | PositionsSubscription | SpotBalancesSubscription | AccountSummarySubscription;
74
- /** @public */
78
+ /** Event containing the provider's aggregate market contexts. @public */
75
79
  export type MarketsContextEvent = {
76
80
  channel: 'marketsContext';
77
81
  data: Record<string, MarketContext>;
78
82
  };
79
- /** @public */
83
+ /** Event containing one market's live context. @public */
80
84
  export type MarketContextEvent = {
81
85
  channel: 'marketContext';
82
86
  data: MarketContext;
83
87
  };
84
- /** @public */
88
+ /** Event containing an order-book snapshot or update. @public */
85
89
  export type OrderbookEvent = {
86
90
  channel: 'orderbook';
87
91
  data: OrderbookResponse;
88
92
  };
89
- /** @public */
93
+ /** Event containing one OHLCV candle. @public */
90
94
  export type CandleEvent = {
91
95
  channel: 'candle';
92
96
  data: Candle;
93
97
  };
94
- /** @public */
98
+ /** Event containing recent trades. @public */
95
99
  export type TradesEvent = {
96
100
  channel: 'trades';
97
101
  data: Trade[];
98
102
  };
99
- /** @public */
103
+ /** Event containing order upserts and terminal order ids. @public */
100
104
  export type OrderUpdatesEvent = {
101
105
  channel: 'orderUpdates';
102
106
  data: {
@@ -111,7 +115,7 @@ export type OrderUpdatesEvent = {
111
115
  terminated: string[];
112
116
  };
113
117
  };
114
- /** @public */
118
+ /** Event containing newly observed executions/fills. @public */
115
119
  export type FillsEvent = {
116
120
  channel: 'fills';
117
121
  data: Fill[];
@@ -148,6 +152,10 @@ export type AccountSummaryEvent = {
148
152
  channel: 'accountSummary';
149
153
  data: AccountSummary;
150
154
  };
151
- /** @public */
155
+ /**
156
+ * Union of all websocket event frame shapes emitted for subscriptions.
157
+ *
158
+ * @public
159
+ */
152
160
  export type SubscriptionEvent = MarketsContextEvent | MarketContextEvent | OrderbookEvent | CandleEvent | TradesEvent | OrderUpdatesEvent | FillsEvent | PositionsEvent | SpotBalancesEvent | AccountSummaryEvent;
153
161
  //# sourceMappingURL=subscriptions.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,YAAY,EACb,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,cAAc;AACd,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,cAAc;AACd,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;AAE9B,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AACD,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AACD,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAC9E,cAAc;AACd,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC7D,cAAc;AACd,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAC9D,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,4CAA4C;QAC5C,UAAU,EAAE,SAAS,EAAE,CAAA;QACvB,8DAA8D;QAC9D,aAAa,EAAE,YAAY,EAAE,CAAA;QAC7B;;;WAGG;QACH,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AACD,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAC3D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AACvE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,CAAA"}
1
+ {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,YAAY,EACb,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACN,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,eAAe,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AACD,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,uEAAuE;AACvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,2EAA2E;AAC3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,cAAc,CAAA;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AACD,kFAAkF;AAClF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,gBAAgB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,0BAA0B,GAC1B,yBAAyB,GACzB,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,CAAA;AAE9B,yEAAyE;AACzE,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACpC,CAAA;AACD,0DAA0D;AAC1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AACD,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAA;AAC9E,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC7D,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,KAAK,EAAE,CAAA;CAAE,CAAA;AAC9D,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE;QACJ,4CAA4C;QAC5C,UAAU,EAAE,SAAS,EAAE,CAAA;QACvB,8DAA8D;QAC9D,aAAa,EAAE,YAAY,EAAE,CAAA;QAC7B;;;WAGG;QACH,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;CACF,CAAA;AACD,gEAAgE;AAChE,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AAC3D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AACvE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,CAAC,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,mBAAmB,CAAA"}
@@ -1,5 +1,10 @@
1
1
  import type { Address, Hex } from './primitives.js';
2
- /** @public */
2
+ /**
3
+ * EIP-712 domain fields used to identify a signing domain. `chainId` is the
4
+ * numeric EVM chain id when present.
5
+ *
6
+ * @public
7
+ */
3
8
  export interface TypedDataDomain {
4
9
  name?: string;
5
10
  version?: string;
@@ -7,21 +12,26 @@ export interface TypedDataDomain {
7
12
  verifyingContract?: Address;
8
13
  salt?: Hex;
9
14
  }
10
- /** @public */
15
+ /** One named field in an EIP-712 primary type definition. @public */
11
16
  export interface TypedDataParameter {
12
17
  name: string;
13
18
  type: string;
14
19
  }
15
- /** @public */
20
+ /** Primary-type name used by a perps EIP-712 payload. @public */
16
21
  export type PerpsPrimaryType = string;
17
- /** @public */
22
+ /**
23
+ * Provider-neutral EIP-712 payload passed between backend and SDK. `message`
24
+ * intentionally remains open because each action defines its own fields.
25
+ *
26
+ * @public
27
+ */
18
28
  export type PerpsTypedData = {
19
29
  domain: TypedDataDomain;
20
30
  types: Record<string, readonly TypedDataParameter[]>;
21
31
  primaryType: PerpsPrimaryType;
22
32
  message: Record<string, any>;
23
33
  };
24
- /** @public */
34
+ /** EIP-712 payload accompanied by its client-produced signature. @public */
25
35
  export type PerpsSignedTypedData = PerpsTypedData & {
26
36
  signature: Hex;
27
37
  };
@@ -1 +1 @@
1
- {"version":3,"file":"typedData.d.ts","sourceRoot":"","sources":["../../src/typedData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAEnD,cAAc;AACd,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,IAAI,CAAC,EAAE,GAAG,CAAA;CACX;AAED,cAAc;AACd,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb;AAED,cAAc;AACd,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAA;AAErC,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,kBAAkB,EAAE,CAAC,CAAA;IACpD,WAAW,EAAE,gBAAgB,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED,cAAc;AACd,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,SAAS,EAAE,GAAG,CAAA;CACf,CAAA"}
1
+ {"version":3,"file":"typedData.d.ts","sourceRoot":"","sources":["../../src/typedData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAEnD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,IAAI,CAAC,EAAE,GAAG,CAAA;CACX;AAED,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb;AAED,iEAAiE;AACjE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAA;AAErC;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,kBAAkB,EAAE,CAAC,CAAA;IACpD,WAAW,EAAE,gBAAgB,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,SAAS,EAAE,GAAG,CAAA;CACf,CAAA"}
@@ -7,7 +7,7 @@ import type { PerpsTypedData, TypedDataParameter } from './typedData.js';
7
7
  * @public
8
8
  */
9
9
  export declare const META_PROVIDER = "meta";
10
- /** @public */
10
+ /** Type alias for the {@link META_PROVIDER} provider-independent sentinel. @public */
11
11
  export type MetaProvider = typeof META_PROVIDER;
12
12
  /**
13
13
  * Vote direction. `up` endorses the subject; `down` opposes it.
@@ -29,7 +29,6 @@ export type VoteType = 'provider';
29
29
  * @public
30
30
  */
31
31
  export interface VoteParams {
32
- /** Key of the inactive provider being voted on (the voted-on subject). */
33
32
  targetProvider: string;
34
33
  direction: VoteDirection;
35
34
  voteType: VoteType;
@@ -39,7 +38,6 @@ export interface VoteParams {
39
38
  * @public
40
39
  */
41
40
  export interface VoteMessage {
42
- /** Key of the inactive provider being voted on. */
43
41
  targetProvider: string;
44
42
  direction: VoteDirection;
45
43
  voteType: VoteType;
@@ -1 +1 @@
1
- {"version":3,"file":"vote.d.ts","sourceRoot":"","sources":["../../src/vote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAS,CAAA;AAEnC,cAAc;AACd,MAAM,MAAM,YAAY,GAAG,OAAO,aAAa,CAAA;AAE/C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,MAAM,CAAA;AAEzC;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAA;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS,kBAAkB,EAMvD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,kBAAkB,EAAE,CAAA;KAAE,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACxE,OAAO,EAAE,WAAW,CAAA;CACrB"}
1
+ {"version":3,"file":"vote.d.ts","sourceRoot":"","sources":["../../src/vote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAS,CAAA;AAEnC,sFAAsF;AACtF,MAAM,MAAM,YAAY,GAAG,OAAO,aAAa,CAAA;AAE/C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,MAAM,CAAA;AAEzC;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAA;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS,kBAAkB,EAMvD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,kBAAkB,EAAE,CAAA;KAAE,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACxE,OAAO,EAAE,WAAW,CAAA;CACrB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lifi/perps-types",
3
- "version": "3.3.2",
3
+ "version": "4.0.1",
4
4
  "description": "Shared types for the LI.FI perps stack",
5
5
  "keywords": [
6
6
  "lifi",