@compass-labs/api-sdk 2.2.97-rc.4 → 2.2.98
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.
- package/dist/commonjs/models/components/creditunlooppreview.d.ts +1 -1
- package/dist/esm/models/components/creditunlooppreview.d.ts +1 -1
- package/docs/models/components/creditunlooppreview.md +13 -13
- package/openapi_prepped_for_speakeasy.json +1 -1
- package/package.json +1 -1
- package/src/models/components/creditunlooppreview.ts +1 -1
|
@@ -19,7 +19,7 @@ export type CreditUnloopPreview = {
|
|
|
19
19
|
*/
|
|
20
20
|
totalDebtRepaid: string;
|
|
21
21
|
/**
|
|
22
|
-
* Pair collateral left supplied after the unwind (token units). On a full close this is 0
|
|
22
|
+
* Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin.
|
|
23
23
|
*/
|
|
24
24
|
endingCollateral: string;
|
|
25
25
|
/**
|
|
@@ -19,7 +19,7 @@ export type CreditUnloopPreview = {
|
|
|
19
19
|
*/
|
|
20
20
|
totalDebtRepaid: string;
|
|
21
21
|
/**
|
|
22
|
-
* Pair collateral left supplied after the unwind (token units). On a full close this is 0
|
|
22
|
+
* Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin.
|
|
23
23
|
*/
|
|
24
24
|
endingCollateral: string;
|
|
25
25
|
/**
|
|
@@ -24,16 +24,16 @@ let value: CreditUnloopPreview = {
|
|
|
24
24
|
|
|
25
25
|
## Fields
|
|
26
26
|
|
|
27
|
-
| Field
|
|
28
|
-
|
|
|
29
|
-
| `iterations`
|
|
30
|
-
| `totalCollateralWithdrawn`
|
|
31
|
-
| `totalDebtRepaid`
|
|
32
|
-
| `endingCollateral`
|
|
33
|
-
| `endingDebt`
|
|
34
|
-
| `endingMultiplier`
|
|
35
|
-
| `projectedLtv`
|
|
36
|
-
| `projectedHealthFactor`
|
|
37
|
-
| `estimatedMaxDust`
|
|
38
|
-
| `fullyUnwound`
|
|
39
|
-
| `legs`
|
|
27
|
+
| Field | Type | Required | Description | Example |
|
|
28
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
29
|
+
| `iterations` | *number* | :heavy_check_mark: | Number of swap-bearing unwind iterations bundled (the final collateral sweep leg does not count). | |
|
|
30
|
+
| `totalCollateralWithdrawn` | *string* | :heavy_check_mark: | Guaranteed minimum total collateral withdrawn (token units). | |
|
|
31
|
+
| `totalDebtRepaid` | *string* | :heavy_check_mark: | Guaranteed minimum total debt repaid (borrow-token units); actual can only be higher (swap fills above the floor repay more). | |
|
|
32
|
+
| `endingCollateral` | *string* | :heavy_check_mark: | Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin. | |
|
|
33
|
+
| `endingDebt` | *string* | :heavy_check_mark: | Projected remaining debt (borrow-token units); 0 on a full close. | |
|
|
34
|
+
| `endingMultiplier` | *string* | :heavy_check_mark: | Projected leverage after the unwind; 1 when the debt is cleared. Never promises more deleverage than is guaranteed. | |
|
|
35
|
+
| `projectedLtv` | *string* | :heavy_check_mark: | Projected end loan-to-value in percent, at the sizing oracle prices; 0 when the debt is cleared. | |
|
|
36
|
+
| `projectedHealthFactor` | *string* | :heavy_check_mark: | Projected health factor (Aave account-level / Morpho market-level). Never overstated at the 1.0 boundary. | |
|
|
37
|
+
| `estimatedMaxDust` | *string* | :heavy_check_mark: | Upper bound of borrow-token surplus the unwind can leave in the Credit Account — the sum of each swap's quote minus its guaranteed floor plus the full-close overshoot. It accumulates in the Credit Account, is recoverable, and is never lost. | |
|
|
38
|
+
| `fullyUnwound` | *boolean* | :heavy_check_mark: | True when the requested target was fully reached in this transaction. False on a partial-progress plan (allow_partial=true) — call unloop again to finish. | |
|
|
39
|
+
| `legs` | [components.UnloopLegPreview](../../models/components/unlooplegpreview.md)[] | :heavy_minus_sign: | Per-iteration breakdown. | [] |
|
|
@@ -14289,7 +14289,7 @@
|
|
|
14289
14289
|
"ending_collateral": {
|
|
14290
14290
|
"type": "string",
|
|
14291
14291
|
"title": "Ending Collateral",
|
|
14292
|
-
"description": "Pair collateral left supplied after the unwind (token units). On a full close this is 0
|
|
14292
|
+
"description": "Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin."
|
|
14293
14293
|
},
|
|
14294
14294
|
"ending_debt": {
|
|
14295
14295
|
"type": "string",
|
package/package.json
CHANGED
|
@@ -29,7 +29,7 @@ export type CreditUnloopPreview = {
|
|
|
29
29
|
*/
|
|
30
30
|
totalDebtRepaid: string;
|
|
31
31
|
/**
|
|
32
|
-
* Pair collateral left supplied after the unwind (token units). On a full close this is 0
|
|
32
|
+
* Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin.
|
|
33
33
|
*/
|
|
34
34
|
endingCollateral: string;
|
|
35
35
|
/**
|