@compass-labs/api-sdk 2.2.63-rc.0 → 2.2.64-rc.0

package/src/models/operations/v2tokenizedassetsmarketssymbol.ts

@@ -3,10 +3,32 @@
  */
 
 import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
 import * as components from "../components/index.js";
 
+/**
+ * The chain to use.
+ */
+export const V2TokenizedAssetsMarketsSymbolChain = {
+  Base: "base",
+  Ethereum: "ethereum",
+  Arbitrum: "arbitrum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * The chain to use.
+ */
+export type V2TokenizedAssetsMarketsSymbolChain = ClosedEnum<
+  typeof V2TokenizedAssetsMarketsSymbolChain
+>;
+
 export type V2TokenizedAssetsMarketsSymbolRequest = {
   symbol: string;
+  /**
+   * Network the market is deployed on (defaults to Ethereum). A token deployed on multiple chains (e.g. Midas RWA on Ethereum and Base) is resolved per chain; 404 if the symbol isn't deployed there. Ondo equities are Ethereum-only.
+   */
+  chain?: V2TokenizedAssetsMarketsSymbolChain | undefined;
   /**
    * Optional candle interval. Must be paired with `range` and form a valid `(interval, range)` pair to include OHLC candles in the response.
    */
@@ -17,9 +39,16 @@ export type V2TokenizedAssetsMarketsSymbolRequest = {
   range?: components.TokenizedAssetsOhlcRange | null | undefined;
 };
 
+/** @internal */
+export const V2TokenizedAssetsMarketsSymbolChain$outboundSchema:
+  z.ZodNativeEnum<typeof V2TokenizedAssetsMarketsSymbolChain> = z.nativeEnum(
+    V2TokenizedAssetsMarketsSymbolChain,
+  );
+
 /** @internal */
 export type V2TokenizedAssetsMarketsSymbolRequest$Outbound = {
   symbol: string;
+  chain?: string | undefined;
   interval?: string | null | undefined;
   range?: string | null | undefined;
 };
@@ -31,6 +60,7 @@ export const V2TokenizedAssetsMarketsSymbolRequest$outboundSchema: z.ZodType<
   V2TokenizedAssetsMarketsSymbolRequest
 > = z.object({
   symbol: z.string(),
+  chain: V2TokenizedAssetsMarketsSymbolChain$outboundSchema.optional(),
   interval: z.nullable(components.TokenizedAssetsOhlcInterval$outboundSchema)
     .optional(),
   range: z.nullable(components.TokenizedAssetsOhlcRange$outboundSchema)

package/src/sdk/tokenizedassets.ts

@@ -26,13 +26,16 @@ export class TokenizedAssets extends ClientSDK {
    * @remarks
    * List tokenized asset markets: Ondo equities and Midas RWA yield tokens.
    *
-   * Each entry includes the symbol, the underlying ticker, the on-chain
-   * contract address, the latest USD price, and 24h price change. Filter
-   * by `category` (sector tag) or `search` (substring match against symbol,
-   * ticker, or name).
-   *
-   * Only Ethereum-deployed tokens are returned; assets that exist only on
-   * other chains are omitted.
+   * Each entry carries `provider` (`ondo` | `midas`), `asset_class` (`EQUITY` |
+   * `T_BILLS` | `BASIS_TRADE` | `BTC_YIELD`), `chain`, the symbol, underlying
+   * ticker, contract address, latest USD price, and 24h change; RWA-yield entries
+   * add `apy_7d`/`apy_30d` and `tvl_usd`. Filter with `provider`, `asset_class`,
+   * and `chain`, plus `category` (sector tag — equities only) or `search`
+   * (substring match against symbol, ticker, or name).
+   *
+   * Equities are Ethereum-only; RWA yield tokens also list on Base — pass
+   * `chain=base` to see them. How to trade each: `asset_class=EQUITY` →
+   * `/quote` + `/order`; the RWA classes → `/transact/buy` + `/transact/sell`.
    */
   async tokenizedAssetsMarkets(
     request: operations.V2TokenizedAssetsMarketsRequest,
@@ -49,14 +52,17 @@ export class TokenizedAssets extends ClientSDK {
    * Get a single market
    *
    * @remarks
-   * Get extended detail for a single tokenized equity (e.g. `TSLAon`).
+   * Get extended detail for a single tokenized market.
    *
-   * Includes 52-week range, volume, market cap, holder count, and tradable
-   * sessions in addition to the fields returned by `/markets`.
+   * Works for both asset families: an Ondo **equity** (e.g. `TSLAon`) or a
+   * Midas **RWA yield token** (e.g. `mTBILL`). Equities add 52-week range,
+   * volume, market cap, holder count, and tradable sessions on top of the
+   * `/markets` fields; RWA-yield entries instead carry `apy_7d`/`apy_30d` and
+   * `tvl_usd`.
    *
-   * **OHLC candles** are opt-in: pass both `interval` and `range` query
-   * params to include a `candles` array in the response. They must be
-   * provided together and must form one of the supported pairs:
+   * **OHLC candles are an equities-only feature** — opt in by passing both
+   * `interval` and `range` query params to include a `candles` array. They
+   * must be provided together and must form one of the supported pairs:
    *
    * - `1min` / `5min` / `15min` with `range=1day`
    * - `1hour` / `4hour` with `range=1month`
@@ -80,14 +86,16 @@ export class TokenizedAssets extends ClientSDK {
    * Get tokenized-asset positions for an owner
    *
    * @remarks
-   * Get the tokenized-equity holdings for an owner.
+   * Get the tokenized-asset holdings for an owner.
    *
-   * The owner's Tokenized Assets Account address is derived deterministically
-   * from the `owner` query param; balances are read from that account (proceeds
-   * from filled orders settle there). The response returns the balance of every
-   * listed tokenized equity, plus the latest USD price and a USD-valued balance
-   * when pricing is available. Zero balances are omitted, and a `total_usd`
-   * aggregate is returned across all priced positions.
+   * Covers **both** asset families held in the account — Ondo equities and
+   * Midas RWA yield tokens (`mTBILL`, `mBASIS`, `mBTC`). The Tokenized Assets
+   * Account address is derived deterministically from the `owner` query param;
+   * balances are read from that account (proceeds from equity orders and RWA
+   * swaps both settle there). Equity positions are priced from the Ondo feed;
+   * RWA positions are valued at the latest indexed NAV. Pass `chain=base` for
+   * Base holdings (equities are Ethereum-only). Zero balances are omitted, and
+   * a `total_usd` aggregate is returned across all priced positions.
    *
    * Returns 400 `ACCOUNT_NOT_DEPLOYED` if the owner has no Tokenized Assets
    * Account deployed yet — create one via `/create_account` first.
@@ -104,10 +112,14 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Get order status
+   * Get tokenized-equity order status (Ondo)
    *
    * @remarks
-   * Get the lifecycle state of a submitted order.
+   * Get the lifecycle state of a submitted tokenized-**equity** order (Ondo).
+   *
+   * Equity-order flow only: RWA-yield trades (`/transact/buy`, `/transact/sell`)
+   * are plain swaps that settle in a single transaction and have no order
+   * lifecycle to poll.
    *
    * The `status` field is one of `pending`, `filled`, `expired`, or
    * `cancelled`. Partial fills stay in `pending` while `filled_amount` is
@@ -134,7 +146,10 @@ export class TokenizedAssets extends ClientSDK {
    * @remarks
    * Create a Tokenized Assets Account for a wallet address.
    *
-   * Before placing orders, the owner must create a Tokenized Assets Account.
+   * Required once before **either** trade flow — tokenized-equity orders
+   * (Ondo, via `/quote` + `/order`) and RWA-yield-token swaps (Midas, via
+   * `/transact/buy` + `/transact/sell`) both settle into this one account.
+   *
    * Each wallet address has one Tokenized Assets Account, isolated from the
    * owner's Earn, Credit, and other product accounts.
    *
@@ -196,10 +211,16 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Preview a buy/sell quote
+   * Preview a tokenized-equity buy/sell quote (Ondo)
    *
    * @remarks
-   * Preview the input/output amounts, fees, and slippage tolerance for an order.
+   * Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).
+   *
+   * **Equities only.** RWA yield tokens (Midas — `mTBILL`, `mBASIS`, `mBTC`) are
+   * rejected here with 422 `WRONG_TRADE_FLOW`; they have no auction/quote step —
+   * buy/sell them directly via `/transact/buy` & `/transact/sell`.
+   *
+   * Returns the input/output amounts, fees, and slippage tolerance for an order.
    *
    * Read-only relative to Fusion: hits ``/quote/receive`` only and does not
    * consume a ``quote_id`` or commit an order. Pair with `POST /order`:
@@ -230,10 +251,15 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Build a buy/sell order
+   * Build a tokenized-equity buy/sell order (Ondo)
    *
    * @remarks
-   * Build a buy or sell order whose maker is the Tokenized Assets Account.
+   * Build a tokenized-**equity** (Ondo) buy/sell order; maker is the product account.
+   *
+   * **Equities only.** RWA yield tokens (Midas — `mTBILL`, `mBASIS`, `mBTC`) are
+   * rejected with 422 `WRONG_TRADE_FLOW`; trade them via `/transact/buy` &
+   * `/transact/sell`. Equity orders are always USDC-paired (USDC→equity to buy,
+   * equity→USDC to sell) and settle through 1inch Fusion.
    *
    * Returns up to three pieces in a single round-trip:
    *
@@ -265,7 +291,7 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Submit a signed order
+   * Submit a signed tokenized-equity order (Ondo)
    *
    * @remarks
    * Submit a signed order to the resolver network.
@@ -292,7 +318,7 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Cancel an unfilled order
+   * Cancel an unfilled tokenized-equity order (Ondo)
    *
    * @remarks
    * Build the EIP-712 payload to cancel an unfilled order on-chain.
@@ -319,18 +345,20 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Buy a swap-traded tokenized asset
+   * Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
    *
    * @remarks
-   * Buy an RWA yield asset (e.g. `mTBILL`) inside the product account.
+   * Buy (mint) an RWA yield asset (e.g. `mTBILL`) inside the product account.
    *
-   * Swaps `token_in` (already held by the Tokenized Assets Account — fund it
-   * with a plain transfer first) into `token_out` via the 1inch Aggregation
-   * Router, executed by the account. Returns an unsigned transaction for the
-   * owner to sign, or an EIP-712 payload when `gas_sponsorship` is true.
+   * Mints `token_out` directly from Midas with `token_in` (a stablecoin already
+   * held by the Tokenized Assets Account — fund it with a plain transfer first).
+   * `token_in` must be a payment token the Midas issuance vault accepts (USDC on
+   * every supported network; mBASIS also accepts USDT/DAI on Ethereum). Returns
+   * an unsigned transaction for the owner to sign, or an EIP-712 payload when
+   * `gas_sponsorship` is true.
    *
-   * `token_out` must be a swap-traded tokenized asset; equities trade via the
-   * order endpoints (`/quote`, `/order`, `/order/submit`).
+   * `token_out` must be a Midas RWA asset; equities trade via the order
+   * endpoints (`/quote`, `/order`, `/order/submit`).
    */
   async tokenizedAssetsTransactBuy(
     request: components.TokenizedAssetsTradeRequest,
@@ -344,15 +372,17 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Sell a swap-traded tokenized asset
+   * Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
    *
    * @remarks
-   * Sell an RWA yield asset (e.g. `mTBILL`) inside the product account.
+   * Sell (redeem) an RWA yield asset (e.g. `mTBILL`) inside the product account.
+   *
+   * Redeems `token_in` (a Midas RWA asset held by the Tokenized Assets Account)
+   * directly with Midas into `token_out` (USDC). Returns an unsigned transaction
+   * for the owner to sign, or an EIP-712 payload when `gas_sponsorship` is true.
    *
-   * Swaps `token_in` (a swap-traded tokenized asset held by the Tokenized
-   * Assets Account) into `token_out` via the 1inch Aggregation Router.
-   * Returns an unsigned transaction for the owner to sign, or an EIP-712
-   * payload when `gas_sponsorship` is true.
+   * Instant redemption draws on Midas's on-chain liquidity and is subject to a
+   * small redemption fee and daily limit.
    */
   async tokenizedAssetsTransactSell(
     request: components.TokenizedAssetsTradeRequest,