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

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 (159) hide show
  1. package/README.md +32 -32
  2. package/dist/commonjs/funcs/earnEarnSwapQuote.d.ts +1 -1
  3. package/dist/commonjs/funcs/earnEarnSwapQuote.js +1 -1
  4. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +6 -4
  5. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -1
  6. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js +6 -4
  7. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -1
  8. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +7 -15
  9. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
  10. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +7 -15
  11. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
  12. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +7 -12
  13. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
  14. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +7 -12
  15. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
  16. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +8 -18
  17. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  18. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +8 -18
  19. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  20. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +9 -24
  21. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
  22. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js +9 -24
  23. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
  24. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +5 -13
  25. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
  26. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +5 -13
  27. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
  28. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +5 -11
  29. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
  30. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +5 -11
  31. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
  32. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +6 -8
  33. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts.map +1 -1
  34. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +6 -8
  35. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js.map +1 -1
  36. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +5 -11
  37. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
  38. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +5 -11
  39. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
  40. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +7 -13
  41. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
  42. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js +7 -13
  43. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
  44. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts +5 -23
  45. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts.map +1 -1
  46. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.js +5 -23
  47. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.js.map +1 -1
  48. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +7 -12
  49. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -1
  50. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +7 -12
  51. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -1
  52. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts +9 -11
  53. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts.map +1 -1
  54. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js +9 -11
  55. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js.map +1 -1
  56. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts +10 -8
  57. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts.map +1 -1
  58. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js +10 -8
  59. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js.map +1 -1
  60. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts +6 -17
  61. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts.map +1 -1
  62. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.js +6 -17
  63. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.js.map +1 -1
  64. package/dist/commonjs/sdk/earn.d.ts +1 -1
  65. package/dist/commonjs/sdk/earn.js +1 -1
  66. package/dist/commonjs/sdk/tokenizedassets.d.ts +110 -208
  67. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  68. package/dist/commonjs/sdk/tokenizedassets.js +110 -208
  69. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  70. package/dist/esm/funcs/earnEarnSwapQuote.d.ts +1 -1
  71. package/dist/esm/funcs/earnEarnSwapQuote.js +1 -1
  72. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +6 -4
  73. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -1
  74. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js +6 -4
  75. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -1
  76. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +7 -15
  77. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
  78. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +7 -15
  79. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
  80. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +7 -12
  81. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
  82. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +7 -12
  83. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
  84. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +8 -18
  85. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  86. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +8 -18
  87. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  88. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +9 -24
  89. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
  90. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js +9 -24
  91. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
  92. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +5 -13
  93. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
  94. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +5 -13
  95. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
  96. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +5 -11
  97. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
  98. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +5 -11
  99. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
  100. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +6 -8
  101. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts.map +1 -1
  102. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +6 -8
  103. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js.map +1 -1
  104. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +5 -11
  105. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
  106. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +5 -11
  107. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
  108. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +7 -13
  109. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
  110. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js +7 -13
  111. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
  112. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts +5 -23
  113. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts.map +1 -1
  114. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.js +5 -23
  115. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.js.map +1 -1
  116. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +7 -12
  117. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -1
  118. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +7 -12
  119. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -1
  120. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts +9 -11
  121. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts.map +1 -1
  122. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js +9 -11
  123. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js.map +1 -1
  124. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts +10 -8
  125. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts.map +1 -1
  126. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js +10 -8
  127. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js.map +1 -1
  128. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts +6 -17
  129. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts.map +1 -1
  130. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.js +6 -17
  131. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.js.map +1 -1
  132. package/dist/esm/sdk/earn.d.ts +1 -1
  133. package/dist/esm/sdk/earn.js +1 -1
  134. package/dist/esm/sdk/tokenizedassets.d.ts +110 -208
  135. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  136. package/dist/esm/sdk/tokenizedassets.js +110 -208
  137. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  138. package/docs/sdks/earn/README.md +1 -1
  139. package/docs/sdks/tokenizedassets/README.md +102 -200
  140. package/openapi_prepped_for_speakeasy.json +31 -31
  141. package/package.json +1 -1
  142. package/src/funcs/earnEarnSwapQuote.ts +1 -1
  143. package/src/funcs/tokenizedAssetsTokenizedAssetsBalances.ts +6 -4
  144. package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts +7 -15
  145. package/src/funcs/tokenizedAssetsTokenizedAssetsMarkets.ts +7 -12
  146. package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts +8 -18
  147. package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts +9 -24
  148. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts +5 -13
  149. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts +5 -11
  150. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.ts +6 -8
  151. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts +5 -11
  152. package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts +7 -13
  153. package/src/funcs/tokenizedAssetsTokenizedAssetsQuote.ts +5 -23
  154. package/src/funcs/tokenizedAssetsTokenizedAssetsRedemptions.ts +7 -12
  155. package/src/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.ts +9 -11
  156. package/src/funcs/tokenizedAssetsTokenizedAssetsTransactSell.ts +10 -8
  157. package/src/funcs/tokenizedAssetsTokenizedAssetsTransfer.ts +6 -17
  158. package/src/sdk/earn.ts +1 -1
  159. package/src/sdk/tokenizedassets.ts +110 -208
@@ -28,21 +28,16 @@ import { APICall, APIPromise } from "../types/async.js";
28
28
  import { Result } from "../types/fp.js";
29
29
 
30
30
  /**
31
- * Get IXS vault redemption requests for an owner
31
+ * List redemption requests
32
32
  *
33
33
  * @remarks
34
- * Get an owner's IXS vault redemption requests (async redemption status).
34
+ * Get an owner's IXS managed-vault redemption requests and their status.
35
35
  *
36
- * IXS managed-vault **sells** are asynchronous: `/transact/sell` returns a
37
- * `requestRedeem` transaction, and the vault operator settles it off-chain
38
- * later. This endpoint reconstructs the owner's requests directly from the
39
- * vault on every call (Compass persists no async state) each entry carries
40
- * its `status` (`pending` | `finalized` | `rejected`), the `shares` requested,
41
- * and, while `pending`, the `expected_net_assets` it would settle for at the
42
- * current NAV (a preview, not a guarantee).
43
- *
44
- * IXS vaults live on BNB Smart Chain — pass `chain=bsc` (the default) and the
45
- * `vault` handle (default `ixv1`).
36
+ * IXS vault sells are asynchronous `/transact/sell` files a `requestRedeem`
37
+ * that the vault operator settles off-chain later. This reconstructs the owner's
38
+ * requests live from the vault (Compass stores no async state), reporting each as
39
+ * `pending`, `finalized`, or `rejected`. IXS vaults live on BNB Smart Chain
40
+ * (`chain=bsc`, vault `ixv1`).
46
41
  */
47
42
  export function tokenizedAssetsTokenizedAssetsRedemptions(
48
43
  client: CompassApiSDKCore,
@@ -27,20 +27,18 @@ import { APICall, APIPromise } from "../types/async.js";
27
27
  import { Result } from "../types/fp.js";
28
28
 
29
29
  /**
30
- * Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
30
+ * Buy an RWA yield token
31
31
  *
32
32
  * @remarks
33
- * Buy (mint) an RWA yield asset (e.g. `mTBILL`) inside the product account.
33
+ * Buy an RWA yield token, or deposit into an IXS managed vault, with a stablecoin
34
+ * in one transaction.
34
35
  *
35
- * Mints `token_out` directly from Midas with `token_in` (a stablecoin already
36
- * held by the Tokenized Assets Account fund it with a plain transfer first).
37
- * `token_in` must be a payment token the Midas issuance vault accepts (USDC on
38
- * every supported network; mBASIS also accepts USDT/DAI on Ethereum). Returns
39
- * an unsigned transaction for the owner to sign, or an EIP-712 payload when
40
- * `gas_sponsorship` is true.
41
- *
42
- * `token_out` must be a Midas RWA asset; equities trade via the order
43
- * endpoints (`/quote`, `/order`, `/order/submit`).
36
+ * Set `token_out` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
37
+ * **vault address** (its shares aren't a registered symbol). The account spends
38
+ * a stablecoin it already holds (fund it with a plain transfer first) and
39
+ * settles inside the product account an unsigned transaction the owner signs,
40
+ * or EIP-712 with `gas_sponsorship`. Both paths are instant. Equities use the
41
+ * order flow (`/quote`, `/order`).
44
42
  */
45
43
  export function tokenizedAssetsTokenizedAssetsTransactBuy(
46
44
  client: CompassApiSDKCore,
@@ -27,17 +27,19 @@ import { APICall, APIPromise } from "../types/async.js";
27
27
  import { Result } from "../types/fp.js";
28
28
 
29
29
  /**
30
- * Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
30
+ * Sell an RWA yield token
31
31
  *
32
32
  * @remarks
33
- * Sell (redeem) an RWA yield asset (e.g. `mTBILL`) inside the product account.
33
+ * Sell an RWA yield token, or redeem from an IXS managed vault, back to a
34
+ * stablecoin.
34
35
  *
35
- * Redeems `token_in` (a Midas RWA asset held by the Tokenized Assets Account)
36
- * directly with Midas into `token_out` (USDC). Returns an unsigned transaction
37
- * for the owner to sign, or an EIP-712 payload when `gas_sponsorship` is true.
38
- *
39
- * Instant redemption draws on Midas's on-chain liquidity and is subject to a
40
- * small redemption fee and daily limit.
36
+ * Set `token_in` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
37
+ * **vault address**. A Midas redemption is instant and settles in the same
38
+ * transaction; an IXS redemption is **asynchronous** it files a
39
+ * `requestRedeem` (`settlement: async`) the vault operator settles off-chain
40
+ * later, so poll `GET /v2/tokenized_assets/redemptions` for status. The
41
+ * transaction executes inside the product account (owner signs, or EIP-712 with
42
+ * `gas_sponsorship`).
41
43
  */
42
44
  export function tokenizedAssetsTokenizedAssetsTransactSell(
43
45
  client: CompassApiSDKCore,
@@ -27,27 +27,16 @@ import { APICall, APIPromise } from "../types/async.js";
27
27
  import { Result } from "../types/fp.js";
28
28
 
29
29
  /**
30
- * Deposit to / withdraw from a Tokenized Assets Account
30
+ * Transfer tokens to/from account
31
31
  *
32
32
  * @remarks
33
33
  * Move tokens between the owner's wallet and their Tokenized Assets Account.
34
34
  *
35
- * Use `DEPOSIT` to fund the account from the owner's wallet, or `WITHDRAW` to
36
- * send tokens from the account back to the owner. Equity orders settle in
37
- * USDC; RWA yield assets trade against USDC on Ethereum and Base.
38
- *
39
- * With `gas_sponsorship=true` the response is EIP-712 typed data the owner
40
- * signs off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the
41
- * sponsor broadcasts and pays the gas:
42
- *
43
- * - **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first
44
- * grant a one-time token->Permit2 allowance (gaslessly via
45
- * `POST /v2/gas_sponsorship/approve_transfer`).
46
- * - **WITHDRAW** returns a Safe transaction the account executes.
47
- *
48
- * With `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer
49
- * the owner broadcasts directly, and a WITHDRAW returns an unsigned Safe
50
- * `execTransaction` the owner signs and broadcasts.
35
+ * `DEPOSIT` funds the account from the owner's wallet; `WITHDRAW` sends tokens
36
+ * back. Supports gas sponsorship: with `gas_sponsorship=true` the owner signs
37
+ * EIP-712 typed data (a Permit2 permit on deposit, a product-account transaction
38
+ * on withdrawal) and a sponsor broadcasts; otherwise the owner broadcasts the
39
+ * transaction directly.
51
40
  */
52
41
  export function tokenizedAssetsTokenizedAssetsTransfer(
53
42
  client: CompassApiSDKCore,
package/src/sdk/earn.ts CHANGED
@@ -141,7 +141,7 @@ export class Earn extends ClientSDK {
141
141
  }
142
142
 
143
143
  /**
144
- * Quote a swap (read-only)
144
+ * Quote a swap
145
145
  *
146
146
  * @remarks
147
147
  * Estimate the output of a swap without building a transaction.
@@ -24,21 +24,16 @@ import { unwrapAsync } from "../types/fp.js";
24
24
 
25
25
  export class TokenizedAssets extends ClientSDK {
26
26
  /**
27
- * List tokenized asset markets
27
+ * List markets
28
28
  *
29
29
  * @remarks
30
- * List tokenized asset markets: Ondo equities and Midas RWA yield tokens.
31
- *
32
- * Each entry carries `provider` (`ondo` | `midas`), `asset_class` (`EQUITY` |
33
- * `T_BILLS` | `BASIS_TRADE` | `BTC_YIELD`), `chain`, the symbol, underlying
34
- * ticker, contract address, latest USD price, and 24h change; RWA-yield entries
35
- * add `apy_7d`/`apy_30d` and `tvl_usd`. Filter with `provider`, `asset_class`,
36
- * and `chain`, plus `category` (sector tag — equities only) or `search`
37
- * (substring match against symbol, ticker, or name).
38
- *
39
- * Equities are Ethereum-only; RWA yield tokens also list on Base — pass
40
- * `chain=base` to see them. How to trade each: `asset_class=EQUITY` →
41
- * `/quote` + `/order`; the RWA classes → `/transact/buy` + `/transact/sell`.
30
+ * List the tradable tokenized-asset catalog.
31
+ *
32
+ * Aggregates all three providers — Ondo (tokenized US equities), Midas (RWA
33
+ * yield tokens), and IXS (managed vaults) into a single list with live USD
34
+ * pricing, plus APY and TVL for yield assets. Filter by provider, asset class,
35
+ * or chain, and narrow the results with a sector `category` or free-text
36
+ * `search`.
42
37
  */
43
38
  async tokenizedAssetsMarkets(
44
39
  request: operations.V2TokenizedAssetsMarketsRequest,
@@ -52,27 +47,17 @@ export class TokenizedAssets extends ClientSDK {
52
47
  }
53
48
 
54
49
  /**
55
- * Get a single market
50
+ * Get a market
56
51
  *
57
52
  * @remarks
58
- * Get extended detail for a single tokenized market.
59
- *
60
- * Works for both asset families: an Ondo **equity** (e.g. `TSLAon`) or a
61
- * Midas **RWA yield token** (e.g. `mTBILL`). Equities add 52-week range,
62
- * volume, market cap, holder count, and tradable sessions on top of the
63
- * `/markets` fields; RWA-yield entries instead carry `apy_7d`/`apy_30d` and
64
- * `tvl_usd`.
65
- *
66
- * **OHLC candles are an equities-only feature** — opt in by passing both
67
- * `interval` and `range` query params to include a `candles` array. They
68
- * must be provided together and must form one of the supported pairs:
69
- *
70
- * - `1min` / `5min` / `15min` with `range=1day`
71
- * - `1hour` / `4hour` with `range=1month`
72
- * - `12hour` with `range=3month`
73
- * - `1day` with `range=3month` / `6month` / `1year` / `all`
74
- *
75
- * Omitting both returns the market detail without `candles`.
53
+ * Get extended detail for a single market — an Ondo **equity** (e.g. `TSLAon`), a
54
+ * Midas **RWA yield token** (e.g. `mTBILL`), or an IXS **managed vault** (e.g.
55
+ * `ixv1`).
56
+ *
57
+ * Adds richer market data on top of the `/markets` listing, plus an optional
58
+ * OHLC candle series: pass matching `interval` and `range` query params to
59
+ * include `candles` (available for equities, Midas tokens except `mBTC`, and IXS
60
+ * vaults; omit both for detail without candles).
76
61
  */
77
62
  async tokenizedAssetsMarketsSymbol(
78
63
  request: operations.V2TokenizedAssetsMarketsSymbolRequest,
@@ -86,22 +71,16 @@ export class TokenizedAssets extends ClientSDK {
86
71
  }
87
72
 
88
73
  /**
89
- * Get tokenized-asset positions for an owner
74
+ * List positions
90
75
  *
91
76
  * @remarks
92
- * Get the tokenized-asset holdings for an owner.
93
- *
94
- * Covers **both** asset families held in the account — Ondo equities and
95
- * Midas RWA yield tokens (`mTBILL`, `mBASIS`, `mBTC`). The Tokenized Assets
96
- * Account address is derived deterministically from the `owner` query param;
97
- * balances are read from that account (proceeds from equity orders and RWA
98
- * swaps both settle there). Equity positions are priced from the Ondo feed;
99
- * RWA positions are valued at the latest indexed NAV. Pass `chain=base` for
100
- * Base holdings (equities are Ethereum-only). Zero balances are omitted, and
101
- * a `total_usd` aggregate is returned across all priced positions.
102
- *
103
- * Returns 400 `ACCOUNT_NOT_DEPLOYED` if the owner has no Tokenized Assets
104
- * Account deployed yet — create one via `/create_account` first.
77
+ * Get an owner's tokenized-asset holdings, priced and aggregated.
78
+ *
79
+ * Returns positions across every asset family the account holds — Ondo equities,
80
+ * Midas RWA yield tokens, and IXS managed vaults each valued in USD (equities
81
+ * from the Ondo feed, RWA at the latest indexed NAV) with a `total_usd` total.
82
+ * The account is derived from `owner`; pass `chain` for Base (Midas) or BNB Smart
83
+ * Chain (IXS) holdings.
105
84
  */
106
85
  async tokenizedAssetsPositions(
107
86
  request: operations.V2TokenizedAssetsPositionsRequest,
@@ -115,13 +94,15 @@ export class TokenizedAssets extends ClientSDK {
115
94
  }
116
95
 
117
96
  /**
118
- * Get account balances
97
+ * Get token balances
119
98
  *
120
99
  * @remarks
121
- * Get the token balances of a Tokenized Assets Account.
100
+ * Get a Tokenized Assets Account's full token ledger.
122
101
  *
123
- * Returns each token held in the account with its current balance, USD value,
124
- * and transfer history. Pass `chain=base` for Base holdings.
102
+ * Returns every token the account has held including zero balances from fully-exited
103
+ * positions and USDC funding each with its USD value and transfer history (a
104
+ * superset of `/positions`). Pass `chain=base` or `chain=bsc` for Base or BNB Smart
105
+ * Chain holdings.
125
106
  */
126
107
  async tokenizedAssetsBalances(
127
108
  request: operations.V2TokenizedAssetsBalancesRequest,
@@ -135,22 +116,14 @@ export class TokenizedAssets extends ClientSDK {
135
116
  }
136
117
 
137
118
  /**
138
- * Get tokenized-equity order status (Ondo)
119
+ * Get order status
139
120
  *
140
121
  * @remarks
141
- * Get the lifecycle state of a submitted tokenized-**equity** order (Ondo).
142
- *
143
- * Equity-order flow only: RWA-yield trades (`/transact/buy`, `/transact/sell`)
144
- * are plain swaps that settle in a single transaction and have no order
145
- * lifecycle to poll.
122
+ * Poll the lifecycle state of a submitted equity order (Ondo).
146
123
  *
147
- * The `status` field is one of `pending`, `filled`, `expired`, or
148
- * `cancelled`. Partial fills stay in `pending` while `filled_amount` is
149
- * populated as fills come in; once an order fully fills, `fill_tx_hash`
150
- * is also returned.
151
- *
152
- * Upstream protocol states beyond these four (e.g. `partially-filled`,
153
- * `refunded`) are mapped onto this set.
124
+ * Reports `pending`, `filled`, `expired`, or `cancelled`, with fill details as
125
+ * they arrive. Equity orders only — RWA yield swaps settle in one transaction and
126
+ * have no lifecycle to poll.
154
127
  */
155
128
  async tokenizedAssetsOrderOrderHash(
156
129
  request: operations.V2TokenizedAssetsOrderOrderHashRequest,
@@ -164,21 +137,16 @@ export class TokenizedAssets extends ClientSDK {
164
137
  }
165
138
 
166
139
  /**
167
- * Get IXS vault redemption requests for an owner
140
+ * List redemption requests
168
141
  *
169
142
  * @remarks
170
- * Get an owner's IXS vault redemption requests (async redemption status).
171
- *
172
- * IXS managed-vault **sells** are asynchronous: `/transact/sell` returns a
173
- * `requestRedeem` transaction, and the vault operator settles it off-chain
174
- * later. This endpoint reconstructs the owner's requests directly from the
175
- * vault on every call (Compass persists no async state) each entry carries
176
- * its `status` (`pending` | `finalized` | `rejected`), the `shares` requested,
177
- * and, while `pending`, the `expected_net_assets` it would settle for at the
178
- * current NAV (a preview, not a guarantee).
179
- *
180
- * IXS vaults live on BNB Smart Chain — pass `chain=bsc` (the default) and the
181
- * `vault` handle (default `ixv1`).
143
+ * Get an owner's IXS managed-vault redemption requests and their status.
144
+ *
145
+ * IXS vault sells are asynchronous `/transact/sell` files a `requestRedeem`
146
+ * that the vault operator settles off-chain later. This reconstructs the owner's
147
+ * requests live from the vault (Compass stores no async state), reporting each as
148
+ * `pending`, `finalized`, or `rejected`. IXS vaults live on BNB Smart Chain
149
+ * (`chain=bsc`, vault `ixv1`).
182
150
  */
183
151
  async tokenizedAssetsRedemptions(
184
152
  request: operations.V2TokenizedAssetsRedemptionsRequest,
@@ -192,29 +160,21 @@ export class TokenizedAssets extends ClientSDK {
192
160
  }
193
161
 
194
162
  /**
195
- * Create a Tokenized Assets Account
163
+ * Create account
196
164
  *
197
165
  * @remarks
198
166
  * Create a Tokenized Assets Account for a wallet address.
199
167
  *
200
- * Required once before **either** trade flow tokenized-equity orders
201
- * (Ondo, via `/quote` + `/order`) and RWA-yield-token swaps (Midas, via
202
- * `/transact/buy` + `/transact/sell`) both settle into this one account.
203
- *
204
- * Each wallet address has one Tokenized Assets Account, isolated from the
205
- * owner's Earn, Credit, and other product accounts.
168
+ * Before trading tokenized assets, the owner must create a Tokenized Assets
169
+ * Account. Each wallet address has one Tokenized Assets Account per chain.
206
170
  *
207
- * The account address is deterministic. If it already exists, the
208
- * response returns `transaction: null` and you can skip straight to
209
- * building orders.
210
- *
211
- * Returns an unsigned transaction to create the account. The `sender`
212
- * signs and broadcasts this transaction.
171
+ * Returns an unsigned transaction to create the account. The `sender` signs
172
+ * and broadcasts this transaction.
213
173
  *
214
174
  * **If owner pays gas:** Set `sender` to the owner's address.
215
175
  *
216
- * **If someone else pays gas:** Set `sender` to the wallet that will
217
- * sign and broadcast the transaction on behalf of the owner.
176
+ * **If someone else pays gas:** Set `sender` to the wallet that will sign and
177
+ * broadcast the transaction on behalf of the owner.
218
178
  */
219
179
  async tokenizedAssetsCreateAccount(
220
180
  request: components.CreateTokenizedAssetsAccountRequest,
@@ -228,27 +188,16 @@ export class TokenizedAssets extends ClientSDK {
228
188
  }
229
189
 
230
190
  /**
231
- * Deposit to / withdraw from a Tokenized Assets Account
191
+ * Transfer tokens to/from account
232
192
  *
233
193
  * @remarks
234
194
  * Move tokens between the owner's wallet and their Tokenized Assets Account.
235
195
  *
236
- * Use `DEPOSIT` to fund the account from the owner's wallet, or `WITHDRAW` to
237
- * send tokens from the account back to the owner. Equity orders settle in
238
- * USDC; RWA yield assets trade against USDC on Ethereum and Base.
239
- *
240
- * With `gas_sponsorship=true` the response is EIP-712 typed data the owner
241
- * signs off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the
242
- * sponsor broadcasts and pays the gas:
243
- *
244
- * - **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first
245
- * grant a one-time token->Permit2 allowance (gaslessly via
246
- * `POST /v2/gas_sponsorship/approve_transfer`).
247
- * - **WITHDRAW** returns a Safe transaction the account executes.
248
- *
249
- * With `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer
250
- * the owner broadcasts directly, and a WITHDRAW returns an unsigned Safe
251
- * `execTransaction` the owner signs and broadcasts.
196
+ * `DEPOSIT` funds the account from the owner's wallet; `WITHDRAW` sends tokens
197
+ * back. Supports gas sponsorship: with `gas_sponsorship=true` the owner signs
198
+ * EIP-712 typed data (a Permit2 permit on deposit, a product-account transaction
199
+ * on withdrawal) and a sponsor broadcasts; otherwise the owner broadcasts the
200
+ * transaction directly.
252
201
  */
253
202
  async tokenizedAssetsTransfer(
254
203
  request: components.TokenizedAssetsTransferRequest,
@@ -262,33 +211,15 @@ export class TokenizedAssets extends ClientSDK {
262
211
  }
263
212
 
264
213
  /**
265
- * Preview a tokenized-equity buy/sell quote (Ondo)
214
+ * Quote an order
266
215
  *
267
216
  * @remarks
268
217
  * Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).
269
218
  *
270
- * **Equities only.** RWA yield tokens (Midas `mTBILL`, `mBASIS`, `mBTC`) are
271
- * rejected here with 422 `Wrong trade flow`; they have no auction/quote step
272
- * buy/sell them directly via `/transact/buy` & `/transact/sell`.
273
- *
274
- * Returns the input/output amounts, fees, and slippage tolerance for an order.
275
- *
276
- * Read-only: previews the quote without consuming a ``quote_id`` or
277
- * committing an order. Pair with `POST /order`:
278
- * surface this preview to the user, and on confirm pass the body plus
279
- * ``recommended_slippage_bps`` to `/order`.
280
- *
281
- * The response carries:
282
- *
283
- * - **`quote`** — input/output token amounts, fees, and an
284
- * ``est_fill_seconds`` upper bound.
285
- * - **`recommended_slippage_bps`** — system-derived slippage tolerance
286
- * that clears the current auction floor; pass back as
287
- * ``slippage_bps`` on `/order` so the build call validates against the
288
- * same floor the user was shown.
289
- * - **`auction_range_bps`** — worst-case bps gap between the auction
290
- * end amount and the reference quote amount. Use to surface a
291
- * thin-liquidity warning to the user.
219
+ * Read-only price preview: returns the expected input/output amounts and a
220
+ * system-recommended slippage tolerance to carry into `/order`. Equities only
221
+ * RWA yield tokens (Midas) have no quote step and are rejected with `422 Wrong
222
+ * trade flow`; trade them via `/transact/buy` and `/transact/sell`.
292
223
  */
293
224
  async tokenizedAssetsQuote(
294
225
  request: components.TokenizedAssetsQuoteRequest,
@@ -302,33 +233,18 @@ export class TokenizedAssets extends ClientSDK {
302
233
  }
303
234
 
304
235
  /**
305
- * Build a tokenized-equity buy/sell order (Ondo)
236
+ * Build an order
306
237
  *
307
238
  * @remarks
308
- * Build a tokenized-**equity** (Ondo) buy/sell order; maker is the product account.
309
- *
310
- * **Equities only.** RWA yield tokens (Midas — `mTBILL`, `mBASIS`, `mBTC`) are
311
- * rejected with 422 `Wrong trade flow`; trade them via `/transact/buy` &
312
- * `/transact/sell`. Equity orders are always USDC-paired (USDC→equity to buy,
313
- * equity→USDC to sell) and settle on-chain.
314
- *
315
- * Returns up to three pieces in a single round-trip:
316
- *
317
- * - **`quote`** — preview of the input/output amounts and fees.
318
- * - **`approval_safe_tx_eip712`** — only present when the account's
319
- * allowance to the settlement contract is below `amount`. The owner
320
- * signs this EIP-712 payload, then it is broadcast via
321
- * `POST /v2/gas_sponsorship/prepare` (or the owner can broadcast
322
- * directly) to set the on-chain allowance. Wait for that transaction
323
- * to confirm before signing the order.
324
- * - **`order`** — the order metadata (`order_hash`, `extension`,
325
- * `quote_id`, `order_message`) plus `safe_message_eip712`, an EIP-712
326
- * payload the owner signs off-chain to authorize the order. The
327
- * signature is submitted to `/order/submit` and is **never** broadcast
328
- * on-chain.
329
- *
330
- * The owner never broadcasts the order itself — only the (one-time)
331
- * approval transaction ever hits the chain.
239
+ * Build a tokenized-**equity** (Ondo) buy/sell order; the product account is the
240
+ * maker.
241
+ *
242
+ * Returns everything needed to place the order in one round-trip: a price quote,
243
+ * a one-time token approval to sign (only until the settlement contract is
244
+ * approved), and the order payload the owner signs off-chain. Only the approval
245
+ * ever touches the chain — the signed order is relayed to market makers, never
246
+ * broadcast. Equities only; RWA yield tokens use `/transact/buy` and
247
+ * `/transact/sell`.
332
248
  */
333
249
  async tokenizedAssetsOrder(
334
250
  request: components.TokenizedAssetsBuildOrderRequest,
@@ -342,20 +258,14 @@ export class TokenizedAssets extends ClientSDK {
342
258
  }
343
259
 
344
260
  /**
345
- * Submit a signed tokenized-equity order (Ondo)
261
+ * Submit a signed order
346
262
  *
347
263
  * @remarks
348
- * Submit a signed order for settlement.
349
- *
350
- * The body echoes the `order` fields from `/order` (`signed_order`,
351
- * `extension`, `quote_id`, optionally `order_hash`) plus the owner's
352
- * signature over `order.safe_message_eip712`. The maker on the order
353
- * struct is the Tokenized Assets Account, not the owner's wallet —
354
- * pass `signed_order` back unchanged.
264
+ * Submit a signed equity order to the market-maker network for settlement.
355
265
  *
356
- * Returns the order hash and a server-side ISO 8601 timestamp.
357
- * Subsequent calls to `GET /order/{order_hash}` track the lifecycle
358
- * (`pending` → `filled` / `expired` / `cancelled`).
266
+ * Relays the payload from `/order` plus the owner's signature, and returns the
267
+ * order hash. Poll `GET /order/{order_hash}` to track its lifecycle (`pending` →
268
+ * `filled` / `expired` / `cancelled`).
359
269
  */
360
270
  async tokenizedAssetsOrderSubmit(
361
271
  request: components.TokenizedAssetsSubmitOrderRequest,
@@ -369,20 +279,14 @@ export class TokenizedAssets extends ClientSDK {
369
279
  }
370
280
 
371
281
  /**
372
- * Cancel an unfilled tokenized-equity order (Ondo)
282
+ * Cancel an order
373
283
  *
374
284
  * @remarks
375
- * Build the EIP-712 payload to cancel an unfilled order on-chain.
285
+ * Cancel an unfilled equity order on-chain.
376
286
  *
377
- * Returns ``cancel_safe_tx_eip712``, an EIP-712 payload that authorizes
378
- * the on-chain cancellation. Sign with the Tokenized Assets Account's
379
- * owner via ``wallet.signTypedData(...)`` and relay via
380
- * ``POST /v2/gas_sponsorship/prepare`` so the sponsor broadcasts the
381
- * cancellation on the product account. The owner can also broadcast
382
- * the resulting transaction directly without using gas sponsorship.
383
- *
384
- * Cancellation works on `pending` and `expired` orders only. Only the
385
- * Tokenized Assets Account that placed the order can cancel it.
287
+ * Returns an EIP-712 payload the owner signs; a sponsor relays it, or the owner
288
+ * broadcasts it directly. Works only on `pending` or `expired` orders, and only
289
+ * the account that placed the order can cancel it.
386
290
  */
387
291
  async tokenizedAssetsOrderOrderHashCancel(
388
292
  request: operations.V2TokenizedAssetsOrderOrderHashCancelRequest,
@@ -396,17 +300,15 @@ export class TokenizedAssets extends ClientSDK {
396
300
  }
397
301
 
398
302
  /**
399
- * Charge a partner fee on a filled sell order's USDC proceeds
303
+ * Charge a partner fee
400
304
  *
401
305
  * @remarks
402
- * Build a USDC fee transfer on a filled equity sell order's proceeds.
403
- *
404
- * Equity orders fill off-chain via a third-party venue, so the fee can't be
405
- * bundled into the trade. Once the sell order has filled, call this with the
406
- * order hash and your `fee` (recipient + percentage/fixed); it reads the actual
407
- * filled USDC proceeds and returns a `transfer(recipient, fee)` executed by the
408
- * product account — an unsigned transaction the owner signs, or an EIP-712
409
- * payload when `gas_sponsorship` is true.
306
+ * Charge a partner fee on a filled equity sell order's USDC proceeds.
307
+ *
308
+ * Equity orders settle off-chain, so fees can't be bundled into the trade call
309
+ * this after a sell fills and it builds a USDC transfer of your `fee` from the
310
+ * actual proceeds, executed by the product account (owner signs, or EIP-712 with
311
+ * `gas_sponsorship`).
410
312
  */
411
313
  async tokenizedAssetsOrderOrderHashChargeFee(
412
314
  request: operations.V2TokenizedAssetsOrderOrderHashChargeFeeRequest,
@@ -420,20 +322,18 @@ export class TokenizedAssets extends ClientSDK {
420
322
  }
421
323
 
422
324
  /**
423
- * Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
325
+ * Buy an RWA yield token
424
326
  *
425
327
  * @remarks
426
- * Buy (mint) an RWA yield asset (e.g. `mTBILL`) inside the product account.
427
- *
428
- * Mints `token_out` directly from Midas with `token_in` (a stablecoin already
429
- * held by the Tokenized Assets Account fund it with a plain transfer first).
430
- * `token_in` must be a payment token the Midas issuance vault accepts (USDC on
431
- * every supported network; mBASIS also accepts USDT/DAI on Ethereum). Returns
432
- * an unsigned transaction for the owner to sign, or an EIP-712 payload when
433
- * `gas_sponsorship` is true.
434
- *
435
- * `token_out` must be a Midas RWA asset; equities trade via the order
436
- * endpoints (`/quote`, `/order`, `/order/submit`).
328
+ * Buy an RWA yield token, or deposit into an IXS managed vault, with a stablecoin
329
+ * in one transaction.
330
+ *
331
+ * Set `token_out` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
332
+ * **vault address** (its shares aren't a registered symbol). The account spends
333
+ * a stablecoin it already holds (fund it with a plain transfer first) and
334
+ * settles inside the product account — an unsigned transaction the owner signs,
335
+ * or EIP-712 with `gas_sponsorship`. Both paths are instant. Equities use the
336
+ * order flow (`/quote`, `/order`).
437
337
  */
438
338
  async tokenizedAssetsTransactBuy(
439
339
  request: components.TokenizedAssetsTradeRequest,
@@ -447,17 +347,19 @@ export class TokenizedAssets extends ClientSDK {
447
347
  }
448
348
 
449
349
  /**
450
- * Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
350
+ * Sell an RWA yield token
451
351
  *
452
352
  * @remarks
453
- * Sell (redeem) an RWA yield asset (e.g. `mTBILL`) inside the product account.
454
- *
455
- * Redeems `token_in` (a Midas RWA asset held by the Tokenized Assets Account)
456
- * directly with Midas into `token_out` (USDC). Returns an unsigned transaction
457
- * for the owner to sign, or an EIP-712 payload when `gas_sponsorship` is true.
458
- *
459
- * Instant redemption draws on Midas's on-chain liquidity and is subject to a
460
- * small redemption fee and daily limit.
353
+ * Sell an RWA yield token, or redeem from an IXS managed vault, back to a
354
+ * stablecoin.
355
+ *
356
+ * Set `token_in` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
357
+ * **vault address**. A Midas redemption is instant and settles in the same
358
+ * transaction; an IXS redemption is **asynchronous** — it files a
359
+ * `requestRedeem` (`settlement: async`) the vault operator settles off-chain
360
+ * later, so poll `GET /v2/tokenized_assets/redemptions` for status. The
361
+ * transaction executes inside the product account (owner signs, or EIP-712 with
362
+ * `gas_sponsorship`).
461
363
  */
462
364
  async tokenizedAssetsTransactSell(
463
365
  request: components.TokenizedAssetsTradeRequest,