compass_api_sdk 2.2.82__tar.gz → 2.2.83__tar.gz

{compass_api_sdk-2.2.82 → compass_api_sdk-2.2.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.82
+Version: 2.2.83
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10

{compass_api_sdk-2.2.82 → compass_api_sdk-2.2.83}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.82"
+version = "2.2.83"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -14,7 +14,7 @@ dependencies = [
 
 [tool.poetry]
 name = "compass_api_sdk"
-version = "2.2.82"
+version = "2.2.83"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.82 → compass_api_sdk-2.2.83}/src/compass_api_sdk/credit.py

@@ -1929,6 +1929,10 @@ class Credit(BaseSDK):
         residual below the router's minimum routable size never fails the call, it is
         reported honestly in the preview (fully_unwound=false).
 
+        When other open Aave loops share this position's collateral reserve, a full
+        close withdraws only this position's attributed share of the pooled collateral
+        (event-ledger bookkeeping), leaving the rest supplied for the other positions.
+
         For protocol=MORPHO pass a market_id from /v2/credit/morpho_markets; inspect
         open loops via /v2/credit/looped_positions.
 
@@ -2096,6 +2100,10 @@ class Credit(BaseSDK):
         residual below the router's minimum routable size never fails the call, it is
         reported honestly in the preview (fully_unwound=false).
 
+        When other open Aave loops share this position's collateral reserve, a full
+        close withdraws only this position's attributed share of the pooled collateral
+        (event-ledger bookkeeping), leaving the rest supplied for the other positions.
+
         For protocol=MORPHO pass a market_id from /v2/credit/morpho_markets; inspect
         open loops via /v2/credit/looped_positions.
 

{compass_api_sdk-2.2.82 → compass_api_sdk-2.2.83}/src/compass_api_sdk/models/loopedpositioncurrentstate.py

@@ -24,19 +24,19 @@ class LoopedPositionCurrentStateTypedDict(TypedDict):
     r"""Live on-chain state of an OPEN looped position."""
 
     collateral_amount: Nullable[str]
-    r"""Current on-chain collateral amount for this position."""
+    r"""Current on-chain collateral amount for this position. When multiple open Aave positions share one collateral reserve (Aave holds a single pooled aToken balance per reserve), that pooled balance is attributed across them pro-rata by each position's event-ledger contribution — bookkeeping, not protocol truth; liquidation sees the pooled account, not this per-position split."""
     debt_amount: Nullable[str]
     r"""Current on-chain debt amount for this position."""
     health_factor_scope: LoopedPositionCurrentStateHealthFactorScope
     r"""'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."""
     collateral_usd: NotRequired[Nullable[str]]
-    r"""Collateral value in USD (null if unpriced)."""
+    r"""Collateral value in USD (null if unpriced). Derived from the attributed collateral_amount for shared-reserve Aave positions."""
     debt_usd: NotRequired[Nullable[str]]
     r"""Debt value in USD (null if unpriced)."""
     net_usd_value: NotRequired[Nullable[str]]
-    r"""Net position value in USD (collateral - debt); null if unpriced."""
+    r"""Net position value in USD (collateral - debt); null if unpriced. For shared-reserve Aave positions the collateral side uses the pro-rata attributed balance (bookkeeping, not protocol truth)."""
     leverage: NotRequired[Nullable[str]]
-    r"""Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive."""
+    r"""Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive. For shared-reserve Aave positions this is derived from the pro-rata attributed collateral (bookkeeping, not protocol truth)."""
     health_factor: NotRequired[Nullable[str]]
     r"""Health factor. Above 1 is safe; below 1 risks liquidation. See health_factor_scope for what it covers."""
 
@@ -45,7 +45,7 @@ class LoopedPositionCurrentState(BaseModel):
     r"""Live on-chain state of an OPEN looped position."""
 
     collateral_amount: Nullable[str]
-    r"""Current on-chain collateral amount for this position."""
+    r"""Current on-chain collateral amount for this position. When multiple open Aave positions share one collateral reserve (Aave holds a single pooled aToken balance per reserve), that pooled balance is attributed across them pro-rata by each position's event-ledger contribution — bookkeeping, not protocol truth; liquidation sees the pooled account, not this per-position split."""
 
     debt_amount: Nullable[str]
     r"""Current on-chain debt amount for this position."""
@@ -54,16 +54,16 @@ class LoopedPositionCurrentState(BaseModel):
     r"""'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."""
 
     collateral_usd: OptionalNullable[str] = UNSET
-    r"""Collateral value in USD (null if unpriced)."""
+    r"""Collateral value in USD (null if unpriced). Derived from the attributed collateral_amount for shared-reserve Aave positions."""
 
     debt_usd: OptionalNullable[str] = UNSET
     r"""Debt value in USD (null if unpriced)."""
 
     net_usd_value: OptionalNullable[str] = UNSET
-    r"""Net position value in USD (collateral - debt); null if unpriced."""
+    r"""Net position value in USD (collateral - debt); null if unpriced. For shared-reserve Aave positions the collateral side uses the pro-rata attributed balance (bookkeeping, not protocol truth)."""
 
     leverage: OptionalNullable[str] = UNSET
-    r"""Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive."""
+    r"""Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive. For shared-reserve Aave positions this is derived from the pro-rata attributed collateral (bookkeeping, not protocol truth)."""
 
     health_factor: OptionalNullable[str] = UNSET
     r"""Health factor. Above 1 is safe; below 1 risks liquidation. See health_factor_scope for what it covers."""