compass_api_sdk 0.1.14__py3-none-any.whl → 0.2.1__py3-none-any.whl

compass_api_sdk/models/aavelooprequest.py

@@ -0,0 +1,87 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .signedauthorization import SignedAuthorization, SignedAuthorizationTypedDict
+from .token_enum import TokenEnum
+from compass_api_sdk.types import BaseModel
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+CollateralAmountTypedDict = TypeAliasType(
+    "CollateralAmountTypedDict", Union[float, str]
+)
+r"""Amount of collateral token to supply to Aave"""
+
+
+CollateralAmount = TypeAliasType("CollateralAmount", Union[float, str])
+r"""Amount of collateral token to supply to Aave"""
+
+
+class AaveLoopRequestTypedDict(TypedDict):
+    r"""Request model for executing an Aave loop transaction."""
+
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    signed_authorization: SignedAuthorizationTypedDict
+    collateral_token: TokenEnum
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+    borrow_token: TokenEnum
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+    collateral_amount: CollateralAmountTypedDict
+    r"""Amount of collateral token to supply to Aave"""
+    loop_count: int
+    r"""Number of times to perform the supply-borrow loop"""
+    max_slippage_percent: float
+    r"""Maximum allowed slippage for token swaps in percentage"""
+    loan_to_value: float
+    r"""Loan To Value percentage of the loop"""
+
+
+class AaveLoopRequest(BaseModel):
+    r"""Request model for executing an Aave loop transaction."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    signed_authorization: SignedAuthorization
+
+    collateral_token: TokenEnum
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+    borrow_token: TokenEnum
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+    collateral_amount: CollateralAmount
+    r"""Amount of collateral token to supply to Aave"""
+
+    loop_count: int
+    r"""Number of times to perform the supply-borrow loop"""
+
+    max_slippage_percent: float
+    r"""Maximum allowed slippage for token swaps in percentage"""
+
+    loan_to_value: float
+    r"""Loan To Value percentage of the loop"""

compass_api_sdk/models/aavereserveoverviewresponse.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class AaveReserveOverviewResponseTypedDict(TypedDict):
+    tvl: float
+    r"""Total tokens supplied in an Aave Reserve in USD. E.G. How much WBTC has been supplied on Aave in USD."""
+    total_borrowed: float
+    r"""Total tokens borrowed in an Aave Reserve converted to USD. E.G. How much WBTC has been supplied on Aave (in USD)."""
+    utilization_ratio: float
+    r"""Total borrowed divided by total supplied in an Aave Reserve. E.G. How much WBTC has been borrowed on Aaave divided by the amount supplied"""
+
+
+class AaveReserveOverviewResponse(BaseModel):
+    tvl: float
+    r"""Total tokens supplied in an Aave Reserve in USD. E.G. How much WBTC has been supplied on Aave in USD."""
+
+    total_borrowed: float
+    r"""Total tokens borrowed in an Aave Reserve converted to USD. E.G. How much WBTC has been supplied on Aave (in USD)."""
+
+    utilization_ratio: float
+    r"""Total borrowed divided by total supplied in an Aave Reserve. E.G. How much WBTC has been borrowed on Aaave divided by the amount supplied"""

compass_api_sdk/models/borrow.py

@@ -3,31 +3,65 @@
 from __future__ import annotations
 from .reserve import Reserve, ReserveTypedDict
 from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import validate_const
+from enum import Enum
 import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal
 from typing_extensions import Annotated, TypedDict
 
 
+class Borrowratemode(int, Enum):
+    r"""The interest rate mode to borrow: 1 represents stable interest rate mode. 2 represents variable interest rate mode"""
+
+    ONE = 1
+    TWO = 2
+
+
 class BorrowTypedDict(TypedDict):
-    amount: str
-    borrow_rate_mode: str
-    borrow_rate: str
-    stable_token_debt: str
-    variable_token_debt: str
+    id: str
+    r"""The id of a historical transaction on aave"""
+    timestamp: int
+    r"""Timestamp in unix time"""
+    tx_hash: str
+    r"""Transaction hash. You can paste these into the search bar on etherscan"""
+    amount: float
+    r"""Quantity of token"""
+    borrow_rate_mode: Borrowratemode
+    r"""The interest rate mode to borrow: 1 represents stable interest rate mode. 2 represents variable interest rate mode"""
     reserve: ReserveTypedDict
-    asset_price_usd: str
+    asset_price_usd: float
+    r"""Price of token in USD"""
+    block: int
+    action: Literal["Borrow"]
+    r"""The type of transaction"""
 
 
 class Borrow(BaseModel):
-    amount: str
+    id: str
+    r"""The id of a historical transaction on aave"""
 
-    borrow_rate_mode: Annotated[str, pydantic.Field(alias="borrowRateMode")]
+    timestamp: int
+    r"""Timestamp in unix time"""
 
-    borrow_rate: Annotated[str, pydantic.Field(alias="borrowRate")]
+    tx_hash: Annotated[str, pydantic.Field(alias="txHash")]
+    r"""Transaction hash. You can paste these into the search bar on etherscan"""
 
-    stable_token_debt: Annotated[str, pydantic.Field(alias="stableTokenDebt")]
+    amount: float
+    r"""Quantity of token"""
 
-    variable_token_debt: Annotated[str, pydantic.Field(alias="variableTokenDebt")]
+    borrow_rate_mode: Annotated[Borrowratemode, pydantic.Field(alias="borrowRateMode")]
+    r"""The interest rate mode to borrow: 1 represents stable interest rate mode. 2 represents variable interest rate mode"""
 
     reserve: Reserve
 
-    asset_price_usd: Annotated[str, pydantic.Field(alias="assetPriceUSD")]
+    asset_price_usd: Annotated[float, pydantic.Field(alias="assetPriceUSD")]
+    r"""Price of token in USD"""
+
+    block: int
+
+    ACTION: Annotated[
+        Annotated[Literal["Borrow"], AfterValidator(validate_const("Borrow"))],
+        pydantic.Field(alias="action"),
+    ] = "Borrow"
+    r"""The type of transaction"""

compass_api_sdk/models/liquidationcall.py

@@ -1,37 +1,64 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .collateralreserve import CollateralReserve, CollateralReserveTypedDict
-from .principalreserve import PrincipalReserve, PrincipalReserveTypedDict
+from .reserve import Reserve, ReserveTypedDict
 from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import validate_const
 import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal
 from typing_extensions import Annotated, TypedDict
 
 
 class LiquidationCallTypedDict(TypedDict):
-    collateral_amount: str
-    collateral_reserve: CollateralReserveTypedDict
-    principal_amount: str
-    principal_reserve: PrincipalReserveTypedDict
-    collateral_asset_price_usd: str
-    borrow_asset_price_usd: str
+    id: str
+    r"""The id of a historical transaction on aave"""
+    timestamp: int
+    r"""Timestamp in unix time"""
+    tx_hash: str
+    r"""Transaction hash. You can paste these into the search bar on etherscan"""
+    collateral_amount: float
+    collateral_reserve: ReserveTypedDict
+    principal_amount: float
+    principal_reserve: ReserveTypedDict
+    collateral_asset_price_usd: float
+    borrow_asset_price_usd: float
+    block: int
+    action: Literal["LiquidationCall"]
 
 
 class LiquidationCall(BaseModel):
-    collateral_amount: Annotated[str, pydantic.Field(alias="collateralAmount")]
+    id: str
+    r"""The id of a historical transaction on aave"""
 
-    collateral_reserve: Annotated[
-        CollateralReserve, pydantic.Field(alias="collateralReserve")
-    ]
+    timestamp: int
+    r"""Timestamp in unix time"""
 
-    principal_amount: Annotated[str, pydantic.Field(alias="principalAmount")]
+    tx_hash: Annotated[str, pydantic.Field(alias="txHash")]
+    r"""Transaction hash. You can paste these into the search bar on etherscan"""
 
-    principal_reserve: Annotated[
-        PrincipalReserve, pydantic.Field(alias="principalReserve")
-    ]
+    collateral_amount: Annotated[float, pydantic.Field(alias="collateralAmount")]
+
+    collateral_reserve: Annotated[Reserve, pydantic.Field(alias="collateralReserve")]
+
+    principal_amount: Annotated[float, pydantic.Field(alias="principalAmount")]
+
+    principal_reserve: Annotated[Reserve, pydantic.Field(alias="principalReserve")]
 
     collateral_asset_price_usd: Annotated[
-        str, pydantic.Field(alias="collateralAssetPriceUSD")
+        float, pydantic.Field(alias="collateralAssetPriceUSD")
+    ]
+
+    borrow_asset_price_usd: Annotated[
+        float, pydantic.Field(alias="borrowAssetPriceUSD")
     ]
 
-    borrow_asset_price_usd: Annotated[str, pydantic.Field(alias="borrowAssetPriceUSD")]
+    block: int
+
+    ACTION: Annotated[
+        Annotated[
+            Literal["LiquidationCall"],
+            AfterValidator(validate_const("LiquidationCall")),
+        ],
+        pydantic.Field(alias="action"),
+    ] = "LiquidationCall"

compass_api_sdk/models/morpho_market_positionop.py

@@ -4,30 +4,26 @@ from __future__ import annotations
 from compass_api_sdk.types import BaseModel
 from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
-from typing_extensions import Annotated, TypedDict
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class MorphoMarketPositionChain(str, Enum):
-    r"""The chain to use."""
-
-    BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
-    ARBITRUM_MAINNET = "arbitrum:mainnet"
+    BASE_MAINNET = "base:mainnet"
 
 
 class MorphoMarketPositionRequestTypedDict(TypedDict):
-    chain: MorphoMarketPositionChain
-    r"""The chain to use."""
+    chain: NotRequired[MorphoMarketPositionChain]
     user_address: str
     unique_market_key: str
 
 
 class MorphoMarketPositionRequest(BaseModel):
     chain: Annotated[
-        MorphoMarketPositionChain,
+        Optional[MorphoMarketPositionChain],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = MorphoMarketPositionChain.ETHEREUM_MAINNET
-    r"""The chain to use."""
 
     user_address: Annotated[
         str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))

compass_api_sdk/models/morpho_marketsop.py

@@ -11,30 +11,26 @@ from compass_api_sdk.types import (
 from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 from pydantic import model_serializer
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class MorphoMarketsChain(str, Enum):
-    r"""The chain to use."""
-
-    BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
-    ARBITRUM_MAINNET = "arbitrum:mainnet"
+    BASE_MAINNET = "base:mainnet"
 
 
 class MorphoMarketsRequestTypedDict(TypedDict):
-    chain: MorphoMarketsChain
-    r"""The chain to use."""
+    chain: NotRequired[MorphoMarketsChain]
     collateral_token: NotRequired[Nullable[str]]
     loan_token: NotRequired[Nullable[str]]
 
 
 class MorphoMarketsRequest(BaseModel):
     chain: Annotated[
-        MorphoMarketsChain,
+        Optional[MorphoMarketsChain],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = MorphoMarketsChain.ETHEREUM_MAINNET
-    r"""The chain to use."""
 
     collateral_token: Annotated[
         OptionalNullable[str],
@@ -48,7 +44,7 @@ class MorphoMarketsRequest(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["collateral_token", "loan_token"]
+        optional_fields = ["chain", "collateral_token", "loan_token"]
         nullable_fields = ["collateral_token", "loan_token"]
         null_default_fields = []
 

compass_api_sdk/models/morpho_vault_positionop.py

@@ -4,30 +4,26 @@ from __future__ import annotations
 from compass_api_sdk.types import BaseModel
 from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
-from typing_extensions import Annotated, TypedDict
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class MorphoVaultPositionChain(str, Enum):
-    r"""The chain to use."""
-
-    BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
-    ARBITRUM_MAINNET = "arbitrum:mainnet"
+    BASE_MAINNET = "base:mainnet"
 
 
 class MorphoVaultPositionRequestTypedDict(TypedDict):
-    chain: MorphoVaultPositionChain
-    r"""The chain to use."""
+    chain: NotRequired[MorphoVaultPositionChain]
     user_address: str
     vault_address: str
 
 
 class MorphoVaultPositionRequest(BaseModel):
     chain: Annotated[
-        MorphoVaultPositionChain,
+        Optional[MorphoVaultPositionChain],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = MorphoVaultPositionChain.ETHEREUM_MAINNET
-    r"""The chain to use."""
 
     user_address: Annotated[
         str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))

compass_api_sdk/models/morpho_vaultsop.py

@@ -1,42 +1,44 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from compass_api_sdk.types import BaseModel, Nullable, UNSET_SENTINEL
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
 from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 from pydantic import model_serializer
-from typing_extensions import Annotated, TypedDict
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class MorphoVaultsChain(str, Enum):
-    r"""The chain to use."""
-
-    BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
-    ARBITRUM_MAINNET = "arbitrum:mainnet"
+    BASE_MAINNET = "base:mainnet"
 
 
 class MorphoVaultsRequestTypedDict(TypedDict):
-    deposit_token: Nullable[str]
-    chain: MorphoVaultsChain
-    r"""The chain to use."""
+    chain: NotRequired[MorphoVaultsChain]
+    deposit_token: NotRequired[Nullable[str]]
 
 
 class MorphoVaultsRequest(BaseModel):
-    deposit_token: Annotated[
-        Nullable[str],
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ]
-
     chain: Annotated[
-        MorphoVaultsChain,
+        Optional[MorphoVaultsChain],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = MorphoVaultsChain.ETHEREUM_MAINNET
-    r"""The chain to use."""
+
+    deposit_token: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
+        optional_fields = ["chain", "deposit_token"]
         nullable_fields = ["deposit_token"]
         null_default_fields = []
 

compass_api_sdk/models/morphoborrowrequest.py

@@ -1,7 +1,6 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .chain import Chain
 from compass_api_sdk.types import (
     BaseModel,
     Nullable,
@@ -9,6 +8,7 @@ from compass_api_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from enum import Enum
 from pydantic import model_serializer
 from typing import Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
@@ -26,13 +26,17 @@ MorphoBorrowRequestAmount = TypeAliasType(
 r"""Amount of the token to borrow from the market."""
 
 
+class MorphoBorrowRequestChain(str, Enum):
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    BASE_MAINNET = "base:mainnet"
+
+
 class MorphoBorrowRequestTypedDict(TypedDict):
     amount: MorphoBorrowRequestAmountTypedDict
     r"""Amount of the token to borrow from the market."""
     unique_market_key: str
     r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoBorrowRequestChain
     sender: str
     r"""The address of the transaction sender."""
     on_behalf_of: NotRequired[Nullable[str]]
@@ -48,8 +52,7 @@ class MorphoBorrowRequest(BaseModel):
     unique_market_key: str
     r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoBorrowRequestChain
 
     sender: str
     r"""The address of the transaction sender."""

compass_api_sdk/models/morphodepositrequest.py

@@ -1,7 +1,6 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .chain import Chain
 from compass_api_sdk.types import (
     BaseModel,
     Nullable,
@@ -9,6 +8,7 @@ from compass_api_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from enum import Enum
 from pydantic import model_serializer
 from typing import Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
@@ -26,13 +26,17 @@ MorphoDepositRequestAmount = TypeAliasType(
 r"""The amount of tokens to deposit into the vault."""
 
 
+class MorphoDepositRequestChain(str, Enum):
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    BASE_MAINNET = "base:mainnet"
+
+
 class MorphoDepositRequestTypedDict(TypedDict):
     vault_address: str
     r"""The vault address you are depositing to."""
     amount: MorphoDepositRequestAmountTypedDict
     r"""The amount of tokens to deposit into the vault."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoDepositRequestChain
     sender: str
     r"""The address of the transaction sender."""
     receiver: NotRequired[Nullable[str]]
@@ -46,8 +50,7 @@ class MorphoDepositRequest(BaseModel):
     amount: MorphoDepositRequestAmount
     r"""The amount of tokens to deposit into the vault."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoDepositRequestChain
 
     sender: str
     r"""The address of the transaction sender."""

compass_api_sdk/models/morphorepayrequest.py

@@ -1,7 +1,6 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .chain import Chain
 from compass_api_sdk.types import (
     BaseModel,
     Nullable,
@@ -9,18 +8,23 @@ from compass_api_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from enum import Enum
 from pydantic import model_serializer
 from typing import Any
 from typing_extensions import NotRequired, TypedDict
 
 
+class MorphoRepayRequestChain(str, Enum):
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    BASE_MAINNET = "base:mainnet"
+
+
 class MorphoRepayRequestTypedDict(TypedDict):
     amount: Any
     r"""Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet."""
     unique_market_key: str
     r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoRepayRequestChain
     sender: str
     r"""The address of the transaction sender."""
     on_behalf_of: NotRequired[Nullable[str]]
@@ -36,8 +40,7 @@ class MorphoRepayRequest(BaseModel):
     unique_market_key: str
     r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoRepayRequestChain
 
     sender: str
     r"""The address of the transaction sender."""

compass_api_sdk/models/morphosetvaultallowancerequest.py

@@ -1,8 +1,8 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .chain import Chain
 from compass_api_sdk.types import BaseModel
+from enum import Enum
 from typing import Union
 from typing_extensions import TypeAliasType, TypedDict
 
@@ -19,13 +19,17 @@ MorphoSetVaultAllowanceRequestAmount = TypeAliasType(
 r"""The amount of tokens to increase the allowance by."""
 
 
+class MorphoSetVaultAllowanceRequestChain(str, Enum):
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    BASE_MAINNET = "base:mainnet"
+
+
 class MorphoSetVaultAllowanceRequestTypedDict(TypedDict):
     vault_address: str
     r"""The vault address you are increasing the allowance for."""
     amount: MorphoSetVaultAllowanceRequestAmountTypedDict
     r"""The amount of tokens to increase the allowance by."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoSetVaultAllowanceRequestChain
     sender: str
     r"""The address of the transaction sender."""
 
@@ -37,8 +41,7 @@ class MorphoSetVaultAllowanceRequest(BaseModel):
     amount: MorphoSetVaultAllowanceRequestAmount
     r"""The amount of tokens to increase the allowance by."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: MorphoSetVaultAllowanceRequestChain
 
     sender: str
     r"""The address of the transaction sender."""