compass_api_sdk 0.9.20__py3-none-any.whl → 0.9.22__py3-none-any.whl

compass_api_sdk/models/vaultdepositrequest.py

@@ -0,0 +1,98 @@
+"""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,
+    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 Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+VaultDepositRequestAmountTypedDict = TypeAliasType(
+    "VaultDepositRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of tokens to deposit into the vault."""
+
+
+VaultDepositRequestAmount = TypeAliasType(
+    "VaultDepositRequestAmount", Union[float, str]
+)
+r"""The amount of tokens to deposit into the vault."""
+
+
+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."""
+    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."""
+
+
+class VaultDepositRequest(BaseModel):
+    vault_address: str
+    r"""The vault address you are depositing to."""
+
+    amount: VaultDepositRequestAmount
+    r"""The amount of tokens to deposit into the vault."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["VAULT_DEPOSIT"]],
+            AfterValidator(validate_const("VAULT_DEPOSIT")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "VAULT_DEPOSIT"
+
+    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."""
+
+    @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

@@ -0,0 +1,86 @@
+"""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,
+    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 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."""
+    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."""
+
+
+class VaultWithdrawRequest(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."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    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/morpho.py

@@ -1508,240 +1508,6 @@ class Morpho(BaseSDK):
             http_res,
         )
 
-    def allowance(
-        self,
-        *,
-        vault_address: str,
-        amount: Union[
-            models.MorphoSetVaultAllowanceRequestAmount,
-            models.MorphoSetVaultAllowanceRequestAmountTypedDict,
-        ],
-        chain: models.MorphoSetVaultAllowanceRequestChain,
-        sender: str,
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TxResponse:
-        r"""Set Allowance for Vault
-
-        Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.
-
-        Each vault has only one associated token that can be deposited.
-
-        Use the 'Get Vaults' endpoint to query a list of vaults you can deposit into.
-
-        :param vault_address: The vault address you are increasing the allowance for.
-        :param amount: The amount of tokens to increase the allowance by.
-        :param chain:
-        :param sender: The address of the transaction sender.
-        :param retries: Override the default retry configuration for this method
-        :param server_url: Override the default server URL for this method
-        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
-        :param http_headers: Additional headers to set or replace on requests.
-        """
-        base_url = None
-        url_variables = None
-        if timeout_ms is None:
-            timeout_ms = self.sdk_configuration.timeout_ms
-
-        if server_url is not None:
-            base_url = server_url
-        else:
-            base_url = self._get_url(base_url, url_variables)
-
-        request = models.MorphoSetVaultAllowanceRequest(
-            vault_address=vault_address,
-            amount=amount,
-            chain=chain,
-            sender=sender,
-        )
-
-        req = self._build_request(
-            method="POST",
-            path="/v0/morpho/allowance",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=True,
-            request_has_path_params=False,
-            request_has_query_params=True,
-            user_agent_header="user-agent",
-            accept_header_value="application/json",
-            http_headers=http_headers,
-            security=self.sdk_configuration.security,
-            get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.MorphoSetVaultAllowanceRequest
-            ),
-            timeout_ms=timeout_ms,
-        )
-
-        if retries == UNSET:
-            if self.sdk_configuration.retry_config is not UNSET:
-                retries = self.sdk_configuration.retry_config
-
-        retry_config = None
-        if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
-
-        http_res = self.do_request(
-            hook_ctx=HookContext(
-                config=self.sdk_configuration,
-                base_url=base_url or "",
-                operation_id="morpho_allowance",
-                oauth2_scopes=[],
-                security_source=self.sdk_configuration.security,
-            ),
-            request=req,
-            error_status_codes=["422", "4XX", "5XX"],
-            retry_config=retry_config,
-        )
-
-        response_data: Any = None
-        if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.TxResponse)
-        if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json(
-                http_res.text, errors.HTTPValidationErrorData
-            )
-            raise errors.HTTPValidationError(data=response_data)
-        if utils.match_response(http_res, "4XX", "*"):
-            http_res_text = utils.stream_to_text(http_res)
-            raise errors.APIError(
-                "API error occurred", http_res.status_code, http_res_text, http_res
-            )
-        if utils.match_response(http_res, "5XX", "*"):
-            http_res_text = utils.stream_to_text(http_res)
-            raise errors.APIError(
-                "API error occurred", http_res.status_code, http_res_text, http_res
-            )
-
-        content_type = http_res.headers.get("Content-Type")
-        http_res_text = utils.stream_to_text(http_res)
-        raise errors.APIError(
-            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
-            http_res.status_code,
-            http_res_text,
-            http_res,
-        )
-
-    async def allowance_async(
-        self,
-        *,
-        vault_address: str,
-        amount: Union[
-            models.MorphoSetVaultAllowanceRequestAmount,
-            models.MorphoSetVaultAllowanceRequestAmountTypedDict,
-        ],
-        chain: models.MorphoSetVaultAllowanceRequestChain,
-        sender: str,
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TxResponse:
-        r"""Set Allowance for Vault
-
-        Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.
-
-        Each vault has only one associated token that can be deposited.
-
-        Use the 'Get Vaults' endpoint to query a list of vaults you can deposit into.
-
-        :param vault_address: The vault address you are increasing the allowance for.
-        :param amount: The amount of tokens to increase the allowance by.
-        :param chain:
-        :param sender: The address of the transaction sender.
-        :param retries: Override the default retry configuration for this method
-        :param server_url: Override the default server URL for this method
-        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
-        :param http_headers: Additional headers to set or replace on requests.
-        """
-        base_url = None
-        url_variables = None
-        if timeout_ms is None:
-            timeout_ms = self.sdk_configuration.timeout_ms
-
-        if server_url is not None:
-            base_url = server_url
-        else:
-            base_url = self._get_url(base_url, url_variables)
-
-        request = models.MorphoSetVaultAllowanceRequest(
-            vault_address=vault_address,
-            amount=amount,
-            chain=chain,
-            sender=sender,
-        )
-
-        req = self._build_request_async(
-            method="POST",
-            path="/v0/morpho/allowance",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=True,
-            request_has_path_params=False,
-            request_has_query_params=True,
-            user_agent_header="user-agent",
-            accept_header_value="application/json",
-            http_headers=http_headers,
-            security=self.sdk_configuration.security,
-            get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.MorphoSetVaultAllowanceRequest
-            ),
-            timeout_ms=timeout_ms,
-        )
-
-        if retries == UNSET:
-            if self.sdk_configuration.retry_config is not UNSET:
-                retries = self.sdk_configuration.retry_config
-
-        retry_config = None
-        if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
-
-        http_res = await self.do_request_async(
-            hook_ctx=HookContext(
-                config=self.sdk_configuration,
-                base_url=base_url or "",
-                operation_id="morpho_allowance",
-                oauth2_scopes=[],
-                security_source=self.sdk_configuration.security,
-            ),
-            request=req,
-            error_status_codes=["422", "4XX", "5XX"],
-            retry_config=retry_config,
-        )
-
-        response_data: Any = None
-        if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.TxResponse)
-        if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json(
-                http_res.text, errors.HTTPValidationErrorData
-            )
-            raise errors.HTTPValidationError(data=response_data)
-        if utils.match_response(http_res, "4XX", "*"):
-            http_res_text = await utils.stream_to_text_async(http_res)
-            raise errors.APIError(
-                "API error occurred", http_res.status_code, http_res_text, http_res
-            )
-        if utils.match_response(http_res, "5XX", "*"):
-            http_res_text = await utils.stream_to_text_async(http_res)
-            raise errors.APIError(
-                "API error occurred", http_res.status_code, http_res_text, http_res
-            )
-
-        content_type = http_res.headers.get("Content-Type")
-        http_res_text = await utils.stream_to_text_async(http_res)
-        raise errors.APIError(
-            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
-            http_res.status_code,
-            http_res_text,
-            http_res,
-        )
-
     def deposit(
         self,
         *,

compass_api_sdk/sdk.py

@@ -24,6 +24,7 @@ if TYPE_CHECKING:
     from compass_api_sdk.transaction_bundler import TransactionBundler
     from compass_api_sdk.uniswap_v3 import UniswapV3
     from compass_api_sdk.universal import Universal
+    from compass_api_sdk.vaults_erc_4626_ import VaultsERC4626
 
 
 class CompassAPI(BaseSDK):
@@ -39,6 +40,7 @@ class CompassAPI(BaseSDK):
     pendle: "Pendle"
     transaction_bundler: "TransactionBundler"
     smart_account: "SmartAccount"
+    vaults_erc_4626: "VaultsERC4626"
     _sub_sdk_map = {
         "aave_v3": ("compass_api_sdk.aave_v3", "AaveV3"),
         "aerodrome_slipstream": (
@@ -56,6 +58,7 @@ class CompassAPI(BaseSDK):
             "TransactionBundler",
         ),
         "smart_account": ("compass_api_sdk.smart_account", "SmartAccount"),
+        "vaults_erc_4626": ("compass_api_sdk.vaults_erc_4626_", "VaultsERC4626"),
     }
 
     def __init__(

compass_api_sdk/smart_account.py

@@ -12,6 +12,7 @@ class SmartAccount(BaseSDK):
         self,
         *,
         chain: models.Chain,
+        sender: str,
         operations: Union[
             List[models.UserOperation], List[models.UserOperationTypedDict]
         ],
@@ -25,6 +26,7 @@ class SmartAccount(BaseSDK):
         Generate a list of user operations for smart account batching.
 
         :param chain: The chain to use.
+        :param sender: The address of the transaction sender.
         :param operations: List of possible user operations
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -43,6 +45,7 @@ class SmartAccount(BaseSDK):
 
         request = models.BatchedUserOperationsRequest(
             chain=chain,
+            sender=sender,
             operations=utils.get_pydantic_model(operations, List[models.UserOperation]),
         )
 
@@ -120,6 +123,7 @@ class SmartAccount(BaseSDK):
         self,
         *,
         chain: models.Chain,
+        sender: str,
         operations: Union[
             List[models.UserOperation], List[models.UserOperationTypedDict]
         ],
@@ -133,6 +137,7 @@ class SmartAccount(BaseSDK):
         Generate a list of user operations for smart account batching.
 
         :param chain: The chain to use.
+        :param sender: The address of the transaction sender.
         :param operations: List of possible user operations
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -151,6 +156,7 @@ class SmartAccount(BaseSDK):
 
         request = models.BatchedUserOperationsRequest(
             chain=chain,
+            sender=sender,
             operations=utils.get_pydantic_model(operations, List[models.UserOperation]),
         )
 

compass_api_sdk/universal.py

@@ -629,7 +629,10 @@ class Universal(BaseSDK):
         token: Union[
             models.GenericAllowanceToken, models.GenericAllowanceTokenTypedDict
         ],
-        contract_name: models.GenericAllowanceContractName = models.GenericAllowanceContractName.AAVE_V3_POOL,
+        contract: Union[
+            models.GenericAllowanceContractUnion,
+            models.GenericAllowanceContractUnionTypedDict,
+        ],
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -648,7 +651,7 @@ class Universal(BaseSDK):
 
         :param chain: The chain to use.
         :param token: The symbol or address of the token for which the allowance is checked..
-        :param contract_name: The name of the contract to check allowance for.
+        :param contract: The name or address of the contract to check allowance for.
         :param user: The user to get the ERC20 allowance of.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -669,7 +672,7 @@ class Universal(BaseSDK):
             chain=chain,
             user=user,
             token=token,
-            contract_name=contract_name,
+            contract=contract,
         )
 
         req = self._build_request(
@@ -744,7 +747,10 @@ class Universal(BaseSDK):
         token: Union[
             models.GenericAllowanceToken, models.GenericAllowanceTokenTypedDict
         ],
-        contract_name: models.GenericAllowanceContractName = models.GenericAllowanceContractName.AAVE_V3_POOL,
+        contract: Union[
+            models.GenericAllowanceContractUnion,
+            models.GenericAllowanceContractUnionTypedDict,
+        ],
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -763,7 +769,7 @@ class Universal(BaseSDK):
 
         :param chain: The chain to use.
         :param token: The symbol or address of the token for which the allowance is checked..
-        :param contract_name: The name of the contract to check allowance for.
+        :param contract: The name or address of the contract to check allowance for.
         :param user: The user to get the ERC20 allowance of.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -784,7 +790,7 @@ class Universal(BaseSDK):
             chain=chain,
             user=user,
             token=token,
-            contract_name=contract_name,
+            contract=contract,
         )
 
         req = self._build_request_async(
@@ -1504,13 +1510,14 @@ class Universal(BaseSDK):
         self,
         *,
         token: Union[
-            models.IncreaseAllowanceRequestToken,
-            models.IncreaseAllowanceRequestTokenTypedDict,
+            models.SetAllowanceRequestToken, models.SetAllowanceRequestTokenTypedDict
+        ],
+        contract: Union[
+            models.SetAllowanceRequestContractUnion,
+            models.SetAllowanceRequestContractUnionTypedDict,
         ],
-        contract_name: models.IncreaseAllowanceRequestContractName,
         amount: Union[
-            models.IncreaseAllowanceRequestAmount,
-            models.IncreaseAllowanceRequestAmountTypedDict,
+            models.SetAllowanceRequestAmount, models.SetAllowanceRequestAmountTypedDict
         ],
         chain: models.Chain,
         sender: str,
@@ -1530,9 +1537,9 @@ class Universal(BaseSDK):
         tokens securely and efficiently, enabling seamless transactions and operations
         within the DeFi ecosystem.
 
-        :param token: The symbol or address of the token for which the allowance is increased..
-        :param contract_name: The name of the contract to increase allowance for.
-        :param amount: The amount to increase the allowance to.
+        :param token: The symbol or address of the token for which the allowance is set..
+        :param contract: The name or address of the contract to set spending allowance for.
+        :param amount: The amount to set the allowance to.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1550,9 +1557,9 @@ class Universal(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.IncreaseAllowanceRequest(
+        request = models.SetAllowanceRequest(
             token=token,
-            contract_name=contract_name,
+            contract=contract,
             amount=amount,
             chain=chain,
             sender=sender,
@@ -1572,7 +1579,7 @@ class Universal(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.IncreaseAllowanceRequest
+                request, False, False, "json", models.SetAllowanceRequest
             ),
             timeout_ms=timeout_ms,
         )
@@ -1630,13 +1637,14 @@ class Universal(BaseSDK):
         self,
         *,
         token: Union[
-            models.IncreaseAllowanceRequestToken,
-            models.IncreaseAllowanceRequestTokenTypedDict,
+            models.SetAllowanceRequestToken, models.SetAllowanceRequestTokenTypedDict
+        ],
+        contract: Union[
+            models.SetAllowanceRequestContractUnion,
+            models.SetAllowanceRequestContractUnionTypedDict,
         ],
-        contract_name: models.IncreaseAllowanceRequestContractName,
         amount: Union[
-            models.IncreaseAllowanceRequestAmount,
-            models.IncreaseAllowanceRequestAmountTypedDict,
+            models.SetAllowanceRequestAmount, models.SetAllowanceRequestAmountTypedDict
         ],
         chain: models.Chain,
         sender: str,
@@ -1656,9 +1664,9 @@ class Universal(BaseSDK):
         tokens securely and efficiently, enabling seamless transactions and operations
         within the DeFi ecosystem.
 
-        :param token: The symbol or address of the token for which the allowance is increased..
-        :param contract_name: The name of the contract to increase allowance for.
-        :param amount: The amount to increase the allowance to.
+        :param token: The symbol or address of the token for which the allowance is set..
+        :param contract: The name or address of the contract to set spending allowance for.
+        :param amount: The amount to set the allowance to.
         :param chain: The chain to use.
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
@@ -1676,9 +1684,9 @@ class Universal(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.IncreaseAllowanceRequest(
+        request = models.SetAllowanceRequest(
             token=token,
-            contract_name=contract_name,
+            contract=contract,
             amount=amount,
             chain=chain,
             sender=sender,
@@ -1698,7 +1706,7 @@ class Universal(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.IncreaseAllowanceRequest
+                request, False, False, "json", models.SetAllowanceRequest
             ),
             timeout_ms=timeout_ms,
         )