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

package/src/models/components/ordertosign.ts

@@ -13,31 +13,30 @@ import {
 } from "./safemessageeip712response.js";
 
 /**
- * Fusion order metadata bundled with the SafeMessage EIP-712 to sign.
+ * Order metadata plus the EIP-712 payload the owner signs to authorize it.
  *
  * @remarks
  *
- * The owner signs ``safe_message_eip712`` (a `SafeMessage(bytes message)`
- * payload wrapping ``order_hash`` for ERC-1271). At submit time the SDK
- * relays the resulting 65-byte ECDSA together with ``order_message``,
- * ``extension``, and ``quote_id`` so 1inch's relayer can broadcast the
- * order; resolvers fill it via ``Safe.isValidSignature``.
+ * The owner signs ``safe_message_eip712`` off-chain. At submit time the
+ * signature is sent back to ``/order/submit`` together with
+ * ``order_message``, ``extension``, and ``quote_id``; resolvers validate
+ * the signature against the Tokenized Assets Account at fill time.
  */
 export type OrderToSign = {
   /**
-   * The 1inch LOP order hash. Wrapped inside `safe_message_eip712.message.message` for ERC-1271 signing; also relayed to `/order/submit` so the API can fall back to it if the upstream submit response omits the hash.
+   * The on-chain order hash. Wrapped inside `safe_message_eip712.message.message` for the owner to sign; also passed back to `/order/submit` so the API can return a usable handle even if the upstream submit response omits the hash.
    */
   orderHash: string;
   /**
-   * Opaque hex blob from 1inch — pass back to `/order/submit` unchanged.
+   * Opaque hex blob from the upstream quote — pass back to `/order/submit` unchanged.
    */
   extension: string;
   /**
-   * 1inch quote identifier — must be echoed back at `/order/submit`.
+   * Upstream quote identifier — must be echoed back at `/order/submit`.
    */
   quoteId: string;
   /**
-   * Fusion order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. Maker is the Tokenized Assets Account, not the EOA owner.
+   * Order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. The maker is the Tokenized Assets Account, not the owner's wallet.
    */
   orderMessage: { [k: string]: any };
   /**

package/src/models/components/quote.ts

@@ -23,11 +23,11 @@ export type Quote = {
    */
   output: TokenAmount;
   /**
-   * Aggregate fee charged by the Fusion auction (resolver + protocol).
+   * Aggregate fee charged for the order.
    */
   fee: QuoteFee;
   /**
-   * Auction duration upper-bound in seconds.
+   * Estimated upper bound on time-to-fill, in seconds.
    */
   estFillSeconds: number;
 };

package/src/models/components/quotefee.ts

@@ -9,11 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Aggregate fee charged by the Fusion auction (resolver + protocol).
+ * Aggregate fee charged for the order.
  */
 export type QuoteFee = {
   /**
-   * Total fee in USD, decimal string.
+   * Total fee in USD as a decimal string.
    */
   amountUsd?: string | null | undefined;
   /**

package/src/models/components/tokenizedassetsbuildorderrequest.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Build a buy/sell order against the 1inch Fusion intent flow.
+ * Build a buy or sell order for a tokenized equity.
  */
 export type TokenizedAssetsBuildOrderRequest = {
   /**
@@ -22,11 +22,11 @@ export type TokenizedAssetsBuildOrderRequest = {
    */
   amount: string;
   /**
-   * EOA that owns the Tokenized Assets Account. Determines the product account address and signs the EIP-712 envelopes returned by this endpoint (the approve SafeTx and the SafeMessage wrapping the order hash).
+   * Wallet that owns the Tokenized Assets Account. The product account address is derived deterministically from this owner. The owner signs the EIP-712 payloads returned by this endpoint (the optional approval and the order itself).
    */
   owner: string;
   /**
-   * Max acceptable slippage in basis points (1 bp = 0.01%).
+   * Max acceptable slippage in basis points (1 bp = 0.01%). Range 1-1000 (0.01%-10%); defaults to 50 (0.5%).
    */
   slippageBps?: number | undefined;
 };

package/src/models/components/tokenizedassetsbuildorderresponse.ts

@@ -15,7 +15,7 @@ import { OrderToSign, OrderToSign$inboundSchema } from "./ordertosign.js";
 import { Quote, Quote$inboundSchema } from "./quote.js";
 
 /**
- * Composed response: quote + optional approval SafeTx + EIP-712 order to sign.
+ * Quote, optional approval payload, and the EIP-712 order to sign.
  */
 export type TokenizedAssetsBuildOrderResponse = {
   /**
@@ -23,19 +23,18 @@ export type TokenizedAssetsBuildOrderResponse = {
    */
   quote: Quote;
   /**
-   * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/gas_sponsorship/prepare`. `null` when allowance is already sufficient.
+   * EIP-712 payload that authorizes a one-time max-approve of `from_token` to the settlement contract. Populated when the Tokenized Assets Account's existing allowance is below `amount`. The owner signs it, then it is broadcast via `POST /v2/gas_sponsorship/prepare` (or directly by the owner) to set the allowance on-chain. `null` when the allowance is already sufficient.
    */
   approvalSafeTxEip712?: BatchedSafeOperationsResponseOutput | null | undefined;
   /**
-   * Fusion order metadata bundled with the SafeMessage EIP-712 to sign.
+   * Order metadata plus the EIP-712 payload the owner signs to authorize it.
    *
    * @remarks
    *
-   * The owner signs ``safe_message_eip712`` (a `SafeMessage(bytes message)`
-   * payload wrapping ``order_hash`` for ERC-1271). At submit time the SDK
-   * relays the resulting 65-byte ECDSA together with ``order_message``,
-   * ``extension``, and ``quote_id`` so 1inch's relayer can broadcast the
-   * order; resolvers fill it via ``Safe.isValidSignature``.
+   * The owner signs ``safe_message_eip712`` off-chain. At submit time the
+   * signature is sent back to ``/order/submit`` together with
+   * ``order_message``, ``extension``, and ``quote_id``; resolvers validate
+   * the signature against the Tokenized Assets Account at fill time.
    */
   order: OrderToSign;
 };

package/src/models/components/tokenizedassetscancelorderrequest.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type TokenizedAssetsCancelOrderRequest = {
   /**
-   * EOA that owns the Tokenized Assets Account. The product account predicted from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it).
+   * Wallet that owns the Tokenized Assets Account. The account address derived from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it).
    */
   owner: string;
 };

package/src/models/components/tokenizedassetssubmitorderrequest.ts

@@ -6,23 +6,21 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Relay an owner-signed Fusion order to the 1inch relayer.
+ * Submit an owner-signed order to the resolver network.
  *
  * @remarks
  *
- * The shape mirrors what `POST /order` returned plus the wallet's
- * EIP-712 signature — all fields are required by the upstream relayer.
- * Maker is the Tokenized Assets Account (the Safe), so the signature is
- * validated via ERC-1271 (`Safe.isValidSignature`) at fill time rather
- * than as an EOA personal-sign.
+ * The shape echoes what `POST /order` returned plus the owner's
+ * EIP-712 signature. The maker is the Tokenized Assets Account, so the
+ * signature is validated against the product account at fill time.
  */
 export type TokenizedAssetsSubmitOrderRequest = {
   /**
-   * The Fusion order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the EOA owner — relay this dict back to the API verbatim.
+   * The order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the owner's wallet — pass this dict back to the API verbatim.
    */
   signedOrder: { [k: string]: any };
   /**
-   * EIP-712 signature produced by `wallet.signTypedData(order.safe_message_eip712)` from the `/order` response. The Tokenized Assets Account validates this via ERC-1271 (`Safe.isValidSignature`) at fill time, so the signature must be the owner's signature over the SafeMessage hash, not the raw Fusion order hash. For a single-owner Safe this is the standard 65-byte ECDSA `(r, s, v)` blob; multi-owner Safes and pre-approved-hash flows produce variable-length signatures and are also accepted — the relayer enforces its own checks downstream.
+   * Owner's EIP-712 signature over `order.safe_message_eip712` from the `/order` response. The signature is validated against the Tokenized Assets Account at fill time, so it must be a signature over the typed-data hash, not the raw order hash.
    */
   signature: string;
   /**
@@ -30,11 +28,11 @@ export type TokenizedAssetsSubmitOrderRequest = {
    */
   extension: string;
   /**
-   * `order.quote_id` from the `/order` response.
+   * `order.quote_id` from the `/order` response — pass back unchanged.
    */
   quoteId: string;
   /**
-   * EIP-712 order hash from `order.order_hash` in the `/order` response. Optional but recommended: 1inch's relayer occasionally accepts a submit with a 2xx empty body; passing the hash through lets the API still return a usable handle for status / cancel lookups instead of failing.
+   * `order.order_hash` from the `/order` response. Optional but recommended: the upstream relayer occasionally returns a 2xx with an empty body, and supplying the hash lets the API still return a usable handle for status and cancel lookups instead of failing.
    */
   orderHash?: string | null | undefined;
 };

package/src/sdk/tokenizedassets.ts

@@ -17,13 +17,18 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class TokenizedAssets extends ClientSDK {
   /**
-   * 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.
    */
   async tokenizedAssetsMarkets(
     request: operations.V2TokenizedAssetsMarketsRequest,
@@ -40,13 +45,21 @@ export class TokenizedAssets extends ClientSDK {
    * 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`).
+   *
+   * 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`.
    */
   async tokenizedAssetsMarketsSymbol(
     request: operations.V2TokenizedAssetsMarketsSymbolRequest,
@@ -60,14 +73,19 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * 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.
    */
   async tokenizedAssetsPositions(
     request: operations.V2TokenizedAssetsPositionsRequest,
@@ -84,11 +102,15 @@ export class TokenizedAssets extends ClientSDK {
    * Get order status
    *
    * @remarks
-   * 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.
    */
   async tokenizedAssetsOrderOrderHash(
     request: operations.V2TokenizedAssetsOrderOrderHashRequest,
@@ -102,22 +124,26 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * 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.
    */
   async tokenizedAssetsCreateAccount(
     request: components.CreateTokenizedAssetsAccountRequest,
@@ -134,24 +160,25 @@ export class TokenizedAssets extends ClientSDK {
    * Build a buy/sell order
    *
    * @remarks
-   * Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
-   *
-   * 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**:
-   *
-   * 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`.
-   *
-   * The owner never broadcasts an on-chain transaction in this flow; all
-   * on-chain action goes through the product account via the sponsor relay.
+   * Build a buy or sell order whose maker is the Tokenized Assets Account.
+   *
+   * 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.
    */
   async tokenizedAssetsOrder(
     request: components.TokenizedAssetsBuildOrderRequest,
@@ -165,21 +192,20 @@ export class TokenizedAssets extends ClientSDK {
   }
 
   /**
-   * Submit a signed order to 1inch Fusion
+   * Submit a signed order
    *
    * @remarks
-   * Relay an owner-signed Fusion order to the 1inch relayer.
-   *
-   * 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.
-   *
-   * Returns the order hash and a server-side timestamp. Subsequent calls to
-   * `GET /order/{order_hash}` track lifecycle (`pending` → `filled` /
-   * `expired` / `cancelled`).
+   * Submit a signed order to the resolver network.
+   *
+   * 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`).
    */
   async tokenizedAssetsOrderSubmit(
     request: components.TokenizedAssetsSubmitOrderRequest,
@@ -196,19 +222,17 @@ export class TokenizedAssets extends ClientSDK {
    * Cancel an unfilled order
    *
    * @remarks
-   * Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
-   *
-   * 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.
-   *
-   * 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.
+   * Build the EIP-712 payload to cancel an unfilled 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.
    */
   async tokenizedAssetsOrderOrderHashCancel(
     request: operations.V2TokenizedAssetsOrderOrderHashCancelRequest,