@compass-labs/api-sdk 2.2.109 → 2.2.111

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 (157) hide show
  1. package/dist/commonjs/models/components/accountsummary.d.ts +2 -3
  2. package/dist/commonjs/models/components/accountsummary.d.ts.map +1 -1
  3. package/dist/commonjs/models/components/accountsummary.js.map +1 -1
  4. package/dist/commonjs/models/components/collateralposition.d.ts +2 -3
  5. package/dist/commonjs/models/components/collateralposition.d.ts.map +1 -1
  6. package/dist/commonjs/models/components/collateralposition.js.map +1 -1
  7. package/dist/commonjs/models/components/creditborrowparams.d.ts +2 -3
  8. package/dist/commonjs/models/components/creditborrowparams.d.ts.map +1 -1
  9. package/dist/commonjs/models/components/creditborrowparams.js.map +1 -1
  10. package/dist/commonjs/models/components/creditborrowrequest.d.ts +2 -3
  11. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  13. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts +2 -3
  14. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts.map +1 -1
  15. package/dist/commonjs/models/components/creditenablecollateralparams.js.map +1 -1
  16. package/dist/commonjs/models/components/creditlooprequest.d.ts +2 -3
  17. package/dist/commonjs/models/components/creditlooprequest.d.ts.map +1 -1
  18. package/dist/commonjs/models/components/creditlooprequest.js.map +1 -1
  19. package/dist/commonjs/models/components/creditloopresponse.d.ts +4 -0
  20. package/dist/commonjs/models/components/creditloopresponse.d.ts.map +1 -1
  21. package/dist/commonjs/models/components/creditloopresponse.js +2 -0
  22. package/dist/commonjs/models/components/creditloopresponse.js.map +1 -1
  23. package/dist/commonjs/models/components/creditprotocol.d.ts +4 -6
  24. package/dist/commonjs/models/components/creditprotocol.d.ts.map +1 -1
  25. package/dist/commonjs/models/components/creditprotocol.js +2 -3
  26. package/dist/commonjs/models/components/creditprotocol.js.map +1 -1
  27. package/dist/commonjs/models/components/creditrepayparams.d.ts +2 -3
  28. package/dist/commonjs/models/components/creditrepayparams.d.ts.map +1 -1
  29. package/dist/commonjs/models/components/creditrepayparams.js.map +1 -1
  30. package/dist/commonjs/models/components/creditrepayrequest.d.ts +2 -3
  31. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  32. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  33. package/dist/commonjs/models/components/creditsupplyparams.d.ts +2 -3
  34. package/dist/commonjs/models/components/creditsupplyparams.d.ts.map +1 -1
  35. package/dist/commonjs/models/components/creditsupplyparams.js.map +1 -1
  36. package/dist/commonjs/models/components/creditunlooprequest.d.ts +2 -3
  37. package/dist/commonjs/models/components/creditunlooprequest.d.ts.map +1 -1
  38. package/dist/commonjs/models/components/creditunlooprequest.js.map +1 -1
  39. package/dist/commonjs/models/components/creditwithdrawparams.d.ts +2 -3
  40. package/dist/commonjs/models/components/creditwithdrawparams.d.ts.map +1 -1
  41. package/dist/commonjs/models/components/creditwithdrawparams.js.map +1 -1
  42. package/dist/commonjs/models/components/debtposition.d.ts +2 -3
  43. package/dist/commonjs/models/components/debtposition.d.ts.map +1 -1
  44. package/dist/commonjs/models/components/debtposition.js.map +1 -1
  45. package/dist/commonjs/models/components/loopedposition.d.ts +2 -3
  46. package/dist/commonjs/models/components/loopedposition.d.ts.map +1 -1
  47. package/dist/commonjs/models/components/loopedposition.js.map +1 -1
  48. package/dist/commonjs/models/components/morpholendingmarket.d.ts +16 -0
  49. package/dist/commonjs/models/components/morpholendingmarket.d.ts.map +1 -1
  50. package/dist/commonjs/models/components/morpholendingmarket.js +8 -0
  51. package/dist/commonjs/models/components/morpholendingmarket.js.map +1 -1
  52. package/dist/commonjs/models/components/rebalancetarget.d.ts +17 -3
  53. package/dist/commonjs/models/components/rebalancetarget.d.ts.map +1 -1
  54. package/dist/commonjs/models/components/rebalancetarget.js +6 -0
  55. package/dist/commonjs/models/components/rebalancetarget.js.map +1 -1
  56. package/dist/commonjs/models/components/rebalancetargetpreview.d.ts +17 -6
  57. package/dist/commonjs/models/components/rebalancetargetpreview.d.ts.map +1 -1
  58. package/dist/commonjs/models/components/rebalancetargetpreview.js +7 -1
  59. package/dist/commonjs/models/components/rebalancetargetpreview.js.map +1 -1
  60. package/dist/esm/models/components/accountsummary.d.ts +2 -3
  61. package/dist/esm/models/components/accountsummary.d.ts.map +1 -1
  62. package/dist/esm/models/components/accountsummary.js.map +1 -1
  63. package/dist/esm/models/components/collateralposition.d.ts +2 -3
  64. package/dist/esm/models/components/collateralposition.d.ts.map +1 -1
  65. package/dist/esm/models/components/collateralposition.js.map +1 -1
  66. package/dist/esm/models/components/creditborrowparams.d.ts +2 -3
  67. package/dist/esm/models/components/creditborrowparams.d.ts.map +1 -1
  68. package/dist/esm/models/components/creditborrowparams.js.map +1 -1
  69. package/dist/esm/models/components/creditborrowrequest.d.ts +2 -3
  70. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  71. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  72. package/dist/esm/models/components/creditenablecollateralparams.d.ts +2 -3
  73. package/dist/esm/models/components/creditenablecollateralparams.d.ts.map +1 -1
  74. package/dist/esm/models/components/creditenablecollateralparams.js.map +1 -1
  75. package/dist/esm/models/components/creditlooprequest.d.ts +2 -3
  76. package/dist/esm/models/components/creditlooprequest.d.ts.map +1 -1
  77. package/dist/esm/models/components/creditlooprequest.js.map +1 -1
  78. package/dist/esm/models/components/creditloopresponse.d.ts +4 -0
  79. package/dist/esm/models/components/creditloopresponse.d.ts.map +1 -1
  80. package/dist/esm/models/components/creditloopresponse.js +2 -0
  81. package/dist/esm/models/components/creditloopresponse.js.map +1 -1
  82. package/dist/esm/models/components/creditprotocol.d.ts +4 -6
  83. package/dist/esm/models/components/creditprotocol.d.ts.map +1 -1
  84. package/dist/esm/models/components/creditprotocol.js +2 -3
  85. package/dist/esm/models/components/creditprotocol.js.map +1 -1
  86. package/dist/esm/models/components/creditrepayparams.d.ts +2 -3
  87. package/dist/esm/models/components/creditrepayparams.d.ts.map +1 -1
  88. package/dist/esm/models/components/creditrepayparams.js.map +1 -1
  89. package/dist/esm/models/components/creditrepayrequest.d.ts +2 -3
  90. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  91. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  92. package/dist/esm/models/components/creditsupplyparams.d.ts +2 -3
  93. package/dist/esm/models/components/creditsupplyparams.d.ts.map +1 -1
  94. package/dist/esm/models/components/creditsupplyparams.js.map +1 -1
  95. package/dist/esm/models/components/creditunlooprequest.d.ts +2 -3
  96. package/dist/esm/models/components/creditunlooprequest.d.ts.map +1 -1
  97. package/dist/esm/models/components/creditunlooprequest.js.map +1 -1
  98. package/dist/esm/models/components/creditwithdrawparams.d.ts +2 -3
  99. package/dist/esm/models/components/creditwithdrawparams.d.ts.map +1 -1
  100. package/dist/esm/models/components/creditwithdrawparams.js.map +1 -1
  101. package/dist/esm/models/components/debtposition.d.ts +2 -3
  102. package/dist/esm/models/components/debtposition.d.ts.map +1 -1
  103. package/dist/esm/models/components/debtposition.js.map +1 -1
  104. package/dist/esm/models/components/loopedposition.d.ts +2 -3
  105. package/dist/esm/models/components/loopedposition.d.ts.map +1 -1
  106. package/dist/esm/models/components/loopedposition.js.map +1 -1
  107. package/dist/esm/models/components/morpholendingmarket.d.ts +16 -0
  108. package/dist/esm/models/components/morpholendingmarket.d.ts.map +1 -1
  109. package/dist/esm/models/components/morpholendingmarket.js +8 -0
  110. package/dist/esm/models/components/morpholendingmarket.js.map +1 -1
  111. package/dist/esm/models/components/rebalancetarget.d.ts +17 -3
  112. package/dist/esm/models/components/rebalancetarget.d.ts.map +1 -1
  113. package/dist/esm/models/components/rebalancetarget.js +6 -0
  114. package/dist/esm/models/components/rebalancetarget.js.map +1 -1
  115. package/dist/esm/models/components/rebalancetargetpreview.d.ts +17 -6
  116. package/dist/esm/models/components/rebalancetargetpreview.d.ts.map +1 -1
  117. package/dist/esm/models/components/rebalancetargetpreview.js +7 -1
  118. package/dist/esm/models/components/rebalancetargetpreview.js.map +1 -1
  119. package/docs/models/components/accountsummary.md +11 -11
  120. package/docs/models/components/collateralposition.md +17 -17
  121. package/docs/models/components/creditborrowparams.md +11 -11
  122. package/docs/models/components/creditborrowrequest.md +21 -21
  123. package/docs/models/components/creditenablecollateralparams.md +7 -7
  124. package/docs/models/components/creditlooprequest.md +19 -19
  125. package/docs/models/components/creditloopresponse.md +1 -0
  126. package/docs/models/components/creditprotocol.md +2 -3
  127. package/docs/models/components/creditrepayparams.md +10 -10
  128. package/docs/models/components/creditrepayrequest.md +20 -20
  129. package/docs/models/components/creditsupplyparams.md +9 -9
  130. package/docs/models/components/creditunlooprequest.md +17 -17
  131. package/docs/models/components/creditwithdrawparams.md +9 -9
  132. package/docs/models/components/debtposition.md +16 -16
  133. package/docs/models/components/loopedposition.md +17 -17
  134. package/docs/models/components/morpholendingmarket.md +4 -0
  135. package/docs/models/components/rebalancetarget.md +13 -10
  136. package/docs/models/components/rebalancetargetpreview.md +19 -16
  137. package/docs/models/components/rebalancetargetpreviewhealthfactorscope.md +1 -1
  138. package/openapi_prepped_for_speakeasy.json +139 -4
  139. package/package.json +1 -1
  140. package/src/models/components/accountsummary.ts +2 -3
  141. package/src/models/components/collateralposition.ts +2 -3
  142. package/src/models/components/creditborrowparams.ts +2 -3
  143. package/src/models/components/creditborrowrequest.ts +2 -3
  144. package/src/models/components/creditenablecollateralparams.ts +2 -3
  145. package/src/models/components/creditlooprequest.ts +2 -3
  146. package/src/models/components/creditloopresponse.ts +6 -0
  147. package/src/models/components/creditprotocol.ts +4 -6
  148. package/src/models/components/creditrepayparams.ts +2 -3
  149. package/src/models/components/creditrepayrequest.ts +2 -3
  150. package/src/models/components/creditsupplyparams.ts +2 -3
  151. package/src/models/components/creditunlooprequest.ts +2 -3
  152. package/src/models/components/creditwithdrawparams.ts +2 -3
  153. package/src/models/components/debtposition.ts +2 -3
  154. package/src/models/components/loopedposition.ts +2 -3
  155. package/src/models/components/morpholendingmarket.ts +24 -0
  156. package/src/models/components/rebalancetarget.ts +23 -3
  157. package/src/models/components/rebalancetargetpreview.ts +23 -6
package/docs/models/components/rebalancetarget.md CHANGED
@@ -20,13 +20,16 @@ let value: RebalanceTarget = {
20
20
 
21
21
  ## Fields
22
22
 
23
- | Field | Type | Required | Description | Example |
24
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path; markets are named by token<br/>symbol. ``MORPHO`` identifies Morpho Blue lending markets by their bytes32<br/>``market_id``. ``EULER`` identifies Euler V2 markets by their EVK<br/>``collateral_vault`` + ``borrow_vault`` addresses and supports isolated<br/>per-sub-account positions (``sub_account_id``).<br/><br/>Deployment is per chain, so a valid protocol can still 422 on a given chain:<br/>AAVE on Ethereum, Base, Arbitrum, BSC and HyperEVM (where it is Hyperlend, the<br/>chain's Aave V3 deployment); MORPHO on Ethereum, Base, Arbitrum and HyperEVM<br/>(where it is Felix); EULER on Ethereum, Base, Arbitrum and BSC.<br/><br/>All three support ``/v2/credit/loop``, ``/v2/credit/unloop`` and<br/>``/v2/credit/looped_positions``. The one gap is ``/v2/credit/rebalance``,<br/>which rejects EULER with a 422. | |
26
- | `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. | |
27
- | `collateralToken` | *string* | :heavy_check_mark: | Token supplied as collateral for this position. For MORPHO it must be the market's collateral token. | |
28
- | `borrowToken` | *string* | :heavy_check_mark: | Token borrowed against the collateral for this position. For MORPHO it must be the market's loan token. | |
29
- | `targetEquityUsd` | *components.TargetEquityUsd* | :heavy_minus_sign: | SIZE knob: the net value (collateral − debt, in USD) to commit to this position; total collateral ≈ target_equity_usd × target_multiplier. To remove a position use close=true, never target_equity_usd=0. | |
30
- | `targetMultiplier` | *components.RebalanceTargetTargetMultiplier* | :heavy_minus_sign: | LEVERAGE knob: total collateral exposure ÷ equity. 1 means unlevered supplied collateral. The protocol maximum is enforced when the plan is built. | |
31
- | `close` | *boolean* | :heavy_minus_sign: | If true, fully unwind this position: the debt is cleared exactly (accrued interest included) and the pair collateral is returned to the Credit Account. | false |
32
- | `maxSlippagePercent` | *components.RebalanceTargetMaxSlippagePercent* | :heavy_minus_sign: | Per-target override of the request-level per-swap slippage tolerance in percent. | |
23
+ | Field | Type | Required | Description | Example |
24
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path; markets are named by token<br/>symbol. ``MORPHO`` identifies Morpho Blue lending markets by their bytes32<br/>``market_id``. ``EULER`` identifies Euler V2 markets by their EVK<br/>``collateral_vault`` + ``borrow_vault`` addresses and supports isolated<br/>per-sub-account positions (``sub_account_id``).<br/><br/>Deployment is per chain, so a valid protocol can still 422 on a given chain:<br/>AAVE on Ethereum, Base, Arbitrum, BSC and HyperEVM (where it is Hyperlend, the<br/>chain's Aave V3 deployment); MORPHO on Ethereum, Base, Arbitrum and HyperEVM<br/>(where it is Felix); EULER on Ethereum, Base, Arbitrum and BSC.<br/><br/>All three support ``/v2/credit/loop``, ``/v2/credit/unloop``,<br/>``/v2/credit/looped_positions`` and ``/v2/credit/rebalance``. | |
26
+ | `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. | |
27
+ | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault the collateral is supplied to (from /v2/credit/euler_markets). Required when protocol=EULER. | |
28
+ | `borrowVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault borrowed from (the sub-account's controller). Required when protocol=EULER. | |
29
+ | `subAccountId` | *number* | :heavy_minus_sign: | Euler only: the EVC sub-account (0-255) this position lives in. Omit it and the plan resolves it from the live book: the sub-account already holding this vault pair, else the lowest free sub-account for a new position. The resolved id is echoed in the preview. Pass it explicitly when the same pair is open on several sub-accounts. | |
30
+ | `collateralToken` | *string* | :heavy_check_mark: | Token supplied as collateral for this position. For MORPHO it must be the market's collateral token. | |
31
+ | `borrowToken` | *string* | :heavy_check_mark: | Token borrowed against the collateral for this position. For MORPHO it must be the market's loan token. | |
32
+ | `targetEquityUsd` | *components.TargetEquityUsd* | :heavy_minus_sign: | SIZE knob: the net value (collateral − debt, in USD) to commit to this position; total collateral ≈ target_equity_usd × target_multiplier. To remove a position use close=true, never target_equity_usd=0. | |
33
+ | `targetMultiplier` | *components.RebalanceTargetTargetMultiplier* | :heavy_minus_sign: | LEVERAGE knob: total collateral exposure ÷ equity. 1 means unlevered supplied collateral. The protocol maximum is enforced when the plan is built. | |
34
+ | `close` | *boolean* | :heavy_minus_sign: | If true, fully unwind this position: the debt is cleared exactly (accrued interest included) and the pair collateral is returned to the Credit Account. | false |
35
+ | `maxSlippagePercent` | *components.RebalanceTargetMaxSlippagePercent* | :heavy_minus_sign: | Per-target override of the request-level per-swap slippage tolerance in percent. | |