compass_api_sdk 0.9.35__py3-none-any.whl → 2.0.21rc1__py3-none-any.whl

compass_api_sdk/models/vaultdepositrequest.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,
@@ -10,6 +9,7 @@ from compass_api_sdk.types import (
     UNSET_SENTINEL,
 )
 from compass_api_sdk.utils import validate_const
+from enum import Enum
 import pydantic
 from pydantic import model_serializer
 from pydantic.functional_validators import AfterValidator
@@ -29,18 +29,25 @@ VaultDepositRequestAmount = TypeAliasType(
 r"""The amount of tokens to deposit into the vault."""
 
 
+class VaultDepositRequestChain(str, Enum):
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+    ETHEREUM = "ethereum"
+
+
 class VaultDepositRequestTypedDict(TypedDict):
     vault_address: str
     r"""The vault address you are depositing to."""
     amount: VaultDepositRequestAmountTypedDict
     r"""The amount of tokens to deposit into the vault."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: VaultDepositRequestChain
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["VAULT_DEPOSIT"]
     receiver: NotRequired[Nullable[str]]
     r"""The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender."""
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class VaultDepositRequest(BaseModel):
@@ -50,8 +57,7 @@ class VaultDepositRequest(BaseModel):
     amount: VaultDepositRequestAmount
     r"""The amount of tokens to deposit into the vault."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: VaultDepositRequestChain
 
     sender: str
     r"""The address of the transaction sender."""
@@ -67,9 +73,12 @@ class VaultDepositRequest(BaseModel):
     receiver: OptionalNullable[str] = UNSET
     r"""The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender."""
 
+    estimate_gas: Optional[bool] = None
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["action_type", "receiver"]
+        optional_fields = ["action_type", "receiver", "estimate_gas"]
         nullable_fields = ["receiver"]
         null_default_fields = []
 

compass_api_sdk/models/vaultgetvaultresponse.py

@@ -2,14 +2,20 @@
 
 from __future__ import annotations
 from .apy import Apy, ApyTypedDict
-from .compass_api_backend_models_vaults_read_response_vault_asset import (
-    CompassAPIBackendModelsVaultsReadResponseVaultAsset,
-    CompassAPIBackendModelsVaultsReadResponseVaultAssetTypedDict,
+from .compass_api_backend_v1_models_vaults_read_response_vault_userposition import (
+    CompassAPIBackendV1ModelsVaultsReadResponseVaultUserPosition,
+    CompassAPIBackendV1ModelsVaultsReadResponseVaultUserPositionTypedDict,
+)
+from .underlyingtoken import UnderlyingToken, UnderlyingTokenTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
 )
-from .userposition import UserPosition, UserPositionTypedDict
-from compass_api_sdk.types import BaseModel, Nullable, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing_extensions import TypedDict
+from typing_extensions import NotRequired, TypedDict
 
 
 class VaultGetVaultResponseTypedDict(TypedDict):
@@ -25,9 +31,11 @@ class VaultGetVaultResponseTypedDict(TypedDict):
     r"""Total amount of shares issued from the vault."""
     share_price: str
     r"""The price of one vault share in terms of the underlying asset."""
-    asset: CompassAPIBackendModelsVaultsReadResponseVaultAssetTypedDict
+    underlying_token: UnderlyingTokenTypedDict
     apy: ApyTypedDict
-    user_position: Nullable[UserPositionTypedDict]
+    user_position: NotRequired[
+        Nullable[CompassAPIBackendV1ModelsVaultsReadResponseVaultUserPositionTypedDict]
+    ]
     r"""The user's position in the vault."""
 
 
@@ -50,16 +58,18 @@ class VaultGetVaultResponse(BaseModel):
     share_price: str
     r"""The price of one vault share in terms of the underlying asset."""
 
-    asset: CompassAPIBackendModelsVaultsReadResponseVaultAsset
+    underlying_token: UnderlyingToken
 
     apy: Apy
 
-    user_position: Nullable[UserPosition]
+    user_position: OptionalNullable[
+        CompassAPIBackendV1ModelsVaultsReadResponseVaultUserPosition
+    ] = UNSET
     r"""The user's position in the vault."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
+        optional_fields = ["user_position"]
         nullable_fields = ["user_position"]
         null_default_fields = []
 

compass_api_sdk/models/vaultinfo.py

@@ -0,0 +1,129 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class VaultInfoTypedDict(TypedDict):
+    r"""Information about a single ERC-4626 vault from the database."""
+
+    vault_address: str
+    r"""The vault contract address."""
+    chain: str
+    r"""Blockchain name (e.g., 'ethereum', 'base')."""
+    owner: str
+    r"""The vault owner address."""
+    asset: str
+    r"""The underlying asset contract address."""
+    name: NotRequired[Nullable[str]]
+    r"""The name of the vault."""
+    symbol: NotRequired[Nullable[str]]
+    r"""The vault share token symbol."""
+    asset_name: NotRequired[Nullable[str]]
+    r"""The name of the underlying asset."""
+    asset_symbol: NotRequired[Nullable[str]]
+    r"""The symbol of the underlying asset (e.g., 'USDC')."""
+    tvl_usd: NotRequired[Nullable[str]]
+    r"""Total Value Locked in USD."""
+    apy_7d: NotRequired[Nullable[str]]
+    r"""7-day APY as a percentage (e.g., 5.25 = 5.25%)."""
+    apy_30d: NotRequired[Nullable[str]]
+    r"""30-day APY as a percentage."""
+    apy_90d: NotRequired[Nullable[str]]
+    r"""90-day APY as a percentage."""
+
+
+class VaultInfo(BaseModel):
+    r"""Information about a single ERC-4626 vault from the database."""
+
+    vault_address: str
+    r"""The vault contract address."""
+
+    chain: str
+    r"""Blockchain name (e.g., 'ethereum', 'base')."""
+
+    owner: str
+    r"""The vault owner address."""
+
+    asset: str
+    r"""The underlying asset contract address."""
+
+    name: OptionalNullable[str] = UNSET
+    r"""The name of the vault."""
+
+    symbol: OptionalNullable[str] = UNSET
+    r"""The vault share token symbol."""
+
+    asset_name: OptionalNullable[str] = UNSET
+    r"""The name of the underlying asset."""
+
+    asset_symbol: OptionalNullable[str] = UNSET
+    r"""The symbol of the underlying asset (e.g., 'USDC')."""
+
+    tvl_usd: OptionalNullable[str] = UNSET
+    r"""Total Value Locked in USD."""
+
+    apy_7d: OptionalNullable[str] = UNSET
+    r"""7-day APY as a percentage (e.g., 5.25 = 5.25%)."""
+
+    apy_30d: OptionalNullable[str] = UNSET
+    r"""30-day APY as a percentage."""
+
+    apy_90d: OptionalNullable[str] = UNSET
+    r"""90-day APY as a percentage."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "name",
+            "symbol",
+            "asset_name",
+            "asset_symbol",
+            "tvl_usd",
+            "apy_7d",
+            "apy_30d",
+            "apy_90d",
+        ]
+        nullable_fields = [
+            "name",
+            "symbol",
+            "asset_name",
+            "asset_symbol",
+            "tvl_usd",
+            "apy_7d",
+            "apy_30d",
+            "apy_90d",
+        ]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk/models/vaultsresponse.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .vaultinfo import VaultInfo, VaultInfoTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class VaultsResponseTypedDict(TypedDict):
+    r"""Response model for a paginated list of ERC-4626 vaults."""
+
+    total: int
+    offset: int
+    limit: int
+    vaults: List[VaultInfoTypedDict]
+    r"""A list of vault information objects."""
+
+
+class VaultsResponse(BaseModel):
+    r"""Response model for a paginated list of ERC-4626 vaults."""
+
+    total: int
+
+    offset: int
+
+    limit: int
+
+    vaults: List[VaultInfo]
+    r"""A list of vault information objects."""

compass_api_sdk/models/vaultvenue.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+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 VaultVenueTypedDict(TypedDict):
+    vault_address: str
+    r"""The vault address you are interacting with for this action."""
+    type: Literal["VAULT"]
+    r"""The venue type discriminator."""
+
+
+class VaultVenue(BaseModel):
+    vault_address: str
+    r"""The vault address you are interacting with for this action."""
+
+    TYPE: Annotated[
+        Annotated[Literal["VAULT"], AfterValidator(validate_const("VAULT"))],
+        pydantic.Field(alias="type"),
+    ] = "VAULT"
+    r"""The venue type discriminator."""

compass_api_sdk/models/vaultwithdrawparams.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import AfterValidator
+from typing import Any, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class VaultWithdrawParamsTypedDict(TypedDict):
+    vault_address: str
+    r"""The vault address you are withdrawing from."""
+    amount: Any
+    r"""The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn."""
+    action_type: Literal["VAULT_WITHDRAW"]
+    receiver: NotRequired[Nullable[str]]
+    r"""The address which will receive the tokens withdrawn. Defaults to the sender."""
+
+
+class VaultWithdrawParams(BaseModel):
+    vault_address: str
+    r"""The vault address you are withdrawing from."""
+
+    amount: Any
+    r"""The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["VAULT_WITHDRAW"]],
+            AfterValidator(validate_const("VAULT_WITHDRAW")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "VAULT_WITHDRAW"
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address which will receive the tokens withdrawn. Defaults to the sender."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["action_type", "receiver"]
+        nullable_fields = ["receiver"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk/models/vaultwithdrawrequest.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,
@@ -10,6 +9,7 @@ from compass_api_sdk.types import (
     UNSET_SENTINEL,
 )
 from compass_api_sdk.utils import validate_const
+from enum import Enum
 import pydantic
 from pydantic import model_serializer
 from pydantic.functional_validators import AfterValidator
@@ -17,18 +17,25 @@ from typing import Any, Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
+class VaultWithdrawRequestChain(str, Enum):
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+    ETHEREUM = "ethereum"
+
+
 class VaultWithdrawRequestTypedDict(TypedDict):
     vault_address: str
     r"""The vault address you are withdrawing from."""
     amount: Any
     r"""The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: VaultWithdrawRequestChain
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["VAULT_WITHDRAW"]
     receiver: NotRequired[Nullable[str]]
     r"""The address which will receive the tokens withdrawn. Defaults to the sender."""
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class VaultWithdrawRequest(BaseModel):
@@ -38,8 +45,7 @@ class VaultWithdrawRequest(BaseModel):
     amount: Any
     r"""The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: VaultWithdrawRequestChain
 
     sender: str
     r"""The address of the transaction sender."""
@@ -55,9 +61,12 @@ class VaultWithdrawRequest(BaseModel):
     receiver: OptionalNullable[str] = UNSET
     r"""The address which will receive the tokens withdrawn. Defaults to the sender."""
 
+    estimate_gas: Optional[bool] = None
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["action_type", "receiver"]
+        optional_fields = ["action_type", "receiver", "estimate_gas"]
         nullable_fields = ["receiver"]
         null_default_fields = []
 

compass_api_sdk/models/wildcatgetmarketresponse.py

@@ -0,0 +1,151 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .compass_api_backend_v1_models_wildcat_read_response_market_userposition import (
+    CompassAPIBackendV1ModelsWildcatReadResponseMarketUserPosition,
+    CompassAPIBackendV1ModelsWildcatReadResponseMarketUserPositionTypedDict,
+)
+from .underlyingtoken import UnderlyingToken, UnderlyingTokenTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class WildcatGetMarketResponseTypedDict(TypedDict):
+    market_address: str
+    r"""The address of the market."""
+    name: str
+    r"""Name of the vault."""
+    symbol: str
+    r"""Symbol of the vault."""
+    decimals: int
+    r"""Number of decimals used for the vault's share precision."""
+    available_to_lend: str
+    r"""The borrower's remaining available credit."""
+    loaned: str
+    r"""The total value of all funds supplied by lenders, including interest."""
+    max_borrowing_capacity: str
+    r"""The maximum limit of funds that borrowers can access in the market."""
+    gross_interest_accrued: str
+    r"""The total gross interest generated by the loan before being split between lenders, reserves, and protocol fees."""
+    minimum_deposit: str
+    r"""The minimum amount of underlying asset required for a single deposit transaction."""
+    minimum_reserve_ratio: str
+    r"""A required percentage of market funds that must remain liquid and unavailable for borrowing."""
+    base_lender_apr: str
+    r"""The fixed annual percentage rate (excluding any protocol fees) that borrowers pay to lenders for assets within the market."""
+    protocol_fee_apr: str
+    r"""An additional APR that accrues to the protocol by slowly increasing required reserves. Derived by the fee configuration of the protocol as a percentage of the current base APR."""
+    effective_lender_apr: str
+    r"""The current interest rate being paid to lenders: the base APR plus penalty APR if applicable."""
+    penalty_apr: str
+    r"""An additional interest rate charged if the market remains delinquent—failing to maintain required reserves—after the grace period has elapsed."""
+    maximum_grace_period: int
+    r"""The number of seconds borrowers have to resolve reserve deficiencies or correct delinquency in the market before penalties take effect."""
+    available_grace_period: int
+    r"""The portion of the grace period left for borrowers to fix non-compliance issues, such as restoring reserves."""
+    withdrawal_cycle_duration: int
+    r"""The number of seconds for which withdrawal requests are grouped and processed."""
+    underlying_token: UnderlyingTokenTypedDict
+    user_position: NotRequired[
+        Nullable[
+            CompassAPIBackendV1ModelsWildcatReadResponseMarketUserPositionTypedDict
+        ]
+    ]
+    r"""The user's position in the vault."""
+
+
+class WildcatGetMarketResponse(BaseModel):
+    market_address: str
+    r"""The address of the market."""
+
+    name: str
+    r"""Name of the vault."""
+
+    symbol: str
+    r"""Symbol of the vault."""
+
+    decimals: int
+    r"""Number of decimals used for the vault's share precision."""
+
+    available_to_lend: str
+    r"""The borrower's remaining available credit."""
+
+    loaned: str
+    r"""The total value of all funds supplied by lenders, including interest."""
+
+    max_borrowing_capacity: str
+    r"""The maximum limit of funds that borrowers can access in the market."""
+
+    gross_interest_accrued: str
+    r"""The total gross interest generated by the loan before being split between lenders, reserves, and protocol fees."""
+
+    minimum_deposit: str
+    r"""The minimum amount of underlying asset required for a single deposit transaction."""
+
+    minimum_reserve_ratio: str
+    r"""A required percentage of market funds that must remain liquid and unavailable for borrowing."""
+
+    base_lender_apr: str
+    r"""The fixed annual percentage rate (excluding any protocol fees) that borrowers pay to lenders for assets within the market."""
+
+    protocol_fee_apr: str
+    r"""An additional APR that accrues to the protocol by slowly increasing required reserves. Derived by the fee configuration of the protocol as a percentage of the current base APR."""
+
+    effective_lender_apr: str
+    r"""The current interest rate being paid to lenders: the base APR plus penalty APR if applicable."""
+
+    penalty_apr: str
+    r"""An additional interest rate charged if the market remains delinquent—failing to maintain required reserves—after the grace period has elapsed."""
+
+    maximum_grace_period: int
+    r"""The number of seconds borrowers have to resolve reserve deficiencies or correct delinquency in the market before penalties take effect."""
+
+    available_grace_period: int
+    r"""The portion of the grace period left for borrowers to fix non-compliance issues, such as restoring reserves."""
+
+    withdrawal_cycle_duration: int
+    r"""The number of seconds for which withdrawal requests are grouped and processed."""
+
+    underlying_token: UnderlyingToken
+
+    user_position: OptionalNullable[
+        CompassAPIBackendV1ModelsWildcatReadResponseMarketUserPosition
+    ] = UNSET
+    r"""The user's position in the vault."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["user_position"]
+        nullable_fields = ["user_position"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk/models/{redeemunderlying.py → withdraw.py}

@@ -7,7 +7,7 @@ import pydantic
 from typing_extensions import Annotated, TypedDict
 
 
-class RedeemUnderlyingTypedDict(TypedDict):
+class WithdrawTypedDict(TypedDict):
     id: str
     r"""The id of a historical transaction on aave"""
     timestamp: int
@@ -24,7 +24,7 @@ class RedeemUnderlyingTypedDict(TypedDict):
     block: int
 
 
-class RedeemUnderlying(BaseModel):
+class Withdraw(BaseModel):
     id: str
     r"""The id of a historical transaction on aave"""