@compass-labs/api-sdk 2.2.70 → 2.2.71-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 (131) hide show
  1. package/dist/commonjs/models/components/accountsummary.d.ts +18 -1
  2. package/dist/commonjs/models/components/accountsummary.d.ts.map +1 -1
  3. package/dist/commonjs/models/components/accountsummary.js +2 -0
  4. package/dist/commonjs/models/components/accountsummary.js.map +1 -1
  5. package/dist/commonjs/models/components/collateralposition.d.ts +16 -1
  6. package/dist/commonjs/models/components/collateralposition.d.ts.map +1 -1
  7. package/dist/commonjs/models/components/collateralposition.js +3 -0
  8. package/dist/commonjs/models/components/collateralposition.js.map +1 -1
  9. package/dist/commonjs/models/components/creditborrowparams.d.ts +17 -0
  10. package/dist/commonjs/models/components/creditborrowparams.d.ts.map +1 -1
  11. package/dist/commonjs/models/components/creditborrowparams.js +4 -0
  12. package/dist/commonjs/models/components/creditborrowparams.js.map +1 -1
  13. package/dist/commonjs/models/components/creditborrowrequest.d.ts +22 -0
  14. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  15. package/dist/commonjs/models/components/creditborrowrequest.js +6 -0
  16. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  17. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts +17 -0
  18. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts.map +1 -1
  19. package/dist/commonjs/models/components/creditenablecollateralparams.js +4 -0
  20. package/dist/commonjs/models/components/creditenablecollateralparams.js.map +1 -1
  21. package/dist/commonjs/models/components/creditpositionsresponse.d.ts +11 -1
  22. package/dist/commonjs/models/components/creditpositionsresponse.d.ts.map +1 -1
  23. package/dist/commonjs/models/components/creditpositionsresponse.js +2 -0
  24. package/dist/commonjs/models/components/creditpositionsresponse.js.map +1 -1
  25. package/dist/commonjs/models/components/creditprotocol.d.ts +30 -0
  26. package/dist/commonjs/models/components/creditprotocol.d.ts.map +1 -0
  27. package/dist/commonjs/models/components/creditprotocol.js +58 -0
  28. package/dist/commonjs/models/components/creditprotocol.js.map +1 -0
  29. package/dist/commonjs/models/components/creditrepayparams.d.ts +18 -1
  30. package/dist/commonjs/models/components/creditrepayparams.d.ts.map +1 -1
  31. package/dist/commonjs/models/components/creditrepayparams.js +4 -0
  32. package/dist/commonjs/models/components/creditrepayparams.js.map +1 -1
  33. package/dist/commonjs/models/components/creditrepayrequest.d.ts +22 -0
  34. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  35. package/dist/commonjs/models/components/creditrepayrequest.js +6 -0
  36. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  37. package/dist/commonjs/models/components/creditsupplyparams.d.ts +18 -1
  38. package/dist/commonjs/models/components/creditsupplyparams.d.ts.map +1 -1
  39. package/dist/commonjs/models/components/creditsupplyparams.js +4 -0
  40. package/dist/commonjs/models/components/creditsupplyparams.js.map +1 -1
  41. package/dist/commonjs/models/components/creditwithdrawparams.d.ts +18 -1
  42. package/dist/commonjs/models/components/creditwithdrawparams.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/creditwithdrawparams.js +4 -0
  44. package/dist/commonjs/models/components/creditwithdrawparams.js.map +1 -1
  45. package/dist/commonjs/models/components/debtposition.d.ts +16 -1
  46. package/dist/commonjs/models/components/debtposition.d.ts.map +1 -1
  47. package/dist/commonjs/models/components/debtposition.js +3 -0
  48. package/dist/commonjs/models/components/debtposition.js.map +1 -1
  49. package/dist/commonjs/models/components/index.d.ts +1 -0
  50. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  51. package/dist/commonjs/models/components/index.js +1 -0
  52. package/dist/commonjs/models/components/index.js.map +1 -1
  53. package/dist/esm/models/components/accountsummary.d.ts +18 -1
  54. package/dist/esm/models/components/accountsummary.d.ts.map +1 -1
  55. package/dist/esm/models/components/accountsummary.js +2 -0
  56. package/dist/esm/models/components/accountsummary.js.map +1 -1
  57. package/dist/esm/models/components/collateralposition.d.ts +16 -1
  58. package/dist/esm/models/components/collateralposition.d.ts.map +1 -1
  59. package/dist/esm/models/components/collateralposition.js +3 -0
  60. package/dist/esm/models/components/collateralposition.js.map +1 -1
  61. package/dist/esm/models/components/creditborrowparams.d.ts +17 -0
  62. package/dist/esm/models/components/creditborrowparams.d.ts.map +1 -1
  63. package/dist/esm/models/components/creditborrowparams.js +4 -0
  64. package/dist/esm/models/components/creditborrowparams.js.map +1 -1
  65. package/dist/esm/models/components/creditborrowrequest.d.ts +22 -0
  66. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  67. package/dist/esm/models/components/creditborrowrequest.js +6 -0
  68. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  69. package/dist/esm/models/components/creditenablecollateralparams.d.ts +17 -0
  70. package/dist/esm/models/components/creditenablecollateralparams.d.ts.map +1 -1
  71. package/dist/esm/models/components/creditenablecollateralparams.js +4 -0
  72. package/dist/esm/models/components/creditenablecollateralparams.js.map +1 -1
  73. package/dist/esm/models/components/creditpositionsresponse.d.ts +11 -1
  74. package/dist/esm/models/components/creditpositionsresponse.d.ts.map +1 -1
  75. package/dist/esm/models/components/creditpositionsresponse.js +2 -0
  76. package/dist/esm/models/components/creditpositionsresponse.js.map +1 -1
  77. package/dist/esm/models/components/creditprotocol.d.ts +30 -0
  78. package/dist/esm/models/components/creditprotocol.d.ts.map +1 -0
  79. package/dist/esm/models/components/creditprotocol.js +22 -0
  80. package/dist/esm/models/components/creditprotocol.js.map +1 -0
  81. package/dist/esm/models/components/creditrepayparams.d.ts +18 -1
  82. package/dist/esm/models/components/creditrepayparams.d.ts.map +1 -1
  83. package/dist/esm/models/components/creditrepayparams.js +4 -0
  84. package/dist/esm/models/components/creditrepayparams.js.map +1 -1
  85. package/dist/esm/models/components/creditrepayrequest.d.ts +22 -0
  86. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  87. package/dist/esm/models/components/creditrepayrequest.js +6 -0
  88. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  89. package/dist/esm/models/components/creditsupplyparams.d.ts +18 -1
  90. package/dist/esm/models/components/creditsupplyparams.d.ts.map +1 -1
  91. package/dist/esm/models/components/creditsupplyparams.js +4 -0
  92. package/dist/esm/models/components/creditsupplyparams.js.map +1 -1
  93. package/dist/esm/models/components/creditwithdrawparams.d.ts +18 -1
  94. package/dist/esm/models/components/creditwithdrawparams.d.ts.map +1 -1
  95. package/dist/esm/models/components/creditwithdrawparams.js +4 -0
  96. package/dist/esm/models/components/creditwithdrawparams.js.map +1 -1
  97. package/dist/esm/models/components/debtposition.d.ts +16 -1
  98. package/dist/esm/models/components/debtposition.d.ts.map +1 -1
  99. package/dist/esm/models/components/debtposition.js +3 -0
  100. package/dist/esm/models/components/debtposition.js.map +1 -1
  101. package/dist/esm/models/components/index.d.ts +1 -0
  102. package/dist/esm/models/components/index.d.ts.map +1 -1
  103. package/dist/esm/models/components/index.js +1 -0
  104. package/dist/esm/models/components/index.js.map +1 -1
  105. package/docs/models/components/accountsummary.md +15 -10
  106. package/docs/models/components/collateralposition.md +14 -12
  107. package/docs/models/components/creditborrowparams.md +9 -7
  108. package/docs/models/components/creditborrowrequest.md +19 -16
  109. package/docs/models/components/creditenablecollateralparams.md +6 -4
  110. package/docs/models/components/creditpositionsresponse.md +16 -7
  111. package/docs/models/components/creditprotocol.md +21 -0
  112. package/docs/models/components/creditrepayparams.md +8 -6
  113. package/docs/models/components/creditrepayrequest.md +18 -15
  114. package/docs/models/components/creditsupplyparams.md +7 -5
  115. package/docs/models/components/creditwithdrawparams.md +7 -5
  116. package/docs/models/components/debtposition.md +13 -11
  117. package/openapi_prepped_for_speakeasy.json +208 -6
  118. package/package.json +1 -1
  119. package/src/models/components/accountsummary.ts +22 -1
  120. package/src/models/components/collateralposition.ts +21 -1
  121. package/src/models/components/creditborrowparams.ts +23 -0
  122. package/src/models/components/creditborrowrequest.ts +30 -0
  123. package/src/models/components/creditenablecollateralparams.ts +23 -0
  124. package/src/models/components/creditpositionsresponse.ts +13 -1
  125. package/src/models/components/creditprotocol.ts +39 -0
  126. package/src/models/components/creditrepayparams.ts +24 -1
  127. package/src/models/components/creditrepayrequest.ts +30 -0
  128. package/src/models/components/creditsupplyparams.ts +24 -1
  129. package/src/models/components/creditwithdrawparams.ts +24 -1
  130. package/src/models/components/debtposition.ts +21 -1
  131. package/src/models/components/index.ts +1 -0
package/docs/models/components/creditenablecollateralparams.md CHANGED
@@ -18,7 +18,9 @@ let value: CreditEnableCollateralParams = {
18
18
 
19
19
  ## Fields
20
20
 
21
- | Field | Type | Required | Description | Example |
22
- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
23
- | `actionType` | *"CREDIT_ENABLE_COLLATERAL"* | :heavy_check_mark: | N/A | CREDIT_ENABLE_COLLATERAL |
24
- | `token` | *string* | :heavy_check_mark: | The underlying reserve token to enable as collateral (e.g. USDC, not aUSDC). | |
21
+ | Field | Type | Required | Description | Example |
22
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
+ | `actionType` | *"CREDIT_ENABLE_COLLATERAL"* | :heavy_check_mark: | N/A | CREDIT_ENABLE_COLLATERAL |
24
+ | `token` | *string* | :heavy_check_mark: | The underlying reserve token to enable as collateral (e.g. USDC, not aUSDC). | |
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. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
26
+ | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK collateral vault to enable. Required when protocol=EULER. | |
package/docs/models/components/creditpositionsresponse.md CHANGED
@@ -18,16 +18,25 @@ let value: CreditPositionsResponse = {
18
18
  ltv: "<value>",
19
19
  emodeCategoryId: 0,
20
20
  },
21
+ eulerAccountSummary: {
22
+ healthFactor: "<value>",
23
+ totalCollateralUsd: "<value>",
24
+ totalDebtUsd: "<value>",
25
+ availableBorrowsUsd: "<value>",
26
+ ltv: "<value>",
27
+ emodeCategoryId: 0,
28
+ },
21
29
  borrowableTokens: [],
22
30
  };
23
31
  ```
24
32
 
25
33
  ## Fields
26
34
 
27
- | Field | Type | Required | Description | Example |
28
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
29
- | `collateralPositions` | [components.CollateralPosition](../../models/components/collateralposition.md)[] | :heavy_minus_sign: | All collateral positions, one per reserve. | [] |
30
- | `debtPositions` | [components.DebtPosition](../../models/components/debtposition.md)[] | :heavy_minus_sign: | All debt positions, one per reserve. | [] |
31
- | `accountSummary` | [components.AccountSummary](../../models/components/accountsummary.md) | :heavy_check_mark: | Aave account-level summary from getUserAccountData(). | |
32
- | `borrowableTokens` | [components.BorrowableToken](../../models/components/borrowabletoken.md)[] | :heavy_minus_sign: | All tokens available for borrowing with max amounts based on current collateral. | [] |
33
- | `totalUsdValue` | *string* | :heavy_minus_sign: | Net position value in USD (total collateral - total debt). Null if prices unavailable. | |
35
+ | Field | Type | Required | Description | Example |
36
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
37
+ | `collateralPositions` | [components.CollateralPosition](../../models/components/collateralposition.md)[] | :heavy_minus_sign: | All collateral positions, one per reserve. | [] |
38
+ | `debtPositions` | [components.DebtPosition](../../models/components/debtposition.md)[] | :heavy_minus_sign: | All debt positions, one per reserve. | [] |
39
+ | `accountSummary` | [components.AccountSummary](../../models/components/accountsummary.md) | :heavy_check_mark: | Account-level summary for one lending protocol.<br/><br/>Populated from Aave ``getUserAccountData()`` or, for Euler, from the<br/>controller vault's risk engine (``accountLiquidity``). The E-Mode fields are<br/>Aave-only and stay at their defaults for Euler. | |
40
+ | `eulerAccountSummary` | [components.AccountSummary](../../models/components/accountsummary.md) | :heavy_minus_sign: | Euler account-level summary (health factor, LTV, etc.), present only when the account holds Euler positions. Null for Aave-only accounts. | |
41
+ | `borrowableTokens` | [components.BorrowableToken](../../models/components/borrowabletoken.md)[] | :heavy_minus_sign: | All tokens available for borrowing with max amounts based on current collateral. | [] |
42
+ | `totalUsdValue` | *string* | :heavy_minus_sign: | Net position value in USD (total collateral - total debt). Null if prices unavailable. | |
package/docs/models/components/creditprotocol.md ADDED
@@ -0,0 +1,21 @@
1
+ # CreditProtocol
2
+
3
+ Which lending protocol a credit action targets.
4
+
5
+ ``AAVE`` is the default so existing callers (which never send a ``protocol``
6
+ field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
7
+ Euler V2 path, where the market is identified by EVK vault address(es).
8
+
9
+ ## Example Usage
10
+
11
+ ```typescript
12
+ import { CreditProtocol } from "@compass-labs/api-sdk/models/components";
13
+
14
+ let value: CreditProtocol = "AAVE";
15
+ ```
16
+
17
+ ## Values
18
+
19
+ ```typescript
20
+ "AAVE" | "EULER"
21
+ ```
package/docs/models/components/creditrepayparams.md CHANGED
@@ -16,9 +16,11 @@ let value: CreditRepayParams = {
16
16
 
17
17
  ## Fields
18
18
 
19
- | Field | Type | Required | Description | Example |
20
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
21
- | `actionType` | *"CREDIT_REPAY"* | :heavy_check_mark: | N/A | CREDIT_REPAY |
22
- | `token` | *string* | :heavy_check_mark: | Token to repay to Aave. | |
23
- | `amount` | *components.CreditRepayParamsAmount* | :heavy_check_mark: | Amount in token units to repay. | |
24
- | `interestRateMode` | [components.InterestRateMode](../../models/components/interestratemode.md) | :heavy_minus_sign: | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. | |
19
+ | Field | Type | Required | Description | Example |
20
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `actionType` | *"CREDIT_REPAY"* | :heavy_check_mark: | N/A | CREDIT_REPAY |
22
+ | `token` | *string* | :heavy_check_mark: | Token to repay. | |
23
+ | `amount` | *components.CreditRepayParamsAmount* | :heavy_check_mark: | Amount in token units to repay. | |
24
+ | `interestRateMode` | [components.InterestRateMode](../../models/components/interestratemode.md) | :heavy_minus_sign: | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. | |
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. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
26
+ | `borrowVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault the debt is owed to. Required when protocol=EULER. | |
package/docs/models/components/creditrepayrequest.md CHANGED
@@ -20,18 +20,21 @@ let value: CreditRepayRequest = {
20
20
 
21
21
  ## Fields
22
22
 
23
- | Field | Type | Required | Description | Example |
24
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | `owner` | *string* | :heavy_check_mark: | The address that owns the Credit Account. | 0x831Ad0C52C77708DA5D49dc8278C966dfdD4ddA1 |
26
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
27
- | `repayToken` | *string* | :heavy_check_mark: | The borrowed asset to repay (e.g. WETH). Must match the debt position's token. | WETH |
28
- | `repayAmount` | *components.RepayAmount* | :heavy_check_mark: | Amount of repay_token to repay (in token units, not wei). | 0.01 |
29
- | `interestRateMode` | [components.InterestRateMode](../../models/components/interestratemode.md) | :heavy_minus_sign: | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. | |
30
- | `withdrawToken` | *string* | :heavy_minus_sign: | Collateral token to withdraw from Aave after repaying debt. Omit together with withdraw_amount for repay-only mode. | USDC |
31
- | `withdrawAmount` | *components.WithdrawAmount* | :heavy_minus_sign: | Amount of collateral to withdraw (in token units, not wei). Omit together with withdraw_token for repay-only mode. | 100 |
32
- | `tokenOut` | *string* | :heavy_minus_sign: | Desired output token. If different from withdraw_token, a swap is performed after withdrawal. If None, the withdrawn collateral is kept as-is. | |
33
- | `slippage` | *components.CreditRepayRequestSlippage* | :heavy_minus_sign: | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed. | 0.5 |
34
- | `gasSponsorship` | *boolean* | :heavy_minus_sign: | If true, returns EIP-712 signature data instead of an unsigned transaction. | false |
35
- | `permit2Signature` | *string* | :heavy_minus_sign: | The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the repay bundle will first pull repay_token from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data. | |
36
- | `permit2Nonce` | *number* | :heavy_minus_sign: | The nonce used in the Permit2 signature (from the signed typed data). | |
37
- | `permit2Deadline` | *number* | :heavy_minus_sign: | The deadline timestamp used in the Permit2 signature (from the signed typed data). | |
23
+ | Field | Type | Required | Description | Example |
24
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
+ | `owner` | *string* | :heavy_check_mark: | The address that owns the Credit Account. | 0x831Ad0C52C77708DA5D49dc8278C966dfdD4ddA1 |
26
+ | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
27
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
28
+ | `borrowVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault the debt is owed to (repay target). Required when protocol=EULER. | |
29
+ | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK collateral vault to withdraw from. Required when protocol=EULER and withdrawing collateral. | |
30
+ | `repayToken` | *string* | :heavy_check_mark: | The borrowed asset to repay (e.g. WETH). Must match the debt position's token. | WETH |
31
+ | `repayAmount` | *components.RepayAmount* | :heavy_check_mark: | Amount of repay_token to repay (in token units, not wei). | 0.01 |
32
+ | `interestRateMode` | [components.InterestRateMode](../../models/components/interestratemode.md) | :heavy_minus_sign: | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. | |
33
+ | `withdrawToken` | *string* | :heavy_minus_sign: | Collateral token to withdraw from Aave after repaying debt. Omit together with withdraw_amount for repay-only mode. | USDC |
34
+ | `withdrawAmount` | *components.WithdrawAmount* | :heavy_minus_sign: | Amount of collateral to withdraw (in token units, not wei). Omit together with withdraw_token for repay-only mode. | 100 |
35
+ | `tokenOut` | *string* | :heavy_minus_sign: | Desired output token. If different from withdraw_token, a swap is performed after withdrawal. If None, the withdrawn collateral is kept as-is. | |
36
+ | `slippage` | *components.CreditRepayRequestSlippage* | :heavy_minus_sign: | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed. | 0.5 |
37
+ | `gasSponsorship` | *boolean* | :heavy_minus_sign: | If true, returns EIP-712 signature data instead of an unsigned transaction. | false |
38
+ | `permit2Signature` | *string* | :heavy_minus_sign: | The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the repay bundle will first pull repay_token from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data. | |
39
+ | `permit2Nonce` | *number* | :heavy_minus_sign: | The nonce used in the Permit2 signature (from the signed typed data). | |
40
+ | `permit2Deadline` | *number* | :heavy_minus_sign: | The deadline timestamp used in the Permit2 signature (from the signed typed data). | |
package/docs/models/components/creditsupplyparams.md CHANGED
@@ -16,8 +16,10 @@ let value: CreditSupplyParams = {
16
16
 
17
17
  ## Fields
18
18
 
19
- | Field | Type | Required | Description | Example |
20
- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
21
- | `actionType` | *"CREDIT_SUPPLY"* | :heavy_check_mark: | N/A | CREDIT_SUPPLY |
22
- | `token` | *string* | :heavy_check_mark: | Collateral token to supply to Aave. | |
23
- | `amount` | *components.CreditSupplyParamsAmount* | :heavy_check_mark: | Amount in token units to supply. | |
19
+ | Field | Type | Required | Description | Example |
20
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `actionType` | *"CREDIT_SUPPLY"* | :heavy_check_mark: | N/A | CREDIT_SUPPLY |
22
+ | `token` | *string* | :heavy_check_mark: | Collateral token to supply. | |
23
+ | `amount` | *components.CreditSupplyParamsAmount* | :heavy_check_mark: | Amount in token units to supply. | |
24
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
25
+ | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK collateral vault to supply into. Required when protocol=EULER. | |
package/docs/models/components/creditwithdrawparams.md CHANGED
@@ -16,8 +16,10 @@ let value: CreditWithdrawParams = {
16
16
 
17
17
  ## Fields
18
18
 
19
- | Field | Type | Required | Description | Example |
20
- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
21
- | `actionType` | *"CREDIT_WITHDRAW"* | :heavy_check_mark: | N/A | CREDIT_WITHDRAW |
22
- | `token` | *string* | :heavy_check_mark: | Collateral token to withdraw from Aave. | |
23
- | `amount` | *components.CreditWithdrawParamsAmount* | :heavy_check_mark: | Amount in token units to withdraw. | |
19
+ | Field | Type | Required | Description | Example |
20
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `actionType` | *"CREDIT_WITHDRAW"* | :heavy_check_mark: | N/A | CREDIT_WITHDRAW |
22
+ | `token` | *string* | :heavy_check_mark: | Collateral token to withdraw. | |
23
+ | `amount` | *components.CreditWithdrawParamsAmount* | :heavy_check_mark: | Amount in token units to withdraw. | |
24
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
25
+ | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK collateral vault to withdraw from. Required when protocol=EULER. | |
package/docs/models/components/debtposition.md CHANGED
@@ -17,14 +17,16 @@ let value: DebtPosition = {
17
17
 
18
18
  ## Fields
19
19
 
20
- | Field | Type | Required | Description | Example |
21
- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
22
- | `token` | *string* | :heavy_check_mark: | Address of the borrow token. | |
23
- | `symbol` | *string* | :heavy_check_mark: | Symbol of the borrow token (e.g. WETH). | |
24
- | `amountBorrowed` | *string* | :heavy_check_mark: | Current on-chain variable debt balance. | |
25
- | `usdValue` | *string* | :heavy_minus_sign: | Debt value in USD. | |
26
- | `borrowApy` | *string* | :heavy_minus_sign: | Current borrow APY in percentage (e.g. 4.5 means 4.5%). | |
27
- | `totalBorrowed` | *string* | :heavy_minus_sign: | Total amount borrowed across all borrow events. | |
28
- | `totalRepaid` | *string* | :heavy_minus_sign: | Total amount repaid across all repay events. | |
29
- | `interestPaid` | *string* | :heavy_minus_sign: | Interest paid on debt: on_chain_balance + total_repaid - total_borrowed. | |
30
- | `events` | [components.CreditEvent](../../models/components/creditevent.md)[] | :heavy_minus_sign: | All historical events for this debt reserve. | [] |
20
+ | Field | Type | Required | Description | Example |
21
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
+ | `token` | *string* | :heavy_check_mark: | Address of the borrow token. | |
23
+ | `symbol` | *string* | :heavy_check_mark: | Symbol of the borrow token (e.g. WETH). | |
24
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
25
+ | `vault` | *string* | :heavy_minus_sign: | Euler only: the EVK borrow vault this debt is owed to. | |
26
+ | `amountBorrowed` | *string* | :heavy_check_mark: | Current on-chain debt balance (the vault's underlying asset for Euler). | |
27
+ | `usdValue` | *string* | :heavy_minus_sign: | Debt value in USD. | |
28
+ | `borrowApy` | *string* | :heavy_minus_sign: | Current borrow APY in percentage (e.g. 4.5 means 4.5%). | |
29
+ | `totalBorrowed` | *string* | :heavy_minus_sign: | Total amount borrowed across all borrow events. | |
30
+ | `totalRepaid` | *string* | :heavy_minus_sign: | Total amount repaid across all repay events. | |
31
+ | `interestPaid` | *string* | :heavy_minus_sign: | Interest paid on debt: on_chain_balance + total_repaid - total_borrowed. | |
32
+ | `events` | [components.CreditEvent](../../models/components/creditevent.md)[] | :heavy_minus_sign: | All historical events for this debt reserve. | [] |