@lifi/perps-sdk 17.0.0 → 17.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -117,8 +117,10 @@ displays read the account-scoped figure.
117
117
 
118
118
  Providers that publish a per-market figure answer it directly. Hyperliquid
119
119
  reads it from `activeAssetData`, and also streams it on the `availableToTrade`
120
- WebSocket channel. For every other provider the client falls back to the
121
- account summary, so `buy` and `sell` both equal `availableMargin`.
120
+ WebSocket channel. Ondo reads it from `/v1/perps/max_order_size` over REST
121
+ only, and needs a session. Without an Ondo session, and for every other
122
+ provider, the client falls back to the account summary, so `buy` and `sell`
123
+ both equal `availableMargin`.
122
124
 
123
125
  ```ts
124
126
  const availableToTrade = await client.getAvailableToTrade({
@@ -1,3 +1,3 @@
1
1
  export declare const name = "@lifi/perps-sdk";
2
- export declare const version = "17.0.0";
2
+ export declare const version = "17.0.1";
3
3
  //# sourceMappingURL=version.d.ts.map
@@ -2,5 +2,5 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = exports.name = void 0;
4
4
  exports.name = '@lifi/perps-sdk';
5
- exports.version = '17.0.0';
5
+ exports.version = '17.0.1';
6
6
  //# sourceMappingURL=version.js.map
@@ -374,10 +374,10 @@ export interface PerpsProviderPlugin {
374
374
  /**
375
375
  * The amounts the account can still buy and sell on one market, in that
376
376
  * market's margin asset. Optional because venues expose this unevenly:
377
- * Hyperliquid reads it directly (`activeAssetData`), other venues publish
378
- * only an account-scoped figure. `undefined` means the venue has nothing
379
- * to read for this market, and the caller falls back to the account
380
- * summary.
377
+ * Hyperliquid (`activeAssetData`) and Ondo (`max_order_size`) read it
378
+ * directly, other venues publish only an account-scoped figure. `undefined`
379
+ * means the venue has nothing to read for this market, and the caller falls
380
+ * back to the account summary.
381
381
  */
382
382
  getAvailableToTrade?(params: ProviderGetAvailableToTradeParams, options?: SDKRequestOptions): Promise<AvailableToTrade | undefined>;
383
383
  getOrders(params: ProviderGetOrdersParams, options?: SDKRequestOptions): Promise<OrdersResponse>;
@@ -9,5 +9,5 @@ export declare const name = "@lifi/perps-sdk";
9
9
  *
10
10
  * @public
11
11
  */
12
- export declare const version = "17.0.0";
12
+ export declare const version = "17.0.1";
13
13
  //# sourceMappingURL=version.d.ts.map
@@ -9,5 +9,5 @@ export const name = '@lifi/perps-sdk';
9
9
  *
10
10
  * @public
11
11
  */
12
- export const version = '17.0.0';
12
+ export const version = '17.0.1';
13
13
  //# sourceMappingURL=version.js.map
@@ -374,10 +374,10 @@ export interface PerpsProviderPlugin {
374
374
  /**
375
375
  * The amounts the account can still buy and sell on one market, in that
376
376
  * market's margin asset. Optional because venues expose this unevenly:
377
- * Hyperliquid reads it directly (`activeAssetData`), other venues publish
378
- * only an account-scoped figure. `undefined` means the venue has nothing
379
- * to read for this market, and the caller falls back to the account
380
- * summary.
377
+ * Hyperliquid (`activeAssetData`) and Ondo (`max_order_size`) read it
378
+ * directly, other venues publish only an account-scoped figure. `undefined`
379
+ * means the venue has nothing to read for this market, and the caller falls
380
+ * back to the account summary.
381
381
  */
382
382
  getAvailableToTrade?(params: ProviderGetAvailableToTradeParams, options?: SDKRequestOptions): Promise<AvailableToTrade | undefined>;
383
383
  getOrders(params: ProviderGetOrdersParams, options?: SDKRequestOptions): Promise<OrdersResponse>;
@@ -9,5 +9,5 @@ export declare const name = "@lifi/perps-sdk";
9
9
  *
10
10
  * @public
11
11
  */
12
- export declare const version = "17.0.0";
12
+ export declare const version = "17.0.1";
13
13
  //# sourceMappingURL=version.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lifi/perps-sdk",
3
- "version": "17.0.0",
3
+ "version": "17.0.1",
4
4
  "description": "LI.FI Perps SDK for perpetuals trading",
5
5
  "homepage": "https://github.com/lifinance/perps-sdk",
6
6
  "bugs": {
@@ -456,10 +456,10 @@ export interface PerpsProviderPlugin {
456
456
  /**
457
457
  * The amounts the account can still buy and sell on one market, in that
458
458
  * market's margin asset. Optional because venues expose this unevenly:
459
- * Hyperliquid reads it directly (`activeAssetData`), other venues publish
460
- * only an account-scoped figure. `undefined` means the venue has nothing
461
- * to read for this market, and the caller falls back to the account
462
- * summary.
459
+ * Hyperliquid (`activeAssetData`) and Ondo (`max_order_size`) read it
460
+ * directly, other venues publish only an account-scoped figure. `undefined`
461
+ * means the venue has nothing to read for this market, and the caller falls
462
+ * back to the account summary.
463
463
  */
464
464
  getAvailableToTrade?(
465
465
  params: ProviderGetAvailableToTradeParams,
package/src/version.ts CHANGED
@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
10
10
  *
11
11
  * @public
12
12
  */
13
- export const version = '17.0.0'
13
+ export const version = '17.0.1'