@compass-labs/api-sdk 2.2.68 → 2.2.69

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/README.md +2 -2
  2. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +4 -7
  3. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -1
  4. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js +4 -7
  5. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -1
  6. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +2 -2
  7. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js +2 -2
  8. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +1 -1
  9. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +1 -1
  10. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +1 -1
  11. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +1 -1
  12. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts +4 -4
  13. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.js +4 -4
  14. package/dist/commonjs/models/components/ordertosign.d.ts +2 -2
  15. package/dist/commonjs/models/components/safemessagemessage.d.ts +1 -1
  16. package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts +4 -7
  17. package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts.map +1 -1
  18. package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.js.map +1 -1
  19. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.d.ts +2 -2
  20. package/dist/commonjs/models/components/tokenizedassetschargefeerequest.d.ts +1 -1
  21. package/dist/commonjs/models/components/tokenizedassetsquoterequest.d.ts +3 -3
  22. package/dist/commonjs/models/components/tokenizedassetsquoteresponse.d.ts +1 -1
  23. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.d.ts +1 -1
  24. package/dist/commonjs/models/components/tokenizedassetssubmitorderresponse.d.ts +1 -1
  25. package/dist/commonjs/models/errors/tokenizedassetserrorresponse.d.ts +2 -2
  26. package/dist/commonjs/sdk/tokenizedassets.d.ts +12 -15
  27. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  28. package/dist/commonjs/sdk/tokenizedassets.js +12 -15
  29. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  30. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +4 -7
  31. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -1
  32. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js +4 -7
  33. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -1
  34. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +2 -2
  35. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js +2 -2
  36. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +1 -1
  37. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +1 -1
  38. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +1 -1
  39. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +1 -1
  40. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts +4 -4
  41. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.js +4 -4
  42. package/dist/esm/models/components/ordertosign.d.ts +2 -2
  43. package/dist/esm/models/components/safemessagemessage.d.ts +1 -1
  44. package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts +4 -7
  45. package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts.map +1 -1
  46. package/dist/esm/models/components/tokenizedassetsbalancesresponse.js.map +1 -1
  47. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.d.ts +2 -2
  48. package/dist/esm/models/components/tokenizedassetschargefeerequest.d.ts +1 -1
  49. package/dist/esm/models/components/tokenizedassetsquoterequest.d.ts +3 -3
  50. package/dist/esm/models/components/tokenizedassetsquoteresponse.d.ts +1 -1
  51. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.d.ts +1 -1
  52. package/dist/esm/models/components/tokenizedassetssubmitorderresponse.d.ts +1 -1
  53. package/dist/esm/models/errors/tokenizedassetserrorresponse.d.ts +2 -2
  54. package/dist/esm/sdk/tokenizedassets.d.ts +12 -15
  55. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  56. package/dist/esm/sdk/tokenizedassets.js +12 -15
  57. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  58. package/docs/models/components/ordertosign.md +2 -2
  59. package/docs/models/components/safemessagemessage.md +3 -3
  60. package/docs/models/components/tokenizedassetsbalancesresponse.md +4 -7
  61. package/docs/models/components/tokenizedassetsbuildorderresponse.md +1 -1
  62. package/docs/models/components/tokenizedassetschargefeerequest.md +1 -1
  63. package/docs/models/components/tokenizedassetsquoterequest.md +3 -3
  64. package/docs/models/components/tokenizedassetsquoteresponse.md +5 -5
  65. package/docs/models/components/tokenizedassetssubmitorderrequest.md +1 -1
  66. package/docs/models/components/tokenizedassetssubmitorderresponse.md +1 -1
  67. package/docs/models/errors/tokenizedassetserrorresponse.md +4 -4
  68. package/docs/sdks/tokenizedassets/README.md +12 -15
  69. package/openapi_prepped_for_speakeasy.json +35 -35
  70. package/package.json +1 -1
  71. package/src/funcs/tokenizedAssetsTokenizedAssetsBalances.ts +4 -7
  72. package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts +2 -2
  73. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.ts +1 -1
  74. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts +1 -1
  75. package/src/funcs/tokenizedAssetsTokenizedAssetsQuote.ts +4 -4
  76. package/src/models/components/ordertosign.ts +2 -2
  77. package/src/models/components/safemessagemessage.ts +1 -1
  78. package/src/models/components/tokenizedassetsbalancesresponse.ts +4 -7
  79. package/src/models/components/tokenizedassetsbuildorderresponse.ts +2 -2
  80. package/src/models/components/tokenizedassetschargefeerequest.ts +1 -1
  81. package/src/models/components/tokenizedassetsquoterequest.ts +3 -3
  82. package/src/models/components/tokenizedassetsquoteresponse.ts +1 -1
  83. package/src/models/components/tokenizedassetssubmitorderrequest.ts +1 -1
  84. package/src/models/components/tokenizedassetssubmitorderresponse.ts +1 -1
  85. package/src/models/errors/tokenizedassetserrorresponse.ts +2 -2
  86. package/src/sdk/tokenizedassets.ts +12 -15
@@ -15,7 +15,7 @@ import {
15
15
  *
16
16
  * @remarks
17
17
  *
18
- * Equity orders fill off-chain via a third-party resolver, so the fee can't
18
+ * Equity orders fill off-chain via a third-party venue, so the fee can't
19
19
  * ride inside the trade (unlike Midas/earn/credit). After the sell order
20
20
  * fills, call this with the order hash to build a USDC `transfer(recipient,
21
21
  * fee)` executed by the product account.
@@ -10,9 +10,9 @@ import { remap as remap$ } from "../../lib/primitives.js";
10
10
  *
11
11
  * @remarks
12
12
  *
13
- * Read-only relative to Fusion: this hits ``/quote/receive`` only and does
14
- * not consume a ``quote_id`` or commit an order. Use it to surface expected
15
- * output, fees, and a thin-liquidity warning before the user confirms; pass
13
+ * Read-only: this previews a quote without consuming a ``quote_id`` or
14
+ * committing an order. Use it to surface expected output, fees, and a
15
+ * thin-liquidity warning before the user confirms; pass
16
16
  * the same body (plus ``slippage_bps``) to ``POST /tokenized_assets/order``
17
17
  * when they do.
18
18
  */
@@ -18,7 +18,7 @@ export type TokenizedAssetsQuoteResponse = {
18
18
  */
19
19
  quote: Quote;
20
20
  /**
21
- * Slippage tolerance in basis points (1 bp = 0.01%) the UI should echo back as `slippage_bps` on `POST /tokenized_assets/order`. Derived from Fusion's Dutch auction range (`auctionEndAmount` vs `toTokenAmount`) plus a small buffer; capped at 5000 bps.
21
+ * Slippage tolerance in basis points (1 bp = 0.01%) the UI should echo back as `slippage_bps` on `POST /tokenized_assets/order`. Derived from the on-chain auction range (`auctionEndAmount` vs `toTokenAmount`) plus a small buffer; capped at 5000 bps.
22
22
  */
23
23
  recommendedSlippageBps: number;
24
24
  /**
@@ -6,7 +6,7 @@ import * as z from "zod/v3";
6
6
  import { remap as remap$ } from "../../lib/primitives.js";
7
7
 
8
8
  /**
9
- * Submit an owner-signed order to the resolver network.
9
+ * Submit an owner-signed order for settlement.
10
10
  *
11
11
  * @remarks
12
12
  *
@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * Returned after the signed order is relayed to 1inch Fusion.
12
+ * Returned after the signed order is submitted for settlement.
13
13
  */
14
14
  export type TokenizedAssetsSubmitOrderResponse = {
15
15
  /**
@@ -15,7 +15,7 @@ import { CompassAPISDKError } from "./compassapisdkerror.js";
15
15
  */
16
16
  export type TokenizedAssetsErrorResponseData = {
17
17
  /**
18
- * Stable machine-readable error code (e.g. `MARKET_NOT_FOUND`, `FUSION_NO_LIQUIDITY`, `ORDER_NOT_FOUND`).
18
+ * Short human-readable error label (e.g. `Market not found.`, `Insufficient liquidity`, `Order not found.`).
19
19
  */
20
20
  error: string;
21
21
  /**
@@ -34,7 +34,7 @@ export type TokenizedAssetsErrorResponseData = {
34
34
  */
35
35
  export class TokenizedAssetsErrorResponse extends CompassAPISDKError {
36
36
  /**
37
- * Stable machine-readable error code (e.g. `MARKET_NOT_FOUND`, `FUSION_NO_LIQUIDITY`, `ORDER_NOT_FOUND`).
37
+ * Short human-readable error label (e.g. `Market not found.`, `Insufficient liquidity`, `Order not found.`).
38
38
  */
39
39
  error: string;
40
40
 
@@ -114,16 +114,13 @@ export class TokenizedAssets extends ClientSDK {
114
114
  }
115
115
 
116
116
  /**
117
- * Get tokenized-asset account balances + transfer history
117
+ * Get account balances
118
118
  *
119
119
  * @remarks
120
- * Get the full token ledger for a Tokenized Assets Account.
120
+ * Get the token balances of a Tokenized Assets Account.
121
121
  *
122
- * Returns every token the account has transferred current balances plus
123
- * complete transfer history keyed by symbol. Unlike `/positions` (current
124
- * equity holdings, priced), this includes **USDC funding** movements and
125
- * **fully-sold positions** (zero balance), making it the account's cash +
126
- * activity ledger. Pass `chain=base` for Base holdings.
122
+ * Returns each token held in the account with its current balance, USD value,
123
+ * and transfer history. Pass `chain=base` for Base holdings.
127
124
  */
128
125
  async tokenizedAssetsBalances(
129
126
  request: operations.V2TokenizedAssetsBalancesRequest,
@@ -242,13 +239,13 @@ export class TokenizedAssets extends ClientSDK {
242
239
  * Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).
243
240
  *
244
241
  * **Equities only.** RWA yield tokens (Midas — `mTBILL`, `mBASIS`, `mBTC`) are
245
- * rejected here with 422 `WRONG_TRADE_FLOW`; they have no auction/quote step —
242
+ * rejected here with 422 `Wrong trade flow`; they have no auction/quote step —
246
243
  * buy/sell them directly via `/transact/buy` & `/transact/sell`.
247
244
  *
248
245
  * Returns the input/output amounts, fees, and slippage tolerance for an order.
249
246
  *
250
- * Read-only relative to Fusion: hits ``/quote/receive`` only and does not
251
- * consume a ``quote_id`` or commit an order. Pair with `POST /order`:
247
+ * Read-only: previews the quote without consuming a ``quote_id`` or
248
+ * committing an order. Pair with `POST /order`:
252
249
  * surface this preview to the user, and on confirm pass the body plus
253
250
  * ``recommended_slippage_bps`` to `/order`.
254
251
  *
@@ -257,7 +254,7 @@ export class TokenizedAssets extends ClientSDK {
257
254
  * - **`quote`** — input/output token amounts, fees, and an
258
255
  * ``est_fill_seconds`` upper bound.
259
256
  * - **`recommended_slippage_bps`** — system-derived slippage tolerance
260
- * that clears Fusion's current auction floor; pass back as
257
+ * that clears the current auction floor; pass back as
261
258
  * ``slippage_bps`` on `/order` so the build call validates against the
262
259
  * same floor the user was shown.
263
260
  * - **`auction_range_bps`** — worst-case bps gap between the auction
@@ -282,9 +279,9 @@ export class TokenizedAssets extends ClientSDK {
282
279
  * Build a tokenized-**equity** (Ondo) buy/sell order; maker is the product account.
283
280
  *
284
281
  * **Equities only.** RWA yield tokens (Midas — `mTBILL`, `mBASIS`, `mBTC`) are
285
- * rejected with 422 `WRONG_TRADE_FLOW`; trade them via `/transact/buy` &
282
+ * rejected with 422 `Wrong trade flow`; trade them via `/transact/buy` &
286
283
  * `/transact/sell`. Equity orders are always USDC-paired (USDC→equity to buy,
287
- * equity→USDC to sell) and settle through 1inch Fusion.
284
+ * equity→USDC to sell) and settle on-chain.
288
285
  *
289
286
  * Returns up to three pieces in a single round-trip:
290
287
  *
@@ -319,7 +316,7 @@ export class TokenizedAssets extends ClientSDK {
319
316
  * Submit a signed tokenized-equity order (Ondo)
320
317
  *
321
318
  * @remarks
322
- * Submit a signed order to the resolver network.
319
+ * Submit a signed order for settlement.
323
320
  *
324
321
  * The body echoes the `order` fields from `/order` (`signed_order`,
325
322
  * `extension`, `quote_id`, optionally `order_hash`) plus the owner's
@@ -375,7 +372,7 @@ export class TokenizedAssets extends ClientSDK {
375
372
  * @remarks
376
373
  * Build a USDC fee transfer on a filled equity sell order's proceeds.
377
374
  *
378
- * Equity orders fill off-chain via a third-party resolver, so the fee can't be
375
+ * Equity orders fill off-chain via a third-party venue, so the fee can't be
379
376
  * bundled into the trade. Once the sell order has filled, call this with the
380
377
  * order hash and your `fee` (recipient + percentage/fixed); it reads the actual
381
378
  * filled USDC proceeds and returns a `transfer(recipient, fee)` executed by the