@compass-labs/api-sdk 2.2.79 → 2.2.80

package/docs/models/components/creditrebalancerequestmaxslippagepercent.md

@@ -0,0 +1,19 @@
+# CreditRebalanceRequestMaxSlippagePercent
+
+Request-level per-swap slippage tolerance in percent (including routing swaps). A per-target max_slippage_percent overrides it where set.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "0.5";
+```
+

package/docs/models/components/creditrebalanceresponse.md

@@ -0,0 +1,27 @@
+# CreditRebalanceResponse
+
+The atomic rebalance transaction plus its guaranteed-floor preview.
+
+## Example Usage
+
+```typescript
+import { CreditRebalanceResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditRebalanceResponse = {
+  preview: {
+    netEquityMovedUsd: "<value>",
+    totalLegs: 255852,
+    routingSwaps: [],
+    estimatedMaxDust: "<value>",
+    perTarget: [],
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                         | Type                                                                                                                                                          | Required                                                                                                                                                      | Description                                                                                                                                                   |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                                                                 | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                              | :heavy_minus_sign:                                                                                                                                            | Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false. Null when the book is already at its target — nothing to execute. |
+| `eip712`                                                                                                                                                      | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)                                              | :heavy_minus_sign:                                                                                                                                            | EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.                                                                            |
+| `preview`                                                                                                                                                     | [components.CreditRebalancePreview](../../models/components/creditrebalancepreview.md)                                                                        | :heavy_check_mark:                                                                                                                                            | Projected end state of the whole rebalance, computed on GUARANTEED swap floors.                                                                               |

package/docs/models/components/creditunlooprequest.md

@@ -31,7 +31,7 @@ let value: CreditUnloopRequest = {
 | `marketId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO.                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | `collateralToken`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Token supplied as collateral in the loop being unwound. For MORPHO it must be the market's collateral token.                                                                                                                                                                                                                                                                                                                                                                                                                               | WETH                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | `borrowToken`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Token borrowed in the loop; withdrawn collateral is swapped back to it and used to repay. For MORPHO it must be the market's loan token.                                                                                                                                                                                                                                                                                                                                                                                                   | USDC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
-| `targetMultiplier`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | *components.TargetMultiplier*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Target leverage after the unwind. Omit (null) for a FULL unwind: the debt is cleared exactly — accrued interest included — and all pair collateral is withdrawn back to the Credit Account. `1` runs the same exact debt close but leaves the collateral supplied (earning). A value greater than 1 delevers the position to that multiplier. Must be below the position's current multiplier.                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `targetMultiplier`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | *components.CreditUnloopRequestTargetMultiplier*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Target leverage after the unwind. Omit (null) for a FULL unwind: the debt is cleared exactly — accrued interest included — and all pair collateral is withdrawn back to the Credit Account. `1` runs the same exact debt close but leaves the collateral supplied (earning). A value greater than 1 delevers the position to that multiplier. Must be below the position's current multiplier.                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | `maxSlippagePercent`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *components.CreditUnloopRequestMaxSlippagePercent*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Per-swap slippage tolerance in percent. Unwind dust is bounded by this per iteration, so tighter slippage means less dust.                                                                                                                                                                                                                                                                                                                                                                                                                 | 0.5                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | `allowPartial`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | If the target cannot be reached in one transaction (e.g. a position opened very close to the liquidation threshold), return the maximum-progress plan (preview.fully_unwound=false) instead of a 400. A second unloop call, now from a much lower leverage, finishes the job.                                                                                                                                                                                                                                                              | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | `gasSponsorship`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.                                                                                                                                                                                                                                                                                                                                                                                                                                        | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

package/docs/models/components/{targetmultiplier.md → creditunlooprequesttargetmultiplier.md}

@@ -1,4 +1,4 @@
-# TargetMultiplier
+# CreditUnloopRequestTargetMultiplier
 
 Target leverage after the unwind. Omit (null) for a FULL unwind: the debt is cleared exactly — accrued interest included — and all pair collateral is withdrawn back to the Credit Account. `1` runs the same exact debt close but leaves the collateral supplied (earning). A value greater than 1 delevers the position to that multiplier. Must be below the position's current multiplier.
 

package/docs/models/components/loopedpositioncurrentstate.md

@@ -25,4 +25,4 @@ let value: LoopedPositionCurrentState = {
 | `netUsdValue`                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Net position value in USD (collateral - debt); null if unpriced.                                                                                                                                                                                              |
 | `leverage`                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive.                                                                                                                                           |
 | `healthFactor`                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Health factor. Above 1 is safe; below 1 risks liquidation. See health_factor_scope for what it covers.                                                                                                                                                        |
-| `healthFactorScope`                                                                                                                                                                                                                                           | [components.HealthFactorScope](../../models/components/healthfactorscope.md)                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                                                            | 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures. |
+| `healthFactorScope`                                                                                                                                                                                                                                           | [components.LoopedPositionCurrentStateHealthFactorScope](../../models/components/loopedpositioncurrentstatehealthfactorscope.md)                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                                                            | 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures. |

package/docs/models/components/{healthfactorscope.md → loopedpositioncurrentstatehealthfactorscope.md}

@@ -1,13 +1,13 @@
-# HealthFactorScope
+# LoopedPositionCurrentStateHealthFactorScope
 
 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures.
 
 ## Example Usage
 
 ```typescript
-import { HealthFactorScope } from "@compass-labs/api-sdk/models/components";
+import { LoopedPositionCurrentStateHealthFactorScope } from "@compass-labs/api-sdk/models/components";
 
-let value: HealthFactorScope = "market";
+let value: LoopedPositionCurrentStateHealthFactorScope = "account";
 ```
 
 ## Values

package/docs/models/components/rebalancedirection.md

@@ -0,0 +1,17 @@
+# RebalanceDirection
+
+What the plan does to one named target.
+
+## Example Usage
+
+```typescript
+import { RebalanceDirection } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalanceDirection = "open";
+```
+
+## Values
+
+```typescript
+"open" | "close" | "grow" | "shrink" | "lever_up" | "lever_down" | "noop"
+```

package/docs/models/components/rebalancetarget.md

@@ -0,0 +1,32 @@
+# RebalanceTarget
+
+The desired end-state of ONE position in the Credit Account.
+
+Scoped-declarative: only positions named in ``targets`` are touched; anything
+unlisted is left as-is. Set ``close=true`` to fully unwind a position — never
+``target_equity_usd=0``.
+
+## Example Usage
+
+```typescript
+import { RebalanceTarget } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalanceTarget = {
+  collateralToken: "<value>",
+  borrowToken: "<value>",
+  close: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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).<br/>``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is<br/>currently read-only: positions and market discovery only — transaction<br/>builders land with the looping work (COM-7106/7107/7108), so transact<br/>endpoints reject it with a 422. |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `marketId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO.                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `collateralToken`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Token supplied as collateral for this position. For MORPHO it must be the market's collateral token.                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `borrowToken`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Token borrowed against the collateral for this position. For MORPHO it must be the market's loan token.                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `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.                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `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.                                                                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `maxSlippagePercent`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *components.RebalanceTargetMaxSlippagePercent*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Per-target override of the request-level per-swap slippage tolerance in percent.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

package/docs/models/components/rebalancetargetmaxslippagepercent.md

@@ -0,0 +1,19 @@
+# RebalanceTargetMaxSlippagePercent
+
+Per-target override of the request-level per-swap slippage tolerance in percent.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/rebalancetargetpreview.md

@@ -0,0 +1,44 @@
+# RebalanceTargetPreview
+
+Projected end state of ONE named target, computed on guaranteed swap floors.
+
+## Example Usage
+
+```typescript
+import { RebalanceTargetPreview } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalanceTargetPreview = {
+  protocol: "EULER",
+  collateralToken: "<value>",
+  borrowToken: "<value>",
+  direction: "lever_down",
+  legs: 71235,
+  unloopLegs: [],
+  loopLegs: [],
+  resultingCollateral: "<value>",
+  resultingDebt: "<value>",
+  resultingMultiplier: "<value>",
+  resultingHealthFactor: "<value>",
+  healthFactorScope: "account",
+  estimatedMaxDust: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `protocol`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [components.CreditProtocol](../../models/components/creditprotocol.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | 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).<br/>``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is<br/>currently read-only: positions and market discovery only — transaction<br/>builders land with the looping work (COM-7106/7107/7108), so transact<br/>endpoints reject it with a 422. |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `marketId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Morpho only: the bytes32 market id of this position.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `collateralToken`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Collateral token address (echoes the request target; joins against /v2/credit/looped_positions).                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `borrowToken`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Borrow token address (echoes the request target).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `direction`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [components.RebalanceDirection](../../models/components/rebalancedirection.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | What the plan does to one named target.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `legs`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | On-chain legs planned for this target (loop + unloop iterations); 0 for a noop.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `unloopLegs`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [components.UnloopLegPreview](../../models/components/unlooplegpreview.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Per-iteration unwind breakdown — populated for releasers (close / shrink / lever_down).                                                                                                                                                                                                                                                                                                                                                                                                                                                    | []                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `loopLegs`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [components.LoopLegPreview](../../models/components/looplegpreview.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Per-iteration loop breakdown — populated for consumers (open / grow / lever_up).                                                                                                                                                                                                                                                                                                                                                                                                                                                           | []                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `resultingCollateral`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Guaranteed minimum collateral supplied to this position after the rebalance (token units).                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `resultingDebt`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Projected debt owed by this position after the rebalance (borrow-token units); 0 on a close.                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `resultingMultiplier`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Projected leverage of this position after the rebalance; 1 when the debt is cleared. Never promises more leverage (or, when deleveraging, more deleverage) than is guaranteed.                                                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `resultingHealthFactor`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Projected health factor of this position after the rebalance. Never overstated at the 1.0 boundary — a liquidatable position is never presented as safe. See health_factor_scope for what it covers.                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `healthFactorScope`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [components.RebalanceTargetPreviewHealthFactorScope](../../models/components/rebalancetargetpreviewhealthfactorscope.md)                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account.                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `estimatedMaxDust`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Upper bound of surplus this target's own swaps can leave in the Credit Account (sum of each swap's quote minus its guaranteed floor). Routing swaps are counted book-level, not here. It accumulates in the Credit Account, is recoverable, and is never lost.                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

package/docs/models/components/rebalancetargetpreviewhealthfactorscope.md

@@ -0,0 +1,17 @@
+# RebalanceTargetPreviewHealthFactorScope
+
+'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account.
+
+## Example Usage
+
+```typescript
+import { RebalanceTargetPreviewHealthFactorScope } from "@compass-labs/api-sdk/models/components";
+
+let value: RebalanceTargetPreviewHealthFactorScope = "account";
+```
+
+## Values
+
+```typescript
+"market" | "account"
+```

package/docs/models/components/rebalancetargettargetmultiplier.md

@@ -0,0 +1,19 @@
+# RebalanceTargetTargetMultiplier
+
+LEVERAGE knob: total collateral exposure ÷ equity. 1 means unlevered supplied collateral. The protocol maximum is enforced when the plan is built.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/routingswappreview.md

@@ -0,0 +1,27 @@
+# RoutingSwapPreview
+
+One Phase-B capital-routing swap that moves freed tokens between positions.
+
+Book-level: it is not attributable to a single target.
+
+## Example Usage
+
+```typescript
+import { RoutingSwapPreview } from "@compass-labs/api-sdk/models/components";
+
+let value: RoutingSwapPreview = {
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: "<value>",
+  minAmountOut: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                           | Type                                                                                                                                                            | Required                                                                                                                                                        | Description                                                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `tokenIn`                                                                                                                                                       | *string*                                                                                                                                                        | :heavy_check_mark:                                                                                                                                              | Token sold by the Credit Account into this routing swap.                                                                                                        |
+| `tokenOut`                                                                                                                                                      | *string*                                                                                                                                                        | :heavy_check_mark:                                                                                                                                              | Token bought and delivered to fund a consuming position.                                                                                                        |
+| `amountIn`                                                                                                                                                      | *string*                                                                                                                                                        | :heavy_check_mark:                                                                                                                                              | Token-in amount the Credit Account gives up to this swap.                                                                                                       |
+| `minAmountOut`                                                                                                                                                  | *string*                                                                                                                                                        | :heavy_check_mark:                                                                                                                                              | Guaranteed minimum output (token-out units), enforced on-chain by the swap's minimum-return. Any fill above it stays in the Credit Account as recoverable dust. |

package/docs/models/components/targetequityusd.md

@@ -0,0 +1,19 @@
+# TargetEquityUsd
+
+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.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+