@compass-labs/api-sdk 2.2.45 → 2.2.46-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 (229) hide show
  1. package/README.md +16 -18
  2. package/codeSamples_typescript.yaml +0 -6
  3. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +12 -8
  4. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
  5. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +12 -8
  6. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
  7. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +8 -3
  8. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
  9. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +8 -3
  10. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
  11. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +16 -2
  12. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  13. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +22 -3
  14. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  15. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +17 -16
  16. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
  17. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js +17 -16
  18. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
  19. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +9 -5
  20. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
  21. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +9 -5
  22. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
  23. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +10 -12
  24. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
  25. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +10 -12
  26. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
  27. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +10 -11
  28. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
  29. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +10 -11
  30. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
  31. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +10 -5
  32. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
  33. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js +10 -5
  34. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
  35. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +4 -4
  36. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +1 -1
  37. package/dist/commonjs/models/components/index.d.ts +2 -1
  38. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  39. package/dist/commonjs/models/components/index.js +2 -1
  40. package/dist/commonjs/models/components/index.js.map +1 -1
  41. package/dist/commonjs/models/components/marketdetail.d.ts +10 -5
  42. package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/marketdetail.js +3 -1
  44. package/dist/commonjs/models/components/marketdetail.js.map +1 -1
  45. package/dist/commonjs/models/components/ohlccandle.d.ts +1 -1
  46. package/dist/commonjs/models/components/orderstatus.d.ts +8 -8
  47. package/dist/commonjs/models/components/orderstatus.js +1 -1
  48. package/dist/commonjs/models/components/ordertosign.d.ts +9 -10
  49. package/dist/commonjs/models/components/ordertosign.d.ts.map +1 -1
  50. package/dist/commonjs/models/components/ordertosign.js.map +1 -1
  51. package/dist/commonjs/models/components/quote.d.ts +2 -2
  52. package/dist/commonjs/models/components/quotefee.d.ts +2 -2
  53. package/dist/commonjs/models/components/tokenizedassetsbuildorderrequest.d.ts +3 -3
  54. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.d.ts +7 -8
  55. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.d.ts.map +1 -1
  56. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.js.map +1 -1
  57. package/dist/commonjs/models/components/tokenizedassetscancelorderrequest.d.ts +1 -1
  58. package/dist/commonjs/models/components/tokenizedassetsohlcinterval.d.ts +15 -0
  59. package/dist/commonjs/models/components/tokenizedassetsohlcinterval.d.ts.map +1 -0
  60. package/dist/commonjs/models/components/{tokenizedassetsohlcresponse.js → tokenizedassetsohlcinterval.js} +12 -13
  61. package/dist/commonjs/models/components/tokenizedassetsohlcinterval.js.map +1 -0
  62. package/dist/commonjs/models/components/tokenizedassetsohlcrange.d.ts +14 -0
  63. package/dist/commonjs/models/components/tokenizedassetsohlcrange.d.ts.map +1 -0
  64. package/dist/commonjs/models/{operations/v2tokenizedassetsmarketssymbolohlc.js → components/tokenizedassetsohlcrange.js} +2 -29
  65. package/dist/commonjs/models/components/tokenizedassetsohlcrange.js.map +1 -0
  66. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.d.ts +8 -10
  67. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.d.ts.map +1 -1
  68. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.js.map +1 -1
  69. package/dist/commonjs/models/operations/index.d.ts +0 -1
  70. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  71. package/dist/commonjs/models/operations/index.js +0 -1
  72. package/dist/commonjs/models/operations/index.js.map +1 -1
  73. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts +11 -0
  74. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
  75. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js +5 -0
  76. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
  77. package/dist/commonjs/sdk/tokenizedassets.d.ts +98 -78
  78. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  79. package/dist/commonjs/sdk/tokenizedassets.js +98 -81
  80. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  81. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +12 -8
  82. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
  83. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +12 -8
  84. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
  85. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +8 -3
  86. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
  87. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +8 -3
  88. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
  89. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +16 -2
  90. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  91. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +23 -4
  92. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  93. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +17 -16
  94. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
  95. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js +17 -16
  96. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
  97. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +9 -5
  98. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
  99. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +9 -5
  100. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
  101. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +10 -12
  102. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
  103. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +10 -12
  104. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
  105. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +10 -11
  106. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
  107. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +10 -11
  108. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
  109. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +10 -5
  110. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
  111. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js +10 -5
  112. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
  113. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +4 -4
  114. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +1 -1
  115. package/dist/esm/models/components/index.d.ts +2 -1
  116. package/dist/esm/models/components/index.d.ts.map +1 -1
  117. package/dist/esm/models/components/index.js +2 -1
  118. package/dist/esm/models/components/index.js.map +1 -1
  119. package/dist/esm/models/components/marketdetail.d.ts +10 -5
  120. package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
  121. package/dist/esm/models/components/marketdetail.js +3 -1
  122. package/dist/esm/models/components/marketdetail.js.map +1 -1
  123. package/dist/esm/models/components/ohlccandle.d.ts +1 -1
  124. package/dist/esm/models/components/orderstatus.d.ts +8 -8
  125. package/dist/esm/models/components/orderstatus.js +1 -1
  126. package/dist/esm/models/components/ordertosign.d.ts +9 -10
  127. package/dist/esm/models/components/ordertosign.d.ts.map +1 -1
  128. package/dist/esm/models/components/ordertosign.js.map +1 -1
  129. package/dist/esm/models/components/quote.d.ts +2 -2
  130. package/dist/esm/models/components/quotefee.d.ts +2 -2
  131. package/dist/esm/models/components/tokenizedassetsbuildorderrequest.d.ts +3 -3
  132. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.d.ts +7 -8
  133. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.d.ts.map +1 -1
  134. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.js.map +1 -1
  135. package/dist/esm/models/components/tokenizedassetscancelorderrequest.d.ts +1 -1
  136. package/dist/esm/models/components/tokenizedassetsohlcinterval.d.ts +15 -0
  137. package/dist/esm/models/components/tokenizedassetsohlcinterval.d.ts.map +1 -0
  138. package/dist/esm/models/components/tokenizedassetsohlcinterval.js +16 -0
  139. package/dist/esm/models/components/tokenizedassetsohlcinterval.js.map +1 -0
  140. package/dist/esm/models/components/tokenizedassetsohlcrange.d.ts +14 -0
  141. package/dist/esm/models/components/tokenizedassetsohlcrange.d.ts.map +1 -0
  142. package/dist/esm/models/components/tokenizedassetsohlcrange.js +15 -0
  143. package/dist/esm/models/components/tokenizedassetsohlcrange.js.map +1 -0
  144. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.d.ts +8 -10
  145. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.d.ts.map +1 -1
  146. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.js.map +1 -1
  147. package/dist/esm/models/operations/index.d.ts +0 -1
  148. package/dist/esm/models/operations/index.d.ts.map +1 -1
  149. package/dist/esm/models/operations/index.js +0 -1
  150. package/dist/esm/models/operations/index.js.map +1 -1
  151. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts +11 -0
  152. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
  153. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js +5 -0
  154. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
  155. package/dist/esm/sdk/tokenizedassets.d.ts +98 -78
  156. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  157. package/dist/esm/sdk/tokenizedassets.js +98 -81
  158. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  159. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +2 -2
  160. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarketchain.md +1 -1
  161. package/docs/models/components/marketdetail.md +24 -23
  162. package/docs/models/components/marketdetailchain.md +1 -1
  163. package/docs/models/components/ohlccandle.md +1 -1
  164. package/docs/models/components/orderstatus.md +9 -9
  165. package/docs/models/components/ordertosign.md +12 -13
  166. package/docs/models/components/quote.md +6 -6
  167. package/docs/models/components/quotefee.md +2 -2
  168. package/docs/models/components/status.md +1 -1
  169. package/docs/models/components/tokenizedassetsbuildorderrequest.md +8 -8
  170. package/docs/models/components/tokenizedassetsbuildorderresponse.md +6 -6
  171. package/docs/models/components/tokenizedassetscancelorderrequest.md +3 -3
  172. package/docs/models/{operations → components}/tokenizedassetsohlcinterval.md +2 -4
  173. package/docs/models/{operations → components}/tokenizedassetsohlcrange.md +2 -4
  174. package/docs/models/components/tokenizedassetssubmitorderrequest.md +11 -13
  175. package/docs/models/operations/v2tokenizedassetsmarketssymbolrequest.md +5 -3
  176. package/docs/sdks/tokenizedassets/README.md +92 -146
  177. package/package.json +1 -1
  178. package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts +12 -8
  179. package/src/funcs/tokenizedAssetsTokenizedAssetsMarkets.ts +8 -3
  180. package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts +24 -4
  181. package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts +17 -16
  182. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts +9 -5
  183. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts +10 -12
  184. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts +10 -11
  185. package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts +10 -5
  186. package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +4 -4
  187. package/src/models/components/index.ts +2 -1
  188. package/src/models/components/marketdetail.ts +11 -5
  189. package/src/models/components/ohlccandle.ts +1 -1
  190. package/src/models/components/orderstatus.ts +8 -8
  191. package/src/models/components/ordertosign.ts +9 -10
  192. package/src/models/components/quote.ts +2 -2
  193. package/src/models/components/quotefee.ts +2 -2
  194. package/src/models/components/tokenizedassetsbuildorderrequest.ts +3 -3
  195. package/src/models/components/tokenizedassetsbuildorderresponse.ts +7 -8
  196. package/src/models/components/tokenizedassetscancelorderrequest.ts +1 -1
  197. package/src/models/components/tokenizedassetsohlcinterval.ts +24 -0
  198. package/src/models/components/tokenizedassetsohlcrange.ts +23 -0
  199. package/src/models/components/tokenizedassetssubmitorderrequest.ts +8 -10
  200. package/src/models/operations/index.ts +0 -1
  201. package/src/models/operations/v2tokenizedassetsmarketssymbol.ts +15 -0
  202. package/src/sdk/tokenizedassets.ts +98 -89
  203. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts +0 -22
  204. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts.map +0 -1
  205. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js +0 -133
  206. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js.map +0 -1
  207. package/dist/commonjs/models/components/tokenizedassetsohlcresponse.d.ts +0 -25
  208. package/dist/commonjs/models/components/tokenizedassetsohlcresponse.d.ts.map +0 -1
  209. package/dist/commonjs/models/components/tokenizedassetsohlcresponse.js.map +0 -1
  210. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts +0 -58
  211. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts.map +0 -1
  212. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbolohlc.js.map +0 -1
  213. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts +0 -22
  214. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts.map +0 -1
  215. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js +0 -97
  216. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js.map +0 -1
  217. package/dist/esm/models/components/tokenizedassetsohlcresponse.d.ts +0 -25
  218. package/dist/esm/models/components/tokenizedassetsohlcresponse.d.ts.map +0 -1
  219. package/dist/esm/models/components/tokenizedassetsohlcresponse.js +0 -16
  220. package/dist/esm/models/components/tokenizedassetsohlcresponse.js.map +0 -1
  221. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts +0 -58
  222. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts.map +0 -1
  223. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.js +0 -41
  224. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.js.map +0 -1
  225. package/docs/models/components/tokenizedassetsohlcresponse.md +0 -31
  226. package/docs/models/operations/v2tokenizedassetsmarketssymbolohlcrequest.md +0 -21
  227. package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.ts +0 -196
  228. package/src/models/components/tokenizedassetsohlcresponse.ts +0 -48
  229. package/src/models/operations/v2tokenizedassetsmarketssymbolohlc.ts +0 -95
@@ -4,7 +4,6 @@
4
4
  import { tokenizedAssetsTokenizedAssetsCreateAccount } from "../funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js";
5
5
  import { tokenizedAssetsTokenizedAssetsMarkets } from "../funcs/tokenizedAssetsTokenizedAssetsMarkets.js";
6
6
  import { tokenizedAssetsTokenizedAssetsMarketsSymbol } from "../funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js";
7
- import { tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc } from "../funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js";
8
7
  import { tokenizedAssetsTokenizedAssetsOrder } from "../funcs/tokenizedAssetsTokenizedAssetsOrder.js";
9
8
  import { tokenizedAssetsTokenizedAssetsOrderOrderHash } from "../funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js";
10
9
  import { tokenizedAssetsTokenizedAssetsOrderOrderHashCancel } from "../funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js";
@@ -17,145 +16,163 @@ export class TokenizedAssets extends ClientSDK {
17
16
  * List tokenized equity markets
18
17
  *
19
18
  * @remarks
20
- * List tokenized equities surfaced on Ethereum.
19
+ * List the tokenized US equities available on Ethereum.
21
20
  *
22
- * Composed from Ondo's metadata + enhanced-prices feeds. Non-Ethereum-only
23
- * assets (BSC/Solana deployments without an Ethereum twin) are skipped.
21
+ * Each entry includes the symbol, the underlying ticker, the on-chain
22
+ * contract address, the latest USD price, and 24h price change. Filter
23
+ * by `category` (sector tag) or `search` (substring match against symbol,
24
+ * ticker, or name).
25
+ *
26
+ * Only Ethereum-deployed tokens are returned; assets that exist only on
27
+ * other chains are omitted.
24
28
  */
25
29
  async tokenizedAssetsMarkets(request, options) {
26
30
  return unwrapAsync(tokenizedAssetsTokenizedAssetsMarkets(this, request, options));
27
31
  }
28
32
  /**
29
- * Get a single tokenized market
33
+ * Get a single market
30
34
  *
31
35
  * @remarks
32
- * Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
36
+ * Get extended detail for a single tokenized equity (e.g. `TSLAon`).
37
+ *
38
+ * Includes 52-week range, volume, market cap, holder count, and tradable
39
+ * sessions in addition to the fields returned by `/markets`.
40
+ *
41
+ * **OHLC candles** are opt-in: pass both `interval` and `range` query
42
+ * params to include a `candles` array in the response. They must be
43
+ * provided together and must form one of the supported pairs:
44
+ *
45
+ * - `1min` / `5min` / `15min` with `range=1day`
46
+ * - `1hour` / `4hour` with `range=1month`
47
+ * - `12hour` with `range=3month`
48
+ * - `1day` with `range=3month` / `6month` / `1year` / `all`
49
+ *
50
+ * Omitting both returns the market detail without `candles`.
33
51
  */
34
52
  async tokenizedAssetsMarketsSymbol(request, options) {
35
53
  return unwrapAsync(tokenizedAssetsTokenizedAssetsMarketsSymbol(this, request, options));
36
54
  }
37
55
  /**
38
- * Get OHLC candles for a market
56
+ * Get tokenized-asset positions for a wallet
39
57
  *
40
58
  * @remarks
41
- * OHLC candles for the given Ondo symbol.
42
- *
43
- * `interval` + `range` must form one of the closed Ondo pairs (see request
44
- * model docstring); invalid pairs return 400.
45
- */
46
- async tokenizedAssetsMarketsSymbolOhlc(request, options) {
47
- return unwrapAsync(tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc(this, request, options));
48
- }
49
- /**
50
- * Get on-chain tokenized-asset positions for a wallet
59
+ * Get the tokenized-asset holdings for a wallet.
51
60
  *
52
- * @remarks
53
- * On-chain ERC-20 balance reads for a wallet across all listed Ondo GM tokens.
61
+ * Returns the balance of every listed tokenized equity at the queried
62
+ * address, plus the latest USD price and a USD-valued balance when
63
+ * pricing is available. Zero balances are omitted, and a `total_usd`
64
+ * aggregate is returned across all priced positions.
54
65
  *
55
- * Reads each Ethereum-deployed Ondo GM token's `balanceOf(wallet)` via a
56
- * single Multicall3 batch and enriches non-zero balances with the latest USD
57
- * price. Returns human-readable amounts (decimals applied).
66
+ * Pass the **Tokenized Assets Account address** (returned by
67
+ * `/create_account`), not the owner's wallet proceeds from filled
68
+ * orders settle into the Tokenized Assets Account.
58
69
  */
59
70
  async tokenizedAssetsPositions(request, options) {
60
71
  return unwrapAsync(tokenizedAssetsTokenizedAssetsPositions(this, request, options));
61
72
  }
62
73
  /**
63
- * Get tokenized-asset order status
74
+ * Get order status
64
75
  *
65
76
  * @remarks
66
- * Status of a relayed Fusion order — `pending` / `filled` / `expired` / `cancelled`.
77
+ * Get the lifecycle state of a submitted order.
67
78
  *
68
- * Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) are
69
- * collapsed into the 4-value enum the SDK promises. Unknown upstream states
70
- * surface as 502 to alert on schema drift.
79
+ * The `status` field is one of `pending`, `filled`, `expired`, or
80
+ * `cancelled`. Partial fills stay in `pending` while `filled_amount` is
81
+ * populated as fills come in; once an order fully fills, `fill_tx_hash`
82
+ * is also returned.
83
+ *
84
+ * Upstream protocol states beyond these four (e.g. `partially-filled`,
85
+ * `refunded`) are mapped onto this set.
71
86
  */
72
87
  async tokenizedAssetsOrderOrderHash(request, options) {
73
88
  return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderOrderHash(this, request, options));
74
89
  }
75
90
  /**
76
- * Create tokenized assets account
91
+ * Create a Tokenized Assets Account
77
92
  *
78
93
  * @remarks
79
94
  * Create a Tokenized Assets Account for a wallet address.
80
95
  *
81
- * Each wallet address has one Tokenized Assets Account per chain. It is owned by
82
- * `owner` and isolated from the owner's Earn, Credit, and Traditional Investing
83
- * accounts.
96
+ * Before placing orders, the owner must create a Tokenized Assets Account.
97
+ * Each wallet address has one Tokenized Assets Account, isolated from the
98
+ * owner's Earn, Credit, and other product accounts.
99
+ *
100
+ * The account address is deterministic. If it already exists, the
101
+ * response returns `transaction: null` and you can skip straight to
102
+ * building orders.
84
103
  *
85
- * Returns an unsigned transaction to create the account. The `sender` signs and
86
- * broadcasts this transaction.
104
+ * Returns an unsigned transaction to create the account. The `sender`
105
+ * signs and broadcasts this transaction.
87
106
  *
88
107
  * **If owner pays gas:** Set `sender` to the owner's address.
89
108
  *
90
- * **If someone else pays gas:** Set `sender` to the wallet that will sign and
91
- * broadcast the transaction on behalf of the owner.
109
+ * **If someone else pays gas:** Set `sender` to the wallet that will
110
+ * sign and broadcast the transaction on behalf of the owner.
92
111
  */
93
112
  async tokenizedAssetsCreateAccount(request, options) {
94
113
  return unwrapAsync(tokenizedAssetsTokenizedAssetsCreateAccount(this, request, options));
95
114
  }
96
115
  /**
97
- * Build a tokenized-asset buy/sell order
116
+ * Build a buy/sell order
98
117
  *
99
118
  * @remarks
100
- * Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
101
- *
102
- * Returns everything the SDK needs to take an `owner` from "I want to buy"
103
- * to a relayed Fusion order whose maker is the Tokenized Assets Account.
104
- * The flow is **signing-based, not transaction-based**:
105
- *
106
- * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
107
- * insufficient), sign it with `wallet.signTypedData(...)` and relay via
108
- * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
109
- * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
110
- * to confirm before signing the order.
111
- * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
112
- * a Safe ERC-1271 wrapper around the Fusion order hash. POST the
113
- * resulting 65-byte ECDSA together with the rest of the `order` fields
114
- * to `/order/submit`.
115
- *
116
- * The owner never broadcasts an on-chain transaction in this flow; all
117
- * on-chain action goes through the product account via the sponsor relay.
119
+ * Build a buy or sell order whose maker is the Tokenized Assets Account.
120
+ *
121
+ * Returns up to three pieces in a single round-trip:
122
+ *
123
+ * - **`quote`** preview of the input/output amounts and fees.
124
+ * - **`approval_safe_tx_eip712`** — only present when the account's
125
+ * allowance to the settlement contract is below `amount`. The owner
126
+ * signs this EIP-712 payload, then it is broadcast via
127
+ * `POST /v2/gas_sponsorship/prepare` (or the owner can broadcast
128
+ * directly) to set the on-chain allowance. Wait for that transaction
129
+ * to confirm before signing the order.
130
+ * - **`order`** the order metadata (`order_hash`, `extension`,
131
+ * `quote_id`, `order_message`) plus `safe_message_eip712`, an EIP-712
132
+ * payload the owner signs off-chain to authorize the order. The
133
+ * signature is submitted to `/order/submit` and is **never** broadcast
134
+ * on-chain.
135
+ *
136
+ * The owner never broadcasts the order itself only the (one-time)
137
+ * approval transaction ever hits the chain.
118
138
  */
119
139
  async tokenizedAssetsOrder(request, options) {
120
140
  return unwrapAsync(tokenizedAssetsTokenizedAssetsOrder(this, request, options));
121
141
  }
122
142
  /**
123
- * Submit a signed tokenized-asset order to 1inch Fusion
143
+ * Submit a signed order
124
144
  *
125
145
  * @remarks
126
- * Relay an owner-signed Fusion order to the 1inch relayer.
127
- *
128
- * The body carries the signature produced by
129
- * `wallet.signTypedData(order.safe_message_eip712)` from the `/order`
130
- * response, plus the order struct (`signed_order`), opaque `extension`,
131
- * and `quote_id`. The signature is validated via ERC-1271
132
- * (`Safe.isValidSignature`) at fill time — the maker on the order struct
133
- * is the Tokenized Assets Account, not the EOA owner.
134
- *
135
- * Returns the order hash and a server-side timestamp. Subsequent calls to
136
- * `GET /order/{order_hash}` track lifecycle (`pending` → `filled` /
137
- * `expired` / `cancelled`).
146
+ * Submit a signed order to the resolver network.
147
+ *
148
+ * The body echoes the `order` fields from `/order` (`signed_order`,
149
+ * `extension`, `quote_id`, optionally `order_hash`) plus the owner's
150
+ * signature over `order.safe_message_eip712`. The maker on the order
151
+ * struct is the Tokenized Assets Account, not the owner's wallet —
152
+ * pass `signed_order` back unchanged.
153
+ *
154
+ * Returns the order hash and a server-side ISO 8601 timestamp.
155
+ * Subsequent calls to `GET /order/{order_hash}` track the lifecycle
156
+ * (`pending` → `filled` / `expired` / `cancelled`).
138
157
  */
139
158
  async tokenizedAssetsOrderSubmit(request, options) {
140
159
  return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderSubmit(this, request, options));
141
160
  }
142
161
  /**
143
- * Cancel an unfilled tokenized-asset order
162
+ * Cancel an unfilled order
144
163
  *
145
164
  * @remarks
146
- * Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
147
- *
148
- * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
149
- * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
150
- * Sign with the Tokenized Assets Account's owner via
151
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
152
- * so the sponsor broadcasts ``execTransaction`` on the product account
153
- * (the order's maker). The owner can also broadcast ``execTransaction``
154
- * directly if not using gas sponsorship.
155
- *
156
- * Authorization is on the *predicted* Safe address: the Tokenized Assets
157
- * Account computed from ``owner`` must match the order's on-chain maker.
158
- * Mismatches return 403 ``OWNER_NOT_MAKER`` before any on-chain reads.
165
+ * Build the EIP-712 payload to cancel an unfilled order on-chain.
166
+ *
167
+ * Returns ``cancel_safe_tx_eip712``, an EIP-712 payload that authorizes
168
+ * the on-chain cancellation. Sign with the Tokenized Assets Account's
169
+ * owner via ``wallet.signTypedData(...)`` and relay via
170
+ * ``POST /v2/gas_sponsorship/prepare`` so the sponsor broadcasts the
171
+ * cancellation on the product account. The owner can also broadcast
172
+ * the resulting transaction directly without using gas sponsorship.
173
+ *
174
+ * Cancellation works on `pending` and `expired` orders only. Only the
175
+ * Tokenized Assets Account that placed the order can cancel it.
159
176
  */
160
177
  async tokenizedAssetsOrderOrderHashCancel(request, options) {
161
178
  return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderOrderHashCancel(this, request, options));
@@ -1 +1 @@
1
- {"version":3,"file":"tokenizedassets.js","sourceRoot":"","sources":["../../../src/sdk/tokenizedassets.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,qCAAqC,EAAE,MAAM,mDAAmD,CAAC;AAC1G,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,+CAA+C,EAAE,MAAM,6DAA6D,CAAC;AAC9H,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,kDAAkD,EAAE,MAAM,gEAAgE,CAAC;AACpI,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,qCAAqC,CACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAA6D,EAC7D,OAAwB;QAExB,OAAO,WAAW,CAAC,+CAA+C,CAChE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,uCAAuC,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAA0D,EAC1D,OAAwB;QAExB,OAAO,WAAW,CAAC,4CAA4C,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,yCAAyC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,mCAAmC,CACvC,OAAgE,EAChE,OAAwB;QAExB,OAAO,WAAW,CAAC,kDAAkD,CACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"tokenizedassets.js","sourceRoot":"","sources":["../../../src/sdk/tokenizedassets.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,qCAAqC,EAAE,MAAM,mDAAmD,CAAC;AAC1G,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,kDAAkD,EAAE,MAAM,gEAAgE,CAAC;AACpI,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,qCAAqC,CACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,uCAAuC,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAA0D,EAC1D,OAAwB;QAExB,OAAO,WAAW,CAAC,4CAA4C,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,yCAAyC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,mCAAmC,CACvC,OAAgE,EAChE,OAAwB;QAExB,OAAO,WAAW,CAAC,kDAAkD,CACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -27,9 +27,9 @@ let value: CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
27
27
  | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
28
28
  | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
29
29
  | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
30
- | `chain` | [components.CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain](../../models/components/compassapibackendv2modelstokenizedassetsmarketmarketchain.md) | :heavy_minus_sign: | Chain on which the surfaced contract is deployed. | ethereum |
30
+ | `chain` | [components.CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain](../../models/components/compassapibackendv2modelstokenizedassetsmarketmarketchain.md) | :heavy_minus_sign: | Chain on which the contract is deployed. | ethereum |
31
31
  | `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address for this token. | |
32
- | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals on the surfaced chain. | |
32
+ | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
33
33
  | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
34
34
  | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
35
35
  | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
@@ -1,6 +1,6 @@
1
1
  # CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain
2
2
 
3
- Chain on which the surfaced contract is deployed.
3
+ Chain on which the contract is deployed.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -24,26 +24,27 @@ let value: MarketDetail = {
24
24
 
25
25
  ## Fields
26
26
 
27
- | Field | Type | Required | Description | Example |
28
- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
29
- | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
30
- | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
31
- | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
32
- | `chain` | [components.MarketDetailChain](../../models/components/marketdetailchain.md) | :heavy_minus_sign: | Chain on which the surfaced contract is deployed. | ethereum |
33
- | `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address for this token. | |
34
- | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals on the surfaced chain. | |
35
- | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
36
- | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
37
- | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
38
- | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
39
- | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
40
- | `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline (sampled timestamps, descending or ascending). | [] |
41
- | `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
42
- | `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
43
- | `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
44
- | `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
45
- | `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
46
- | `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
47
- | `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized asset. | |
48
- | `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
49
- | `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
27
+ | Field | Type | Required | Description | Example |
28
+ | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
29
+ | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
30
+ | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
31
+ | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
32
+ | `chain` | [components.MarketDetailChain](../../models/components/marketdetailchain.md) | :heavy_minus_sign: | Chain on which the contract is deployed. | ethereum |
33
+ | `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address for this token. | |
34
+ | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
35
+ | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
36
+ | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
37
+ | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
38
+ | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
39
+ | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
40
+ | `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline as `(timestamp, price)` samples in chronological order. | [] |
41
+ | `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
42
+ | `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
43
+ | `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
44
+ | `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
45
+ | `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
46
+ | `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
47
+ | `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized asset. | |
48
+ | `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
49
+ | `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
50
+ | `candles` | [components.OhlcCandle](../../models/components/ohlccandle.md)[] | :heavy_minus_sign: | OHLC candles. Present only when both `interval` and `range` query params are provided and form a valid pair; omitted otherwise. | |
@@ -1,6 +1,6 @@
1
1
  # MarketDetailChain
2
2
 
3
- Chain on which the surfaced contract is deployed.
3
+ Chain on which the contract is deployed.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -1,6 +1,6 @@
1
1
  # OhlcCandle
2
2
 
3
- A single OHLC candle. Note: Ondo does not return per-candle volume.
3
+ A single OHLC candle. Per-candle volume is not provided.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -16,12 +16,12 @@ let value: OrderStatus = {
16
16
 
17
17
  ## Fields
18
18
 
19
- | Field | Type | Required | Description |
20
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | `orderHash` | *string* | :heavy_check_mark: | On-chain order hash. |
22
- | `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum. |
23
- | `fillTxHash` | *string* | :heavy_minus_sign: | Tx hash of the most recent resolver fill (populated when filled or partially filled). |
24
- | `fillPriceUsd` | *string* | :heavy_minus_sign: | 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. |
25
- | `filledAmount` | *string* | :heavy_minus_sign: | Sum of base-unit amounts filled so far. Populated for partial fills while `status` is still `pending`, and for fully filled orders. |
26
- | `submittedAt` | *string* | :heavy_minus_sign: | ISO 8601 UTC timestamp of order submission. |
27
- | `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 UTC timestamp of this status read. |
19
+ | Field | Type | Required | Description |
20
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `orderHash` | *string* | :heavy_check_mark: | On-chain order hash. |
22
+ | `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | 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. |
23
+ | `fillTxHash` | *string* | :heavy_minus_sign: | Transaction hash of the most recent fill. Populated for fully filled orders and for partial fills while `status` is still `pending`. |
24
+ | `fillPriceUsd` | *string* | :heavy_minus_sign: | 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. |
25
+ | `filledAmount` | *string* | :heavy_minus_sign: | 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. |
26
+ | `submittedAt` | *string* | :heavy_minus_sign: | ISO 8601 UTC timestamp at which the order was submitted. |
27
+ | `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 UTC timestamp at which this status was read. |
@@ -1,12 +1,11 @@
1
1
  # OrderToSign
2
2
 
3
- Fusion order metadata bundled with the SafeMessage EIP-712 to sign.
3
+ Order metadata plus the EIP-712 payload the owner signs to authorize it.
4
4
 
5
- The owner signs ``safe_message_eip712`` (a `SafeMessage(bytes message)`
6
- payload wrapping ``order_hash`` for ERC-1271). At submit time the SDK
7
- relays the resulting 65-byte ECDSA together with ``order_message``,
8
- ``extension``, and ``quote_id`` so 1inch's relayer can broadcast the
9
- order; resolvers fill it via ``Safe.isValidSignature``.
5
+ The owner signs ``safe_message_eip712`` off-chain. At submit time the
6
+ signature is sent back to ``/order/submit`` together with
7
+ ``order_message``, ``extension``, and ``quote_id``; resolvers validate
8
+ the signature against the Tokenized Assets Account at fill time.
10
9
 
11
10
  ## Example Usage
12
11
 
@@ -46,10 +45,10 @@ let value: OrderToSign = {
46
45
 
47
46
  ## Fields
48
47
 
49
- | Field | Type | Required | Description |
50
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51
- | `orderHash` | *string* | :heavy_check_mark: | 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. |
52
- | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from 1inch — pass back to `/order/submit` unchanged. |
53
- | `quoteId` | *string* | :heavy_check_mark: | 1inch quote identifier — must be echoed back at `/order/submit`. |
54
- | `orderMessage` | Record<string, *any*> | :heavy_check_mark: | Fusion order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. Maker is the Tokenized Assets Account, not the EOA owner. |
55
- | `safeMessageEip712` | [components.SafeMessageEip712Response](../../models/components/safemessageeip712response.md) | :heavy_check_mark: | ``signTypedData`` payload for ``SafeMessage(bytes message)``. |
48
+ | Field | Type | Required | Description |
49
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
+ | `orderHash` | *string* | :heavy_check_mark: | 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. |
51
+ | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from the upstream quote — pass back to `/order/submit` unchanged. |
52
+ | `quoteId` | *string* | :heavy_check_mark: | Upstream quote identifier — must be echoed back at `/order/submit`. |
53
+ | `orderMessage` | Record<string, *any*> | :heavy_check_mark: | Order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. The maker is the Tokenized Assets Account, not the owner's wallet. |
54
+ | `safeMessageEip712` | [components.SafeMessageEip712Response](../../models/components/safemessageeip712response.md) | :heavy_check_mark: | ``signTypedData`` payload for ``SafeMessage(bytes message)``. |
@@ -25,9 +25,9 @@ let value: Quote = {
25
25
 
26
26
  ## Fields
27
27
 
28
- | Field | Type | Required | Description |
29
- | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
30
- | `input` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
31
- | `output` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
32
- | `fee` | [components.QuoteFee](../../models/components/quotefee.md) | :heavy_check_mark: | Aggregate fee charged by the Fusion auction (resolver + protocol). |
33
- | `estFillSeconds` | *number* | :heavy_check_mark: | Auction duration upper-bound in seconds. |
28
+ | Field | Type | Required | Description |
29
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
30
+ | `input` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
31
+ | `output` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
32
+ | `fee` | [components.QuoteFee](../../models/components/quotefee.md) | :heavy_check_mark: | Aggregate fee charged for the order. |
33
+ | `estFillSeconds` | *number* | :heavy_check_mark: | Estimated upper bound on time-to-fill, in seconds. |
@@ -1,6 +1,6 @@
1
1
  # QuoteFee
2
2
 
3
- Aggregate fee charged by the Fusion auction (resolver + protocol).
3
+ Aggregate fee charged for the order.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -14,5 +14,5 @@ let value: QuoteFee = {};
14
14
 
15
15
  | Field | Type | Required | Description |
16
16
  | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
17
- | `amountUsd` | *string* | :heavy_minus_sign: | Total fee in USD, decimal string. |
17
+ | `amountUsd` | *string* | :heavy_minus_sign: | Total fee in USD as a decimal string. |
18
18
  | `bps` | *number* | :heavy_minus_sign: | Fee as basis points of the input amount. |
@@ -1,6 +1,6 @@
1
1
  # Status
2
2
 
3
- Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum.
3
+ 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.
4
4
 
5
5
  ## Example Usage
6
6