@compass-labs/api-sdk 2.1.11 → 2.1.12-rc.0

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 (622) hide show
  1. package/CONTRIBUTING.md +26 -0
  2. package/USAGE.md +20 -0
  3. package/codeSamples_typescript.yaml +551 -0
  4. package/dist/commonjs/funcs/bridgeCctpMint.d.ts +2 -4
  5. package/dist/commonjs/funcs/bridgeCctpMint.d.ts.map +1 -1
  6. package/dist/commonjs/funcs/bridgeCctpMint.js +2 -4
  7. package/dist/commonjs/funcs/bridgeCctpMint.js.map +1 -1
  8. package/dist/commonjs/lib/config.d.ts +2 -2
  9. package/dist/commonjs/lib/config.js +2 -2
  10. package/dist/commonjs/sdk/bridge.d.ts +2 -4
  11. package/dist/commonjs/sdk/bridge.d.ts.map +1 -1
  12. package/dist/commonjs/sdk/bridge.js +2 -4
  13. package/dist/commonjs/sdk/bridge.js.map +1 -1
  14. package/dist/esm/funcs/bridgeCctpMint.d.ts +2 -4
  15. package/dist/esm/funcs/bridgeCctpMint.d.ts.map +1 -1
  16. package/dist/esm/funcs/bridgeCctpMint.js +2 -4
  17. package/dist/esm/funcs/bridgeCctpMint.js.map +1 -1
  18. package/dist/esm/lib/config.d.ts +2 -2
  19. package/dist/esm/lib/config.js +2 -2
  20. package/dist/esm/sdk/bridge.d.ts +2 -4
  21. package/dist/esm/sdk/bridge.d.ts.map +1 -1
  22. package/dist/esm/sdk/bridge.js +2 -4
  23. package/dist/esm/sdk/bridge.js.map +1 -1
  24. package/docs/lib/utils/retryconfig.md +24 -0
  25. package/docs/models/components/aaveavgrateresponse.md +27 -0
  26. package/docs/models/components/aaveborrowparams.md +24 -0
  27. package/docs/models/components/aaveborrowparamsamount.md +19 -0
  28. package/docs/models/components/aaveborrowrequest.md +29 -0
  29. package/docs/models/components/aaveborrowrequestamount.md +19 -0
  30. package/docs/models/components/aaveborrowrequestchain.md +15 -0
  31. package/docs/models/components/aavehistoricaltransactionsresponse.md +23 -0
  32. package/docs/models/components/aavehistoricaltransactionsresponsetransaction.md +148 -0
  33. package/docs/models/components/aaveliquiditychangeresponse.md +21 -0
  34. package/docs/models/components/aavelooprequest.md +46 -0
  35. package/docs/models/components/aavelooprequestchain.md +15 -0
  36. package/docs/models/components/aaveposition.md +25 -0
  37. package/docs/models/components/aaverateresponse.md +27 -0
  38. package/docs/models/components/aaverepayparams.md +24 -0
  39. package/docs/models/components/aaverepayparamsamount.md +19 -0
  40. package/docs/models/components/aaverepayrequest.md +29 -0
  41. package/docs/models/components/aaverepayrequestamount.md +19 -0
  42. package/docs/models/components/aaverepayrequestchain.md +15 -0
  43. package/docs/models/components/aavereserveoverviewresponse.md +21 -0
  44. package/docs/models/components/aavestdrateresponse.md +27 -0
  45. package/docs/models/components/aavesupplyparams.md +22 -0
  46. package/docs/models/components/aavesupplyparamsamount.md +19 -0
  47. package/docs/models/components/aavesupplyrequest.md +26 -0
  48. package/docs/models/components/aavesupplyrequestamount.md +19 -0
  49. package/docs/models/components/aavesupplyrequestchain.md +15 -0
  50. package/docs/models/components/aavesupportedtokenmetadata.md +23 -0
  51. package/docs/models/components/aavesupportedtokensresponse.md +24 -0
  52. package/docs/models/components/aavetokenpriceresponse.md +17 -0
  53. package/docs/models/components/aaveusdcratesresponse.md +40 -0
  54. package/docs/models/components/aaveuserpositionpertokenresponse.md +33 -0
  55. package/docs/models/components/aaveuserpositionsummaryresponse.md +27 -0
  56. package/docs/models/components/aavevenue.md +19 -0
  57. package/docs/models/components/aavewithdrawparams.md +23 -0
  58. package/docs/models/components/aavewithdrawparamsamount.md +19 -0
  59. package/docs/models/components/aavewithdrawrequest.md +27 -0
  60. package/docs/models/components/aavewithdrawrequestamount.md +19 -0
  61. package/docs/models/components/aavewithdrawrequestchain.md +15 -0
  62. package/docs/models/components/aerodromelppositionsresponse.md +17 -0
  63. package/docs/models/components/aerodromeposition.md +41 -0
  64. package/docs/models/components/aerodromeslipstreambuyexactlyparams.md +29 -0
  65. package/docs/models/components/aerodromeslipstreambuyexactlyparamsamountinmaximum.md +19 -0
  66. package/docs/models/components/aerodromeslipstreambuyexactlyparamsamountout.md +19 -0
  67. package/docs/models/components/aerodromeslipstreambuyexactlyrequest.md +33 -0
  68. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountinmaximum.md +19 -0
  69. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountout.md +19 -0
  70. package/docs/models/components/aerodromeslipstreambuyexactlyrequestchain.md +15 -0
  71. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparams.md +32 -0
  72. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount0desired.md +19 -0
  73. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount0min.md +19 -0
  74. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount1desired.md +19 -0
  75. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount1min.md +19 -0
  76. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequest.md +31 -0
  77. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0desired.md +19 -0
  78. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0min.md +19 -0
  79. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1desired.md +19 -0
  80. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1min.md +19 -0
  81. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestchain.md +15 -0
  82. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparams.md +38 -0
  83. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount0desired.md +19 -0
  84. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount0min.md +19 -0
  85. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount1desired.md +19 -0
  86. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount1min.md +19 -0
  87. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequest.md +43 -0
  88. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0desired.md +19 -0
  89. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0min.md +19 -0
  90. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1desired.md +19 -0
  91. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1min.md +19 -0
  92. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestchain.md +15 -0
  93. package/docs/models/components/aerodromeslipstreampoolpriceresponse.md +23 -0
  94. package/docs/models/components/aerodromeslipstreamsellexactlyparams.md +29 -0
  95. package/docs/models/components/aerodromeslipstreamsellexactlyparamsamountin.md +19 -0
  96. package/docs/models/components/aerodromeslipstreamsellexactlyparamsamountoutminimum.md +19 -0
  97. package/docs/models/components/aerodromeslipstreamsellexactlyrequest.md +33 -0
  98. package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountin.md +19 -0
  99. package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountoutminimum.md +19 -0
  100. package/docs/models/components/aerodromeslipstreamsellexactlyrequestchain.md +15 -0
  101. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionparams.md +26 -0
  102. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionparamspercentageforwithdrawal.md +19 -0
  103. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequest.md +25 -0
  104. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestchain.md +15 -0
  105. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +19 -0
  106. package/docs/models/components/allowanceinforesponse.md +27 -0
  107. package/docs/models/components/approvetransferrequest.md +22 -0
  108. package/docs/models/components/approvetransferresponse.md +48 -0
  109. package/docs/models/components/apy.md +23 -0
  110. package/docs/models/components/batchedsafeoperationsresponseinput.md +47 -0
  111. package/docs/models/components/batchedsafeoperationsresponseoutput.md +47 -0
  112. package/docs/models/components/batcheduseroperationsrequest.md +36 -0
  113. package/docs/models/components/batcheduseroperationsrequestchain.md +15 -0
  114. package/docs/models/components/batcheduseroperationsresponse.md +17 -0
  115. package/docs/models/components/body.md +424 -0
  116. package/docs/models/components/borrow.md +37 -0
  117. package/docs/models/components/borrowratemode.md +17 -0
  118. package/docs/models/components/bundlertransactionresponse.md +28 -0
  119. package/docs/models/components/chain.md +17 -0
  120. package/docs/models/components/chaininfo.md +18 -0
  121. package/docs/models/components/chainratedata.md +21 -0
  122. package/docs/models/components/compassapibackendv1modelsgenericreadresponseportfoliotokenbalance.md +27 -0
  123. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionapydata.md +20 -0
  124. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionasset.md +27 -0
  125. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionmarketstate.md +34 -0
  126. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultposition.md +52 -0
  127. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultstate.md +24 -0
  128. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketapydata.md +23 -0
  129. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketasset.md +27 -0
  130. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketmarketstate.md +28 -0
  131. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketsasset.md +23 -0
  132. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketsmarketstate.md +31 -0
  133. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsasset.md +25 -0
  134. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsvaultstate.md +28 -0
  135. package/docs/models/components/compassapibackendv1modelspendlereadresponsemarketuserposition.md +28 -0
  136. package/docs/models/components/compassapibackendv1modelspendlereadresponsepositionstokenbalance.md +19 -0
  137. package/docs/models/components/compassapibackendv1modelsvaultsreadresponsevaultuserposition.md +19 -0
  138. package/docs/models/components/compassapibackendv1modelswildcatreadresponsemarketuserposition.md +19 -0
  139. package/docs/models/components/compassapibackendv2modelsearnreadresponsepositionsvaultposition.md +27 -0
  140. package/docs/models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712domain.md +21 -0
  141. package/docs/models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712types.md +61 -0
  142. package/docs/models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712domain.md +26 -0
  143. package/docs/models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712types.md +21 -0
  144. package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md +23 -0
  145. package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md +23 -0
  146. package/docs/models/components/cooldownend.md +19 -0
  147. package/docs/models/components/cooldownposition.md +21 -0
  148. package/docs/models/components/createaccountrequest.md +24 -0
  149. package/docs/models/components/createaccountrequestchain.md +15 -0
  150. package/docs/models/components/createaccountresponse.md +31 -0
  151. package/docs/models/components/denomination.md +17 -0
  152. package/docs/models/components/depositforburnrequest.md +27 -0
  153. package/docs/models/components/depositforburnrequestamount.md +19 -0
  154. package/docs/models/components/depositforburnrequestchain.md +17 -0
  155. package/docs/models/components/depositforburnrequesttransfermode.md +17 -0
  156. package/docs/models/components/depositforburnresponse.md +68 -0
  157. package/docs/models/components/depositforburnresponsetransfermode.md +17 -0
  158. package/docs/models/components/destinationchain.md +17 -0
  159. package/docs/models/components/details.md +33 -0
  160. package/docs/models/components/earnmanagerequest.md +30 -0
  161. package/docs/models/components/earnmanagerequestaction.md +17 -0
  162. package/docs/models/components/earnmanageresponse.md +29 -0
  163. package/docs/models/components/earnpositionresponse.md +26 -0
  164. package/docs/models/components/earnpositionsresponse.md +17 -0
  165. package/docs/models/components/earnswaprequest.md +29 -0
  166. package/docs/models/components/earnswaprequestamountin.md +19 -0
  167. package/docs/models/components/earnswapresponse.md +58 -0
  168. package/docs/models/components/earntransferrequest.md +27 -0
  169. package/docs/models/components/earntransferrequestaction.md +17 -0
  170. package/docs/models/components/earntransferrequestamount.md +19 -0
  171. package/docs/models/components/earntransferresponse.md +56 -0
  172. package/docs/models/components/earntransferresponseeip712.md +102 -0
  173. package/docs/models/components/eip712domainfield.md +21 -0
  174. package/docs/models/components/eip712field.md +19 -0
  175. package/docs/models/components/ensnameinforesponse.md +21 -0
  176. package/docs/models/components/erc20data.md +23 -0
  177. package/docs/models/components/ethenadepositparams.md +20 -0
  178. package/docs/models/components/ethenadepositparamsamount.md +19 -0
  179. package/docs/models/components/ethenadepositrequest.md +24 -0
  180. package/docs/models/components/ethenadepositrequestamount.md +19 -0
  181. package/docs/models/components/ethenadepositrequestchain.md +15 -0
  182. package/docs/models/components/ethenagetvaultresponse.md +45 -0
  183. package/docs/models/components/ethenarequesttowithdrawparams.md +19 -0
  184. package/docs/models/components/ethenarequesttowithdrawrequest.md +23 -0
  185. package/docs/models/components/ethenarequesttowithdrawrequestchain.md +15 -0
  186. package/docs/models/components/ethenarequesttowithdrawtransactionresponse.md +29 -0
  187. package/docs/models/components/ethenarequesttowithdrawtransactionresponsetransaction.md +33 -0
  188. package/docs/models/components/ethenaunstakeparams.md +18 -0
  189. package/docs/models/components/ethenaunstakerequest.md +22 -0
  190. package/docs/models/components/ethenaunstakerequestchain.md +15 -0
  191. package/docs/models/components/fee.md +21 -0
  192. package/docs/models/components/feeamount.md +19 -0
  193. package/docs/models/components/feeenum.md +19 -0
  194. package/docs/models/components/initialcollateralamount.md +19 -0
  195. package/docs/models/components/interestratemode.md +19 -0
  196. package/docs/models/components/liquidationcall.md +45 -0
  197. package/docs/models/components/loantovalue.md +19 -0
  198. package/docs/models/components/loc.md +17 -0
  199. package/docs/models/components/lpbalance.md +21 -0
  200. package/docs/models/components/market.md +17 -0
  201. package/docs/models/components/marketposition.md +35 -0
  202. package/docs/models/components/markettokens.md +50 -0
  203. package/docs/models/components/maxslippagepercent.md +19 -0
  204. package/docs/models/components/maxsupplyapydata.md +24 -0
  205. package/docs/models/components/mintpreparecompletedresponse.md +27 -0
  206. package/docs/models/components/mintpreparependingresponse.md +33 -0
  207. package/docs/models/components/mintpreparereadyresponse.md +36 -0
  208. package/docs/models/components/mintpreparerequest.md +22 -0
  209. package/docs/models/components/morphoborrowparams.md +23 -0
  210. package/docs/models/components/morphoborrowparamsamount.md +19 -0
  211. package/docs/models/components/morphoborrowrequest.md +28 -0
  212. package/docs/models/components/morphoborrowrequestamount.md +19 -0
  213. package/docs/models/components/morphoborrowrequestchain.md +15 -0
  214. package/docs/models/components/morphocheckmarketpositionresponse.md +25 -0
  215. package/docs/models/components/morphocheckuserpositionresponse.md +28 -0
  216. package/docs/models/components/morphodepositparams.md +22 -0
  217. package/docs/models/components/morphodepositparamsamount.md +19 -0
  218. package/docs/models/components/morphodepositrequest.md +26 -0
  219. package/docs/models/components/morphodepositrequestamount.md +19 -0
  220. package/docs/models/components/morphodepositrequestchain.md +15 -0
  221. package/docs/models/components/morphogetmarketresponse.md +71 -0
  222. package/docs/models/components/morphogetmarketsresponse.md +17 -0
  223. package/docs/models/components/morphogetvaultsresponse.md +17 -0
  224. package/docs/models/components/morphomarket.md +49 -0
  225. package/docs/models/components/morphorepayparams.md +23 -0
  226. package/docs/models/components/morphorepayrequest.md +28 -0
  227. package/docs/models/components/morphorepayrequestchain.md +15 -0
  228. package/docs/models/components/morphosupplycollateralparams.md +23 -0
  229. package/docs/models/components/morphosupplycollateralparamsamount.md +19 -0
  230. package/docs/models/components/morphosupplycollateralrequest.md +28 -0
  231. package/docs/models/components/morphosupplycollateralrequestamount.md +19 -0
  232. package/docs/models/components/morphosupplycollateralrequestchain.md +15 -0
  233. package/docs/models/components/morphovault.md +51 -0
  234. package/docs/models/components/morphowithdrawcollateralparams.md +23 -0
  235. package/docs/models/components/morphowithdrawcollateralparamsamount.md +19 -0
  236. package/docs/models/components/morphowithdrawcollateralrequest.md +28 -0
  237. package/docs/models/components/morphowithdrawcollateralrequestamount.md +19 -0
  238. package/docs/models/components/morphowithdrawcollateralrequestchain.md +15 -0
  239. package/docs/models/components/morphowithdrawparams.md +22 -0
  240. package/docs/models/components/morphowithdrawrequest.md +26 -0
  241. package/docs/models/components/morphowithdrawrequestchain.md +15 -0
  242. package/docs/models/components/movement10percent.md +18 -0
  243. package/docs/models/components/multicallauthorizationrequest.md +25 -0
  244. package/docs/models/components/multicallauthorizationrequestchain.md +15 -0
  245. package/docs/models/components/multicallauthorizationresponse.md +23 -0
  246. package/docs/models/components/multicallexecuterequest.md +84 -0
  247. package/docs/models/components/multicallexecuterequestchain.md +15 -0
  248. package/docs/models/components/multiplier.md +19 -0
  249. package/docs/models/components/odosswapparams.md +25 -0
  250. package/docs/models/components/odosswapparamsamountin.md +19 -0
  251. package/docs/models/components/odosswaprequest.md +29 -0
  252. package/docs/models/components/odosswaprequestamountin.md +19 -0
  253. package/docs/models/components/odosswaprequestchain.md +15 -0
  254. package/docs/models/components/odostransactionresponse.md +23 -0
  255. package/docs/models/components/odostransactionresponsetransaction.md +33 -0
  256. package/docs/models/components/openposition.md +33 -0
  257. package/docs/models/components/operationtype.md +17 -0
  258. package/docs/models/components/pendlegetmarketresponse.md +55 -0
  259. package/docs/models/components/pendlelistmarketsresponse.md +42 -0
  260. package/docs/models/components/pendlelistuserpositionsresponse.md +67 -0
  261. package/docs/models/components/pendlemanageliquidityparams.md +27 -0
  262. package/docs/models/components/pendlemanageliquidityparamsaction.md +17 -0
  263. package/docs/models/components/pendlemanageliquidityparamsamountin.md +19 -0
  264. package/docs/models/components/pendlemanageliquidityrequest.md +31 -0
  265. package/docs/models/components/pendlemanageliquidityrequestaction.md +17 -0
  266. package/docs/models/components/pendlemanageliquidityrequestamountin.md +19 -0
  267. package/docs/models/components/pendlemanageliquidityrequestchain.md +15 -0
  268. package/docs/models/components/pendlemarket.md +48 -0
  269. package/docs/models/components/pendleredeemyieldparams.md +19 -0
  270. package/docs/models/components/pendleredeemyieldrequest.md +23 -0
  271. package/docs/models/components/pendleredeemyieldrequestchain.md +15 -0
  272. package/docs/models/components/pendletradeptparams.md +27 -0
  273. package/docs/models/components/pendletradeptparamsaction.md +17 -0
  274. package/docs/models/components/pendletradeptparamsamountin.md +19 -0
  275. package/docs/models/components/pendletradeptrequest.md +31 -0
  276. package/docs/models/components/pendletradeptrequestaction.md +17 -0
  277. package/docs/models/components/pendletradeptrequestamountin.md +19 -0
  278. package/docs/models/components/pendletradeptrequestchain.md +15 -0
  279. package/docs/models/components/pendletradeytparams.md +27 -0
  280. package/docs/models/components/pendletradeytparamsaction.md +17 -0
  281. package/docs/models/components/pendletradeytparamsamountin.md +19 -0
  282. package/docs/models/components/pendletradeytrequest.md +31 -0
  283. package/docs/models/components/pendletradeytrequestaction.md +17 -0
  284. package/docs/models/components/pendletradeytrequestamountin.md +19 -0
  285. package/docs/models/components/pendletradeytrequestchain.md +15 -0
  286. package/docs/models/components/pendletxresponse.md +29 -0
  287. package/docs/models/components/pendletxresponsetransaction.md +33 -0
  288. package/docs/models/components/permit2typeddatainput.md +76 -0
  289. package/docs/models/components/permit2typeddataoutput.md +76 -0
  290. package/docs/models/components/permitfield.md +21 -0
  291. package/docs/models/components/permitmessage.md +27 -0
  292. package/docs/models/components/permittransferfrommessage.md +26 -0
  293. package/docs/models/components/permittypeddataresponseinput.md +39 -0
  294. package/docs/models/components/permittypeddataresponseoutput.md +39 -0
  295. package/docs/models/components/portfolio.md +28 -0
  296. package/docs/models/components/position.md +70 -0
  297. package/docs/models/components/positionunion.md +32 -0
  298. package/docs/models/components/protocol.md +15 -0
  299. package/docs/models/components/r.md +19 -0
  300. package/docs/models/components/repay.md +35 -0
  301. package/docs/models/components/reserve.md +22 -0
  302. package/docs/models/components/s.md +19 -0
  303. package/docs/models/components/safetxfield.md +21 -0
  304. package/docs/models/components/safetxmessage.md +37 -0
  305. package/docs/models/components/security.md +17 -0
  306. package/docs/models/components/setallowanceparams.md +25 -0
  307. package/docs/models/components/setallowanceparamsamount.md +19 -0
  308. package/docs/models/components/setallowanceparamscontractenum.md +15 -0
  309. package/docs/models/components/setallowanceparamscontractunion.md +20 -0
  310. package/docs/models/components/setallowancerequest.md +29 -0
  311. package/docs/models/components/setallowancerequestamount.md +19 -0
  312. package/docs/models/components/setallowancerequestchain.md +15 -0
  313. package/docs/models/components/setallowancerequestcontractenum.md +15 -0
  314. package/docs/models/components/setallowancerequestcontractunion.md +19 -0
  315. package/docs/models/components/signedauthorization.md +27 -0
  316. package/docs/models/components/skybuyparams.md +21 -0
  317. package/docs/models/components/skybuyparamsamount.md +19 -0
  318. package/docs/models/components/skybuyparamstokenin.md +17 -0
  319. package/docs/models/components/skybuyrequest.md +25 -0
  320. package/docs/models/components/skybuyrequestamount.md +19 -0
  321. package/docs/models/components/skybuyrequestchain.md +15 -0
  322. package/docs/models/components/skybuyrequesttokenin.md +17 -0
  323. package/docs/models/components/skycheckpositionresponse.md +19 -0
  324. package/docs/models/components/skydepositparams.md +20 -0
  325. package/docs/models/components/skydepositparamsamount.md +19 -0
  326. package/docs/models/components/skydepositrequest.md +24 -0
  327. package/docs/models/components/skydepositrequestamount.md +19 -0
  328. package/docs/models/components/skydepositrequestchain.md +15 -0
  329. package/docs/models/components/skysellparams.md +21 -0
  330. package/docs/models/components/skysellparamsamount.md +19 -0
  331. package/docs/models/components/skysellparamstokenout.md +17 -0
  332. package/docs/models/components/skysellrequest.md +25 -0
  333. package/docs/models/components/skysellrequestamount.md +19 -0
  334. package/docs/models/components/skysellrequestchain.md +15 -0
  335. package/docs/models/components/skysellrequesttokenout.md +17 -0
  336. package/docs/models/components/skywithdrawparams.md +20 -0
  337. package/docs/models/components/skywithdrawrequest.md +24 -0
  338. package/docs/models/components/skywithdrawrequestchain.md +15 -0
  339. package/docs/models/components/slippage.md +19 -0
  340. package/docs/models/components/sponsorgasrequest.md +84 -0
  341. package/docs/models/components/sponsorgasrequesteip712.md +129 -0
  342. package/docs/models/components/sponsorgasresponse.md +27 -0
  343. package/docs/models/components/supply.md +35 -0
  344. package/docs/models/components/supportedchaininfo.md +19 -0
  345. package/docs/models/components/swapborrowrate.md +39 -0
  346. package/docs/models/components/syposition.md +19 -0
  347. package/docs/models/components/tokenbalanceresponse.md +25 -0
  348. package/docs/models/components/tokenconfig.md +23 -0
  349. package/docs/models/components/tokenlistresponse.md +26 -0
  350. package/docs/models/components/tokenpermissions.md +19 -0
  351. package/docs/models/components/tokenpriceresponse.md +17 -0
  352. package/docs/models/components/tokentransferparams.md +25 -0
  353. package/docs/models/components/tokentransferparamsamount.md +19 -0
  354. package/docs/models/components/tokentransferrequest.md +29 -0
  355. package/docs/models/components/tokentransferrequestamount.md +19 -0
  356. package/docs/models/components/tokentransferrequestchain.md +15 -0
  357. package/docs/models/components/transactionresponse.md +21 -0
  358. package/docs/models/components/transactionresponsetransaction.md +33 -0
  359. package/docs/models/components/underlyingtoken.md +23 -0
  360. package/docs/models/components/uniswapbuyexactlyparams.md +27 -0
  361. package/docs/models/components/uniswapbuyexactlyparamsamountout.md +19 -0
  362. package/docs/models/components/uniswapbuyexactlyrequest.md +33 -0
  363. package/docs/models/components/uniswapbuyexactlyrequestamountout.md +19 -0
  364. package/docs/models/components/uniswapbuyexactlyrequestchain.md +15 -0
  365. package/docs/models/components/uniswapbuyexactlytransactionresponse.md +29 -0
  366. package/docs/models/components/uniswapbuyexactlytransactionresponsetransaction.md +33 -0
  367. package/docs/models/components/uniswapbuyquoteinforesponse.md +19 -0
  368. package/docs/models/components/uniswapcheckinrangeresponse.md +17 -0
  369. package/docs/models/components/uniswapincreaseliquidityprovisionparams.md +27 -0
  370. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount0desired.md +19 -0
  371. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount0min.md +19 -0
  372. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount1desired.md +19 -0
  373. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount1min.md +19 -0
  374. package/docs/models/components/uniswapincreaseliquidityprovisionrequest.md +33 -0
  375. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0desired.md +19 -0
  376. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0min.md +19 -0
  377. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1desired.md +19 -0
  378. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1min.md +19 -0
  379. package/docs/models/components/uniswapincreaseliquidityprovisionrequestchain.md +15 -0
  380. package/docs/models/components/uniswaplppositionsinforesponse.md +17 -0
  381. package/docs/models/components/uniswapmintliquidityprovisionparams.md +36 -0
  382. package/docs/models/components/uniswapmintliquidityprovisionparamsamount0desired.md +19 -0
  383. package/docs/models/components/uniswapmintliquidityprovisionparamsamount0min.md +19 -0
  384. package/docs/models/components/uniswapmintliquidityprovisionparamsamount1desired.md +19 -0
  385. package/docs/models/components/uniswapmintliquidityprovisionparamsamount1min.md +19 -0
  386. package/docs/models/components/uniswapmintliquidityprovisionrequest.md +43 -0
  387. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0desired.md +19 -0
  388. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0min.md +19 -0
  389. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1desired.md +19 -0
  390. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1min.md +19 -0
  391. package/docs/models/components/uniswapmintliquidityprovisionrequestchain.md +15 -0
  392. package/docs/models/components/uniswappoolpriceresponse.md +23 -0
  393. package/docs/models/components/uniswappositionssolidityresponse.md +40 -0
  394. package/docs/models/components/uniswapsellexactlyparams.md +29 -0
  395. package/docs/models/components/uniswapsellexactlyparamsamountin.md +19 -0
  396. package/docs/models/components/uniswapsellexactlyrequest.md +33 -0
  397. package/docs/models/components/uniswapsellexactlyrequestamountin.md +19 -0
  398. package/docs/models/components/uniswapsellexactlyrequestchain.md +15 -0
  399. package/docs/models/components/uniswapsellexactlytransactionresponse.md +23 -0
  400. package/docs/models/components/uniswapsellexactlytransactionresponsetransaction.md +33 -0
  401. package/docs/models/components/uniswapsellquoteinforesponse.md +19 -0
  402. package/docs/models/components/uniswapwithdrawliquidityprovisionparams.md +26 -0
  403. package/docs/models/components/uniswapwithdrawliquidityprovisionparamspercentageforwithdrawal.md +19 -0
  404. package/docs/models/components/uniswapwithdrawliquidityprovisionrequest.md +25 -0
  405. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestchain.md +15 -0
  406. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +19 -0
  407. package/docs/models/components/unsignedmulticalltransaction.md +35 -0
  408. package/docs/models/components/unsignedtransaction.md +33 -0
  409. package/docs/models/components/unwrapwethparams.md +21 -0
  410. package/docs/models/components/unwrapwethparamsamount.md +19 -0
  411. package/docs/models/components/unwrapwethrequest.md +25 -0
  412. package/docs/models/components/unwrapwethrequestamount.md +19 -0
  413. package/docs/models/components/unwrapwethrequestchain.md +15 -0
  414. package/docs/models/components/usageascollateral.md +35 -0
  415. package/docs/models/components/useroperation.md +21 -0
  416. package/docs/models/components/useroperationresponse.md +21 -0
  417. package/docs/models/components/userposition.md +30 -0
  418. package/docs/models/components/userstate.md +27 -0
  419. package/docs/models/components/validationerror.md +23 -0
  420. package/docs/models/components/vault.md +47 -0
  421. package/docs/models/components/vaultdepositparams.md +22 -0
  422. package/docs/models/components/vaultdepositparamsamount.md +19 -0
  423. package/docs/models/components/vaultdepositrequest.md +26 -0
  424. package/docs/models/components/vaultdepositrequestamount.md +19 -0
  425. package/docs/models/components/vaultdepositrequestchain.md +15 -0
  426. package/docs/models/components/vaultgetvaultresponse.md +42 -0
  427. package/docs/models/components/vaultinfo.md +57 -0
  428. package/docs/models/components/vaultslistresponse.md +25 -0
  429. package/docs/models/components/vaultvenue.md +19 -0
  430. package/docs/models/components/vaultwithdrawparams.md +22 -0
  431. package/docs/models/components/vaultwithdrawrequest.md +26 -0
  432. package/docs/models/components/vaultwithdrawrequestchain.md +15 -0
  433. package/docs/models/components/venue.md +25 -0
  434. package/docs/models/components/weeklyapys.md +23 -0
  435. package/docs/models/components/wildcatgetmarketresponse.md +57 -0
  436. package/docs/models/components/withdraw.md +35 -0
  437. package/docs/models/components/wrapethparams.md +21 -0
  438. package/docs/models/components/wrapethparamsamount.md +19 -0
  439. package/docs/models/components/wrapethrequest.md +25 -0
  440. package/docs/models/components/wrapethrequestamount.md +19 -0
  441. package/docs/models/components/wrapethrequestchain.md +15 -0
  442. package/docs/models/components/yieldrange.md +19 -0
  443. package/docs/models/errors/httpvalidationerror.md +15 -0
  444. package/docs/models/errors/mintpreparenotfoundresponseerror.md +22 -0
  445. package/docs/models/operations/amountin.md +19 -0
  446. package/docs/models/operations/amountout.md +19 -0
  447. package/docs/models/operations/contract.md +19 -0
  448. package/docs/models/operations/contractenum.md +15 -0
  449. package/docs/models/operations/direction.md +17 -0
  450. package/docs/models/operations/response200v2cctpmint.md +38 -0
  451. package/docs/models/operations/responsev1transactionbundleraaveloop.md +34 -0
  452. package/docs/models/operations/v1aaveaavesupportedtokenschain.md +15 -0
  453. package/docs/models/operations/v1aaveaavesupportedtokensrequest.md +18 -0
  454. package/docs/models/operations/v1aaveavgratechain.md +15 -0
  455. package/docs/models/operations/v1aaveavgraterequest.md +22 -0
  456. package/docs/models/operations/v1aavehistoricaltransactionschain.md +15 -0
  457. package/docs/models/operations/v1aavehistoricaltransactionsrequest.md +23 -0
  458. package/docs/models/operations/v1aaveliquiditychangechain.md +15 -0
  459. package/docs/models/operations/v1aaveliquiditychangerequest.md +23 -0
  460. package/docs/models/operations/v1aaveratechain.md +15 -0
  461. package/docs/models/operations/v1aaveraterequest.md +20 -0
  462. package/docs/models/operations/v1aavereserveoverviewchain.md +15 -0
  463. package/docs/models/operations/v1aavereserveoverviewrequest.md +20 -0
  464. package/docs/models/operations/v1aavestdratechain.md +15 -0
  465. package/docs/models/operations/v1aavestdraterequest.md +22 -0
  466. package/docs/models/operations/v1aavetokenpricechain.md +15 -0
  467. package/docs/models/operations/v1aavetokenpricerequest.md +20 -0
  468. package/docs/models/operations/v1aaveuserpositionpertokenchain.md +15 -0
  469. package/docs/models/operations/v1aaveuserpositionpertokenrequest.md +22 -0
  470. package/docs/models/operations/v1aaveuserpositionsummarychain.md +15 -0
  471. package/docs/models/operations/v1aaveuserpositionsummaryrequest.md +20 -0
  472. package/docs/models/operations/v1aerodromeslipstreamliquidityprovisionpositionschain.md +15 -0
  473. package/docs/models/operations/v1aerodromeslipstreamliquidityprovisionpositionsrequest.md +19 -0
  474. package/docs/models/operations/v1aerodromeslipstreampoolpricechain.md +15 -0
  475. package/docs/models/operations/v1aerodromeslipstreampoolpricerequest.md +23 -0
  476. package/docs/models/operations/v1ethenavaultchain.md +15 -0
  477. package/docs/models/operations/v1ethenavaultrequest.md +20 -0
  478. package/docs/models/operations/v1genericallowancechain.md +15 -0
  479. package/docs/models/operations/v1genericallowancerequest.md +23 -0
  480. package/docs/models/operations/v1genericenschain.md +15 -0
  481. package/docs/models/operations/v1genericensrequest.md +19 -0
  482. package/docs/models/operations/v1genericportfoliochain.md +15 -0
  483. package/docs/models/operations/v1genericportfoliorequest.md +19 -0
  484. package/docs/models/operations/v1genericsupportedchainsrequest.md +17 -0
  485. package/docs/models/operations/v1morphomarketchain.md +15 -0
  486. package/docs/models/operations/v1morphomarketpositionchain.md +15 -0
  487. package/docs/models/operations/v1morphomarketpositionrequest.md +22 -0
  488. package/docs/models/operations/v1morphomarketrequest.md +20 -0
  489. package/docs/models/operations/v1morphomarketschain.md +15 -0
  490. package/docs/models/operations/v1morphomarketsrequest.md +21 -0
  491. package/docs/models/operations/v1morphouserpositionchain.md +15 -0
  492. package/docs/models/operations/v1morphouserpositionrequest.md +19 -0
  493. package/docs/models/operations/v1morphovaultchain.md +15 -0
  494. package/docs/models/operations/v1morphovaultrequest.md +22 -0
  495. package/docs/models/operations/v1morphovaultschain.md +15 -0
  496. package/docs/models/operations/v1morphovaultsrequest.md +19 -0
  497. package/docs/models/operations/v1pendlemarketchain.md +15 -0
  498. package/docs/models/operations/v1pendlemarketrequest.md +22 -0
  499. package/docs/models/operations/v1pendlemarketschain.md +15 -0
  500. package/docs/models/operations/v1pendlemarketsrequest.md +17 -0
  501. package/docs/models/operations/v1pendlepositionschain.md +15 -0
  502. package/docs/models/operations/v1pendlepositionsrequest.md +19 -0
  503. package/docs/models/operations/v1skypositionchain.md +15 -0
  504. package/docs/models/operations/v1skypositionrequest.md +19 -0
  505. package/docs/models/operations/v1tokenbalancechain.md +15 -0
  506. package/docs/models/operations/v1tokenbalancerequest.md +21 -0
  507. package/docs/models/operations/v1tokenlistchain.md +15 -0
  508. package/docs/models/operations/v1tokenlistrequest.md +17 -0
  509. package/docs/models/operations/v1tokenpricechain.md +15 -0
  510. package/docs/models/operations/v1tokenpricerequest.md +20 -0
  511. package/docs/models/operations/v1uniswapliquidityprovisioninrangechain.md +15 -0
  512. package/docs/models/operations/v1uniswapliquidityprovisioninrangerequest.md +19 -0
  513. package/docs/models/operations/v1uniswapliquidityprovisionpositionschain.md +15 -0
  514. package/docs/models/operations/v1uniswapliquidityprovisionpositionsrequest.md +19 -0
  515. package/docs/models/operations/v1uniswappoolpricechain.md +15 -0
  516. package/docs/models/operations/v1uniswappoolpricefeeenum.md +19 -0
  517. package/docs/models/operations/v1uniswappoolpricerequest.md +23 -0
  518. package/docs/models/operations/v1uniswapquotebuyexactlychain.md +15 -0
  519. package/docs/models/operations/v1uniswapquotebuyexactlyfeeenum.md +19 -0
  520. package/docs/models/operations/v1uniswapquotebuyexactlyrequest.md +25 -0
  521. package/docs/models/operations/v1uniswapquotesellexactlychain.md +15 -0
  522. package/docs/models/operations/v1uniswapquotesellexactlyfeeenum.md +19 -0
  523. package/docs/models/operations/v1uniswapquotesellexactlyrequest.md +25 -0
  524. package/docs/models/operations/v1vaultsvaultchain.md +15 -0
  525. package/docs/models/operations/v1vaultsvaultrequest.md +22 -0
  526. package/docs/models/operations/v1wildcatmarketchain.md +15 -0
  527. package/docs/models/operations/v1wildcatmarketrequest.md +22 -0
  528. package/docs/models/operations/v2cctpmintresponse.md +26 -0
  529. package/docs/models/operations/v2earnaavetokenratesrequest.md +17 -0
  530. package/docs/models/operations/v2earnpositionschain.md +15 -0
  531. package/docs/models/operations/v2earnpositionspositionidrequest.md +21 -0
  532. package/docs/models/operations/v2earnpositionsrequest.md +25 -0
  533. package/docs/models/operations/v2earnvaultschain.md +15 -0
  534. package/docs/models/operations/v2earnvaultsrequest.md +25 -0
  535. package/docs/sdks/aavev3/README.md +1247 -0
  536. package/docs/sdks/aerodromeslipstream/README.md +702 -0
  537. package/docs/sdks/bridge/README.md +222 -0
  538. package/docs/sdks/earn/README.md +696 -0
  539. package/docs/sdks/erc4626vaults/README.md +264 -0
  540. package/docs/sdks/ethena/README.md +357 -0
  541. package/docs/sdks/gassponsorship/README.md +296 -0
  542. package/docs/sdks/morpho/README.md +1066 -0
  543. package/docs/sdks/pendle/README.md +630 -0
  544. package/docs/sdks/sky/README.md +458 -0
  545. package/docs/sdks/smartaccount/README.md +106 -0
  546. package/docs/sdks/swap/README.md +100 -0
  547. package/docs/sdks/token/README.md +481 -0
  548. package/docs/sdks/transactionbundler/README.md +411 -0
  549. package/docs/sdks/uniswapv3/README.md +947 -0
  550. package/docs/sdks/universal/README.md +419 -0
  551. package/docs/sdks/wildcat/README.md +88 -0
  552. package/eslint.config.mjs +22 -0
  553. package/examples/README.md +31 -0
  554. package/examples/node_modules/@esbuild/linux-x64/README.md +3 -0
  555. package/examples/node_modules/@esbuild/linux-x64/bin/esbuild +0 -0
  556. package/examples/node_modules/@types/node/LICENSE +21 -0
  557. package/examples/node_modules/@types/node/README.md +15 -0
  558. package/examples/node_modules/dotenv/CHANGELOG.md +520 -0
  559. package/examples/node_modules/dotenv/LICENSE +23 -0
  560. package/examples/node_modules/dotenv/README-es.md +411 -0
  561. package/examples/node_modules/dotenv/README.md +645 -0
  562. package/examples/node_modules/dotenv/SECURITY.md +1 -0
  563. package/examples/node_modules/esbuild/LICENSE.md +21 -0
  564. package/examples/node_modules/esbuild/README.md +3 -0
  565. package/examples/node_modules/esbuild/bin/esbuild +0 -0
  566. package/examples/node_modules/get-tsconfig/LICENSE +21 -0
  567. package/examples/node_modules/get-tsconfig/README.md +235 -0
  568. package/examples/node_modules/get-tsconfig/dist/index.cjs +7 -0
  569. package/examples/node_modules/get-tsconfig/dist/index.d.cts +2088 -0
  570. package/examples/node_modules/get-tsconfig/dist/index.d.mts +2088 -0
  571. package/examples/node_modules/get-tsconfig/dist/index.mjs +0 -0
  572. package/examples/node_modules/resolve-pkg-maps/LICENSE +21 -0
  573. package/examples/node_modules/resolve-pkg-maps/README.md +216 -0
  574. package/examples/node_modules/resolve-pkg-maps/dist/index.cjs +1 -0
  575. package/examples/node_modules/resolve-pkg-maps/dist/index.d.cts +11 -0
  576. package/examples/node_modules/resolve-pkg-maps/dist/index.d.mts +11 -0
  577. package/examples/node_modules/resolve-pkg-maps/dist/index.mjs +0 -0
  578. package/examples/node_modules/tsx/LICENSE +21 -0
  579. package/examples/node_modules/tsx/README.md +32 -0
  580. package/examples/node_modules/tsx/dist/cjs/api/index.cjs +1 -0
  581. package/examples/node_modules/tsx/dist/cjs/api/index.d.cts +35 -0
  582. package/examples/node_modules/tsx/dist/cjs/api/index.d.mts +35 -0
  583. package/examples/node_modules/tsx/dist/cjs/api/index.mjs +0 -0
  584. package/examples/node_modules/tsx/dist/cjs/index.cjs +1 -0
  585. package/examples/node_modules/tsx/dist/cjs/index.mjs +0 -0
  586. package/examples/node_modules/tsx/dist/cli.cjs +54 -0
  587. package/examples/node_modules/tsx/dist/cli.mjs +0 -0
  588. package/examples/node_modules/tsx/dist/client-D6NvIMSC.cjs +1 -0
  589. package/examples/node_modules/tsx/dist/esm/api/index.cjs +1 -0
  590. package/examples/node_modules/tsx/dist/esm/api/index.d.cts +35 -0
  591. package/examples/node_modules/tsx/dist/esm/api/index.d.mts +35 -0
  592. package/examples/node_modules/tsx/dist/esm/api/index.mjs +0 -0
  593. package/examples/node_modules/tsx/dist/esm/index.cjs +2 -0
  594. package/examples/node_modules/tsx/dist/esm/index.mjs +0 -0
  595. package/examples/node_modules/tsx/dist/get-pipe-path-BoR10qr8.cjs +1 -0
  596. package/examples/node_modules/tsx/dist/index-BWFBUo6r.cjs +1 -0
  597. package/examples/node_modules/tsx/dist/index-gckBtVBf.cjs +14 -0
  598. package/examples/node_modules/tsx/dist/lexer-DgIbo0BU.cjs +3 -0
  599. package/examples/node_modules/tsx/dist/loader.cjs +1 -0
  600. package/examples/node_modules/tsx/dist/loader.mjs +0 -0
  601. package/examples/node_modules/tsx/dist/node-features-roYmp9jK.cjs +1 -0
  602. package/examples/node_modules/tsx/dist/package-Dxt5kIHw.cjs +1 -0
  603. package/examples/node_modules/tsx/dist/patch-repl.cjs +1 -0
  604. package/examples/node_modules/tsx/dist/patch-repl.mjs +0 -0
  605. package/examples/node_modules/tsx/dist/preflight.cjs +1 -0
  606. package/examples/node_modules/tsx/dist/preflight.mjs +0 -0
  607. package/examples/node_modules/tsx/dist/register-2sWVXuRQ.cjs +1 -0
  608. package/examples/node_modules/tsx/dist/register-D46fvsV_.cjs +4 -0
  609. package/examples/node_modules/tsx/dist/repl.cjs +3 -0
  610. package/examples/node_modules/tsx/dist/repl.mjs +0 -0
  611. package/examples/node_modules/tsx/dist/require-D4F1Lv60.cjs +1 -0
  612. package/examples/node_modules/tsx/dist/suppress-warnings.cjs +1 -0
  613. package/examples/node_modules/tsx/dist/suppress-warnings.mjs +0 -0
  614. package/examples/node_modules/tsx/dist/temporary-directory-B83uKxJF.cjs +1 -0
  615. package/examples/node_modules/undici-types/LICENSE +21 -0
  616. package/examples/node_modules/undici-types/README.md +6 -0
  617. package/package.json +1 -1
  618. package/src/funcs/bridgeCctpMint.ts +2 -4
  619. package/src/lib/config.ts +2 -2
  620. package/src/sdk/bridge.ts +2 -4
  621. package/tsconfig.json +1 -1
  622. package/examples/node_modules/.package-lock.json +0 -159
@@ -0,0 +1,1247 @@
1
+ # AaveV3
2
+ (*aaveV3*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [aaveAaveSupportedTokens](#aaveaavesupportedtokens) - Aave Supported Tokens
9
+ * [aaveRate](#aaverate) - Interest Rates
10
+ * [aaveAvgRate](#aaveavgrate) - Interest Rates: Time Average
11
+ * [aaveStdRate](#aavestdrate) - Interest Rates: Standard Deviation
12
+ * [aaveReserveOverview](#aavereserveoverview) - Reserve Overview
13
+ * [aaveTokenPrice](#aavetokenprice) - Token Prices
14
+ * [aaveLiquidityChange](#aaveliquiditychange) - Liquidity Index
15
+ * [aaveUserPositionSummary](#aaveuserpositionsummary) - Positions - Total
16
+ * [aaveUserPositionPerToken](#aaveuserpositionpertoken) - Positions - per Token
17
+ * [aaveHistoricalTransactions](#aavehistoricaltransactions) - Historical Transactions
18
+ * [aaveSupply](#aavesupply) - Supply/Lend
19
+ * [aaveBorrow](#aaveborrow) - Borrow
20
+ * [aaveRepay](#aaverepay) - Repay Loans
21
+ * [aaveWithdraw](#aavewithdraw) - Unstake
22
+
23
+ ## aaveAaveSupportedTokens
24
+
25
+ Returns the list of supported tokens on Aave for the specified network, along
26
+ with key metadata.
27
+
28
+ For each token, the response includes:
29
+ - The symbol and contract address.
30
+ - Whether the token is currently enabled for supplying (depositing).
31
+ - Whether it is enabled for borrowing.
32
+
33
+ ### Example Usage
34
+
35
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_aave_supported_tokens" method="get" path="/v1/aave/aave_supported_tokens" -->
36
+ ```typescript
37
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
38
+
39
+ const compassApiSDK = new CompassApiSDK({
40
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
41
+ });
42
+
43
+ async function run() {
44
+ const result = await compassApiSDK.aaveV3.aaveAaveSupportedTokens({
45
+ chain: "arbitrum",
46
+ });
47
+
48
+ console.log(result);
49
+ }
50
+
51
+ run();
52
+ ```
53
+
54
+ ### Standalone function
55
+
56
+ The standalone function version of this method:
57
+
58
+ ```typescript
59
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
60
+ import { aaveV3AaveAaveSupportedTokens } from "@compass-labs/api-sdk/funcs/aaveV3AaveAaveSupportedTokens.js";
61
+
62
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
63
+ // You can create one instance of it to use across an application.
64
+ const compassApiSDK = new CompassApiSDKCore({
65
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
66
+ });
67
+
68
+ async function run() {
69
+ const res = await aaveV3AaveAaveSupportedTokens(compassApiSDK, {
70
+ chain: "arbitrum",
71
+ });
72
+ if (res.ok) {
73
+ const { value: result } = res;
74
+ console.log(result);
75
+ } else {
76
+ console.log("aaveV3AaveAaveSupportedTokens failed:", res.error);
77
+ }
78
+ }
79
+
80
+ run();
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ | Parameter | Type | Required | Description |
86
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
87
+ | `request` | [operations.V1AaveAaveSupportedTokensRequest](../../models/operations/v1aaveaavesupportedtokensrequest.md) | :heavy_check_mark: | The request object to use for the request. |
88
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
89
+ | `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. |
90
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
91
+
92
+ ### Response
93
+
94
+ **Promise\<[components.AaveSupportedTokensResponse](../../models/components/aavesupportedtokensresponse.md)\>**
95
+
96
+ ### Errors
97
+
98
+ | Error Type | Status Code | Content Type |
99
+ | -------------------------- | -------------------------- | -------------------------- |
100
+ | errors.HTTPValidationError | 422 | application/json |
101
+ | errors.APIError | 4XX, 5XX | \*/\* |
102
+
103
+ ## aaveRate
104
+
105
+ Returns the latest APY and APR rates for a specified token on Aave, for both
106
+ deposits and loans.
107
+
108
+ **Annual percentage yield (APY)** is the yearly return/cost after continuous
109
+ compounding of the per-second rate stored on-chain. This value is the same value as
110
+ seen the on [app.aave.com](
111
+ https://app.aave.com/)
112
+ but more up-to-date as it is taken directly from the
113
+ blockchain every time this endpoint is called.
114
+
115
+ **Annual percentage rate (APR)** is the yearly simple interest rate (no
116
+ compounding).
117
+
118
+ For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
119
+
120
+ ### Example Usage
121
+
122
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_rate" method="get" path="/v1/aave/rate" -->
123
+ ```typescript
124
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
125
+
126
+ const compassApiSDK = new CompassApiSDK({
127
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
128
+ });
129
+
130
+ async function run() {
131
+ const result = await compassApiSDK.aaveV3.aaveRate({
132
+ chain: "arbitrum",
133
+ token: "USDC",
134
+ });
135
+
136
+ console.log(result);
137
+ }
138
+
139
+ run();
140
+ ```
141
+
142
+ ### Standalone function
143
+
144
+ The standalone function version of this method:
145
+
146
+ ```typescript
147
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
148
+ import { aaveV3AaveRate } from "@compass-labs/api-sdk/funcs/aaveV3AaveRate.js";
149
+
150
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
151
+ // You can create one instance of it to use across an application.
152
+ const compassApiSDK = new CompassApiSDKCore({
153
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
154
+ });
155
+
156
+ async function run() {
157
+ const res = await aaveV3AaveRate(compassApiSDK, {
158
+ chain: "arbitrum",
159
+ token: "USDC",
160
+ });
161
+ if (res.ok) {
162
+ const { value: result } = res;
163
+ console.log(result);
164
+ } else {
165
+ console.log("aaveV3AaveRate failed:", res.error);
166
+ }
167
+ }
168
+
169
+ run();
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+ | Parameter | Type | Required | Description |
175
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
176
+ | `request` | [operations.V1AaveRateRequest](../../models/operations/v1aaveraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
177
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
178
+ | `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. |
179
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
180
+
181
+ ### Response
182
+
183
+ **Promise\<[components.AaveRateResponse](../../models/components/aaverateresponse.md)\>**
184
+
185
+ ### Errors
186
+
187
+ | Error Type | Status Code | Content Type |
188
+ | -------------------------- | -------------------------- | -------------------------- |
189
+ | errors.HTTPValidationError | 422 | application/json |
190
+ | errors.APIError | 4XX, 5XX | \*/\* |
191
+
192
+ ## aaveAvgRate
193
+
194
+ Provides time-weighted averages of deposit and borrow rates for Aave reserves.
195
+
196
+ ### Example Usage
197
+
198
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_avg_rate" method="get" path="/v1/aave/avg_rate" -->
199
+ ```typescript
200
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
201
+
202
+ const compassApiSDK = new CompassApiSDK({
203
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
204
+ });
205
+
206
+ async function run() {
207
+ const result = await compassApiSDK.aaveV3.aaveAvgRate({
208
+ chain: "ethereum",
209
+ token: "USDC",
210
+ days: 2,
211
+ });
212
+
213
+ console.log(result);
214
+ }
215
+
216
+ run();
217
+ ```
218
+
219
+ ### Standalone function
220
+
221
+ The standalone function version of this method:
222
+
223
+ ```typescript
224
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
225
+ import { aaveV3AaveAvgRate } from "@compass-labs/api-sdk/funcs/aaveV3AaveAvgRate.js";
226
+
227
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
228
+ // You can create one instance of it to use across an application.
229
+ const compassApiSDK = new CompassApiSDKCore({
230
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
231
+ });
232
+
233
+ async function run() {
234
+ const res = await aaveV3AaveAvgRate(compassApiSDK, {
235
+ chain: "ethereum",
236
+ token: "USDC",
237
+ days: 2,
238
+ });
239
+ if (res.ok) {
240
+ const { value: result } = res;
241
+ console.log(result);
242
+ } else {
243
+ console.log("aaveV3AaveAvgRate failed:", res.error);
244
+ }
245
+ }
246
+
247
+ run();
248
+ ```
249
+
250
+ ### Parameters
251
+
252
+ | Parameter | Type | Required | Description |
253
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
254
+ | `request` | [operations.V1AaveAvgRateRequest](../../models/operations/v1aaveavgraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
255
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
256
+ | `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. |
257
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
258
+
259
+ ### Response
260
+
261
+ **Promise\<[components.AaveAvgRateResponse](../../models/components/aaveavgrateresponse.md)\>**
262
+
263
+ ### Errors
264
+
265
+ | Error Type | Status Code | Content Type |
266
+ | -------------------------- | -------------------------- | -------------------------- |
267
+ | errors.HTTPValidationError | 422 | application/json |
268
+ | errors.APIError | 4XX, 5XX | \*/\* |
269
+
270
+ ## aaveStdRate
271
+
272
+ Returns the historical standard deviation of lending and borrowing rates for Aave
273
+ reserves, illustrating market volatility.
274
+
275
+ ### Example Usage
276
+
277
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_std_rate" method="get" path="/v1/aave/std_rate" -->
278
+ ```typescript
279
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
280
+
281
+ const compassApiSDK = new CompassApiSDK({
282
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
283
+ });
284
+
285
+ async function run() {
286
+ const result = await compassApiSDK.aaveV3.aaveStdRate({
287
+ chain: "ethereum",
288
+ token: "USDC",
289
+ days: 7,
290
+ });
291
+
292
+ console.log(result);
293
+ }
294
+
295
+ run();
296
+ ```
297
+
298
+ ### Standalone function
299
+
300
+ The standalone function version of this method:
301
+
302
+ ```typescript
303
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
304
+ import { aaveV3AaveStdRate } from "@compass-labs/api-sdk/funcs/aaveV3AaveStdRate.js";
305
+
306
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
307
+ // You can create one instance of it to use across an application.
308
+ const compassApiSDK = new CompassApiSDKCore({
309
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
310
+ });
311
+
312
+ async function run() {
313
+ const res = await aaveV3AaveStdRate(compassApiSDK, {
314
+ chain: "ethereum",
315
+ token: "USDC",
316
+ days: 7,
317
+ });
318
+ if (res.ok) {
319
+ const { value: result } = res;
320
+ console.log(result);
321
+ } else {
322
+ console.log("aaveV3AaveStdRate failed:", res.error);
323
+ }
324
+ }
325
+
326
+ run();
327
+ ```
328
+
329
+ ### Parameters
330
+
331
+ | Parameter | Type | Required | Description |
332
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
333
+ | `request` | [operations.V1AaveStdRateRequest](../../models/operations/v1aavestdraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
334
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
335
+ | `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. |
336
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
337
+
338
+ ### Response
339
+
340
+ **Promise\<[components.AaveSTDRateResponse](../../models/components/aavestdrateresponse.md)\>**
341
+
342
+ ### Errors
343
+
344
+ | Error Type | Status Code | Content Type |
345
+ | -------------------------- | -------------------------- | -------------------------- |
346
+ | errors.HTTPValidationError | 422 | application/json |
347
+ | errors.APIError | 4XX, 5XX | \*/\* |
348
+
349
+ ## aaveReserveOverview
350
+
351
+ Returns key metrics for Aave Reserves:
352
+ - Total Supplied (TVL) in USD
353
+ - Total Borrowed in USD
354
+ - Utilization Ratio
355
+
356
+ See below for more info:
357
+
358
+ ### Example Usage
359
+
360
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_reserve_overview" method="get" path="/v1/aave/reserve_overview" -->
361
+ ```typescript
362
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
363
+
364
+ const compassApiSDK = new CompassApiSDK({
365
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
366
+ });
367
+
368
+ async function run() {
369
+ const result = await compassApiSDK.aaveV3.aaveReserveOverview({
370
+ chain: "arbitrum",
371
+ token: "USDC",
372
+ });
373
+
374
+ console.log(result);
375
+ }
376
+
377
+ run();
378
+ ```
379
+
380
+ ### Standalone function
381
+
382
+ The standalone function version of this method:
383
+
384
+ ```typescript
385
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
386
+ import { aaveV3AaveReserveOverview } from "@compass-labs/api-sdk/funcs/aaveV3AaveReserveOverview.js";
387
+
388
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
389
+ // You can create one instance of it to use across an application.
390
+ const compassApiSDK = new CompassApiSDKCore({
391
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
392
+ });
393
+
394
+ async function run() {
395
+ const res = await aaveV3AaveReserveOverview(compassApiSDK, {
396
+ chain: "arbitrum",
397
+ token: "USDC",
398
+ });
399
+ if (res.ok) {
400
+ const { value: result } = res;
401
+ console.log(result);
402
+ } else {
403
+ console.log("aaveV3AaveReserveOverview failed:", res.error);
404
+ }
405
+ }
406
+
407
+ run();
408
+ ```
409
+
410
+ ### Parameters
411
+
412
+ | Parameter | Type | Required | Description |
413
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
414
+ | `request` | [operations.V1AaveReserveOverviewRequest](../../models/operations/v1aavereserveoverviewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
415
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
416
+ | `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. |
417
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
418
+
419
+ ### Response
420
+
421
+ **Promise\<[components.AaveReserveOverviewResponse](../../models/components/aavereserveoverviewresponse.md)\>**
422
+
423
+ ### Errors
424
+
425
+ | Error Type | Status Code | Content Type |
426
+ | -------------------------- | -------------------------- | -------------------------- |
427
+ | errors.HTTPValidationError | 422 | application/json |
428
+ | errors.APIError | 4XX, 5XX | \*/\* |
429
+
430
+ ## aaveTokenPrice
431
+
432
+ This endpoint retrieves the current price of a specified token in USD as
433
+ determined by the Aave protocol.
434
+
435
+ It utilizes the Aave V3 Oracle to fetch the token price, ensuring accurate and up-
436
+ to-date information. The request requires the token identifier and the blockchain
437
+ network (chain) on which the token resides. The response provides the token price in
438
+ a standardized format, converted from Wei to the base currency decimals defined by
439
+ Aave.
440
+
441
+ ### Example Usage
442
+
443
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_token_price" method="get" path="/v1/aave/token_price" -->
444
+ ```typescript
445
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
446
+
447
+ const compassApiSDK = new CompassApiSDK({
448
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
449
+ });
450
+
451
+ async function run() {
452
+ const result = await compassApiSDK.aaveV3.aaveTokenPrice({
453
+ chain: "arbitrum",
454
+ token: "USDC",
455
+ });
456
+
457
+ console.log(result);
458
+ }
459
+
460
+ run();
461
+ ```
462
+
463
+ ### Standalone function
464
+
465
+ The standalone function version of this method:
466
+
467
+ ```typescript
468
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
469
+ import { aaveV3AaveTokenPrice } from "@compass-labs/api-sdk/funcs/aaveV3AaveTokenPrice.js";
470
+
471
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
472
+ // You can create one instance of it to use across an application.
473
+ const compassApiSDK = new CompassApiSDKCore({
474
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
475
+ });
476
+
477
+ async function run() {
478
+ const res = await aaveV3AaveTokenPrice(compassApiSDK, {
479
+ chain: "arbitrum",
480
+ token: "USDC",
481
+ });
482
+ if (res.ok) {
483
+ const { value: result } = res;
484
+ console.log(result);
485
+ } else {
486
+ console.log("aaveV3AaveTokenPrice failed:", res.error);
487
+ }
488
+ }
489
+
490
+ run();
491
+ ```
492
+
493
+ ### Parameters
494
+
495
+ | Parameter | Type | Required | Description |
496
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
497
+ | `request` | [operations.V1AaveTokenPriceRequest](../../models/operations/v1aavetokenpricerequest.md) | :heavy_check_mark: | The request object to use for the request. |
498
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
499
+ | `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. |
500
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
501
+
502
+ ### Response
503
+
504
+ **Promise\<[components.AaveTokenPriceResponse](../../models/components/aavetokenpriceresponse.md)\>**
505
+
506
+ ### Errors
507
+
508
+ | Error Type | Status Code | Content Type |
509
+ | -------------------------- | -------------------------- | -------------------------- |
510
+ | errors.HTTPValidationError | 422 | application/json |
511
+ | errors.APIError | 4XX, 5XX | \*/\* |
512
+
513
+ ## aaveLiquidityChange
514
+
515
+ This endpoint retrieves the change in the reserve liquidity index between two
516
+ provided blocks.
517
+
518
+ This is then converted to a percentage change. The liquidity index represents the
519
+ change in debt and interest accrual over each block. Aave does not store individual
520
+ user balances directly. Instead, it keeps a scaled balance and uses the liquidity
521
+ index to compute real balances dynamically. If a user was to have deposited tokens
522
+ at the start block, a positive liquidity index change will represent accrued
523
+ interest and a profit. If tokens were borrowed at the start block, this debt will
524
+ increase, compound on itself and represent large debt. The reverse in both cases is
525
+ true if the liquidity index is negative.
526
+
527
+ ### Example Usage
528
+
529
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_liquidity_change" method="get" path="/v1/aave/liquidity/change" -->
530
+ ```typescript
531
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
532
+
533
+ const compassApiSDK = new CompassApiSDK({
534
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
535
+ });
536
+
537
+ async function run() {
538
+ const result = await compassApiSDK.aaveV3.aaveLiquidityChange({
539
+ chain: "arbitrum",
540
+ token: "USDC",
541
+ startBlock: 0,
542
+ endBlock: 319407231,
543
+ });
544
+
545
+ console.log(result);
546
+ }
547
+
548
+ run();
549
+ ```
550
+
551
+ ### Standalone function
552
+
553
+ The standalone function version of this method:
554
+
555
+ ```typescript
556
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
557
+ import { aaveV3AaveLiquidityChange } from "@compass-labs/api-sdk/funcs/aaveV3AaveLiquidityChange.js";
558
+
559
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
560
+ // You can create one instance of it to use across an application.
561
+ const compassApiSDK = new CompassApiSDKCore({
562
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
563
+ });
564
+
565
+ async function run() {
566
+ const res = await aaveV3AaveLiquidityChange(compassApiSDK, {
567
+ chain: "arbitrum",
568
+ token: "USDC",
569
+ startBlock: 0,
570
+ endBlock: 319407231,
571
+ });
572
+ if (res.ok) {
573
+ const { value: result } = res;
574
+ console.log(result);
575
+ } else {
576
+ console.log("aaveV3AaveLiquidityChange failed:", res.error);
577
+ }
578
+ }
579
+
580
+ run();
581
+ ```
582
+
583
+ ### Parameters
584
+
585
+ | Parameter | Type | Required | Description |
586
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
587
+ | `request` | [operations.V1AaveLiquidityChangeRequest](../../models/operations/v1aaveliquiditychangerequest.md) | :heavy_check_mark: | The request object to use for the request. |
588
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
589
+ | `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. |
590
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
591
+
592
+ ### Response
593
+
594
+ **Promise\<[components.AaveLiquidityChangeResponse](../../models/components/aaveliquiditychangeresponse.md)\>**
595
+
596
+ ### Errors
597
+
598
+ | Error Type | Status Code | Content Type |
599
+ | -------------------------- | -------------------------- | -------------------------- |
600
+ | errors.HTTPValidationError | 422 | application/json |
601
+ | errors.APIError | 4XX, 5XX | \*/\* |
602
+
603
+ ## aaveUserPositionSummary
604
+
605
+ This endpoint retrieves a comprehensive summary of a user's position on the AAVE
606
+ platform.
607
+
608
+ It provides key financial metrics including the total collateral deposited, total
609
+ debt accrued, available borrowing capacity, liquidation threshold, maximum loan-to-
610
+ value ratio, and the health factor of the user's account. These metrics are
611
+ calculated by aggregating data across all open positions held by the user, offering
612
+ a holistic view of their financial standing within the AAVE ecosystem.
613
+
614
+ ### Example Usage
615
+
616
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_user_position_summary" method="get" path="/v1/aave/user_position_summary" -->
617
+ ```typescript
618
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
619
+
620
+ const compassApiSDK = new CompassApiSDK({
621
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
622
+ });
623
+
624
+ async function run() {
625
+ const result = await compassApiSDK.aaveV3.aaveUserPositionSummary({
626
+ chain: "base",
627
+ user: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
628
+ });
629
+
630
+ console.log(result);
631
+ }
632
+
633
+ run();
634
+ ```
635
+
636
+ ### Standalone function
637
+
638
+ The standalone function version of this method:
639
+
640
+ ```typescript
641
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
642
+ import { aaveV3AaveUserPositionSummary } from "@compass-labs/api-sdk/funcs/aaveV3AaveUserPositionSummary.js";
643
+
644
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
645
+ // You can create one instance of it to use across an application.
646
+ const compassApiSDK = new CompassApiSDKCore({
647
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
648
+ });
649
+
650
+ async function run() {
651
+ const res = await aaveV3AaveUserPositionSummary(compassApiSDK, {
652
+ chain: "base",
653
+ user: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
654
+ });
655
+ if (res.ok) {
656
+ const { value: result } = res;
657
+ console.log(result);
658
+ } else {
659
+ console.log("aaveV3AaveUserPositionSummary failed:", res.error);
660
+ }
661
+ }
662
+
663
+ run();
664
+ ```
665
+
666
+ ### Parameters
667
+
668
+ | Parameter | Type | Required | Description |
669
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
670
+ | `request` | [operations.V1AaveUserPositionSummaryRequest](../../models/operations/v1aaveuserpositionsummaryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
671
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
672
+ | `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. |
673
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
674
+
675
+ ### Response
676
+
677
+ **Promise\<[components.AaveUserPositionSummaryResponse](../../models/components/aaveuserpositionsummaryresponse.md)\>**
678
+
679
+ ### Errors
680
+
681
+ | Error Type | Status Code | Content Type |
682
+ | -------------------------- | -------------------------- | -------------------------- |
683
+ | errors.HTTPValidationError | 422 | application/json |
684
+ | errors.APIError | 4XX, 5XX | \*/\* |
685
+
686
+ ## aaveUserPositionPerToken
687
+
688
+ This endpoint retrieves the user's position for a specific token on the AAVE
689
+ platform.
690
+
691
+ It provides key financial metrics including the current aToken balance, current
692
+ stable debt, current variable debt, principal stable debt, principal variable debt,
693
+ stable borrow rate, stable borrow rate for new loans, variable borrow rate, and
694
+ liquidity rate. These metrics are calculated by aggregating data across all open
695
+ positions held by the user for the specified token, offering a detailed view of
696
+ their financial standing within the AAVE ecosystem.
697
+
698
+ ### Example Usage
699
+
700
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_user_position_per_token" method="get" path="/v1/aave/user_position_per_token" -->
701
+ ```typescript
702
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
703
+
704
+ const compassApiSDK = new CompassApiSDK({
705
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
706
+ });
707
+
708
+ async function run() {
709
+ const result = await compassApiSDK.aaveV3.aaveUserPositionPerToken({
710
+ chain: "base",
711
+ user: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
712
+ token: "USDC",
713
+ });
714
+
715
+ console.log(result);
716
+ }
717
+
718
+ run();
719
+ ```
720
+
721
+ ### Standalone function
722
+
723
+ The standalone function version of this method:
724
+
725
+ ```typescript
726
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
727
+ import { aaveV3AaveUserPositionPerToken } from "@compass-labs/api-sdk/funcs/aaveV3AaveUserPositionPerToken.js";
728
+
729
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
730
+ // You can create one instance of it to use across an application.
731
+ const compassApiSDK = new CompassApiSDKCore({
732
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
733
+ });
734
+
735
+ async function run() {
736
+ const res = await aaveV3AaveUserPositionPerToken(compassApiSDK, {
737
+ chain: "base",
738
+ user: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
739
+ token: "USDC",
740
+ });
741
+ if (res.ok) {
742
+ const { value: result } = res;
743
+ console.log(result);
744
+ } else {
745
+ console.log("aaveV3AaveUserPositionPerToken failed:", res.error);
746
+ }
747
+ }
748
+
749
+ run();
750
+ ```
751
+
752
+ ### Parameters
753
+
754
+ | Parameter | Type | Required | Description |
755
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
756
+ | `request` | [operations.V1AaveUserPositionPerTokenRequest](../../models/operations/v1aaveuserpositionpertokenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
757
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
758
+ | `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. |
759
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
760
+
761
+ ### Response
762
+
763
+ **Promise\<[components.AaveUserPositionPerTokenResponse](../../models/components/aaveuserpositionpertokenresponse.md)\>**
764
+
765
+ ### Errors
766
+
767
+ | Error Type | Status Code | Content Type |
768
+ | -------------------------- | -------------------------- | -------------------------- |
769
+ | errors.HTTPValidationError | 422 | application/json |
770
+ | errors.APIError | 4XX, 5XX | \*/\* |
771
+
772
+ ## aaveHistoricalTransactions
773
+
774
+ This endpoint retrieves historical transactions for a user on the AAVE platform.
775
+
776
+ It returns a list of transactions including deposits, withdrawals, borrows, and
777
+ repayments. Each transaction includes details such as the token, amount, timestamp,
778
+ and transaction type. This provides a comprehensive view of the user's historical
779
+ activity within the AAVE protocol.
780
+
781
+ ⚠️ Data comes from the official Aave subgraph (
782
+ https://github.com/aave/protocol-subgraphs)
783
+ and thus this particular endpoint may be less reliable than our other endpoints. ⚠️
784
+
785
+ ### Example Usage
786
+
787
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_historical_transactions" method="get" path="/v1/aave/historical_transactions" -->
788
+ ```typescript
789
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
790
+
791
+ const compassApiSDK = new CompassApiSDK({
792
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
793
+ });
794
+
795
+ async function run() {
796
+ const result = await compassApiSDK.aaveV3.aaveHistoricalTransactions({
797
+ offset: 0,
798
+ limit: 100,
799
+ chain: "base",
800
+ userAddress: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
801
+ });
802
+
803
+ console.log(result);
804
+ }
805
+
806
+ run();
807
+ ```
808
+
809
+ ### Standalone function
810
+
811
+ The standalone function version of this method:
812
+
813
+ ```typescript
814
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
815
+ import { aaveV3AaveHistoricalTransactions } from "@compass-labs/api-sdk/funcs/aaveV3AaveHistoricalTransactions.js";
816
+
817
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
818
+ // You can create one instance of it to use across an application.
819
+ const compassApiSDK = new CompassApiSDKCore({
820
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
821
+ });
822
+
823
+ async function run() {
824
+ const res = await aaveV3AaveHistoricalTransactions(compassApiSDK, {
825
+ offset: 0,
826
+ limit: 100,
827
+ chain: "base",
828
+ userAddress: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
829
+ });
830
+ if (res.ok) {
831
+ const { value: result } = res;
832
+ console.log(result);
833
+ } else {
834
+ console.log("aaveV3AaveHistoricalTransactions failed:", res.error);
835
+ }
836
+ }
837
+
838
+ run();
839
+ ```
840
+
841
+ ### Parameters
842
+
843
+ | Parameter | Type | Required | Description |
844
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
845
+ | `request` | [operations.V1AaveHistoricalTransactionsRequest](../../models/operations/v1aavehistoricaltransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
846
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
847
+ | `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. |
848
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
849
+
850
+ ### Response
851
+
852
+ **Promise\<[components.AaveHistoricalTransactionsResponse](../../models/components/aavehistoricaltransactionsresponse.md)\>**
853
+
854
+ ### Errors
855
+
856
+ | Error Type | Status Code | Content Type |
857
+ | -------------------------- | -------------------------- | -------------------------- |
858
+ | errors.HTTPValidationError | 422 | application/json |
859
+ | errors.APIError | 4XX, 5XX | \*/\* |
860
+
861
+ ## aaveSupply
862
+
863
+ By supplying assets, users can earn interest on their deposits.
864
+
865
+ The supplied collateral can be used as a basis for borrowing other assets, allowing
866
+ users to leverage their positions. In combination with a trading protocol, this can
867
+ create leverage.
868
+
869
+ Overall, this endpoint is a critical component for users looking to maximize their
870
+ asset utility within the AAVEv3 ecosystem, providing both earning potential and
871
+ borrowing flexibility.
872
+ <Info>
873
+ **Required Allowances**
874
+
875
+ In order to make this transaction, token allowances need to be set for the following contracts.
876
+
877
+ - `AaveV3Pool`
878
+ </Info>
879
+
880
+
881
+ ### Example Usage
882
+
883
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_supply" method="post" path="/v1/aave/supply" -->
884
+ ```typescript
885
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
886
+
887
+ const compassApiSDK = new CompassApiSDK({
888
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
889
+ });
890
+
891
+ async function run() {
892
+ const result = await compassApiSDK.aaveV3.aaveSupply({
893
+ token: "USDC",
894
+ amount: "0.5",
895
+ chain: "base",
896
+ sender: "0x466C298e40c57e1DfD364443B364DFB2717BF882",
897
+ });
898
+
899
+ console.log(result);
900
+ }
901
+
902
+ run();
903
+ ```
904
+
905
+ ### Standalone function
906
+
907
+ The standalone function version of this method:
908
+
909
+ ```typescript
910
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
911
+ import { aaveV3AaveSupply } from "@compass-labs/api-sdk/funcs/aaveV3AaveSupply.js";
912
+
913
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
914
+ // You can create one instance of it to use across an application.
915
+ const compassApiSDK = new CompassApiSDKCore({
916
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
917
+ });
918
+
919
+ async function run() {
920
+ const res = await aaveV3AaveSupply(compassApiSDK, {
921
+ token: "USDC",
922
+ amount: "0.5",
923
+ chain: "base",
924
+ sender: "0x466C298e40c57e1DfD364443B364DFB2717BF882",
925
+ });
926
+ if (res.ok) {
927
+ const { value: result } = res;
928
+ console.log(result);
929
+ } else {
930
+ console.log("aaveV3AaveSupply failed:", res.error);
931
+ }
932
+ }
933
+
934
+ run();
935
+ ```
936
+
937
+ ### Parameters
938
+
939
+ | Parameter | Type | Required | Description |
940
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
941
+ | `request` | [components.AaveSupplyRequest](../../models/components/aavesupplyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
942
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
943
+ | `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. |
944
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
945
+
946
+ ### Response
947
+
948
+ **Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
949
+
950
+ ### Errors
951
+
952
+ | Error Type | Status Code | Content Type |
953
+ | -------------------------- | -------------------------- | -------------------------- |
954
+ | errors.HTTPValidationError | 422 | application/json |
955
+ | errors.APIError | 4XX, 5XX | \*/\* |
956
+
957
+ ## aaveBorrow
958
+
959
+ You will pay interest for your borrows.
960
+
961
+ Price changes in the assets may lead to some or all of your collateral being
962
+ liquidated, if the borrow position becomes unhealthy.
963
+ <Info>
964
+ **Required Allowances**
965
+
966
+ In order to make this transaction, token allowances need to be set for the following contracts.
967
+
968
+ - `AaveV3Pool`
969
+ </Info>
970
+
971
+
972
+ ### Example Usage
973
+
974
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_borrow" method="post" path="/v1/aave/borrow" -->
975
+ ```typescript
976
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
977
+
978
+ const compassApiSDK = new CompassApiSDK({
979
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
980
+ });
981
+
982
+ async function run() {
983
+ const result = await compassApiSDK.aaveV3.aaveBorrow({
984
+ token: "USDC",
985
+ amount: 0.3,
986
+ interestRateMode: "variable",
987
+ onBehalfOf: "0x4d20E7dE18219cBf60E8382cDbBa65e97E45Fd08",
988
+ chain: "base",
989
+ sender: "0x4d20E7dE18219cBf60E8382cDbBa65e97E45Fd08",
990
+ });
991
+
992
+ console.log(result);
993
+ }
994
+
995
+ run();
996
+ ```
997
+
998
+ ### Standalone function
999
+
1000
+ The standalone function version of this method:
1001
+
1002
+ ```typescript
1003
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
1004
+ import { aaveV3AaveBorrow } from "@compass-labs/api-sdk/funcs/aaveV3AaveBorrow.js";
1005
+
1006
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
1007
+ // You can create one instance of it to use across an application.
1008
+ const compassApiSDK = new CompassApiSDKCore({
1009
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
1010
+ });
1011
+
1012
+ async function run() {
1013
+ const res = await aaveV3AaveBorrow(compassApiSDK, {
1014
+ token: "USDC",
1015
+ amount: 0.3,
1016
+ interestRateMode: "variable",
1017
+ onBehalfOf: "0x4d20E7dE18219cBf60E8382cDbBa65e97E45Fd08",
1018
+ chain: "base",
1019
+ sender: "0x4d20E7dE18219cBf60E8382cDbBa65e97E45Fd08",
1020
+ });
1021
+ if (res.ok) {
1022
+ const { value: result } = res;
1023
+ console.log(result);
1024
+ } else {
1025
+ console.log("aaveV3AaveBorrow failed:", res.error);
1026
+ }
1027
+ }
1028
+
1029
+ run();
1030
+ ```
1031
+
1032
+ ### Parameters
1033
+
1034
+ | Parameter | Type | Required | Description |
1035
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1036
+ | `request` | [components.AaveBorrowRequest](../../models/components/aaveborrowrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1037
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1038
+ | `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. |
1039
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1040
+
1041
+ ### Response
1042
+
1043
+ **Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
1044
+
1045
+ ### Errors
1046
+
1047
+ | Error Type | Status Code | Content Type |
1048
+ | -------------------------- | -------------------------- | -------------------------- |
1049
+ | errors.HTTPValidationError | 422 | application/json |
1050
+ | errors.APIError | 4XX, 5XX | \*/\* |
1051
+
1052
+ ## aaveRepay
1053
+
1054
+ This endpoint allows users to repay a portion or the entirety of their borrowed
1055
+ tokens on the Aave platform.
1056
+
1057
+ By repaying borrowed amounts, users can improve their health factor, which is a
1058
+ measure of the safety of their loan position. A higher health factor reduces the
1059
+ risk of liquidation, ensuring a more secure borrowing experience. The endpoint
1060
+ requires specifying the chain and the details of the repayment transaction,
1061
+ including the amount and the asset to be repaid.
1062
+ <Info>
1063
+ **Required Allowances**
1064
+
1065
+ In order to make this transaction, token allowances need to be set for the following contracts.
1066
+
1067
+ - `AaveV3Pool`
1068
+ </Info>
1069
+
1070
+
1071
+ ### Example Usage
1072
+
1073
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_repay" method="post" path="/v1/aave/repay" -->
1074
+ ```typescript
1075
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
1076
+
1077
+ const compassApiSDK = new CompassApiSDK({
1078
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
1079
+ });
1080
+
1081
+ async function run() {
1082
+ const result = await compassApiSDK.aaveV3.aaveRepay({
1083
+ token: "USDC",
1084
+ amount: "0.2",
1085
+ interestRateMode: "variable",
1086
+ onBehalfOf: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
1087
+ chain: "base",
1088
+ sender: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
1089
+ });
1090
+
1091
+ console.log(result);
1092
+ }
1093
+
1094
+ run();
1095
+ ```
1096
+
1097
+ ### Standalone function
1098
+
1099
+ The standalone function version of this method:
1100
+
1101
+ ```typescript
1102
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
1103
+ import { aaveV3AaveRepay } from "@compass-labs/api-sdk/funcs/aaveV3AaveRepay.js";
1104
+
1105
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
1106
+ // You can create one instance of it to use across an application.
1107
+ const compassApiSDK = new CompassApiSDKCore({
1108
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
1109
+ });
1110
+
1111
+ async function run() {
1112
+ const res = await aaveV3AaveRepay(compassApiSDK, {
1113
+ token: "USDC",
1114
+ amount: "0.2",
1115
+ interestRateMode: "variable",
1116
+ onBehalfOf: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
1117
+ chain: "base",
1118
+ sender: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
1119
+ });
1120
+ if (res.ok) {
1121
+ const { value: result } = res;
1122
+ console.log(result);
1123
+ } else {
1124
+ console.log("aaveV3AaveRepay failed:", res.error);
1125
+ }
1126
+ }
1127
+
1128
+ run();
1129
+ ```
1130
+
1131
+ ### Parameters
1132
+
1133
+ | Parameter | Type | Required | Description |
1134
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1135
+ | `request` | [components.AaveRepayRequest](../../models/components/aaverepayrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1136
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1137
+ | `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. |
1138
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1139
+
1140
+ ### Response
1141
+
1142
+ **Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
1143
+
1144
+ ### Errors
1145
+
1146
+ | Error Type | Status Code | Content Type |
1147
+ | -------------------------- | -------------------------- | -------------------------- |
1148
+ | errors.HTTPValidationError | 422 | application/json |
1149
+ | errors.APIError | 4XX, 5XX | \*/\* |
1150
+
1151
+ ## aaveWithdraw
1152
+
1153
+ This endpoint facilitates the withdrawal of collateral from the Aave protocol.
1154
+
1155
+ Users can withdraw a portion or all of their collateral, which may increase the risk
1156
+ of liquidation if there are outstanding borrows. The withdrawal process also
1157
+ includes the collection of any interest earned on the collateral. It is important
1158
+ for users to carefully consider their outstanding debts and the potential impact on
1159
+ their liquidation threshold before proceeding with a withdrawal. This endpoint is
1160
+ designed to provide a seamless and efficient way to manage your collateral within
1161
+ the Aave ecosystem.
1162
+ <Info>
1163
+ **Required Allowances**
1164
+
1165
+ In order to make this transaction, token allowances need to be set for the following contracts.
1166
+
1167
+ - `AaveV3Pool`
1168
+ </Info>
1169
+
1170
+
1171
+ ### Example Usage
1172
+
1173
+ <!-- UsageSnippet language="typescript" operationID="v1_aave_withdraw" method="post" path="/v1/aave/withdraw" -->
1174
+ ```typescript
1175
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
1176
+
1177
+ const compassApiSDK = new CompassApiSDK({
1178
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
1179
+ });
1180
+
1181
+ async function run() {
1182
+ const result = await compassApiSDK.aaveV3.aaveWithdraw({
1183
+ token: "USDC",
1184
+ amount: "0.5",
1185
+ recipient: "0x388f03DABdc414E11da8Da63198D183C82836866",
1186
+ chain: "base",
1187
+ sender: "0x388f03DABdc414E11da8Da63198D183C82836866",
1188
+ });
1189
+
1190
+ console.log(result);
1191
+ }
1192
+
1193
+ run();
1194
+ ```
1195
+
1196
+ ### Standalone function
1197
+
1198
+ The standalone function version of this method:
1199
+
1200
+ ```typescript
1201
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
1202
+ import { aaveV3AaveWithdraw } from "@compass-labs/api-sdk/funcs/aaveV3AaveWithdraw.js";
1203
+
1204
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
1205
+ // You can create one instance of it to use across an application.
1206
+ const compassApiSDK = new CompassApiSDKCore({
1207
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
1208
+ });
1209
+
1210
+ async function run() {
1211
+ const res = await aaveV3AaveWithdraw(compassApiSDK, {
1212
+ token: "USDC",
1213
+ amount: "0.5",
1214
+ recipient: "0x388f03DABdc414E11da8Da63198D183C82836866",
1215
+ chain: "base",
1216
+ sender: "0x388f03DABdc414E11da8Da63198D183C82836866",
1217
+ });
1218
+ if (res.ok) {
1219
+ const { value: result } = res;
1220
+ console.log(result);
1221
+ } else {
1222
+ console.log("aaveV3AaveWithdraw failed:", res.error);
1223
+ }
1224
+ }
1225
+
1226
+ run();
1227
+ ```
1228
+
1229
+ ### Parameters
1230
+
1231
+ | Parameter | Type | Required | Description |
1232
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1233
+ | `request` | [components.AaveWithdrawRequest](../../models/components/aavewithdrawrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1234
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1235
+ | `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. |
1236
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1237
+
1238
+ ### Response
1239
+
1240
+ **Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
1241
+
1242
+ ### Errors
1243
+
1244
+ | Error Type | Status Code | Content Type |
1245
+ | -------------------------- | -------------------------- | -------------------------- |
1246
+ | errors.HTTPValidationError | 422 | application/json |
1247
+ | errors.APIError | 4XX, 5XX | \*/\* |