@compass-labs/api-sdk 2.2.85-rc.0 → 2.2.85

package/openapi_prepped_for_speakeasy.json

@@ -5357,7 +5357,7 @@
         "tags": [
           "Earn"
         ],
-        "summary": "Quote a swap (read-only)",
+        "summary": "Quote a swap",
         "description": "Estimate the output of a swap without building a transaction.\n\nReturns the expected amount of `token_out` received for selling `amount_in`\nof `token_in`, routed via 1inch. This is read-only: it does not build a\ntransaction, require an account, or check balances.\n\nUse it to gauge exit liquidity and price impact for a token before entering\na position \u2014 for example, to warn when a market's underlying asset cannot be\nswapped back to a stablecoin without large slippage.",
         "operationId": "v2_earn_swap_quote",
         "parameters": [
@@ -7365,8 +7365,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "List tokenized asset markets",
-        "description": "List tokenized asset markets: Ondo equities and Midas RWA yield tokens.\n\nEach entry carries `provider` (`ondo` | `midas`), `asset_class` (`EQUITY` |\n`T_BILLS` | `BASIS_TRADE` | `BTC_YIELD`), `chain`, the symbol, underlying\nticker, contract address, latest USD price, and 24h change; RWA-yield entries\nadd `apy_7d`/`apy_30d` and `tvl_usd`. Filter with `provider`, `asset_class`,\nand `chain`, plus `category` (sector tag \u2014 equities only) or `search`\n(substring match against symbol, ticker, or name).\n\nEquities are Ethereum-only; RWA yield tokens also list on Base \u2014 pass\n`chain=base` to see them. How to trade each: `asset_class=EQUITY` \u2192\n`/quote` + `/order`; the RWA classes \u2192 `/transact/buy` + `/transact/sell`.",
+        "summary": "List markets",
+        "description": "List the tradable tokenized-asset catalog.\n\nAggregates all three providers \u2014 Ondo (tokenized US equities), Midas (RWA\nyield tokens), and IXS (managed vaults) \u2014 into a single list with live USD\npricing, plus APY and TVL for yield assets. Filter by provider, asset class,\nor chain, and narrow the results with a sector `category` or free-text\n`search`.",
         "operationId": "v2_tokenized_assets_markets",
         "parameters": [
           {
@@ -7500,8 +7500,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Get a single market",
-        "description": "Get extended detail for a single tokenized market.\n\nWorks for both asset families: an Ondo **equity** (e.g. `TSLAon`) or a\nMidas **RWA yield token** (e.g. `mTBILL`). Equities add 52-week range,\nvolume, market cap, holder count, and tradable sessions on top of the\n`/markets` fields; RWA-yield entries instead carry `apy_7d`/`apy_30d` and\n`tvl_usd`.\n\n**OHLC candles are an equities-only feature** \u2014 opt in by passing both\n`interval` and `range` query params to include a `candles` array. They\nmust be provided together and must form one of the supported pairs:\n\n- `1min` / `5min` / `15min` with `range=1day`\n- `1hour` / `4hour` with `range=1month`\n- `12hour` with `range=3month`\n- `1day` with `range=3month` / `6month` / `1year` / `all`\n\nOmitting both returns the market detail without `candles`.",
+        "summary": "Get a market",
+        "description": "Get extended detail for a single market \u2014 an Ondo **equity** (e.g. `TSLAon`), a\nMidas **RWA yield token** (e.g. `mTBILL`), or an IXS **managed vault** (e.g.\n`ixv1`).\n\nAdds richer market data on top of the `/markets` listing, plus an optional\nOHLC candle series: pass matching `interval` and `range` query params to\ninclude `candles` (available for equities, Midas tokens except `mBTC`, and IXS\nvaults; omit both for detail without candles).",
         "operationId": "v2_tokenized_assets_markets_{symbol}",
         "parameters": [
           {
@@ -7627,8 +7627,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Get tokenized-asset positions for an owner",
-        "description": "Get the tokenized-asset holdings for an owner.\n\nCovers **both** asset families held in the account \u2014 Ondo equities and\nMidas RWA yield tokens (`mTBILL`, `mBASIS`, `mBTC`). The Tokenized Assets\nAccount address is derived deterministically from the `owner` query param;\nbalances are read from that account (proceeds from equity orders and RWA\nswaps both settle there). Equity positions are priced from the Ondo feed;\nRWA positions are valued at the latest indexed NAV. Pass `chain=base` for\nBase holdings (equities are Ethereum-only). Zero balances are omitted, and\na `total_usd` aggregate is returned across all priced positions.\n\nReturns 400 `ACCOUNT_NOT_DEPLOYED` if the owner has no Tokenized Assets\nAccount deployed yet \u2014 create one via `/create_account` first.",
+        "summary": "List positions",
+        "description": "Get an owner's tokenized-asset holdings, priced and aggregated.\n\nReturns positions across every asset family the account holds \u2014 Ondo equities,\nMidas RWA yield tokens, and IXS managed vaults \u2014 each valued in USD (equities\nfrom the Ondo feed, RWA at the latest indexed NAV) with a `total_usd` total.\nThe account is derived from `owner`; pass `chain` for Base (Midas) or BNB Smart\nChain (IXS) holdings.",
         "operationId": "v2_tokenized_assets_positions",
         "parameters": [
           {
@@ -7712,8 +7712,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Get account balances",
-        "description": "Get the token balances of a Tokenized Assets Account.\n\nReturns each token held in the account with its current balance, USD value,\nand transfer history. Pass `chain=base` for Base holdings.",
+        "summary": "Get token balances",
+        "description": "Get a Tokenized Assets Account's full token ledger.\n\nReturns every token the account has held \u2014 including zero balances from fully-exited\npositions and USDC funding \u2014 each with its USD value and transfer history (a\nsuperset of `/positions`). Pass `chain=base` or `chain=bsc` for Base or BNB Smart\nChain holdings.",
         "operationId": "v2_tokenized_assets_balances",
         "parameters": [
           {
@@ -7777,8 +7777,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Get tokenized-equity order status (Ondo)",
-        "description": "Get the lifecycle state of a submitted tokenized-**equity** order (Ondo).\n\nEquity-order flow only: RWA-yield trades (`/transact/buy`, `/transact/sell`)\nare plain swaps that settle in a single transaction and have no order\nlifecycle to poll.\n\nThe `status` field is one of `pending`, `filled`, `expired`, or\n`cancelled`. Partial fills stay in `pending` while `filled_amount` is\npopulated as fills come in; once an order fully fills, `fill_tx_hash`\nis also returned.\n\nUpstream protocol states beyond these four (e.g. `partially-filled`,\n`refunded`) are mapped onto this set.",
+        "summary": "Get order status",
+        "description": "Poll the lifecycle state of a submitted equity order (Ondo).\n\nReports `pending`, `filled`, `expired`, or `cancelled`, with fill details as\nthey arrive. Equity orders only \u2014 RWA yield swaps settle in one transaction and\nhave no lifecycle to poll.",
         "operationId": "v2_tokenized_assets_order_{order_hash}",
         "parameters": [
           {
@@ -7851,8 +7851,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Get IXS vault redemption requests for an owner",
-        "description": "Get an owner's IXS vault redemption requests (async redemption status).\n\nIXS managed-vault **sells** are asynchronous: `/transact/sell` returns a\n`requestRedeem` transaction, and the vault operator settles it off-chain\nlater. This endpoint reconstructs the owner's requests directly from the\nvault on every call (Compass persists no async state) \u2014 each entry carries\nits `status` (`pending` | `finalized` | `rejected`), the `shares` requested,\nand, while `pending`, the `expected_net_assets` it would settle for at the\ncurrent NAV (a preview, not a guarantee).\n\nIXS vaults live on BNB Smart Chain \u2014 pass `chain=bsc` (the default) and the\n`vault` handle (default `ixv1`).",
+        "summary": "List redemption requests",
+        "description": "Get an owner's IXS managed-vault redemption requests and their status.\n\nIXS vault sells are asynchronous \u2014 `/transact/sell` files a `requestRedeem`\nthat the vault operator settles off-chain later. This reconstructs the owner's\nrequests live from the vault (Compass stores no async state), reporting each as\n`pending`, `finalized`, or `rejected`. IXS vaults live on BNB Smart Chain\n(`chain=bsc`, vault `ixv1`).",
         "operationId": "v2_tokenized_assets_redemptions",
         "parameters": [
           {
@@ -7928,8 +7928,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Create a Tokenized Assets Account",
-        "description": "Create a Tokenized Assets Account for a wallet address.\n\nRequired once before **either** trade flow \u2014 tokenized-equity orders\n(Ondo, via `/quote` + `/order`) and RWA-yield-token swaps (Midas, via\n`/transact/buy` + `/transact/sell`) both settle into this one account.\n\nEach wallet address has one Tokenized Assets Account, isolated from the\nowner's Earn, Credit, and other product accounts.\n\nThe account address is deterministic. If it already exists, the\nresponse returns `transaction: null` and you can skip straight to\nbuilding orders.\n\nReturns an unsigned transaction to create the account. The `sender`\nsigns and broadcasts this transaction.\n\n**If owner pays gas:** Set `sender` to the owner's address.\n\n**If someone else pays gas:** Set `sender` to the wallet that will\nsign and broadcast the transaction on behalf of the owner.",
+        "summary": "Create account",
+        "description": "Create a Tokenized Assets Account for a wallet address.\n\nBefore trading tokenized assets, the owner must create a Tokenized Assets\nAccount. Each wallet address has one Tokenized Assets Account per chain.\n\nReturns an unsigned transaction to create the account. The `sender` signs\nand broadcasts this transaction.\n\n**If owner pays gas:** Set `sender` to the owner's address.\n\n**If someone else pays gas:** Set `sender` to the wallet that will sign and\nbroadcast the transaction on behalf of the owner.",
         "operationId": "v2_tokenized_assets_create_account",
         "requestBody": {
           "content": {
@@ -7971,8 +7971,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Deposit to / withdraw from a Tokenized Assets Account",
-        "description": "Move tokens between the owner's wallet and their Tokenized Assets Account.\n\nUse `DEPOSIT` to fund the account from the owner's wallet, or `WITHDRAW` to\nsend tokens from the account back to the owner. Equity orders settle in\nUSDC; RWA yield assets trade against USDC on Ethereum and Base.\n\nWith `gas_sponsorship=true` the response is EIP-712 typed data the owner\nsigns off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the\nsponsor broadcasts and pays the gas:\n\n- **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first\n  grant a one-time token->Permit2 allowance (gaslessly via\n  `POST /v2/gas_sponsorship/approve_transfer`).\n- **WITHDRAW** returns a Safe transaction the account executes.\n\nWith `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer\nthe owner broadcasts directly, and a WITHDRAW returns an unsigned Safe\n`execTransaction` the owner signs and broadcasts.",
+        "summary": "Transfer tokens to/from account",
+        "description": "Move tokens between the owner's wallet and their Tokenized Assets Account.\n\n`DEPOSIT` funds the account from the owner's wallet; `WITHDRAW` sends tokens\nback. Supports gas sponsorship: with `gas_sponsorship=true` the owner signs\nEIP-712 typed data (a Permit2 permit on deposit, a product-account transaction\non withdrawal) and a sponsor broadcasts; otherwise the owner broadcasts the\ntransaction directly.",
         "operationId": "v2_tokenized_assets_transfer",
         "requestBody": {
           "content": {
@@ -8024,8 +8024,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Preview a tokenized-equity buy/sell quote (Ondo)",
-        "description": "Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).\n\n**Equities only.** RWA yield tokens (Midas \u2014 `mTBILL`, `mBASIS`, `mBTC`) are\nrejected here with 422 `Wrong trade flow`; they have no auction/quote step \u2014\nbuy/sell them directly via `/transact/buy` & `/transact/sell`.\n\nReturns the input/output amounts, fees, and slippage tolerance for an order.\n\nRead-only: previews the quote without consuming a ``quote_id`` or\ncommitting an order. Pair with `POST /order`:\nsurface this preview to the user, and on confirm pass the body plus\n``recommended_slippage_bps`` to `/order`.\n\nThe response carries:\n\n- **`quote`** \u2014 input/output token amounts, fees, and an\n  ``est_fill_seconds`` upper bound.\n- **`recommended_slippage_bps`** \u2014 system-derived slippage tolerance\n  that clears the current auction floor; pass back as\n  ``slippage_bps`` on `/order` so the build call validates against the\n  same floor the user was shown.\n- **`auction_range_bps`** \u2014 worst-case bps gap between the auction\n  end amount and the reference quote amount. Use to surface a\n  thin-liquidity warning to the user.",
+        "summary": "Quote an order",
+        "description": "Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).\n\nRead-only price preview: returns the expected input/output amounts and a\nsystem-recommended slippage tolerance to carry into `/order`. Equities only \u2014\nRWA yield tokens (Midas) have no quote step and are rejected with `422 Wrong\ntrade flow`; trade them via `/transact/buy` and `/transact/sell`.",
         "operationId": "v2_tokenized_assets_quote",
         "requestBody": {
           "content": {
@@ -8107,8 +8107,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Build a tokenized-equity buy/sell order (Ondo)",
-        "description": "Build a tokenized-**equity** (Ondo) buy/sell order; maker is the product account.\n\n**Equities only.** RWA yield tokens (Midas \u2014 `mTBILL`, `mBASIS`, `mBTC`) are\nrejected with 422 `Wrong trade flow`; trade them via `/transact/buy` &\n`/transact/sell`. Equity orders are always USDC-paired (USDC\u2192equity to buy,\nequity\u2192USDC to sell) and settle on-chain.\n\nReturns up to three pieces in a single round-trip:\n\n- **`quote`** \u2014 preview of the input/output amounts and fees.\n- **`approval_safe_tx_eip712`** \u2014 only present when the account's\n  allowance to the settlement contract is below `amount`. The owner\n  signs this EIP-712 payload, then it is broadcast via\n  `POST /v2/gas_sponsorship/prepare` (or the owner can broadcast\n  directly) to set the on-chain allowance. Wait for that transaction\n  to confirm before signing the order.\n- **`order`** \u2014 the order metadata (`order_hash`, `extension`,\n  `quote_id`, `order_message`) plus `safe_message_eip712`, an EIP-712\n  payload the owner signs off-chain to authorize the order. The\n  signature is submitted to `/order/submit` and is **never** broadcast\n  on-chain.\n\nThe owner never broadcasts the order itself \u2014 only the (one-time)\napproval transaction ever hits the chain.",
+        "summary": "Build an order",
+        "description": "Build a tokenized-**equity** (Ondo) buy/sell order; the product account is the\nmaker.\n\nReturns everything needed to place the order in one round-trip: a price quote,\na one-time token approval to sign (only until the settlement contract is\napproved), and the order payload the owner signs off-chain. Only the approval\never touches the chain \u2014 the signed order is relayed to market makers, never\nbroadcast. Equities only; RWA yield tokens use `/transact/buy` and\n`/transact/sell`.",
         "operationId": "v2_tokenized_assets_order",
         "requestBody": {
           "content": {
@@ -8200,8 +8200,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Submit a signed tokenized-equity order (Ondo)",
-        "description": "Submit a signed order for settlement.\n\nThe body echoes the `order` fields from `/order` (`signed_order`,\n`extension`, `quote_id`, optionally `order_hash`) plus the owner's\nsignature over `order.safe_message_eip712`. The maker on the order\nstruct is the Tokenized Assets Account, not the owner's wallet \u2014\npass `signed_order` back unchanged.\n\nReturns the order hash and a server-side ISO 8601 timestamp.\nSubsequent calls to `GET /order/{order_hash}` track the lifecycle\n(`pending` \u2192 `filled` / `expired` / `cancelled`).",
+        "summary": "Submit a signed order",
+        "description": "Submit a signed equity order to the market-maker network for settlement.\n\nRelays the payload from `/order` plus the owner's signature, and returns the\norder hash. Poll `GET /order/{order_hash}` to track its lifecycle (`pending` \u2192\n`filled` / `expired` / `cancelled`).",
         "operationId": "v2_tokenized_assets_order_submit",
         "requestBody": {
           "content": {
@@ -8273,8 +8273,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Cancel an unfilled tokenized-equity order (Ondo)",
-        "description": "Build the EIP-712 payload to cancel an unfilled order on-chain.\n\nReturns ``cancel_safe_tx_eip712``, an EIP-712 payload that authorizes\nthe on-chain cancellation. Sign with the Tokenized Assets Account's\nowner via ``wallet.signTypedData(...)`` and relay via\n``POST /v2/gas_sponsorship/prepare`` so the sponsor broadcasts the\ncancellation on the product account. The owner can also broadcast\nthe resulting transaction directly without using gas sponsorship.\n\nCancellation works on `pending` and `expired` orders only. Only the\nTokenized Assets Account that placed the order can cancel it.",
+        "summary": "Cancel an order",
+        "description": "Cancel an unfilled equity order on-chain.\n\nReturns an EIP-712 payload the owner signs; a sponsor relays it, or the owner\nbroadcasts it directly. Works only on `pending` or `expired` orders, and only\nthe account that placed the order can cancel it.",
         "operationId": "v2_tokenized_assets_order_{order_hash}_cancel",
         "parameters": [
           {
@@ -8377,8 +8377,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Charge a partner fee on a filled sell order's USDC proceeds",
-        "description": "Build a USDC fee transfer on a filled equity sell order's proceeds.\n\nEquity orders fill off-chain via a third-party venue, so the fee can't be\nbundled into the trade. Once the sell order has filled, call this with the\norder hash and your `fee` (recipient + percentage/fixed); it reads the actual\nfilled USDC proceeds and returns a `transfer(recipient, fee)` executed by the\nproduct account \u2014 an unsigned transaction the owner signs, or an EIP-712\npayload when `gas_sponsorship` is true.",
+        "summary": "Charge a partner fee",
+        "description": "Charge a partner fee on a filled equity sell order's USDC proceeds.\n\nEquity orders settle off-chain, so fees can't be bundled into the trade \u2014 call\nthis after a sell fills and it builds a USDC transfer of your `fee` from the\nactual proceeds, executed by the product account (owner signs, or EIP-712 with\n`gas_sponsorship`).",
         "operationId": "v2_tokenized_assets_order_{order_hash}_charge_fee",
         "parameters": [
           {
@@ -8431,8 +8431,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)",
-        "description": "Buy (mint) an RWA yield asset (e.g. `mTBILL`) inside the product account.\n\nMints `token_out` directly from Midas with `token_in` (a stablecoin already\nheld by the Tokenized Assets Account \u2014 fund it with a plain transfer first).\n`token_in` must be a payment token the Midas issuance vault accepts (USDC on\nevery supported network; mBASIS also accepts USDT/DAI on Ethereum). Returns\nan unsigned transaction for the owner to sign, or an EIP-712 payload when\n`gas_sponsorship` is true.\n\n`token_out` must be a Midas RWA asset; equities trade via the order\nendpoints (`/quote`, `/order`, `/order/submit`).",
+        "summary": "Buy an RWA yield token",
+        "description": "Buy an RWA yield token, or deposit into an IXS managed vault, with a stablecoin\nin one transaction.\n\nSet `token_out` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS\n**vault address** (its shares aren't a registered symbol). The account spends\na stablecoin it already holds (fund it with a plain transfer first) and\nsettles inside the product account \u2014 an unsigned transaction the owner signs,\nor EIP-712 with `gas_sponsorship`. Both paths are instant. Equities use the\norder flow (`/quote`, `/order`).",
         "operationId": "v2_tokenized_assets_transact_buy",
         "requestBody": {
           "content": {
@@ -8474,8 +8474,8 @@
         "tags": [
           "Tokenized Assets"
         ],
-        "summary": "Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)",
-        "description": "Sell (redeem) an RWA yield asset (e.g. `mTBILL`) inside the product account.\n\nRedeems `token_in` (a Midas RWA asset held by the Tokenized Assets Account)\ndirectly with Midas into `token_out` (USDC). Returns an unsigned transaction\nfor the owner to sign, or an EIP-712 payload when `gas_sponsorship` is true.\n\nInstant redemption draws on Midas's on-chain liquidity and is subject to a\nsmall redemption fee and daily limit.",
+        "summary": "Sell an RWA yield token",
+        "description": "Sell an RWA yield token, or redeem from an IXS managed vault, back to a\nstablecoin.\n\nSet `token_in` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS\n**vault address**. A Midas redemption is instant and settles in the same\ntransaction; an IXS redemption is **asynchronous** \u2014 it files a\n`requestRedeem` (`settlement: async`) the vault operator settles off-chain\nlater, so poll `GET /v2/tokenized_assets/redemptions` for status. The\ntransaction executes inside the product account (owner signs, or EIP-712 with\n`gas_sponsorship`).",
         "operationId": "v2_tokenized_assets_transact_sell",
         "requestBody": {
           "content": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.85-rc.0",
+  "version": "2.2.85",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/funcs/earnEarnSwapQuote.ts

@@ -28,7 +28,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Quote a swap (read-only)
+ * Quote a swap
  *
  * @remarks
  * Estimate the output of a swap without building a transaction.

package/src/funcs/tokenizedAssetsTokenizedAssetsBalances.ts

@@ -28,13 +28,15 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get account balances
+ * Get token balances
  *
  * @remarks
- * Get the token balances of a Tokenized Assets Account.
+ * Get a Tokenized Assets Account's full token ledger.
  *
- * Returns each token held in the account with its current balance, USD value,
- * and transfer history. Pass `chain=base` for Base holdings.
+ * Returns every token the account has held — including zero balances from fully-exited
+ * positions and USDC funding — each with its USD value and transfer history (a
+ * superset of `/positions`). Pass `chain=base` or `chain=bsc` for Base or BNB Smart
+ * Chain holdings.
  */
 export function tokenizedAssetsTokenizedAssetsBalances(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts

@@ -27,29 +27,21 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a Tokenized Assets Account
+ * Create account
  *
  * @remarks
  * Create a Tokenized Assets Account for a wallet address.
  *
- * 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.
+ * Before trading tokenized assets, the owner must create a Tokenized Assets
+ * Account. Each wallet address has one Tokenized Assets Account per chain.
  *
- * Each wallet address has one Tokenized Assets Account, isolated from the
- * owner's Earn, Credit, and other product accounts.
- *
- * The account address is deterministic. If it already exists, the
- * response returns `transaction: null` and you can skip straight to
- * building orders.
- *
- * Returns an unsigned transaction to create the account. The `sender`
- * signs and broadcasts this transaction.
+ * Returns an unsigned transaction to create the account. The `sender` signs
+ * and broadcasts this transaction.
  *
  * **If owner pays gas:** Set `sender` to the owner's address.
  *
- * **If someone else pays gas:** Set `sender` to the wallet that will
- * sign and broadcast the transaction on behalf of the owner.
+ * **If someone else pays gas:** Set `sender` to the wallet that will sign and
+ * broadcast the transaction on behalf of the owner.
  */
 export function tokenizedAssetsTokenizedAssetsCreateAccount(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsMarkets.ts

@@ -28,21 +28,16 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List tokenized asset markets
+ * List markets
  *
  * @remarks
- * List tokenized asset markets: Ondo equities and Midas RWA yield tokens.
+ * List the tradable tokenized-asset catalog.
  *
- * 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`.
+ * Aggregates all three providers — Ondo (tokenized US equities), Midas (RWA
+ * yield tokens), and IXS (managed vaults) — into a single list with live USD
+ * pricing, plus APY and TVL for yield assets. Filter by provider, asset class,
+ * or chain, and narrow the results with a sector `category` or free-text
+ * `search`.
  */
 export function tokenizedAssetsTokenizedAssetsMarkets(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts

@@ -28,27 +28,17 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get a single market
+ * Get a market
  *
  * @remarks
- * Get extended detail for a single tokenized market.
+ * Get extended detail for a single market — an Ondo **equity** (e.g. `TSLAon`), a
+ * Midas **RWA yield token** (e.g. `mTBILL`), or an IXS **managed vault** (e.g.
+ * `ixv1`).
  *
- * 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 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`
- * - `12hour` with `range=3month`
- * - `1day` with `range=3month` / `6month` / `1year` / `all`
- *
- * Omitting both returns the market detail without `candles`.
+ * Adds richer market data on top of the `/markets` listing, plus an optional
+ * OHLC candle series: pass matching `interval` and `range` query params to
+ * include `candles` (available for equities, Midas tokens except `mBTC`, and IXS
+ * vaults; omit both for detail without candles).
  */
 export function tokenizedAssetsTokenizedAssetsMarketsSymbol(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts

@@ -27,33 +27,18 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Build a tokenized-equity buy/sell order (Ondo)
+ * Build an order
  *
  * @remarks
- * Build a tokenized-**equity** (Ondo) buy/sell order; maker is the product account.
+ * Build a tokenized-**equity** (Ondo) buy/sell order; the product account is the
+ * maker.
  *
- * **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 on-chain.
- *
- * Returns up to three pieces in a single round-trip:
- *
- * - **`quote`** — preview of the input/output amounts and fees.
- * - **`approval_safe_tx_eip712`** — only present when the account's
- *   allowance to the settlement contract is below `amount`. The owner
- *   signs this EIP-712 payload, then it is broadcast via
- *   `POST /v2/gas_sponsorship/prepare` (or the owner can broadcast
- *   directly) to set the on-chain allowance. Wait for that transaction
- *   to confirm before signing the order.
- * - **`order`** — the order metadata (`order_hash`, `extension`,
- *   `quote_id`, `order_message`) plus `safe_message_eip712`, an EIP-712
- *   payload the owner signs off-chain to authorize the order. The
- *   signature is submitted to `/order/submit` and is **never** broadcast
- *   on-chain.
- *
- * The owner never broadcasts the order itself — only the (one-time)
- * approval transaction ever hits the chain.
+ * Returns everything needed to place the order in one round-trip: a price quote,
+ * a one-time token approval to sign (only until the settlement contract is
+ * approved), and the order payload the owner signs off-chain. Only the approval
+ * ever touches the chain — the signed order is relayed to market makers, never
+ * broadcast. Equities only; RWA yield tokens use `/transact/buy` and
+ * `/transact/sell`.
  */
 export function tokenizedAssetsTokenizedAssetsOrder(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts

@@ -28,22 +28,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get tokenized-equity order status (Ondo)
+ * Get order status
  *
  * @remarks
- * Get the lifecycle state of a submitted tokenized-**equity** order (Ondo).
+ * Poll the lifecycle state of a submitted 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
- * populated as fills come in; once an order fully fills, `fill_tx_hash`
- * is also returned.
- *
- * Upstream protocol states beyond these four (e.g. `partially-filled`,
- * `refunded`) are mapped onto this set.
+ * Reports `pending`, `filled`, `expired`, or `cancelled`, with fill details as
+ * they arrive. Equity orders only — RWA yield swaps settle in one transaction and
+ * have no lifecycle to poll.
  */
 export function tokenizedAssetsTokenizedAssetsOrderOrderHash(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts

@@ -28,20 +28,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Cancel an unfilled tokenized-equity order (Ondo)
+ * Cancel an order
  *
  * @remarks
- * Build the EIP-712 payload to cancel an unfilled order on-chain.
+ * Cancel an unfilled equity order on-chain.
  *
- * Returns ``cancel_safe_tx_eip712``, an EIP-712 payload that authorizes
- * the on-chain cancellation. Sign with the Tokenized Assets Account's
- * owner via ``wallet.signTypedData(...)`` and relay via
- * ``POST /v2/gas_sponsorship/prepare`` so the sponsor broadcasts the
- * cancellation on the product account. The owner can also broadcast
- * the resulting transaction directly without using gas sponsorship.
- *
- * Cancellation works on `pending` and `expired` orders only. Only the
- * Tokenized Assets Account that placed the order can cancel it.
+ * Returns an EIP-712 payload the owner signs; a sponsor relays it, or the owner
+ * broadcasts it directly. Works only on `pending` or `expired` orders, and only
+ * the account that placed the order can cancel it.
  */
 export function tokenizedAssetsTokenizedAssetsOrderOrderHashCancel(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.ts

@@ -28,17 +28,15 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Charge a partner fee on a filled sell order's USDC proceeds
+ * Charge a partner fee
  *
  * @remarks
- * Build a USDC fee transfer on a filled equity sell order's proceeds.
+ * Charge a partner fee on a filled equity sell order's USDC proceeds.
  *
- * Equity orders fill off-chain via a third-party venue, so the fee can't be
- * bundled into the trade. Once the sell order has filled, call this with the
- * order hash and your `fee` (recipient + percentage/fixed); it reads the actual
- * filled USDC proceeds and returns a `transfer(recipient, fee)` executed by the
- * product account — an unsigned transaction the owner signs, or an EIP-712
- * payload when `gas_sponsorship` is true.
+ * Equity orders settle off-chain, so fees can't be bundled into the trade — call
+ * this after a sell fills and it builds a USDC transfer of your `fee` from the
+ * actual proceeds, executed by the product account (owner signs, or EIP-712 with
+ * `gas_sponsorship`).
  */
 export function tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts

@@ -27,20 +27,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Submit a signed tokenized-equity order (Ondo)
+ * Submit a signed order
  *
  * @remarks
- * Submit a signed order for settlement.
+ * Submit a signed equity order to the market-maker network for settlement.
  *
- * The body echoes the `order` fields from `/order` (`signed_order`,
- * `extension`, `quote_id`, optionally `order_hash`) plus the owner's
- * signature over `order.safe_message_eip712`. The maker on the order
- * struct is the Tokenized Assets Account, not the owner's wallet —
- * pass `signed_order` back unchanged.
- *
- * Returns the order hash and a server-side ISO 8601 timestamp.
- * Subsequent calls to `GET /order/{order_hash}` track the lifecycle
- * (`pending` → `filled` / `expired` / `cancelled`).
+ * Relays the payload from `/order` plus the owner's signature, and returns the
+ * order hash. Poll `GET /order/{order_hash}` to track its lifecycle (`pending` →
+ * `filled` / `expired` / `cancelled`).
  */
 export function tokenizedAssetsTokenizedAssetsOrderSubmit(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts

@@ -28,22 +28,16 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get tokenized-asset positions for an owner
+ * List positions
  *
  * @remarks
- * Get the tokenized-asset holdings for an owner.
+ * Get an owner's tokenized-asset holdings, priced and aggregated.
  *
- * 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.
+ * Returns positions across every asset family the account holds — Ondo equities,
+ * Midas RWA yield tokens, and IXS managed vaults — each valued in USD (equities
+ * from the Ondo feed, RWA at the latest indexed NAV) with a `total_usd` total.
+ * The account is derived from `owner`; pass `chain` for Base (Midas) or BNB Smart
+ * Chain (IXS) holdings.
  */
 export function tokenizedAssetsTokenizedAssetsPositions(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsQuote.ts

@@ -27,33 +27,15 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Preview a tokenized-equity buy/sell quote (Ondo)
+ * Quote an order
  *
  * @remarks
  * 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: previews the quote without consuming a ``quote_id`` or
- * committing an order. Pair with `POST /order`:
- * surface this preview to the user, and on confirm pass the body plus
- * ``recommended_slippage_bps`` to `/order`.
- *
- * The response carries:
- *
- * - **`quote`** — input/output token amounts, fees, and an
- *   ``est_fill_seconds`` upper bound.
- * - **`recommended_slippage_bps`** — system-derived slippage tolerance
- *   that clears the current auction floor; pass back as
- *   ``slippage_bps`` on `/order` so the build call validates against the
- *   same floor the user was shown.
- * - **`auction_range_bps`** — worst-case bps gap between the auction
- *   end amount and the reference quote amount. Use to surface a
- *   thin-liquidity warning to the user.
+ * Read-only price preview: returns the expected input/output amounts and a
+ * system-recommended slippage tolerance to carry into `/order`. Equities only —
+ * RWA yield tokens (Midas) have no quote step and are rejected with `422 Wrong
+ * trade flow`; trade them via `/transact/buy` and `/transact/sell`.
  */
 export function tokenizedAssetsTokenizedAssetsQuote(
   client: CompassApiSDKCore,