@compass-labs/api-sdk 2.2.46-rc.0 → 2.2.46-rc.1

package/docs/sdks/tokenizedassets/README.md

@@ -4,21 +4,26 @@
 
 ### Available Operations
 
-* [tokenizedAssetsMarkets](#tokenizedassetsmarkets) - List equity markets
+* [tokenizedAssetsMarkets](#tokenizedassetsmarkets) - List tokenized equity markets
 * [tokenizedAssetsMarketsSymbol](#tokenizedassetsmarketssymbol) - Get a single market
-* [tokenizedAssetsPositions](#tokenizedassetspositions) - Get on-chain positions for a wallet
+* [tokenizedAssetsPositions](#tokenizedassetspositions) - Get tokenized-asset positions for a wallet
 * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get order status
-* [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create account
+* [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create a Tokenized Assets Account
 * [tokenizedAssetsOrder](#tokenizedassetsorder) - Build a buy/sell order
-* [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed order to 1inch Fusion
+* [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed order
 * [tokenizedAssetsOrderOrderHashCancel](#tokenizedassetsorderorderhashcancel) - Cancel an unfilled order
 
 ## tokenizedAssetsMarkets
 
-List tokenized equities surfaced on Ethereum.
+List the tokenized US equities available on Ethereum.
 
-Composed from Ondo's metadata + enhanced-prices feeds. Non-Ethereum-only
-assets (BSC/Solana deployments without an Ethereum twin) are skipped.
+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.
 
 ### Example Usage
 
@@ -89,13 +94,21 @@ run();
 
 ## tokenizedAssetsMarketsSymbol
 
-Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
+Get extended detail for a single tokenized equity (e.g. `TSLAon`).
+
+Includes 52-week range, volume, market cap, holder count, and tradable
+sessions in addition to the fields returned by `/markets`.
+
+**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 opt-in via `interval` + `range`:
+- `1min` / `5min` / `15min` with `range=1day`
+- `1hour` / `4hour` with `range=1month`
+- `12hour` with `range=3month`
+- `1day` with `range=3month` / `6month` / `1year` / `all`
 
-- Both omitted: 200 with `candles` absent.
-- Both supplied and forming a valid Ondo pair: 200 with `candles` populated.
-- Exactly one supplied, or both supplied with an invalid pair: 400.
+Omitting both returns the market detail without `candles`.
 
 ### Example Usage
 
@@ -171,11 +184,16 @@ run();
 
 ## tokenizedAssetsPositions
 
-On-chain ERC-20 balance reads for a wallet across all listed Ondo GM tokens.
+Get the tokenized-asset holdings for a wallet.
 
-Reads each Ethereum-deployed Ondo GM token's `balanceOf(wallet)` via a
-single Multicall3 batch and enriches non-zero balances with the latest USD
-price. Returns human-readable amounts (decimals applied).
+Returns the balance of every listed tokenized equity at the queried
+address, 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.
+
+Pass the **Tokenized Assets Account address** (returned by
+`/create_account`), not the owner's wallet — proceeds from filled
+orders settle into the Tokenized Assets Account.
 
 ### Example Usage
 
@@ -250,11 +268,15 @@ run();
 
 ## tokenizedAssetsOrderOrderHash
 
-Status of a relayed Fusion order — `pending` / `filled` / `expired` / `cancelled`.
+Get the lifecycle state of a submitted order.
+
+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.
 
-Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) are
-collapsed into the 4-value enum the SDK promises. Unknown upstream states
-surface as 502 to alert on schema drift.
+Upstream protocol states beyond these four (e.g. `partially-filled`,
+`refunded`) are mapped onto this set.
 
 ### Example Usage
 
@@ -332,17 +354,21 @@ run();
 
 Create a Tokenized Assets Account for a wallet address.
 
-Each wallet address has one Tokenized Assets Account per chain. It is owned by
-`owner` and isolated from the owner's Earn, Credit, and Traditional Investing
-accounts.
+Before placing orders, the owner must create a Tokenized Assets Account.
+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.
 
 ### Example Usage
 
@@ -420,24 +446,25 @@ run();
 
 ## tokenizedAssetsOrder
 
-Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
+Build a buy or sell order whose maker is the Tokenized Assets Account.
 
-Returns everything the SDK needs to take an `owner` from "I want to buy"
-to a relayed Fusion order whose maker is the Tokenized Assets Account.
-The flow is **signing-based, not transaction-based**:
+Returns up to three pieces in a single round-trip:
 
-1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
-   insufficient), sign it with `wallet.signTypedData(...)` and relay via
-   `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
-   `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
-   to confirm before signing the order.
-2. Sign `order.safe_message_eip712` with the same owner wallet — this is
-   a Safe ERC-1271 wrapper around the Fusion order hash. POST the
-   resulting 65-byte ECDSA together with the rest of the `order` fields
-   to `/order/submit`.
+- **`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 an on-chain transaction in this flow; all
-on-chain action goes through the product account via the sponsor relay.
+The owner never broadcasts the order itself — only the (one-time)
+approval transaction ever hits the chain.
 
 ### Example Usage
 
@@ -521,18 +548,17 @@ run();
 
 ## tokenizedAssetsOrderSubmit
 
-Relay an owner-signed Fusion order to the 1inch relayer.
+Submit a signed order to the resolver network.
 
-The body carries the signature produced by
-`wallet.signTypedData(order.safe_message_eip712)` from the `/order`
-response, plus the order struct (`signed_order`), opaque `extension`,
-and `quote_id`. The signature is validated via ERC-1271
-(`Safe.isValidSignature`) at fill time — the maker on the order struct
-is the Tokenized Assets Account, not the EOA owner.
+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 timestamp. Subsequent calls to
-`GET /order/{order_hash}` track lifecycle (`pending` → `filled` /
-`expired` / `cancelled`).
+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`).
 
 ### Example Usage
 
@@ -618,19 +644,17 @@ run();
 
 ## tokenizedAssetsOrderOrderHashCancel
 
-Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
+Build the EIP-712 payload to cancel an unfilled order on-chain.
 
-Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
-payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
-Sign with the Tokenized Assets Account's owner via
-``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
-so the sponsor broadcasts ``execTransaction`` on the product account
-(the order's maker). The owner can also broadcast ``execTransaction``
-directly if not using gas sponsorship.
+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.
 
-Authorization is on the *predicted* Safe address: the Tokenized Assets
-Account computed from ``owner`` must match the order's on-chain maker.
-Mismatches return 403 ``OWNER_NOT_MAKER`` before any on-chain reads.
+Cancellation works on `pending` and `expired` orders only. Only the
+Tokenized Assets Account that placed the order can cancel it.
 
 ### Example Usage
 

package/package.json

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

package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts

@@ -27,22 +27,26 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create account
+ * Create a Tokenized Assets Account
  *
  * @remarks
  * Create a Tokenized Assets Account for a wallet address.
  *
- * Each wallet address has one Tokenized Assets Account per chain. It is owned by
- * `owner` and isolated from the owner's Earn, Credit, and Traditional Investing
- * accounts.
+ * Before placing orders, the owner must create a Tokenized Assets Account.
+ * Each wallet address has one Tokenized Assets Account, isolated from the
+ * owner's Earn, Credit, and other product accounts.
  *
- * Returns an unsigned transaction to create the account. The `sender` signs and
- * broadcasts this transaction.
+ * 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.
  *
  * **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,13 +28,18 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List equity markets
+ * List tokenized equity markets
  *
  * @remarks
- * List tokenized equities surfaced on Ethereum.
+ * List the tokenized US equities available on Ethereum.
  *
- * Composed from Ondo's metadata + enhanced-prices feeds. Non-Ethereum-only
- * assets (BSC/Solana deployments without an Ethereum twin) are skipped.
+ * 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.
  */
 export function tokenizedAssetsTokenizedAssetsMarkets(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts

@@ -31,13 +31,21 @@ import { Result } from "../types/fp.js";
  * Get a single market
  *
  * @remarks
- * Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
+ * Get extended detail for a single tokenized equity (e.g. `TSLAon`).
  *
- * OHLC candles are opt-in via `interval` + `range`:
+ * Includes 52-week range, volume, market cap, holder count, and tradable
+ * sessions in addition to the fields returned by `/markets`.
  *
- * - Both omitted: 200 with `candles` absent.
- * - Both supplied and forming a valid Ondo pair: 200 with `candles` populated.
- * - Exactly one supplied, or both supplied with an invalid pair: 400.
+ * **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:
+ *
+ * - `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`.
  */
 export function tokenizedAssetsTokenizedAssetsMarketsSymbol(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts

@@ -30,24 +30,25 @@ import { Result } from "../types/fp.js";
  * Build a buy/sell order
  *
  * @remarks
- * Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
+ * Build a buy or sell order whose maker is the Tokenized Assets Account.
  *
- * Returns everything the SDK needs to take an `owner` from "I want to buy"
- * to a relayed Fusion order whose maker is the Tokenized Assets Account.
- * The flow is **signing-based, not transaction-based**:
+ * Returns up to three pieces in a single round-trip:
  *
- * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
- *    insufficient), sign it with `wallet.signTypedData(...)` and relay via
- *    `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
- *    `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
- *    to confirm before signing the order.
- * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
- *    a Safe ERC-1271 wrapper around the Fusion order hash. POST the
- *    resulting 65-byte ECDSA together with the rest of the `order` fields
- *    to `/order/submit`.
+ * - **`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 an on-chain transaction in this flow; all
- * on-chain action goes through the product account via the sponsor relay.
+ * The owner never broadcasts the order itself — only the (one-time)
+ * approval transaction ever hits the chain.
  */
 export function tokenizedAssetsTokenizedAssetsOrder(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts

@@ -31,11 +31,15 @@ import { Result } from "../types/fp.js";
  * Get order status
  *
  * @remarks
- * Status of a relayed Fusion order — `pending` / `filled` / `expired` / `cancelled`.
+ * Get the lifecycle state of a submitted order.
  *
- * Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) are
- * collapsed into the 4-value enum the SDK promises. Unknown upstream states
- * surface as 502 to alert on schema drift.
+ * 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.
  */
 export function tokenizedAssetsTokenizedAssetsOrderOrderHash(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts

@@ -31,19 +31,17 @@ import { Result } from "../types/fp.js";
  * Cancel an unfilled order
  *
  * @remarks
- * Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
+ * Build the EIP-712 payload to cancel an unfilled order on-chain.
  *
- * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
- * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
- * Sign with the Tokenized Assets Account's owner via
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
- * so the sponsor broadcasts ``execTransaction`` on the product account
- * (the order's maker). The owner can also broadcast ``execTransaction``
- * directly if not using gas sponsorship.
+ * 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.
  *
- * Authorization is on the *predicted* Safe address: the Tokenized Assets
- * Account computed from ``owner`` must match the order's on-chain maker.
- * Mismatches return 403 ``OWNER_NOT_MAKER`` before any on-chain reads.
+ * Cancellation works on `pending` and `expired` orders only. Only the
+ * Tokenized Assets Account that placed the order can cancel it.
  */
 export function tokenizedAssetsTokenizedAssetsOrderOrderHashCancel(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts

@@ -27,21 +27,20 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Submit a signed order to 1inch Fusion
+ * Submit a signed order
  *
  * @remarks
- * Relay an owner-signed Fusion order to the 1inch relayer.
+ * Submit a signed order to the resolver network.
  *
- * The body carries the signature produced by
- * `wallet.signTypedData(order.safe_message_eip712)` from the `/order`
- * response, plus the order struct (`signed_order`), opaque `extension`,
- * and `quote_id`. The signature is validated via ERC-1271
- * (`Safe.isValidSignature`) at fill time — the maker on the order struct
- * is the Tokenized Assets Account, not the EOA owner.
+ * 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 timestamp. Subsequent calls to
- * `GET /order/{order_hash}` track lifecycle (`pending` → `filled` /
- * `expired` / `cancelled`).
+ * 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`).
  */
 export function tokenizedAssetsTokenizedAssetsOrderSubmit(
   client: CompassApiSDKCore,

package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts

@@ -28,14 +28,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get on-chain positions for a wallet
+ * Get tokenized-asset positions for a wallet
  *
  * @remarks
- * On-chain ERC-20 balance reads for a wallet across all listed Ondo GM tokens.
+ * Get the tokenized-asset holdings for a wallet.
  *
- * Reads each Ethereum-deployed Ondo GM token's `balanceOf(wallet)` via a
- * single Multicall3 batch and enriches non-zero balances with the latest USD
- * price. Returns human-readable amounts (decimals applied).
+ * Returns the balance of every listed tokenized equity at the queried
+ * address, 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.
+ *
+ * Pass the **Tokenized Assets Account address** (returned by
+ * `/create_account`), not the owner's wallet — proceeds from filled
+ * orders settle into the Tokenized Assets Account.
  */
 export function tokenizedAssetsTokenizedAssetsPositions(
   client: CompassApiSDKCore,

package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts

@@ -10,13 +10,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Chain on which the surfaced contract is deployed.
+ * Chain on which the contract is deployed.
  */
 export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain = {
   Ethereum: "ethereum",
 } as const;
 /**
- * Chain on which the surfaced contract is deployed.
+ * Chain on which the contract is deployed.
  */
 export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain =
   ClosedEnum<typeof CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain>;
@@ -38,7 +38,7 @@ export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
    */
   name: string;
   /**
-   * Chain on which the surfaced contract is deployed.
+   * Chain on which the contract is deployed.
    */
   chain?: CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain | undefined;
   /**
@@ -46,7 +46,7 @@ export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
    */
   contractAddress: string;
   /**
-   * ERC-20 decimals on the surfaced chain.
+   * ERC-20 decimals for this token.
    */
   decimals: number;
   /**

package/src/models/components/marketdetail.ts

@@ -12,13 +12,13 @@ import { OhlcCandle, OhlcCandle$inboundSchema } from "./ohlccandle.js";
 import { PricePoint, PricePoint$inboundSchema } from "./pricepoint.js";
 
 /**
- * Chain on which the surfaced contract is deployed.
+ * Chain on which the contract is deployed.
  */
 export const MarketDetailChain = {
   Ethereum: "ethereum",
 } as const;
 /**
- * Chain on which the surfaced contract is deployed.
+ * Chain on which the contract is deployed.
  */
 export type MarketDetailChain = ClosedEnum<typeof MarketDetailChain>;
 
@@ -39,7 +39,7 @@ export type MarketDetail = {
    */
   name: string;
   /**
-   * Chain on which the surfaced contract is deployed.
+   * Chain on which the contract is deployed.
    */
   chain?: MarketDetailChain | undefined;
   /**
@@ -47,7 +47,7 @@ export type MarketDetail = {
    */
   contractAddress: string;
   /**
-   * ERC-20 decimals on the surfaced chain.
+   * ERC-20 decimals for this token.
    */
   decimals: number;
   /**
@@ -71,7 +71,7 @@ export type MarketDetail = {
    */
   regionExposure?: Array<string> | undefined;
   /**
-   * 24h price sparkline (sampled timestamps, descending or ascending).
+   * 24h price sparkline as `(timestamp, price)` samples in chronological order.
    */
   priceHistory24h?: Array<PricePoint> | undefined;
   /**

package/src/models/components/ohlccandle.ts

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * A single OHLC candle. Note: Ondo does not return per-candle volume.
+ * A single OHLC candle. Per-candle volume is not provided.
  */
 export type OhlcCandle = {
   /**

package/src/models/components/orderstatus.ts

@@ -10,7 +10,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum.
+ * Order lifecycle state. One of `pending`, `filled`, `expired`, or `cancelled`. Upstream protocol states beyond these four (e.g. `partially-filled`, `refunded`) are mapped onto this set.
  */
 export const Status = {
   Pending: "pending",
@@ -19,7 +19,7 @@ export const Status = {
   Cancelled: "cancelled",
 } as const;
 /**
- * Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum.
+ * Order lifecycle state. One of `pending`, `filled`, `expired`, or `cancelled`. Upstream protocol states beyond these four (e.g. `partially-filled`, `refunded`) are mapped onto this set.
  */
 export type Status = ClosedEnum<typeof Status>;
 
@@ -32,27 +32,27 @@ export type OrderStatus = {
    */
   orderHash: string;
   /**
-   * Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum.
+   * Order lifecycle state. One of `pending`, `filled`, `expired`, or `cancelled`. Upstream protocol states beyond these four (e.g. `partially-filled`, `refunded`) are mapped onto this set.
    */
   status: Status;
   /**
-   * Tx hash of the most recent resolver fill (populated when filled or partially filled).
+   * Transaction hash of the most recent fill. Populated for fully filled orders and for partial fills while `status` is still `pending`.
    */
   fillTxHash?: string | null | undefined;
   /**
-   * Implied USD execution rate per unit of the taker token, derived from filled amounts and the maker-side USD price. For USDC→equity buys this is the USD paid per equity unit. Omitted if maker/taker decimals are unknown.
+   * Implied USD execution rate per unit of the received token, derived from filled amounts and the input token's USD price. For USDC → equity buys, this is the USD paid per equity unit. Omitted when token decimals or pricing are not available.
    */
   fillPriceUsd?: string | null | undefined;
   /**
-   * Sum of base-unit amounts filled so far. Populated for partial fills while `status` is still `pending`, and for fully filled orders.
+   * Total amount filled so far, expressed as a raw integer in the input token's decimals. Populated for partial fills while `status` is still `pending`, and for fully filled orders.
    */
   filledAmount?: string | null | undefined;
   /**
-   * ISO 8601 UTC timestamp of order submission.
+   * ISO 8601 UTC timestamp at which the order was submitted.
    */
   submittedAt?: string | null | undefined;
   /**
-   * ISO 8601 UTC timestamp of this status read.
+   * ISO 8601 UTC timestamp at which this status was read.
    */
   updatedAt: string;
 };