@compass-labs/api-sdk 2.2.75 → 2.2.76-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 (276) hide show
  1. package/README.md +7 -3
  2. package/codeSamples_typescript.yaml +12 -0
  3. package/dist/commonjs/funcs/creditCreditMorphoMarkets.d.ts +24 -0
  4. package/dist/commonjs/funcs/creditCreditMorphoMarkets.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/creditCreditMorphoMarkets.js +128 -0
  6. package/dist/commonjs/funcs/creditCreditMorphoMarkets.js.map +1 -0
  7. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +30 -0
  8. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -0
  9. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +136 -0
  10. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -0
  11. package/dist/commonjs/models/components/accountsummary.d.ts +4 -0
  12. package/dist/commonjs/models/components/accountsummary.d.ts.map +1 -1
  13. package/dist/commonjs/models/components/accountsummary.js.map +1 -1
  14. package/dist/commonjs/models/components/collateralposition.d.ts +12 -0
  15. package/dist/commonjs/models/components/collateralposition.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/collateralposition.js +4 -0
  17. package/dist/commonjs/models/components/collateralposition.js.map +1 -1
  18. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +8 -6
  19. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +3 -3
  21. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  22. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +4 -2
  23. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  24. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  25. package/dist/commonjs/models/components/creditborrowparams.d.ts +4 -0
  26. package/dist/commonjs/models/components/creditborrowparams.d.ts.map +1 -1
  27. package/dist/commonjs/models/components/creditborrowparams.js.map +1 -1
  28. package/dist/commonjs/models/components/creditborrowrequest.d.ts +4 -0
  29. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  30. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  31. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts +4 -0
  32. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts.map +1 -1
  33. package/dist/commonjs/models/components/creditenablecollateralparams.js.map +1 -1
  34. package/dist/commonjs/models/components/creditprotocol.d.ts +9 -0
  35. package/dist/commonjs/models/components/creditprotocol.d.ts.map +1 -1
  36. package/dist/commonjs/models/components/creditprotocol.js +5 -0
  37. package/dist/commonjs/models/components/creditprotocol.js.map +1 -1
  38. package/dist/commonjs/models/components/creditrepayparams.d.ts +4 -0
  39. package/dist/commonjs/models/components/creditrepayparams.d.ts.map +1 -1
  40. package/dist/commonjs/models/components/creditrepayparams.js.map +1 -1
  41. package/dist/commonjs/models/components/creditrepayrequest.d.ts +4 -0
  42. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  44. package/dist/commonjs/models/components/creditsupplyparams.d.ts +4 -0
  45. package/dist/commonjs/models/components/creditsupplyparams.d.ts.map +1 -1
  46. package/dist/commonjs/models/components/creditsupplyparams.js.map +1 -1
  47. package/dist/commonjs/models/components/creditwithdrawparams.d.ts +4 -0
  48. package/dist/commonjs/models/components/creditwithdrawparams.d.ts.map +1 -1
  49. package/dist/commonjs/models/components/creditwithdrawparams.js.map +1 -1
  50. package/dist/commonjs/models/components/debtposition.d.ts +12 -0
  51. package/dist/commonjs/models/components/debtposition.d.ts.map +1 -1
  52. package/dist/commonjs/models/components/debtposition.js +4 -0
  53. package/dist/commonjs/models/components/debtposition.js.map +1 -1
  54. package/dist/commonjs/models/components/index.d.ts +4 -0
  55. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  56. package/dist/commonjs/models/components/index.js +4 -0
  57. package/dist/commonjs/models/components/index.js.map +1 -1
  58. package/dist/commonjs/models/components/marketdetail.d.ts +8 -6
  59. package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
  60. package/dist/commonjs/models/components/marketdetail.js +3 -3
  61. package/dist/commonjs/models/components/marketdetail.js.map +1 -1
  62. package/dist/commonjs/models/components/morpholendingmarket.d.ts +80 -0
  63. package/dist/commonjs/models/components/morpholendingmarket.d.ts.map +1 -0
  64. package/dist/commonjs/models/components/morpholendingmarket.js +82 -0
  65. package/dist/commonjs/models/components/morpholendingmarket.js.map +1 -0
  66. package/dist/commonjs/models/components/morphomarketsresponse.d.ts +21 -0
  67. package/dist/commonjs/models/components/morphomarketsresponse.d.ts.map +1 -0
  68. package/dist/commonjs/models/components/morphomarketsresponse.js +52 -0
  69. package/dist/commonjs/models/components/morphomarketsresponse.js.map +1 -0
  70. package/dist/commonjs/models/components/redemption.d.ts +52 -0
  71. package/dist/commonjs/models/components/redemption.d.ts.map +1 -0
  72. package/dist/commonjs/models/components/redemption.js +73 -0
  73. package/dist/commonjs/models/components/redemption.js.map +1 -0
  74. package/dist/commonjs/models/components/redemptionsresponse.d.ts +17 -0
  75. package/dist/commonjs/models/components/redemptionsresponse.d.ts.map +1 -0
  76. package/dist/commonjs/models/components/redemptionsresponse.js +51 -0
  77. package/dist/commonjs/models/components/redemptionsresponse.js.map +1 -0
  78. package/dist/commonjs/models/components/tokenizedassetclass.d.ts +9 -4
  79. package/dist/commonjs/models/components/tokenizedassetclass.d.ts.map +1 -1
  80. package/dist/commonjs/models/components/tokenizedassetclass.js +5 -2
  81. package/dist/commonjs/models/components/tokenizedassetclass.js.map +1 -1
  82. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts +1 -0
  83. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts.map +1 -1
  84. package/dist/commonjs/models/components/tokenizedassetprovider.js +1 -0
  85. package/dist/commonjs/models/components/tokenizedassetprovider.js.map +1 -1
  86. package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts +22 -0
  87. package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
  88. package/dist/commonjs/models/components/tokenizedassetstraderesponse.js +14 -1
  89. package/dist/commonjs/models/components/tokenizedassetstraderesponse.js.map +1 -1
  90. package/dist/commonjs/models/operations/index.d.ts +2 -0
  91. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  92. package/dist/commonjs/models/operations/index.js +2 -0
  93. package/dist/commonjs/models/operations/index.js.map +1 -1
  94. package/dist/commonjs/models/operations/v2creditmorphomarkets.d.ts +22 -0
  95. package/dist/commonjs/models/operations/v2creditmorphomarkets.d.ts.map +1 -0
  96. package/dist/commonjs/models/operations/v2creditmorphomarkets.js +57 -0
  97. package/dist/commonjs/models/operations/v2creditmorphomarkets.js.map +1 -0
  98. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts +43 -0
  99. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -0
  100. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js +64 -0
  101. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js.map +1 -0
  102. package/dist/commonjs/sdk/credit.d.ts +12 -0
  103. package/dist/commonjs/sdk/credit.d.ts.map +1 -1
  104. package/dist/commonjs/sdk/credit.js +15 -0
  105. package/dist/commonjs/sdk/credit.js.map +1 -1
  106. package/dist/commonjs/sdk/tokenizedassets.d.ts +18 -0
  107. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  108. package/dist/commonjs/sdk/tokenizedassets.js +21 -0
  109. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  110. package/dist/esm/funcs/creditCreditMorphoMarkets.d.ts +24 -0
  111. package/dist/esm/funcs/creditCreditMorphoMarkets.d.ts.map +1 -0
  112. package/dist/esm/funcs/creditCreditMorphoMarkets.js +92 -0
  113. package/dist/esm/funcs/creditCreditMorphoMarkets.js.map +1 -0
  114. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +30 -0
  115. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -0
  116. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +100 -0
  117. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -0
  118. package/dist/esm/models/components/accountsummary.d.ts +4 -0
  119. package/dist/esm/models/components/accountsummary.d.ts.map +1 -1
  120. package/dist/esm/models/components/accountsummary.js.map +1 -1
  121. package/dist/esm/models/components/collateralposition.d.ts +12 -0
  122. package/dist/esm/models/components/collateralposition.d.ts.map +1 -1
  123. package/dist/esm/models/components/collateralposition.js +4 -0
  124. package/dist/esm/models/components/collateralposition.js.map +1 -1
  125. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +8 -6
  126. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  127. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +3 -3
  128. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  129. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +4 -2
  130. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  131. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  132. package/dist/esm/models/components/creditborrowparams.d.ts +4 -0
  133. package/dist/esm/models/components/creditborrowparams.d.ts.map +1 -1
  134. package/dist/esm/models/components/creditborrowparams.js.map +1 -1
  135. package/dist/esm/models/components/creditborrowrequest.d.ts +4 -0
  136. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  137. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  138. package/dist/esm/models/components/creditenablecollateralparams.d.ts +4 -0
  139. package/dist/esm/models/components/creditenablecollateralparams.d.ts.map +1 -1
  140. package/dist/esm/models/components/creditenablecollateralparams.js.map +1 -1
  141. package/dist/esm/models/components/creditprotocol.d.ts +9 -0
  142. package/dist/esm/models/components/creditprotocol.d.ts.map +1 -1
  143. package/dist/esm/models/components/creditprotocol.js +5 -0
  144. package/dist/esm/models/components/creditprotocol.js.map +1 -1
  145. package/dist/esm/models/components/creditrepayparams.d.ts +4 -0
  146. package/dist/esm/models/components/creditrepayparams.d.ts.map +1 -1
  147. package/dist/esm/models/components/creditrepayparams.js.map +1 -1
  148. package/dist/esm/models/components/creditrepayrequest.d.ts +4 -0
  149. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  150. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  151. package/dist/esm/models/components/creditsupplyparams.d.ts +4 -0
  152. package/dist/esm/models/components/creditsupplyparams.d.ts.map +1 -1
  153. package/dist/esm/models/components/creditsupplyparams.js.map +1 -1
  154. package/dist/esm/models/components/creditwithdrawparams.d.ts +4 -0
  155. package/dist/esm/models/components/creditwithdrawparams.d.ts.map +1 -1
  156. package/dist/esm/models/components/creditwithdrawparams.js.map +1 -1
  157. package/dist/esm/models/components/debtposition.d.ts +12 -0
  158. package/dist/esm/models/components/debtposition.d.ts.map +1 -1
  159. package/dist/esm/models/components/debtposition.js +4 -0
  160. package/dist/esm/models/components/debtposition.js.map +1 -1
  161. package/dist/esm/models/components/index.d.ts +4 -0
  162. package/dist/esm/models/components/index.d.ts.map +1 -1
  163. package/dist/esm/models/components/index.js +4 -0
  164. package/dist/esm/models/components/index.js.map +1 -1
  165. package/dist/esm/models/components/marketdetail.d.ts +8 -6
  166. package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
  167. package/dist/esm/models/components/marketdetail.js +3 -3
  168. package/dist/esm/models/components/marketdetail.js.map +1 -1
  169. package/dist/esm/models/components/morpholendingmarket.d.ts +80 -0
  170. package/dist/esm/models/components/morpholendingmarket.d.ts.map +1 -0
  171. package/dist/esm/models/components/morpholendingmarket.js +45 -0
  172. package/dist/esm/models/components/morpholendingmarket.js.map +1 -0
  173. package/dist/esm/models/components/morphomarketsresponse.d.ts +21 -0
  174. package/dist/esm/models/components/morphomarketsresponse.d.ts.map +1 -0
  175. package/dist/esm/models/components/morphomarketsresponse.js +15 -0
  176. package/dist/esm/models/components/morphomarketsresponse.js.map +1 -0
  177. package/dist/esm/models/components/redemption.d.ts +52 -0
  178. package/dist/esm/models/components/redemption.d.ts.map +1 -0
  179. package/dist/esm/models/components/redemption.js +36 -0
  180. package/dist/esm/models/components/redemption.js.map +1 -0
  181. package/dist/esm/models/components/redemptionsresponse.d.ts +17 -0
  182. package/dist/esm/models/components/redemptionsresponse.d.ts.map +1 -0
  183. package/dist/esm/models/components/redemptionsresponse.js +14 -0
  184. package/dist/esm/models/components/redemptionsresponse.js.map +1 -0
  185. package/dist/esm/models/components/tokenizedassetclass.d.ts +9 -4
  186. package/dist/esm/models/components/tokenizedassetclass.d.ts.map +1 -1
  187. package/dist/esm/models/components/tokenizedassetclass.js +5 -2
  188. package/dist/esm/models/components/tokenizedassetclass.js.map +1 -1
  189. package/dist/esm/models/components/tokenizedassetprovider.d.ts +1 -0
  190. package/dist/esm/models/components/tokenizedassetprovider.d.ts.map +1 -1
  191. package/dist/esm/models/components/tokenizedassetprovider.js +1 -0
  192. package/dist/esm/models/components/tokenizedassetprovider.js.map +1 -1
  193. package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts +22 -0
  194. package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
  195. package/dist/esm/models/components/tokenizedassetstraderesponse.js +13 -0
  196. package/dist/esm/models/components/tokenizedassetstraderesponse.js.map +1 -1
  197. package/dist/esm/models/operations/index.d.ts +2 -0
  198. package/dist/esm/models/operations/index.d.ts.map +1 -1
  199. package/dist/esm/models/operations/index.js +2 -0
  200. package/dist/esm/models/operations/index.js.map +1 -1
  201. package/dist/esm/models/operations/v2creditmorphomarkets.d.ts +22 -0
  202. package/dist/esm/models/operations/v2creditmorphomarkets.d.ts.map +1 -0
  203. package/dist/esm/models/operations/v2creditmorphomarkets.js +20 -0
  204. package/dist/esm/models/operations/v2creditmorphomarkets.js.map +1 -0
  205. package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts +43 -0
  206. package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -0
  207. package/dist/esm/models/operations/v2tokenizedassetsredemptions.js +27 -0
  208. package/dist/esm/models/operations/v2tokenizedassetsredemptions.js.map +1 -0
  209. package/dist/esm/sdk/credit.d.ts +12 -0
  210. package/dist/esm/sdk/credit.d.ts.map +1 -1
  211. package/dist/esm/sdk/credit.js +15 -0
  212. package/dist/esm/sdk/credit.js.map +1 -1
  213. package/dist/esm/sdk/tokenizedassets.d.ts +18 -0
  214. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  215. package/dist/esm/sdk/tokenizedassets.js +21 -0
  216. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  217. package/docs/models/components/accountsummary.md +10 -10
  218. package/docs/models/components/collateralposition.md +16 -14
  219. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +21 -18
  220. package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +15 -15
  221. package/docs/models/components/creditborrowparams.md +9 -9
  222. package/docs/models/components/creditborrowrequest.md +19 -19
  223. package/docs/models/components/creditenablecollateralparams.md +6 -6
  224. package/docs/models/components/creditprotocol.md +5 -1
  225. package/docs/models/components/creditrepayparams.md +8 -8
  226. package/docs/models/components/creditrepayrequest.md +18 -18
  227. package/docs/models/components/creditsupplyparams.md +7 -7
  228. package/docs/models/components/creditwithdrawparams.md +7 -7
  229. package/docs/models/components/debtposition.md +15 -13
  230. package/docs/models/components/marketdetail.md +32 -29
  231. package/docs/models/components/morpholendingmarket.md +49 -0
  232. package/docs/models/components/morphomarketsresponse.md +21 -0
  233. package/docs/models/components/redemption.md +27 -0
  234. package/docs/models/components/redemptionsresponse.md +19 -0
  235. package/docs/models/components/redemptionstatus.md +17 -0
  236. package/docs/models/components/settlement.md +17 -0
  237. package/docs/models/components/tokenizedassetclass.md +6 -4
  238. package/docs/models/components/tokenizedassetprovider.md +2 -2
  239. package/docs/models/components/tokenizedassetstraderesponse.md +9 -6
  240. package/docs/models/operations/v2creditmorphomarketschain.md +15 -0
  241. package/docs/models/operations/v2creditmorphomarketsrequest.md +17 -0
  242. package/docs/models/operations/v2tokenizedassetsredemptionschain.md +17 -0
  243. package/docs/models/operations/v2tokenizedassetsredemptionsrequest.md +21 -0
  244. package/docs/sdks/credit/README.md +80 -0
  245. package/docs/sdks/tokenizedassets/README.md +90 -0
  246. package/openapi_prepped_for_speakeasy.json +451 -21
  247. package/package.json +1 -1
  248. package/src/funcs/creditCreditMorphoMarkets.ts +182 -0
  249. package/src/funcs/tokenizedAssetsTokenizedAssetsRedemptions.ts +192 -0
  250. package/src/models/components/accountsummary.ts +4 -0
  251. package/src/models/components/collateralposition.ts +16 -0
  252. package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +11 -9
  253. package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +4 -2
  254. package/src/models/components/creditborrowparams.ts +4 -0
  255. package/src/models/components/creditborrowrequest.ts +4 -0
  256. package/src/models/components/creditenablecollateralparams.ts +4 -0
  257. package/src/models/components/creditprotocol.ts +9 -0
  258. package/src/models/components/creditrepayparams.ts +4 -0
  259. package/src/models/components/creditrepayrequest.ts +4 -0
  260. package/src/models/components/creditsupplyparams.ts +4 -0
  261. package/src/models/components/creditwithdrawparams.ts +4 -0
  262. package/src/models/components/debtposition.ts +16 -0
  263. package/src/models/components/index.ts +4 -0
  264. package/src/models/components/marketdetail.ts +11 -9
  265. package/src/models/components/morpholendingmarket.ts +133 -0
  266. package/src/models/components/morphomarketsresponse.ts +46 -0
  267. package/src/models/components/redemption.ts +89 -0
  268. package/src/models/components/redemptionsresponse.ts +38 -0
  269. package/src/models/components/tokenizedassetclass.ts +9 -4
  270. package/src/models/components/tokenizedassetprovider.ts +1 -0
  271. package/src/models/components/tokenizedassetstraderesponse.ts +28 -0
  272. package/src/models/operations/index.ts +2 -0
  273. package/src/models/operations/v2creditmorphomarkets.ts +49 -0
  274. package/src/models/operations/v2tokenizedassetsredemptions.ts +72 -0
  275. package/src/sdk/credit.ts +23 -0
  276. package/src/sdk/tokenizedassets.ts +29 -0
package/docs/models/components/debtposition.md CHANGED
@@ -17,16 +17,18 @@ let value: DebtPosition = {
17
17
 
18
18
  ## Fields
19
19
 
20
- | Field | Type | Required | Description | Example |
21
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | `token` | *string* | :heavy_check_mark: | Address of the borrow token. | |
23
- | `symbol` | *string* | :heavy_check_mark: | Symbol of the borrow token (e.g. WETH). | |
24
- | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
25
- | `vault` | *string* | :heavy_minus_sign: | Euler only: the EVK borrow vault this debt is owed to. | |
26
- | `amountBorrowed` | *string* | :heavy_check_mark: | Current on-chain debt balance (the vault's underlying asset for Euler). | |
27
- | `usdValue` | *string* | :heavy_minus_sign: | Debt value in USD. | |
28
- | `borrowApy` | *string* | :heavy_minus_sign: | Current borrow APY in percentage (e.g. 4.5 means 4.5%). | |
29
- | `totalBorrowed` | *string* | :heavy_minus_sign: | Total amount borrowed across all borrow events. | |
30
- | `totalRepaid` | *string* | :heavy_minus_sign: | Total amount repaid across all repay events. | |
31
- | `interestPaid` | *string* | :heavy_minus_sign: | Interest paid on debt: on_chain_balance + total_repaid - total_borrowed. | |
32
- | `events` | [components.CreditEvent](../../models/components/creditevent.md)[] | :heavy_minus_sign: | All historical events for this debt reserve. | [] |
20
+ | Field | Type | Required | Description | Example |
21
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
22
+ | `token` | *string* | :heavy_check_mark: | Address of the borrow token. | |
23
+ | `symbol` | *string* | :heavy_check_mark: | Symbol of the borrow token (e.g. WETH). | |
24
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es).<br/>``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is<br/>currently read-only: positions and market discovery only — transaction<br/>builders land with the looping work (COM-7106/7107/7108), so transact<br/>endpoints reject it with a 422. | |
25
+ | `vault` | *string* | :heavy_minus_sign: | Euler only: the EVK borrow vault this debt is owed to. | |
26
+ | `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 id of the isolated market this debt is owed to. | |
27
+ | `healthFactor` | *string* | :heavy_minus_sign: | Morpho only: this market's health factor (markets are isolated, so health is per market — below 1 the position is liquidatable). Null for other protocols and when the oracle read fails. | |
28
+ | `amountBorrowed` | *string* | :heavy_check_mark: | Current on-chain debt balance (the vault's underlying asset for Euler). | |
29
+ | `usdValue` | *string* | :heavy_minus_sign: | Debt value in USD. | |
30
+ | `borrowApy` | *string* | :heavy_minus_sign: | Current borrow APY in percentage (e.g. 4.5 means 4.5%). | |
31
+ | `totalBorrowed` | *string* | :heavy_minus_sign: | Total amount borrowed across all borrow events. | |
32
+ | `totalRepaid` | *string* | :heavy_minus_sign: | Total amount repaid across all repay events. | |
33
+ | `interestPaid` | *string* | :heavy_minus_sign: | Interest paid on debt: on_chain_balance + total_repaid - total_borrowed. | |
34
+ | `events` | [components.CreditEvent](../../models/components/creditevent.md)[] | :heavy_minus_sign: | All historical events for this debt reserve. | [] |
package/docs/models/components/marketdetail.md CHANGED
@@ -16,6 +16,9 @@ let value: MarketDetail = {
16
16
  currentPriceUsd: "<value>",
17
17
  sectors: [],
18
18
  regionExposure: [],
19
+ provider: "ixs",
20
+ assetClass: "MANAGED_VAULT",
21
+ chain: "arbitrum",
19
22
  priceHistory24h: [],
20
23
  tradableSessions: [],
21
24
  };
@@ -23,32 +26,32 @@ let value: MarketDetail = {
23
26
 
24
27
  ## Fields
25
28
 
26
- | Field | Type | Required | Description | Example |
27
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
- | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
29
- | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
30
- | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
31
- | `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address for this token. | |
32
- | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
33
- | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
34
- | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
35
- | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
36
- | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
37
- | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
38
- | `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_minus_sign: | Issuer/provider of a tokenized asset. | |
39
- | `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_minus_sign: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) trade via the<br/>swap-based `transact/buy` and `transact/sell` endpoints. | |
40
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_minus_sign: | The chain to use. | |
41
- | `apy7d` | *string* | :heavy_minus_sign: | Trailing 7-day annualized NAV growth (decimal fraction string, e.g. '0.0512' = 5.12%). RWA yield assets only; null until enough NAV history exists. | |
42
- | `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
43
- | `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
44
- | `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline as `(timestamp, price)` samples in chronological order. | [] |
45
- | `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
46
- | `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
47
- | `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
48
- | `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
49
- | `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
50
- | `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
51
- | `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized equity. | |
52
- | `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
53
- | `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
54
- | `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. | |
29
+ | Field | Type | Required | Description | Example |
30
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
31
+ | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
32
+ | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
33
+ | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
34
+ | `contractAddress` | *string* | :heavy_check_mark: | On-chain ERC-20 address for this token, on the network given by `chain`. | |
35
+ | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
36
+ | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
37
+ | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
38
+ | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
39
+ | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
40
+ | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
41
+ | `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_check_mark: | Issuer/provider of a tokenized asset. | |
42
+ | `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_check_mark: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`<br/>trade via the swap-based `transact/buy` and `transact/sell` endpoints.<br/>`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an<br/>*asynchronous* redemption request settled off-chain by the vault operator. | |
43
+ | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
44
+ | `apy7d` | *string* | :heavy_minus_sign: | Trailing 7-day annualized NAV growth (decimal fraction string, e.g. '0.0512' = 5.12%). RWA yield assets only; null until enough NAV history exists. | |
45
+ | `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
46
+ | `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
47
+ | `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline as `(timestamp, price)` samples in chronological order. | [] |
48
+ | `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
49
+ | `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
50
+ | `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
51
+ | `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
52
+ | `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
53
+ | `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
54
+ | `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized equity. | |
55
+ | `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
56
+ | `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
57
+ | `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. | |
package/docs/models/components/morpholendingmarket.md ADDED
@@ -0,0 +1,49 @@
1
+ # MorphoLendingMarket
2
+
3
+ A Morpho Blue lending market: one isolated (collateral, loan) pair.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { MorphoLendingMarket } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: MorphoLendingMarket = {
11
+ marketId: "<id>",
12
+ loanToken: "<value>",
13
+ loanTokenSymbol: "<value>",
14
+ loanTokenDecimals: 959829,
15
+ collateralToken: "<value>",
16
+ collateralTokenSymbol: "<value>",
17
+ collateralTokenDecimals: 294886,
18
+ oracle: "<value>",
19
+ irm: "<value>",
20
+ lltv: "<value>",
21
+ utilization: "<value>",
22
+ totalSupplyAssets: "<value>",
23
+ totalBorrowAssets: "<value>",
24
+ availableLiquidity: "<value>",
25
+ fee: "<value>",
26
+ };
27
+ ```
28
+
29
+ ## Fields
30
+
31
+ | Field | Type | Required | Description |
32
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
33
+ | `marketId` | *string* | :heavy_check_mark: | Morpho Blue market id — the bytes32 keccak of the market's (loanToken, collateralToken, oracle, irm, lltv) tuple. Pass this to the Morpho credit actions to identify the market. |
34
+ | `loanToken` | *string* | :heavy_check_mark: | Token that is supplied and borrowed in this market. |
35
+ | `loanTokenSymbol` | *string* | :heavy_check_mark: | Symbol of the loan token (e.g. USDC). |
36
+ | `loanTokenDecimals` | *number* | :heavy_check_mark: | Decimals of the loan token. |
37
+ | `collateralToken` | *string* | :heavy_check_mark: | Token accepted as collateral in this market. |
38
+ | `collateralTokenSymbol` | *string* | :heavy_check_mark: | Symbol of the collateral token (e.g. wstETH). |
39
+ | `collateralTokenDecimals` | *number* | :heavy_check_mark: | Decimals of the collateral token. |
40
+ | `oracle` | *string* | :heavy_check_mark: | Oracle pricing the collateral in loan-token terms for this market. |
41
+ | `irm` | *string* | :heavy_check_mark: | Interest rate model contract of this market. |
42
+ | `lltv` | *string* | :heavy_check_mark: | Liquidation loan-to-value in percentage (e.g. 86 means a position is liquidatable once debt exceeds 86% of collateral value). |
43
+ | `supplyApy` | *string* | :heavy_minus_sign: | Current supply APY for lending the loan token, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable. |
44
+ | `borrowApy` | *string* | :heavy_minus_sign: | Current borrow APY for the loan token, in percentage (e.g. 5.25 means 5.25%). Null if the rate is unavailable. |
45
+ | `utilization` | *string* | :heavy_check_mark: | Borrowed share of supplied assets, in percentage 0-100. |
46
+ | `totalSupplyAssets` | *string* | :heavy_check_mark: | Total loan tokens supplied to the market, in token units. |
47
+ | `totalBorrowAssets` | *string* | :heavy_check_mark: | Total loan tokens borrowed from the market, in token units. |
48
+ | `availableLiquidity` | *string* | :heavy_check_mark: | Loan tokens available to borrow or withdraw (supplied - borrowed), in token units. |
49
+ | `fee` | *string* | :heavy_check_mark: | Protocol fee taken from interest, in percentage of interest (e.g. 0 means no fee). |
package/docs/models/components/morphomarketsresponse.md ADDED
@@ -0,0 +1,21 @@
1
+ # MorphoMarketsResponse
2
+
3
+ Curated Morpho Blue lending markets, read on-chain per request.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { MorphoMarketsResponse } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: MorphoMarketsResponse = {
11
+ morpho: "<value>",
12
+ markets: [],
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description | Example |
19
+ | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
20
+ | `morpho` | *string* | :heavy_check_mark: | Morpho Blue singleton contract the markets were read from. | |
21
+ | `markets` | [components.MorphoLendingMarket](../../models/components/morpholendingmarket.md)[] | :heavy_minus_sign: | Curated lending markets with live LLTV, APYs, utilization, and liquidity. | [] |
package/docs/models/components/redemption.md ADDED
@@ -0,0 +1,27 @@
1
+ # Redemption
2
+
3
+ One IXS vault redemption request, reconstructed on-chain.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { Redemption } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: Redemption = {
11
+ id: 125800,
12
+ status: "pending",
13
+ shares: "<value>",
14
+ requestedAt: 555089,
15
+ };
16
+ ```
17
+
18
+ ## Fields
19
+
20
+ | Field | Type | Required | Description |
21
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
+ | `id` | *number* | :heavy_check_mark: | On-chain redemption request id. |
23
+ | `status` | [components.RedemptionStatus](../../models/components/redemptionstatus.md) | :heavy_check_mark: | Lifecycle state: `pending` (awaiting operator settlement), `finalized` (settled — assets paid to the product account), `rejected` (operator declined; shares returned to the account), or `unknown` (an unrecognized on-chain status code — should not occur for the current contract, surfaced defensively instead of erroring). |
24
+ | `shares` | *string* | :heavy_check_mark: | Vault shares in the request (human units). |
25
+ | `expectedNetAssets` | *string* | :heavy_minus_sign: | For a `pending` request, the estimated net assets (after the exit fee) it would settle for at the current NAV — a preview, not a guarantee (settlement depends on the operator and the vault's available assets). Null once finalized or rejected. |
26
+ | `requestedAt` | *number* | :heavy_check_mark: | Unix timestamp when the redemption was requested. |
27
+ | `processedAt` | *number* | :heavy_minus_sign: | Unix timestamp when finalized/rejected; null while pending. |