@lifi/perps-sdk 0.0.0-preview-bb1a973 → 0.0.0-preview-b49efcc

package/src/client/PerpsClient.ts

@@ -4,6 +4,7 @@ import type {
   ActionParamsMap,
   ActionResult,
   ActionStep,
+  AvailableToTrade,
   CreateActionResponse,
   ExecuteActionResponse,
   MarketRef,
@@ -28,7 +29,8 @@ import {
 import Big from 'big.js'
 import type { Address } from 'viem'
 import { PerpsError } from '../errors/PerpsError.js'
-import { getAssetRegistry } from '../registry/assetRegistry.js'
+import { getAssetRegistry, toAssetDisplay } from '../registry/assetRegistry.js'
+import { getMarketRegistry } from '../registry/marketRegistry.js'
 import { createAction } from '../services/createAction.js'
 import { executeAction } from '../services/executeAction.js'
 import { getAccount as fetchAccount } from '../services/getAccount.js'
@@ -498,6 +500,58 @@ export class PerpsClient {
     })
   }
 
+  /**
+   * The amounts `params.address` can still buy and sell on one market, in
+   * that market's margin asset. The order panel reads this per-market figure;
+   * account displays read the account-scoped
+   * {@link AccountSummary.availableMargin} instead.
+   *
+   * Providers that read a per-market figure answer it directly. For every
+   * other provider this falls back to the account summary, so both sides
+   * equal `availableMargin` and the asset is the market's quote asset.
+   *
+   * @throws {PerpsError} When the provider plugin is not registered, or the
+   *   market is unknown to the provider's market registry.
+   * @public
+   */
+  async getAvailableToTrade(
+    params: {
+      provider: string
+      address: Address
+      marketId: string
+    },
+    options?: SDKRequestOptions
+  ): Promise<AvailableToTrade> {
+    const plugin = this.requireProvider(params.provider)
+    const perMarket = await plugin.getAvailableToTrade?.(
+      { address: params.address, marketId: params.marketId },
+      options
+    )
+    if (perMarket !== undefined) {
+      return perMarket
+    }
+
+    const registry = getMarketRegistry(this.sdkClient, params.provider)
+    await registry.sync()
+    const market = registry.require(params.marketId)
+    const account = await fetchAccount(
+      this.sdkClient,
+      { provider: params.provider, address: params.address },
+      options
+    )
+    const { availableMargin } = plugin.getAccountSummary(
+      account,
+      account.positions
+    )
+    return {
+      providerId: market.providerId,
+      marketId: market.id,
+      asset: toAssetDisplay(market.quoteAsset),
+      buy: availableMargin,
+      sell: availableMargin,
+    }
+  }
+
   /**
    * Resolve the exact venue-owned margin requirements for `position`.
    * Returns `undefined` when the position has no individual margin adjustment.

package/src/index.ts

@@ -19,7 +19,11 @@ export { PerpsClient } from './client/PerpsClient.js'
 export { PerpsErrorMessage } from './errors/constants.js'
 export { PerpsError } from './errors/PerpsError.js'
 // Registries
-export { AssetRegistry, getAssetRegistry } from './registry/assetRegistry.js'
+export {
+  AssetRegistry,
+  getAssetRegistry,
+  toAssetDisplay,
+} from './registry/assetRegistry.js'
 export type { DefaultMarketProvider } from './registry/marketRegistry.js'
 export {
   DEFAULT_MARKET_ID,
@@ -152,6 +156,7 @@ export type {
   ProviderAccountExistsParams,
   ProviderGetAccountParams,
   ProviderGetActivityParams,
+  ProviderGetAvailableToTradeParams,
   ProviderGetDepositFlowParams,
   ProviderGetFillsParams,
   ProviderGetMarketSettingsParams,

package/src/registry/assetRegistry.ts

@@ -1,4 +1,4 @@
-import type { Asset, AssetsResponse } from '@lifi/perps-types'
+import type { Asset, AssetDisplay, AssetsResponse } from '@lifi/perps-types'
 import { PerpsErrorCode } from '@lifi/perps-types'
 import { PerpsError } from '../errors/PerpsError.js'
 import { buildUrl, request } from '../transport/request.js'
@@ -59,6 +59,21 @@ export class AssetRegistry extends ReferenceDataRegistry<Asset> {
   }
 }
 
+/**
+ * Project an {@link Asset} to the identity and labels a display needs.
+ *
+ * @public
+ */
+export const toAssetDisplay = (asset: Asset): AssetDisplay => ({
+  providerId: asset.providerId,
+  id: asset.id,
+  displaySymbol: asset.displaySymbol,
+  logoURI: asset.logoURI,
+  ...(asset.displayName === undefined
+    ? {}
+    : { displayName: asset.displayName }),
+})
+
 const registries = new WeakMap<PerpsSDKClient, Map<string, AssetRegistry>>()
 
 /**

package/src/types/provider.ts

@@ -8,6 +8,7 @@ import type {
   ActionType,
   ActivitiesResponse,
   ActivityType,
+  AvailableToTrade,
   FillsResponse,
   Market,
   MarketRef,
@@ -216,6 +217,17 @@ export interface ProviderGetMarketSettingsParams {
   market: MarketRef
 }
 
+/**
+ * Read params for {@link PerpsProviderPlugin.getAvailableToTrade}.
+ *
+ * @public
+ */
+export interface ProviderGetAvailableToTradeParams {
+  address: Address
+  /** The market's opaque `Market.id` (not a display symbol). */
+  marketId: string
+}
+
 /**
  * Read params for {@link PerpsProvider.getOrders}.
  *
@@ -442,6 +454,19 @@ export interface PerpsProviderPlugin {
     options?: SDKRequestOptions
   ): Promise<MarketSettings | undefined>
 
+  /**
+   * The amounts the account can still buy and sell on one market, in that
+   * market's margin asset. Optional because venues expose this unevenly:
+   * Hyperliquid reads it directly (`activeAssetData`), other venues publish
+   * only an account-scoped figure. `undefined` means the venue has nothing
+   * to read for this market, and the caller falls back to the account
+   * summary.
+   */
+  getAvailableToTrade?(
+    params: ProviderGetAvailableToTradeParams,
+    options?: SDKRequestOptions
+  ): Promise<AvailableToTrade | undefined>
+
   getOrders(
     params: ProviderGetOrdersParams,
     options?: SDKRequestOptions

package/src/version.ts

@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
  *
  * @public
  */
-export const version = '0.0.0-preview-bb1a973'
+export const version = '0.0.0-preview-b49efcc'