@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
package/docs/models/components/tokenizedassetsbuildorderrequest.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TokenizedAssetsBuildOrderRequest
2
2
 
3
- Build a buy/sell order against the 1inch Fusion intent flow.
3
+ Build a buy or sell order for a tokenized equity.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -18,10 +18,10 @@ let value: TokenizedAssetsBuildOrderRequest = {
18
18
 
19
19
  ## Fields
20
20
 
21
- | Field | Type | Required | Description | Example |
22
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
- | `fromToken` | *string* | :heavy_check_mark: | Token the sender is paying. Either an on-chain Ondo symbol (e.g. `TSLAon`), the literal `USDC`, or a 0x-prefixed Ethereum address. | |
24
- | `toToken` | *string* | :heavy_check_mark: | Token the sender is receiving. Same accepted forms as `from_token`. | |
25
- | `amount` | *string* | :heavy_check_mark: | Human-readable amount of `from_token` to swap (decimal string). Decimals are applied server-side. | |
26
- | `owner` | *string* | :heavy_check_mark: | EOA that owns the Tokenized Assets Account. Determines the product account address and signs the EIP-712 envelopes returned by this endpoint (the approve SafeTx and the SafeMessage wrapping the order hash). | |
27
- | `slippageBps` | *number* | :heavy_minus_sign: | Max acceptable slippage in basis points (1 bp = 0.01%). | 50 |
21
+ | Field | Type | Required | Description | Example |
22
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
+ | `fromToken` | *string* | :heavy_check_mark: | Token the sender is paying. Either an on-chain Ondo symbol (e.g. `TSLAon`), the literal `USDC`, or a 0x-prefixed Ethereum address. | |
24
+ | `toToken` | *string* | :heavy_check_mark: | Token the sender is receiving. Same accepted forms as `from_token`. | |
25
+ | `amount` | *string* | :heavy_check_mark: | Human-readable amount of `from_token` to swap (decimal string). Decimals are applied server-side. | |
26
+ | `owner` | *string* | :heavy_check_mark: | Wallet that owns the Tokenized Assets Account. The product account address is derived deterministically from this owner. The owner signs the EIP-712 payloads returned by this endpoint (the optional approval and the order itself). | |
27
+ | `slippageBps` | *number* | :heavy_minus_sign: | Max acceptable slippage in basis points (1 bp = 0.01%). Range 1-1000 (0.01%-10%); defaults to 50 (0.5%). | 50 |
package/docs/models/components/tokenizedassetsbuildorderresponse.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TokenizedAssetsBuildOrderResponse
2
2
 
3
- Composed response: quote + optional approval SafeTx + EIP-712 order to sign.
3
+ Quote, optional approval payload, and the EIP-712 order to sign.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -55,8 +55,8 @@ let value: TokenizedAssetsBuildOrderResponse = {
55
55
 
56
56
  ## Fields
57
57
 
58
- | Field | Type | Required | Description |
59
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60
- | `quote` | [components.Quote](../../models/components/quote.md) | :heavy_check_mark: | Quote preview returned alongside an order. |
61
- | `approvalSafeTxEip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/gas_sponsorship/prepare`. `null` when allowance is already sufficient. |
62
- | `order` | [components.OrderToSign](../../models/components/ordertosign.md) | :heavy_check_mark: | Fusion order metadata bundled with the SafeMessage EIP-712 to sign.<br/><br/>The owner signs ``safe_message_eip712`` (a `SafeMessage(bytes message)`<br/>payload wrapping ``order_hash`` for ERC-1271). At submit time the SDK<br/>relays the resulting 65-byte ECDSA together with ``order_message``,<br/>``extension``, and ``quote_id`` so 1inch's relayer can broadcast the<br/>order; resolvers fill it via ``Safe.isValidSignature``. |
58
+ | Field | Type | Required | Description |
59
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60
+ | `quote` | [components.Quote](../../models/components/quote.md) | :heavy_check_mark: | Quote preview returned alongside an order. |
61
+ | `approvalSafeTxEip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 payload that authorizes a one-time max-approve of `from_token` to the settlement contract. Populated when the Tokenized Assets Account's existing allowance is below `amount`. The owner signs it, then it is broadcast via `POST /v2/gas_sponsorship/prepare` (or directly by the owner) to set the allowance on-chain. `null` when the allowance is already sufficient. |
62
+ | `order` | [components.OrderToSign](../../models/components/ordertosign.md) | :heavy_check_mark: | Order metadata plus the EIP-712 payload the owner signs to authorize it.<br/><br/>The owner signs ``safe_message_eip712`` off-chain. At submit time the<br/>signature is sent back to ``/order/submit`` together with<br/>``order_message``, ``extension``, and ``quote_id``; resolvers validate<br/>the signature against the Tokenized Assets Account at fill time. |
package/docs/models/components/tokenizedassetscancelorderrequest.md CHANGED
@@ -12,6 +12,6 @@ let value: TokenizedAssetsCancelOrderRequest = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | `owner` | *string* | :heavy_check_mark: | EOA that owns the Tokenized Assets Account. The product account predicted from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it). |
15
+ | Field | Type | Required | Description |
16
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `owner` | *string* | :heavy_check_mark: | Wallet that owns the Tokenized Assets Account. The account address derived from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it). |
package/docs/models/{operations → components}/tokenizedassetsohlcinterval.md RENAMED
@@ -1,13 +1,11 @@
1
1
  # TokenizedAssetsOhlcInterval
2
2
 
3
- Candle interval. Must form a valid pair with `range`.
4
-
5
3
  ## Example Usage
6
4
 
7
5
  ```typescript
8
- import { TokenizedAssetsOhlcInterval } from "@compass-labs/api-sdk/models/operations";
6
+ import { TokenizedAssetsOhlcInterval } from "@compass-labs/api-sdk/models/components";
9
7
 
10
- let value: TokenizedAssetsOhlcInterval = "1hour";
8
+ let value: TokenizedAssetsOhlcInterval = "15min";
11
9
  ```
12
10
 
13
11
  ## Values
package/docs/models/{operations → components}/tokenizedassetsohlcrange.md RENAMED
@@ -1,13 +1,11 @@
1
1
  # TokenizedAssetsOhlcRange
2
2
 
3
- Lookback window. Must form a valid pair with `interval`.
4
-
5
3
  ## Example Usage
6
4
 
7
5
  ```typescript
8
- import { TokenizedAssetsOhlcRange } from "@compass-labs/api-sdk/models/operations";
6
+ import { TokenizedAssetsOhlcRange } from "@compass-labs/api-sdk/models/components";
9
7
 
10
- let value: TokenizedAssetsOhlcRange = "1month";
8
+ let value: TokenizedAssetsOhlcRange = "6month";
11
9
  ```
12
10
 
13
11
  ## Values
package/docs/models/components/tokenizedassetssubmitorderrequest.md CHANGED
@@ -1,12 +1,10 @@
1
1
  # TokenizedAssetsSubmitOrderRequest
2
2
 
3
- Relay an owner-signed Fusion order to the 1inch relayer.
3
+ Submit an owner-signed order to the resolver network.
4
4
 
5
- The shape mirrors what `POST /order` returned plus the wallet's
6
- EIP-712 signature — all fields are required by the upstream relayer.
7
- Maker is the Tokenized Assets Account (the Safe), so the signature is
8
- validated via ERC-1271 (`Safe.isValidSignature`) at fill time rather
9
- than as an EOA personal-sign.
5
+ The shape echoes what `POST /order` returned plus the owner's
6
+ EIP-712 signature. The maker is the Tokenized Assets Account, so the
7
+ signature is validated against the product account at fill time.
10
8
 
11
9
  ## Example Usage
12
10
 
@@ -27,10 +25,10 @@ let value: TokenizedAssetsSubmitOrderRequest = {
27
25
 
28
26
  ## Fields
29
27
 
30
- | Field | Type | Required | Description |
31
- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32
- | `signedOrder` | Record<string, *any*> | :heavy_check_mark: | The Fusion order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the EOA owner — relay this dict back to the API verbatim. |
33
- | `signature` | *string* | :heavy_check_mark: | EIP-712 signature produced by `wallet.signTypedData(order.safe_message_eip712)` from the `/order` response. The Tokenized Assets Account validates this via ERC-1271 (`Safe.isValidSignature`) at fill time, so the signature must be the owner's signature over the SafeMessage hash, not the raw Fusion order hash. For a single-owner Safe this is the standard 65-byte ECDSA `(r, s, v)` blob; multi-owner Safes and pre-approved-hash flows produce variable-length signatures and are also accepted — the relayer enforces its own checks downstream. |
34
- | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from the `/order` response — pass back unchanged. |
35
- | `quoteId` | *string* | :heavy_check_mark: | `order.quote_id` from the `/order` response. |
36
- | `orderHash` | *string* | :heavy_minus_sign: | EIP-712 order hash from `order.order_hash` in the `/order` response. Optional but recommended: 1inch's relayer occasionally accepts a submit with a 2xx empty body; passing the hash through lets the API still return a usable handle for status / cancel lookups instead of failing. |
28
+ | Field | Type | Required | Description |
29
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30
+ | `signedOrder` | Record<string, *any*> | :heavy_check_mark: | The order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the owner's wallet — pass this dict back to the API verbatim. |
31
+ | `signature` | *string* | :heavy_check_mark: | Owner's EIP-712 signature over `order.safe_message_eip712` from the `/order` response. The signature is validated against the Tokenized Assets Account at fill time, so it must be a signature over the typed-data hash, not the raw order hash. |
32
+ | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from the `/order` response — pass back unchanged. |
33
+ | `quoteId` | *string* | :heavy_check_mark: | `order.quote_id` from the `/order` response — pass back unchanged. |
34
+ | `orderHash` | *string* | :heavy_minus_sign: | `order.order_hash` from the `/order` response. Optional but recommended: the upstream relayer occasionally returns a 2xx with an empty body, and supplying the hash lets the API still return a usable handle for status and cancel lookups instead of failing. |
package/docs/models/operations/v2tokenizedassetsmarketssymbolrequest.md CHANGED
@@ -12,6 +12,8 @@ let value: V2TokenizedAssetsMarketsSymbolRequest = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | ------------------ | ------------------ | ------------------ | ------------------ |
17
- | `symbol` | *string* | :heavy_check_mark: | N/A |
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `symbol` | *string* | :heavy_check_mark: | N/A |
18
+ | `interval` | [components.TokenizedAssetsOhlcInterval](../../models/components/tokenizedassetsohlcinterval.md) | :heavy_minus_sign: | Optional candle interval. Must be paired with `range` and form a valid `(interval, range)` pair to include OHLC candles in the response. |
19
+ | `range` | [components.TokenizedAssetsOhlcRange](../../models/components/tokenizedassetsohlcrange.md) | :heavy_minus_sign: | Optional lookback window. Must be paired with `interval` and form a valid `(interval, range)` pair to include OHLC candles in the response. |
package/docs/sdks/tokenizedassets/README.md CHANGED
@@ -5,21 +5,25 @@
5
5
  ### Available Operations
6
6
 
7
7
  * [tokenizedAssetsMarkets](#tokenizedassetsmarkets) - List tokenized equity markets
8
- * [tokenizedAssetsMarketsSymbol](#tokenizedassetsmarketssymbol) - Get a single tokenized market
9
- * [tokenizedAssetsMarketsSymbolOhlc](#tokenizedassetsmarketssymbolohlc) - Get OHLC candles for a market
10
- * [tokenizedAssetsPositions](#tokenizedassetspositions) - Get on-chain tokenized-asset positions for a wallet
11
- * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get tokenized-asset order status
12
- * [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create tokenized assets account
13
- * [tokenizedAssetsOrder](#tokenizedassetsorder) - Build a tokenized-asset buy/sell order
14
- * [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed tokenized-asset order to 1inch Fusion
15
- * [tokenizedAssetsOrderOrderHashCancel](#tokenizedassetsorderorderhashcancel) - Cancel an unfilled tokenized-asset order
8
+ * [tokenizedAssetsMarketsSymbol](#tokenizedassetsmarketssymbol) - Get a single market
9
+ * [tokenizedAssetsPositions](#tokenizedassetspositions) - Get tokenized-asset positions for a wallet
10
+ * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get order status
11
+ * [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create a Tokenized Assets Account
12
+ * [tokenizedAssetsOrder](#tokenizedassetsorder) - Build a buy/sell order
13
+ * [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed order
14
+ * [tokenizedAssetsOrderOrderHashCancel](#tokenizedassetsorderorderhashcancel) - Cancel an unfilled order
16
15
 
17
16
  ## tokenizedAssetsMarkets
18
17
 
19
- List tokenized equities surfaced on Ethereum.
18
+ List the tokenized US equities available on Ethereum.
20
19
 
21
- Composed from Ondo's metadata + enhanced-prices feeds. Non-Ethereum-only
22
- assets (BSC/Solana deployments without an Ethereum twin) are skipped.
20
+ Each entry includes the symbol, the underlying ticker, the on-chain
21
+ contract address, the latest USD price, and 24h price change. Filter
22
+ by `category` (sector tag) or `search` (substring match against symbol,
23
+ ticker, or name).
24
+
25
+ Only Ethereum-deployed tokens are returned; assets that exist only on
26
+ other chains are omitted.
23
27
 
24
28
  ### Example Usage
25
29
 
@@ -90,7 +94,21 @@ run();
90
94
 
91
95
  ## tokenizedAssetsMarketsSymbol
92
96
 
93
- Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
97
+ Get extended detail for a single tokenized equity (e.g. `TSLAon`).
98
+
99
+ Includes 52-week range, volume, market cap, holder count, and tradable
100
+ sessions in addition to the fields returned by `/markets`.
101
+
102
+ **OHLC candles** are opt-in: pass both `interval` and `range` query
103
+ params to include a `candles` array in the response. They must be
104
+ provided together and must form one of the supported pairs:
105
+
106
+ - `1min` / `5min` / `15min` with `range=1day`
107
+ - `1hour` / `4hour` with `range=1month`
108
+ - `12hour` with `range=3month`
109
+ - `1day` with `range=3month` / `6month` / `1year` / `all`
110
+
111
+ Omitting both returns the market detail without `candles`.
94
112
 
95
113
  ### Example Usage
96
114
 
@@ -157,89 +175,6 @@ run();
157
175
 
158
176
  ### Errors
159
177
 
160
- | Error Type | Status Code | Content Type |
161
- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
162
- | errors.TokenizedAssetsErrorResponse | 404 | application/json |
163
- | errors.HTTPValidationError | 422 | application/json |
164
- | errors.TokenizedAssetsErrorResponse | 502 | application/json |
165
- | errors.APIError | 4XX, 5XX | \*/\* |
166
-
167
- ## tokenizedAssetsMarketsSymbolOhlc
168
-
169
- OHLC candles for the given Ondo symbol.
170
-
171
- `interval` + `range` must form one of the closed Ondo pairs (see request
172
- model docstring); invalid pairs return 400.
173
-
174
- ### Example Usage
175
-
176
- <!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_markets_{symbol}_ohlc" method="get" path="/v2/tokenized_assets/markets/{symbol}/ohlc" -->
177
- ```typescript
178
- import { CompassApiSDK } from "@compass-labs/api-sdk";
179
-
180
- const compassApiSDK = new CompassApiSDK({
181
- apiKeyAuth: "<YOUR_API_KEY_HERE>",
182
- });
183
-
184
- async function run() {
185
- const result = await compassApiSDK.tokenizedAssets.tokenizedAssetsMarketsSymbolOhlc({
186
- symbol: "<value>",
187
- interval: "1hour",
188
- range: "1month",
189
- });
190
-
191
- console.log(result);
192
- }
193
-
194
- run();
195
- ```
196
-
197
- ### Standalone function
198
-
199
- The standalone function version of this method:
200
-
201
- ```typescript
202
- import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
203
- import { tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc } from "@compass-labs/api-sdk/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js";
204
-
205
- // Use `CompassApiSDKCore` for best tree-shaking performance.
206
- // You can create one instance of it to use across an application.
207
- const compassApiSDK = new CompassApiSDKCore({
208
- apiKeyAuth: "<YOUR_API_KEY_HERE>",
209
- });
210
-
211
- async function run() {
212
- const res = await tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc(compassApiSDK, {
213
- symbol: "<value>",
214
- interval: "1hour",
215
- range: "1month",
216
- });
217
- if (res.ok) {
218
- const { value: result } = res;
219
- console.log(result);
220
- } else {
221
- console.log("tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc failed:", res.error);
222
- }
223
- }
224
-
225
- run();
226
- ```
227
-
228
- ### Parameters
229
-
230
- | Parameter | Type | Required | Description |
231
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
232
- | `request` | [operations.V2TokenizedAssetsMarketsSymbolOhlcRequest](../../models/operations/v2tokenizedassetsmarketssymbolohlcrequest.md) | :heavy_check_mark: | The request object to use for the request. |
233
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
234
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
235
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
236
-
237
- ### Response
238
-
239
- **Promise\<[components.TokenizedAssetsOhlcResponse](../../models/components/tokenizedassetsohlcresponse.md)\>**
240
-
241
- ### Errors
242
-
243
178
  | Error Type | Status Code | Content Type |
244
179
  | ----------------------------------- | ----------------------------------- | ----------------------------------- |
245
180
  | errors.TokenizedAssetsErrorResponse | 400, 404 | application/json |
@@ -249,11 +184,16 @@ run();
249
184
 
250
185
  ## tokenizedAssetsPositions
251
186
 
252
- On-chain ERC-20 balance reads for a wallet across all listed Ondo GM tokens.
187
+ Get the tokenized-asset holdings for a wallet.
188
+
189
+ Returns the balance of every listed tokenized equity at the queried
190
+ address, plus the latest USD price and a USD-valued balance when
191
+ pricing is available. Zero balances are omitted, and a `total_usd`
192
+ aggregate is returned across all priced positions.
253
193
 
254
- Reads each Ethereum-deployed Ondo GM token's `balanceOf(wallet)` via a
255
- single Multicall3 batch and enriches non-zero balances with the latest USD
256
- price. Returns human-readable amounts (decimals applied).
194
+ Pass the **Tokenized Assets Account address** (returned by
195
+ `/create_account`), not the owner's wallet — proceeds from filled
196
+ orders settle into the Tokenized Assets Account.
257
197
 
258
198
  ### Example Usage
259
199
 
@@ -328,11 +268,15 @@ run();
328
268
 
329
269
  ## tokenizedAssetsOrderOrderHash
330
270
 
331
- Status of a relayed Fusion order — `pending` / `filled` / `expired` / `cancelled`.
271
+ Get the lifecycle state of a submitted order.
332
272
 
333
- Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) are
334
- collapsed into the 4-value enum the SDK promises. Unknown upstream states
335
- surface as 502 to alert on schema drift.
273
+ The `status` field is one of `pending`, `filled`, `expired`, or
274
+ `cancelled`. Partial fills stay in `pending` while `filled_amount` is
275
+ populated as fills come in; once an order fully fills, `fill_tx_hash`
276
+ is also returned.
277
+
278
+ Upstream protocol states beyond these four (e.g. `partially-filled`,
279
+ `refunded`) are mapped onto this set.
336
280
 
337
281
  ### Example Usage
338
282
 
@@ -410,17 +354,21 @@ run();
410
354
 
411
355
  Create a Tokenized Assets Account for a wallet address.
412
356
 
413
- Each wallet address has one Tokenized Assets Account per chain. It is owned by
414
- `owner` and isolated from the owner's Earn, Credit, and Traditional Investing
415
- accounts.
357
+ Before placing orders, the owner must create a Tokenized Assets Account.
358
+ Each wallet address has one Tokenized Assets Account, isolated from the
359
+ owner's Earn, Credit, and other product accounts.
360
+
361
+ The account address is deterministic. If it already exists, the
362
+ response returns `transaction: null` and you can skip straight to
363
+ building orders.
416
364
 
417
- Returns an unsigned transaction to create the account. The `sender` signs and
418
- broadcasts this transaction.
365
+ Returns an unsigned transaction to create the account. The `sender`
366
+ signs and broadcasts this transaction.
419
367
 
420
368
  **If owner pays gas:** Set `sender` to the owner's address.
421
369
 
422
- **If someone else pays gas:** Set `sender` to the wallet that will sign and
423
- broadcast the transaction on behalf of the owner.
370
+ **If someone else pays gas:** Set `sender` to the wallet that will
371
+ sign and broadcast the transaction on behalf of the owner.
424
372
 
425
373
  ### Example Usage
426
374
 
@@ -498,24 +446,25 @@ run();
498
446
 
499
447
  ## tokenizedAssetsOrder
500
448
 
501
- Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
449
+ Build a buy or sell order whose maker is the Tokenized Assets Account.
502
450
 
503
- Returns everything the SDK needs to take an `owner` from "I want to buy"
504
- to a relayed Fusion order whose maker is the Tokenized Assets Account.
505
- The flow is **signing-based, not transaction-based**:
451
+ Returns up to three pieces in a single round-trip:
506
452
 
507
- 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
508
- insufficient), sign it with `wallet.signTypedData(...)` and relay via
509
- `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
510
- `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
511
- to confirm before signing the order.
512
- 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
513
- a Safe ERC-1271 wrapper around the Fusion order hash. POST the
514
- resulting 65-byte ECDSA together with the rest of the `order` fields
515
- to `/order/submit`.
453
+ - **`quote`** — preview of the input/output amounts and fees.
454
+ - **`approval_safe_tx_eip712`** — only present when the account's
455
+ allowance to the settlement contract is below `amount`. The owner
456
+ signs this EIP-712 payload, then it is broadcast via
457
+ `POST /v2/gas_sponsorship/prepare` (or the owner can broadcast
458
+ directly) to set the on-chain allowance. Wait for that transaction
459
+ to confirm before signing the order.
460
+ - **`order`** — the order metadata (`order_hash`, `extension`,
461
+ `quote_id`, `order_message`) plus `safe_message_eip712`, an EIP-712
462
+ payload the owner signs off-chain to authorize the order. The
463
+ signature is submitted to `/order/submit` and is **never** broadcast
464
+ on-chain.
516
465
 
517
- The owner never broadcasts an on-chain transaction in this flow; all
518
- on-chain action goes through the product account via the sponsor relay.
466
+ The owner never broadcasts the order itself — only the (one-time)
467
+ approval transaction ever hits the chain.
519
468
 
520
469
  ### Example Usage
521
470
 
@@ -599,18 +548,17 @@ run();
599
548
 
600
549
  ## tokenizedAssetsOrderSubmit
601
550
 
602
- Relay an owner-signed Fusion order to the 1inch relayer.
551
+ Submit a signed order to the resolver network.
603
552
 
604
- The body carries the signature produced by
605
- `wallet.signTypedData(order.safe_message_eip712)` from the `/order`
606
- response, plus the order struct (`signed_order`), opaque `extension`,
607
- and `quote_id`. The signature is validated via ERC-1271
608
- (`Safe.isValidSignature`) at fill time — the maker on the order struct
609
- is the Tokenized Assets Account, not the EOA owner.
553
+ The body echoes the `order` fields from `/order` (`signed_order`,
554
+ `extension`, `quote_id`, optionally `order_hash`) plus the owner's
555
+ signature over `order.safe_message_eip712`. The maker on the order
556
+ struct is the Tokenized Assets Account, not the owner's wallet —
557
+ pass `signed_order` back unchanged.
610
558
 
611
- Returns the order hash and a server-side timestamp. Subsequent calls to
612
- `GET /order/{order_hash}` track lifecycle (`pending` → `filled` /
613
- `expired` / `cancelled`).
559
+ Returns the order hash and a server-side ISO 8601 timestamp.
560
+ Subsequent calls to `GET /order/{order_hash}` track the lifecycle
561
+ (`pending` → `filled` / `expired` / `cancelled`).
614
562
 
615
563
  ### Example Usage
616
564
 
@@ -696,19 +644,17 @@ run();
696
644
 
697
645
  ## tokenizedAssetsOrderOrderHashCancel
698
646
 
699
- Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
647
+ Build the EIP-712 payload to cancel an unfilled order on-chain.
700
648
 
701
- Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
702
- payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
703
- Sign with the Tokenized Assets Account's owner via
704
- ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
705
- so the sponsor broadcasts ``execTransaction`` on the product account
706
- (the order's maker). The owner can also broadcast ``execTransaction``
707
- directly if not using gas sponsorship.
649
+ Returns ``cancel_safe_tx_eip712``, an EIP-712 payload that authorizes
650
+ the on-chain cancellation. Sign with the Tokenized Assets Account's
651
+ owner via ``wallet.signTypedData(...)`` and relay via
652
+ ``POST /v2/gas_sponsorship/prepare`` so the sponsor broadcasts the
653
+ cancellation on the product account. The owner can also broadcast
654
+ the resulting transaction directly without using gas sponsorship.
708
655
 
709
- Authorization is on the *predicted* Safe address: the Tokenized Assets
710
- Account computed from ``owner`` must match the order's on-chain maker.
711
- Mismatches return 403 ``OWNER_NOT_MAKER`` before any on-chain reads.
656
+ Cancellation works on `pending` and `expired` orders only. Only the
657
+ Tokenized Assets Account that placed the order can cancel it.
712
658
 
713
659
  ### Example Usage
714
660
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.45",
3
+ "version": "2.2.46-rc.1",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {