@compass-labs/api-sdk 2.2.103 → 2.2.104

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 (193) hide show
  1. package/dist/commonjs/lib/config.d.ts +2 -2
  2. package/dist/commonjs/lib/config.js +2 -2
  3. package/dist/commonjs/lib/encodings.d.ts +10 -9
  4. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  5. package/dist/commonjs/lib/encodings.js +29 -13
  6. package/dist/commonjs/lib/encodings.js.map +1 -1
  7. package/dist/commonjs/models/components/accountsummary.d.ts +3 -7
  8. package/dist/commonjs/models/components/accountsummary.d.ts.map +1 -1
  9. package/dist/commonjs/models/components/accountsummary.js.map +1 -1
  10. package/dist/commonjs/models/components/builder.d.ts +1 -1
  11. package/dist/commonjs/models/components/collateralposition.d.ts +3 -7
  12. package/dist/commonjs/models/components/collateralposition.d.ts.map +1 -1
  13. package/dist/commonjs/models/components/collateralposition.js.map +1 -1
  14. package/dist/commonjs/models/components/creditborrowparams.d.ts +3 -7
  15. package/dist/commonjs/models/components/creditborrowparams.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/creditborrowparams.js.map +1 -1
  17. package/dist/commonjs/models/components/creditborrowrequest.d.ts +3 -7
  18. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  19. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  20. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts +3 -7
  21. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts.map +1 -1
  22. package/dist/commonjs/models/components/creditenablecollateralparams.js.map +1 -1
  23. package/dist/commonjs/models/components/creditloopedpositionsresponse.d.ts +3 -3
  24. package/dist/commonjs/models/components/creditlooprequest.d.ts +3 -7
  25. package/dist/commonjs/models/components/creditlooprequest.d.ts.map +1 -1
  26. package/dist/commonjs/models/components/creditlooprequest.js.map +1 -1
  27. package/dist/commonjs/models/components/creditprotocol.d.ts +6 -14
  28. package/dist/commonjs/models/components/creditprotocol.d.ts.map +1 -1
  29. package/dist/commonjs/models/components/creditprotocol.js +3 -7
  30. package/dist/commonjs/models/components/creditprotocol.js.map +1 -1
  31. package/dist/commonjs/models/components/creditrepayparams.d.ts +3 -7
  32. package/dist/commonjs/models/components/creditrepayparams.d.ts.map +1 -1
  33. package/dist/commonjs/models/components/creditrepayparams.js.map +1 -1
  34. package/dist/commonjs/models/components/creditrepayrequest.d.ts +3 -7
  35. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  36. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  37. package/dist/commonjs/models/components/creditsupplyparams.d.ts +3 -7
  38. package/dist/commonjs/models/components/creditsupplyparams.d.ts.map +1 -1
  39. package/dist/commonjs/models/components/creditsupplyparams.js.map +1 -1
  40. package/dist/commonjs/models/components/creditunlooprequest.d.ts +3 -7
  41. package/dist/commonjs/models/components/creditunlooprequest.d.ts.map +1 -1
  42. package/dist/commonjs/models/components/creditunlooprequest.js.map +1 -1
  43. package/dist/commonjs/models/components/creditwithdrawparams.d.ts +3 -7
  44. package/dist/commonjs/models/components/creditwithdrawparams.d.ts.map +1 -1
  45. package/dist/commonjs/models/components/creditwithdrawparams.js.map +1 -1
  46. package/dist/commonjs/models/components/debtposition.d.ts +3 -7
  47. package/dist/commonjs/models/components/debtposition.d.ts.map +1 -1
  48. package/dist/commonjs/models/components/debtposition.js.map +1 -1
  49. package/dist/commonjs/models/components/loopedposition.d.ts +15 -7
  50. package/dist/commonjs/models/components/loopedposition.d.ts.map +1 -1
  51. package/dist/commonjs/models/components/loopedposition.js +6 -0
  52. package/dist/commonjs/models/components/loopedposition.js.map +1 -1
  53. package/dist/commonjs/models/components/loopedpositioncurrentstate.d.ts +3 -3
  54. package/dist/commonjs/models/components/loopedpositioncurrentstate.js +1 -1
  55. package/dist/commonjs/models/components/rebalancetarget.d.ts +3 -7
  56. package/dist/commonjs/models/components/rebalancetarget.d.ts.map +1 -1
  57. package/dist/commonjs/models/components/rebalancetarget.js.map +1 -1
  58. package/dist/commonjs/models/components/rebalancetargetpreview.d.ts +3 -7
  59. package/dist/commonjs/models/components/rebalancetargetpreview.d.ts.map +1 -1
  60. package/dist/commonjs/models/components/rebalancetargetpreview.js.map +1 -1
  61. package/dist/esm/lib/config.d.ts +2 -2
  62. package/dist/esm/lib/config.js +2 -2
  63. package/dist/esm/lib/encodings.d.ts +10 -9
  64. package/dist/esm/lib/encodings.d.ts.map +1 -1
  65. package/dist/esm/lib/encodings.js +29 -13
  66. package/dist/esm/lib/encodings.js.map +1 -1
  67. package/dist/esm/models/components/accountsummary.d.ts +3 -7
  68. package/dist/esm/models/components/accountsummary.d.ts.map +1 -1
  69. package/dist/esm/models/components/accountsummary.js.map +1 -1
  70. package/dist/esm/models/components/builder.d.ts +1 -1
  71. package/dist/esm/models/components/collateralposition.d.ts +3 -7
  72. package/dist/esm/models/components/collateralposition.d.ts.map +1 -1
  73. package/dist/esm/models/components/collateralposition.js.map +1 -1
  74. package/dist/esm/models/components/creditborrowparams.d.ts +3 -7
  75. package/dist/esm/models/components/creditborrowparams.d.ts.map +1 -1
  76. package/dist/esm/models/components/creditborrowparams.js.map +1 -1
  77. package/dist/esm/models/components/creditborrowrequest.d.ts +3 -7
  78. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  79. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  80. package/dist/esm/models/components/creditenablecollateralparams.d.ts +3 -7
  81. package/dist/esm/models/components/creditenablecollateralparams.d.ts.map +1 -1
  82. package/dist/esm/models/components/creditenablecollateralparams.js.map +1 -1
  83. package/dist/esm/models/components/creditloopedpositionsresponse.d.ts +3 -3
  84. package/dist/esm/models/components/creditlooprequest.d.ts +3 -7
  85. package/dist/esm/models/components/creditlooprequest.d.ts.map +1 -1
  86. package/dist/esm/models/components/creditlooprequest.js.map +1 -1
  87. package/dist/esm/models/components/creditprotocol.d.ts +6 -14
  88. package/dist/esm/models/components/creditprotocol.d.ts.map +1 -1
  89. package/dist/esm/models/components/creditprotocol.js +3 -7
  90. package/dist/esm/models/components/creditprotocol.js.map +1 -1
  91. package/dist/esm/models/components/creditrepayparams.d.ts +3 -7
  92. package/dist/esm/models/components/creditrepayparams.d.ts.map +1 -1
  93. package/dist/esm/models/components/creditrepayparams.js.map +1 -1
  94. package/dist/esm/models/components/creditrepayrequest.d.ts +3 -7
  95. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  96. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  97. package/dist/esm/models/components/creditsupplyparams.d.ts +3 -7
  98. package/dist/esm/models/components/creditsupplyparams.d.ts.map +1 -1
  99. package/dist/esm/models/components/creditsupplyparams.js.map +1 -1
  100. package/dist/esm/models/components/creditunlooprequest.d.ts +3 -7
  101. package/dist/esm/models/components/creditunlooprequest.d.ts.map +1 -1
  102. package/dist/esm/models/components/creditunlooprequest.js.map +1 -1
  103. package/dist/esm/models/components/creditwithdrawparams.d.ts +3 -7
  104. package/dist/esm/models/components/creditwithdrawparams.d.ts.map +1 -1
  105. package/dist/esm/models/components/creditwithdrawparams.js.map +1 -1
  106. package/dist/esm/models/components/debtposition.d.ts +3 -7
  107. package/dist/esm/models/components/debtposition.d.ts.map +1 -1
  108. package/dist/esm/models/components/debtposition.js.map +1 -1
  109. package/dist/esm/models/components/loopedposition.d.ts +15 -7
  110. package/dist/esm/models/components/loopedposition.d.ts.map +1 -1
  111. package/dist/esm/models/components/loopedposition.js +6 -0
  112. package/dist/esm/models/components/loopedposition.js.map +1 -1
  113. package/dist/esm/models/components/loopedpositioncurrentstate.d.ts +3 -3
  114. package/dist/esm/models/components/loopedpositioncurrentstate.js +1 -1
  115. package/dist/esm/models/components/rebalancetarget.d.ts +3 -7
  116. package/dist/esm/models/components/rebalancetarget.d.ts.map +1 -1
  117. package/dist/esm/models/components/rebalancetarget.js.map +1 -1
  118. package/dist/esm/models/components/rebalancetargetpreview.d.ts +3 -7
  119. package/dist/esm/models/components/rebalancetargetpreview.d.ts.map +1 -1
  120. package/dist/esm/models/components/rebalancetargetpreview.js.map +1 -1
  121. package/docs/models/components/accountsummary.md +11 -11
  122. package/docs/models/components/builder.md +4 -4
  123. package/docs/models/components/collateralposition.md +17 -17
  124. package/docs/models/components/creditborrowparams.md +11 -11
  125. package/docs/models/components/creditborrowrequest.md +21 -21
  126. package/docs/models/components/creditenablecollateralparams.md +7 -7
  127. package/docs/models/components/creditloopedpositionsresponse.md +6 -6
  128. package/docs/models/components/creditlooprequest.md +19 -19
  129. package/docs/models/components/creditprotocol.md +3 -7
  130. package/docs/models/components/creditrepayparams.md +10 -10
  131. package/docs/models/components/creditrepayrequest.md +20 -20
  132. package/docs/models/components/creditsupplyparams.md +9 -9
  133. package/docs/models/components/creditunlooprequest.md +17 -17
  134. package/docs/models/components/creditwithdrawparams.md +9 -9
  135. package/docs/models/components/debtposition.md +16 -16
  136. package/docs/models/components/loopedposition.md +17 -14
  137. package/docs/models/components/loopedpositioncurrentstate.md +1 -1
  138. package/docs/models/components/loopedpositioncurrentstatehealthfactorscope.md +1 -1
  139. package/docs/models/components/rebalancetarget.md +10 -10
  140. package/docs/models/components/rebalancetargetpreview.md +16 -16
  141. package/examples/node_modules/tsx/dist/cjs/api/index.cjs +1 -1
  142. package/examples/node_modules/tsx/dist/cjs/api/index.mjs +1 -1
  143. package/examples/node_modules/tsx/dist/cjs/index.cjs +1 -1
  144. package/examples/node_modules/tsx/dist/cjs/index.mjs +1 -1
  145. package/examples/node_modules/tsx/dist/cli.cjs +1 -1
  146. package/examples/node_modules/tsx/dist/cli.mjs +1 -1
  147. package/examples/node_modules/tsx/dist/esm/api/index.cjs +1 -1
  148. package/examples/node_modules/tsx/dist/esm/api/index.mjs +1 -1
  149. package/examples/node_modules/tsx/dist/esm/index.cjs +1 -1
  150. package/examples/node_modules/tsx/dist/esm/index.mjs +1 -1
  151. package/examples/node_modules/tsx/dist/index-D1vYaNWZ.cjs +14 -0
  152. package/examples/node_modules/tsx/dist/index-DCefr8NP.mjs +14 -0
  153. package/examples/node_modules/tsx/dist/loader.cjs +1 -1
  154. package/examples/node_modules/tsx/dist/loader.mjs +1 -1
  155. package/examples/node_modules/tsx/dist/package-B1lIY_Tn.cjs +1 -0
  156. package/examples/node_modules/tsx/dist/package-BL7Whz21.mjs +1 -0
  157. package/examples/node_modules/tsx/dist/{register-C9AniqUt.mjs → register-DHgpdRjs.mjs} +1 -1
  158. package/examples/node_modules/tsx/dist/{register-Ciecs-Zx.cjs → register-DjPW2kSr.cjs} +2 -2
  159. package/examples/node_modules/tsx/dist/{register-C557imBs.cjs → register-OY9cqBEN.cjs} +1 -1
  160. package/examples/node_modules/tsx/dist/{register-C4vWVmug.mjs → register-SoqaU4rg.mjs} +1 -1
  161. package/examples/node_modules/tsx/dist/repl.cjs +1 -1
  162. package/examples/node_modules/tsx/dist/repl.mjs +1 -1
  163. package/examples/node_modules/tsx/dist/{require-DDxgG93A.cjs → require-Blr_8TcJ.cjs} +1 -1
  164. package/examples/node_modules/tsx/dist/{require-CywAB2e6.mjs → require-Cuv-0BLU.mjs} +1 -1
  165. package/examples/node_modules/tsx/package.json +1 -1
  166. package/examples/package-lock.json +3 -3
  167. package/openapi_prepped_for_speakeasy.json +43 -7
  168. package/package.json +1 -1
  169. package/src/lib/config.ts +2 -2
  170. package/src/lib/encodings.ts +58 -23
  171. package/src/models/components/accountsummary.ts +3 -7
  172. package/src/models/components/builder.ts +1 -1
  173. package/src/models/components/collateralposition.ts +3 -7
  174. package/src/models/components/creditborrowparams.ts +3 -7
  175. package/src/models/components/creditborrowrequest.ts +3 -7
  176. package/src/models/components/creditenablecollateralparams.ts +3 -7
  177. package/src/models/components/creditloopedpositionsresponse.ts +3 -3
  178. package/src/models/components/creditlooprequest.ts +3 -7
  179. package/src/models/components/creditprotocol.ts +6 -14
  180. package/src/models/components/creditrepayparams.ts +3 -7
  181. package/src/models/components/creditrepayrequest.ts +3 -7
  182. package/src/models/components/creditsupplyparams.ts +3 -7
  183. package/src/models/components/creditunlooprequest.ts +3 -7
  184. package/src/models/components/creditwithdrawparams.ts +3 -7
  185. package/src/models/components/debtposition.ts +3 -7
  186. package/src/models/components/loopedposition.ts +21 -7
  187. package/src/models/components/loopedpositioncurrentstate.ts +3 -3
  188. package/src/models/components/rebalancetarget.ts +3 -7
  189. package/src/models/components/rebalancetargetpreview.ts +3 -7
  190. package/examples/node_modules/tsx/dist/index-6kqi0x0U.cjs +0 -14
  191. package/examples/node_modules/tsx/dist/index-DQtFPMc2.mjs +0 -14
  192. package/examples/node_modules/tsx/dist/package-B13bX4zz.mjs +0 -1
  193. package/examples/node_modules/tsx/dist/package-sd2gMcZx.cjs +0 -1
package/docs/models/components/accountsummary.md CHANGED
@@ -23,14 +23,14 @@ let value: AccountSummary = {
23
23
 
24
24
  ## Fields
25
25
 
26
- | Field | Type | Required | Description | Example |
27
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
- | `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`` and ``/v2/credit/unloop``. EULER does<br/>NOT: ``/v2/credit/rebalance`` rejects it with a 422, and<br/>``/v2/credit/looped_positions`` covers only AAVE and MORPHO — an Euler loop is<br/>silently absent there rather than an error, so read it from<br/>``/v2/credit/positions`` instead. (EULER still appears in the<br/>``looped_positions`` response enum because this enum is shared; it is never<br/>emitted.) | |
29
- | `subAccountId` | *number* | :heavy_minus_sign: | Euler only: the EVC sub-account (0–255) this summary describes. Euler health is per-sub-account. Null for Aave/Morpho. | |
30
- | `healthFactor` | *string* | :heavy_check_mark: | Health factor. Above 1 is safe; below 1 risks liquidation. | |
31
- | `totalCollateralUsd` | *string* | :heavy_check_mark: | Total collateral value in USD. | |
32
- | `totalDebtUsd` | *string* | :heavy_check_mark: | Total debt value in USD. | |
33
- | `availableBorrowsUsd` | *string* | :heavy_check_mark: | Available borrow capacity in USD. | |
34
- | `ltv` | *string* | :heavy_check_mark: | Current loan-to-value ratio. | |
35
- | `emodeCategoryId` | *number* | :heavy_minus_sign: | E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative). | 0 |
36
- | `emodeLabel` | *string* | :heavy_minus_sign: | Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0). | |
26
+ | Field | Type | Required | Description | Example |
27
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
+ | `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. | |
29
+ | `subAccountId` | *number* | :heavy_minus_sign: | Euler only: the EVC sub-account (0–255) this summary describes. Euler health is per-sub-account. Null for Aave/Morpho. | |
30
+ | `healthFactor` | *string* | :heavy_check_mark: | Health factor. Above 1 is safe; below 1 risks liquidation. | |
31
+ | `totalCollateralUsd` | *string* | :heavy_check_mark: | Total collateral value in USD. | |
32
+ | `totalDebtUsd` | *string* | :heavy_check_mark: | Total debt value in USD. | |
33
+ | `availableBorrowsUsd` | *string* | :heavy_check_mark: | Available borrow capacity in USD. | |
34
+ | `ltv` | *string* | :heavy_check_mark: | Current loan-to-value ratio. | |
35
+ | `emodeCategoryId` | *number* | :heavy_minus_sign: | E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative). | 0 |
36
+ | `emodeLabel` | *string* | :heavy_minus_sign: | Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0). | |
package/docs/models/components/builder.md CHANGED
@@ -15,7 +15,7 @@ let value: Builder = {
15
15
 
16
16
  ## Fields
17
17
 
18
- | Field | Type | Required | Description |
19
- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
20
- | `address` | *string* | :heavy_check_mark: | Builder address that receives the fee. The address must hold ≥100 USDC on Hyperliquid perps and must not be the zero address. |
21
- | `maxFeeRate` | *string* | :heavy_check_mark: | Maximum fee rate the end-user authorizes for this builder, in Hyperliquid grammar (e.g. '0.01%'). Must end with '%' and parse to a value in [0, 100]. |
18
+ | Field | Type | Required | Description |
19
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20
+ | `address` | *string* | :heavy_check_mark: | Builder address that receives the fee. The address must hold ≥100 USDC on Hyperliquid perps and must not be the zero address. |
21
+ | `maxFeeRate` | *string* | :heavy_check_mark: | Maximum fee rate the end-user authorizes for this builder, in Hyperliquid grammar (e.g. '0.01%'). Must end with '%', use at most 0.001% precision (one tenth of a basis point) and be at most 0.1%, Hyperliquid's cap on perps builder fees. The fee is charged on top of Hyperliquid's own trading fee. |