compass_api_sdk 2.2.40rc1__tar.gz → 2.2.41__tar.gz

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/PKG-INFO

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

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.40rc1"
+version = "2.2.41"
 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.40rc1"
+version = "2.2.41"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/_version.py

@@ -5,8 +5,8 @@ import importlib.metadata
 __title__: str = "compass_api_sdk"
 __version__: str = "2.0.0"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.881.0"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.881.0 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.881.4"
+__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.881.4 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/credit.py

@@ -624,7 +624,9 @@ class Credit(BaseSDK):
             ]
         ] = None,
         gas_sponsorship: Optional[bool] = None,
-        fee: OptionalNullable[Union[models.Fee, models.FeeTypedDict]] = UNSET,
+        fee: OptionalNullable[
+            Union[models.CreditFee, models.CreditFeeTypedDict]
+        ] = UNSET,
         permit2_signature: OptionalNullable[str] = UNSET,
         permit2_nonce: OptionalNullable[int] = UNSET,
         permit2_deadline: OptionalNullable[int] = UNSET,
@@ -656,7 +658,7 @@ class Credit(BaseSDK):
             A stable (but typically higher rate), or a variable rate.
         :param slippage: Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
         :param gas_sponsorship: If true, returns EIP-712 signature data instead of an unsigned transaction.
-        :param fee: Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address. Only PERCENTAGE and FIXED denominations are supported.
+        :param fee: Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address.
         :param permit2_signature: The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data.
         :param permit2_nonce: The nonce used in the Permit2 signature (from the signed typed data).
         :param permit2_deadline: The deadline timestamp used in the Permit2 signature (from the signed typed data).
@@ -686,7 +688,7 @@ class Credit(BaseSDK):
             interest_rate_mode=interest_rate_mode,
             slippage=slippage,
             gas_sponsorship=gas_sponsorship,
-            fee=utils.get_pydantic_model(fee, OptionalNullable[models.Fee]),
+            fee=utils.get_pydantic_model(fee, OptionalNullable[models.CreditFee]),
             permit2_signature=permit2_signature,
             permit2_nonce=permit2_nonce,
             permit2_deadline=permit2_deadline,
@@ -773,7 +775,9 @@ class Credit(BaseSDK):
             ]
         ] = None,
         gas_sponsorship: Optional[bool] = None,
-        fee: OptionalNullable[Union[models.Fee, models.FeeTypedDict]] = UNSET,
+        fee: OptionalNullable[
+            Union[models.CreditFee, models.CreditFeeTypedDict]
+        ] = UNSET,
         permit2_signature: OptionalNullable[str] = UNSET,
         permit2_nonce: OptionalNullable[int] = UNSET,
         permit2_deadline: OptionalNullable[int] = UNSET,
@@ -805,7 +809,7 @@ class Credit(BaseSDK):
             A stable (but typically higher rate), or a variable rate.
         :param slippage: Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
         :param gas_sponsorship: If true, returns EIP-712 signature data instead of an unsigned transaction.
-        :param fee: Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address. Only PERCENTAGE and FIXED denominations are supported.
+        :param fee: Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address.
         :param permit2_signature: The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data.
         :param permit2_nonce: The nonce used in the Permit2 signature (from the signed typed data).
         :param permit2_deadline: The deadline timestamp used in the Permit2 signature (from the signed typed data).
@@ -835,7 +839,7 @@ class Credit(BaseSDK):
             interest_rate_mode=interest_rate_mode,
             slippage=slippage,
             gas_sponsorship=gas_sponsorship,
-            fee=utils.get_pydantic_model(fee, OptionalNullable[models.Fee]),
+            fee=utils.get_pydantic_model(fee, OptionalNullable[models.CreditFee]),
             permit2_signature=permit2_signature,
             permit2_nonce=permit2_nonce,
             permit2_deadline=permit2_deadline,

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/models/__init__.py

@@ -426,6 +426,13 @@ if TYPE_CHECKING:
         CreditEnableCollateralParamsTypedDict,
     )
     from .creditevent import CreditEvent, CreditEventTypedDict, EventType
+    from .creditfee import (
+        CreditFee,
+        CreditFeeAmount,
+        CreditFeeAmountTypedDict,
+        CreditFeeDenomination,
+        CreditFeeTypedDict,
+    )
     from .creditpositionsresponse import (
         CreditPositionsResponse,
         CreditPositionsResponseTypedDict,
@@ -622,7 +629,7 @@ if TYPE_CHECKING:
         EthenaUnstakeRequestChain,
         EthenaUnstakeRequestTypedDict,
     )
-    from .fee import Denomination, Fee, FeeAmount, FeeAmountTypedDict, FeeTypedDict
+    from .fee import Fee, FeeAmount, FeeAmountTypedDict, FeeDenomination, FeeTypedDict
     from .feeenum import FeeEnum
     from .interestratemode import InterestRateMode
     from .liquidationcall import LiquidationCall, LiquidationCallTypedDict
@@ -1855,6 +1862,11 @@ __all__ = [
     "CreditEnableCollateralParamsTypedDict",
     "CreditEvent",
     "CreditEventTypedDict",
+    "CreditFee",
+    "CreditFeeAmount",
+    "CreditFeeAmountTypedDict",
+    "CreditFeeDenomination",
+    "CreditFeeTypedDict",
     "CreditPositionsResponse",
     "CreditPositionsResponseTypedDict",
     "CreditRepayParams",
@@ -1894,7 +1906,6 @@ __all__ = [
     "CreditWithdrawParamsTypedDict",
     "DebtPosition",
     "DebtPositionTypedDict",
-    "Denomination",
     "DepositEvent",
     "DepositEventTypedDict",
     "DepositForBurnRequest",
@@ -2004,6 +2015,7 @@ __all__ = [
     "Fee",
     "FeeAmount",
     "FeeAmountTypedDict",
+    "FeeDenomination",
     "FeeEnum",
     "FeeTypedDict",
     "InitialCollateralAmount",
@@ -2988,6 +3000,11 @@ _dynamic_imports: dict[str, str] = {
     "CreditEvent": ".creditevent",
     "CreditEventTypedDict": ".creditevent",
     "EventType": ".creditevent",
+    "CreditFee": ".creditfee",
+    "CreditFeeAmount": ".creditfee",
+    "CreditFeeAmountTypedDict": ".creditfee",
+    "CreditFeeDenomination": ".creditfee",
+    "CreditFeeTypedDict": ".creditfee",
     "CreditPositionsResponse": ".creditpositionsresponse",
     "CreditPositionsResponseTypedDict": ".creditpositionsresponse",
     "CreditRepayParams": ".creditrepayparams",
@@ -3135,10 +3152,10 @@ _dynamic_imports: dict[str, str] = {
     "EthenaUnstakeRequest": ".ethenaunstakerequest",
     "EthenaUnstakeRequestChain": ".ethenaunstakerequest",
     "EthenaUnstakeRequestTypedDict": ".ethenaunstakerequest",
-    "Denomination": ".fee",
     "Fee": ".fee",
     "FeeAmount": ".fee",
     "FeeAmountTypedDict": ".fee",
+    "FeeDenomination": ".fee",
     "FeeTypedDict": ".fee",
     "FeeEnum": ".feeenum",
     "InterestRateMode": ".interestratemode",

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/models/chainmarketinfo.py

@@ -16,6 +16,12 @@ class ChainMarketInfoTypedDict(TypedDict):
     r"""Variable rate APY for deposits, in percentage (e.g., 4.5 means 4.5%)."""
     borrow_apy: str
     r"""Variable rate APY for loans, in percentage (e.g., 6.2 means 6.2%)."""
+    total_borrowed: str
+    r"""Total amount currently borrowed from this market, in token units (e.g., 1234567.89 USDC)."""
+    available_liquidity: str
+    r"""Amount of tokens available to borrow, in token units. Equals total supplied minus total borrowed."""
+    utilization_rate: str
+    r"""Percentage of supplied tokens that are currently borrowed (e.g., 85.0 means 85%)."""
 
 
 class ChainMarketInfo(BaseModel):
@@ -32,3 +38,12 @@ class ChainMarketInfo(BaseModel):
 
     borrow_apy: str
     r"""Variable rate APY for loans, in percentage (e.g., 6.2 means 6.2%)."""
+
+    total_borrowed: str
+    r"""Total amount currently borrowed from this market, in token units (e.g., 1234567.89 USDC)."""
+
+    available_liquidity: str
+    r"""Amount of tokens available to borrow, in token units. Equals total supplied minus total borrowed."""
+
+    utilization_rate: str
+    r"""Percentage of supplied tokens that are currently borrowed (e.g., 85.0 means 85%)."""

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/models/creditborrowparams.py

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .fee import Fee, FeeTypedDict
+from .creditfee import CreditFee, CreditFeeTypedDict
 from .interestratemode import InterestRateMode
 from compass_api_sdk.types import (
     BaseModel,
@@ -41,8 +41,8 @@ class CreditBorrowParamsTypedDict(TypedDict):
 
     A stable (but typically higher rate), or a variable rate.
     """
-    fee: NotRequired[Nullable[FeeTypedDict]]
-    r"""Optional fee on the borrowed amount. Only PERCENTAGE and FIXED denominations are supported."""
+    fee: NotRequired[Nullable[CreditFeeTypedDict]]
+    r"""Optional fee on the borrowed amount."""
 
 
 class CreditBorrowParams(BaseModel):
@@ -68,8 +68,8 @@ class CreditBorrowParams(BaseModel):
     A stable (but typically higher rate), or a variable rate.
     """
 
-    fee: OptionalNullable[Fee] = UNSET
-    r"""Optional fee on the borrowed amount. Only PERCENTAGE and FIXED denominations are supported."""
+    fee: OptionalNullable[CreditFee] = UNSET
+    r"""Optional fee on the borrowed amount."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/models/creditborrowrequest.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 from .chain import Chain
-from .fee import Fee, FeeTypedDict
+from .creditfee import CreditFee, CreditFeeTypedDict
 from .interestratemode import InterestRateMode
 from compass_api_sdk.types import (
     BaseModel,
@@ -72,8 +72,8 @@ class CreditBorrowRequestTypedDict(TypedDict):
     r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed."""
     gas_sponsorship: NotRequired[bool]
     r"""If true, returns EIP-712 signature data instead of an unsigned transaction."""
-    fee: NotRequired[Nullable[FeeTypedDict]]
-    r"""Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address. Only PERCENTAGE and FIXED denominations are supported."""
+    fee: NotRequired[Nullable[CreditFeeTypedDict]]
+    r"""Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address."""
     permit2_signature: NotRequired[Nullable[str]]
     r"""The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data."""
     permit2_nonce: NotRequired[Nullable[int]]
@@ -116,8 +116,8 @@ class CreditBorrowRequest(BaseModel):
     gas_sponsorship: Optional[bool] = None
     r"""If true, returns EIP-712 signature data instead of an unsigned transaction."""
 
-    fee: OptionalNullable[Fee] = UNSET
-    r"""Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address. Only PERCENTAGE and FIXED denominations are supported."""
+    fee: OptionalNullable[CreditFee] = UNSET
+    r"""Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address."""
 
     permit2_signature: OptionalNullable[str] = UNSET
     r"""The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data."""

compass_api_sdk-2.2.41/src/compass_api_sdk/models/creditfee.py

@@ -0,0 +1,73 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel, UNSET_SENTINEL
+from enum import Enum
+from pydantic import model_serializer
+from typing import Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+CreditFeeAmountTypedDict = TypeAliasType("CreditFeeAmountTypedDict", Union[float, str])
+r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
+
+
+CreditFeeAmount = TypeAliasType("CreditFeeAmount", Union[float, str])
+r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
+
+
+class CreditFeeDenomination(str, Enum):
+    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens)."""
+
+    PERCENTAGE = "PERCENTAGE"
+    FIXED = "FIXED"
+
+
+class CreditFeeTypedDict(TypedDict):
+    r"""Fee configuration for credit-product actions.
+
+    Same shape as `Fee`, but narrows `denomination` to the values supported by
+    credit borrows. PERFORMANCE is not supported because realized-profit fees
+    are not meaningful for debt positions.
+    """
+
+    recipient: str
+    r"""The wallet address that will receive the fee."""
+    amount: CreditFeeAmountTypedDict
+    r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
+    denomination: NotRequired[CreditFeeDenomination]
+    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens)."""
+
+
+class CreditFee(BaseModel):
+    r"""Fee configuration for credit-product actions.
+
+    Same shape as `Fee`, but narrows `denomination` to the values supported by
+    credit borrows. PERFORMANCE is not supported because realized-profit fees
+    are not meaningful for debt positions.
+    """
+
+    recipient: str
+    r"""The wallet address that will receive the fee."""
+
+    amount: CreditFeeAmount
+    r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
+
+    denomination: Optional[CreditFeeDenomination] = None
+    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["denomination"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

{compass_api_sdk-2.2.40rc1 → compass_api_sdk-2.2.41}/src/compass_api_sdk/models/fee.py

@@ -16,7 +16,7 @@ FeeAmount = TypeAliasType("FeeAmount", Union[float, str])
 r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
 
 
-class Denomination(str, Enum):
+class FeeDenomination(str, Enum):
     r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit)."""
 
     PERCENTAGE = "PERCENTAGE"
@@ -29,7 +29,7 @@ class FeeTypedDict(TypedDict):
     r"""The wallet address that will receive the fee."""
     amount: FeeAmountTypedDict
     r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
-    denomination: NotRequired[Denomination]
+    denomination: NotRequired[FeeDenomination]
     r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit)."""
 
 
@@ -40,7 +40,7 @@ class Fee(BaseModel):
     amount: FeeAmount
     r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
 
-    denomination: Optional[Denomination] = None
+    denomination: Optional[FeeDenomination] = None
     r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit)."""
 
     @model_serializer(mode="wrap")