compass_api_sdk 1.1.2__py3-none-any.whl → 1.1.3__py3-none-any.whl

compass_api_sdk/{token_sdk.py → token.py}

@@ -8,192 +8,12 @@ from compass_api_sdk.utils.unmarshal_json_response import unmarshal_json_respons
 from typing import Any, Mapping, Optional, Union
 
 
-class TokenSDK(BaseSDK):
-    def token_address(
-        self,
-        *,
-        chain: models.V1TokenAddressChain = models.V1TokenAddressChain.ARBITRUM,
-        token: models.V1TokenAddressToken = models.V1TokenAddressToken.WETH,
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TokenAddressResponse:
-        r"""Token Address
-
-        This endpoint retrieves the address for a token supported by us.
-
-        :param chain:
-        :param token: The token symbol to get the address for..
-        :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.V1TokenAddressRequest(
-            chain=chain,
-            token=token,
-        )
-
-        req = self._build_request(
-            method="GET",
-            path="/v1/token/address",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=False,
-            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,
-            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="v1_token_address",
-                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 unmarshal_json_response(models.TokenAddressResponse, http_res)
-        if utils.match_response(http_res, "422", "application/json"):
-            response_data = unmarshal_json_response(
-                errors.HTTPValidationErrorData, http_res
-            )
-            raise errors.HTTPValidationError(response_data, http_res)
-        if utils.match_response(http_res, "4XX", "*"):
-            http_res_text = utils.stream_to_text(http_res)
-            raise errors.APIError("API error occurred", http_res, http_res_text)
-        if utils.match_response(http_res, "5XX", "*"):
-            http_res_text = utils.stream_to_text(http_res)
-            raise errors.APIError("API error occurred", http_res, http_res_text)
-
-        raise errors.APIError("Unexpected response received", http_res)
-
-    async def token_address_async(
-        self,
-        *,
-        chain: models.V1TokenAddressChain = models.V1TokenAddressChain.ARBITRUM,
-        token: models.V1TokenAddressToken = models.V1TokenAddressToken.WETH,
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TokenAddressResponse:
-        r"""Token Address
-
-        This endpoint retrieves the address for a token supported by us.
-
-        :param chain:
-        :param token: The token symbol to get the address for..
-        :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.V1TokenAddressRequest(
-            chain=chain,
-            token=token,
-        )
-
-        req = self._build_request_async(
-            method="GET",
-            path="/v1/token/address",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=False,
-            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,
-            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="v1_token_address",
-                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 unmarshal_json_response(models.TokenAddressResponse, http_res)
-        if utils.match_response(http_res, "422", "application/json"):
-            response_data = unmarshal_json_response(
-                errors.HTTPValidationErrorData, http_res
-            )
-            raise errors.HTTPValidationError(response_data, http_res)
-        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, http_res_text)
-        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, http_res_text)
-
-        raise errors.APIError("Unexpected response received", http_res)
-
+class Token(BaseSDK):
     def token_price(
         self,
         *,
         chain: models.V1TokenPriceChain = models.V1TokenPriceChain.ETHEREUM,
-        token: Any,
+        token: str = "AAVE",
         block: OptionalNullable[int] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -209,7 +29,7 @@ class TokenSDK(BaseSDK):
         with the update frequency of the oracle.
 
         :param chain:
-        :param token: The symbol or address of the token for which to get the price.
+        :param token: The symbol or address of the token for which to get the price..
         :param block: Optional block number (defaults to latest).
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -290,7 +110,7 @@ class TokenSDK(BaseSDK):
         self,
         *,
         chain: models.V1TokenPriceChain = models.V1TokenPriceChain.ETHEREUM,
-        token: Any,
+        token: str = "AAVE",
         block: OptionalNullable[int] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -306,7 +126,7 @@ class TokenSDK(BaseSDK):
         with the update frequency of the oracle.
 
         :param chain:
-        :param token: The symbol or address of the token for which to get the price.
+        :param token: The symbol or address of the token for which to get the price..
         :param block: Optional block number (defaults to latest).
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -388,7 +208,7 @@ class TokenSDK(BaseSDK):
         *,
         chain: models.V1TokenBalanceChain = models.V1TokenBalanceChain.ARBITRUM,
         user: str = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Union[models.V1TokenBalanceToken, models.V1TokenBalanceTokenTypedDict],
+        token: str = "USDC",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -399,8 +219,8 @@ class TokenSDK(BaseSDK):
         Returns the balance of a specific ERC20 token for a given user address.
 
         :param chain:
-        :param user: The user to get the ERC20 balance of.
-        :param token: The symbol of the token for which the balance is checked..
+        :param user: The user to get the token balance of.
+        :param token: The symbol or address of the token for which the balance is checked.
         :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
@@ -481,7 +301,7 @@ class TokenSDK(BaseSDK):
         *,
         chain: models.V1TokenBalanceChain = models.V1TokenBalanceChain.ARBITRUM,
         user: str = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Union[models.V1TokenBalanceToken, models.V1TokenBalanceTokenTypedDict],
+        token: str = "USDC",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -492,8 +312,8 @@ class TokenSDK(BaseSDK):
         Returns the balance of a specific ERC20 token for a given user address.
 
         :param chain:
-        :param user: The user to get the ERC20 balance of.
-        :param token: The symbol of the token for which the balance is checked..
+        :param user: The user to get the token balance of.
+        :param token: The symbol or address of the token for which the balance is checked.
         :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
@@ -573,15 +393,14 @@ class TokenSDK(BaseSDK):
         self,
         *,
         to: str,
-        token: Union[
-            models.TokenTransferRequestToken, models.TokenTransferRequestTokenTypedDict
-        ],
+        token: str,
         amount: Union[
             models.TokenTransferRequestAmount,
             models.TokenTransferRequestAmountTypedDict,
         ],
         chain: models.TokenTransferRequestChain,
         sender: str,
+        estimate_gas: Optional[bool] = True,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -596,6 +415,7 @@ class TokenSDK(BaseSDK):
         :param amount: Amount of token to transfer
         :param chain:
         :param sender: The address of the transaction sender.
+        :param estimate_gas: Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
         :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
@@ -617,6 +437,7 @@ class TokenSDK(BaseSDK):
             amount=amount,
             chain=chain,
             sender=sender,
+            estimate_gas=estimate_gas,
         )
 
         req = self._build_request(
@@ -680,15 +501,14 @@ class TokenSDK(BaseSDK):
         self,
         *,
         to: str,
-        token: Union[
-            models.TokenTransferRequestToken, models.TokenTransferRequestTokenTypedDict
-        ],
+        token: str,
         amount: Union[
             models.TokenTransferRequestAmount,
             models.TokenTransferRequestAmountTypedDict,
         ],
         chain: models.TokenTransferRequestChain,
         sender: str,
+        estimate_gas: Optional[bool] = True,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -703,6 +523,7 @@ class TokenSDK(BaseSDK):
         :param amount: Amount of token to transfer
         :param chain:
         :param sender: The address of the transaction sender.
+        :param estimate_gas: Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
         :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
@@ -724,6 +545,7 @@ class TokenSDK(BaseSDK):
             amount=amount,
             chain=chain,
             sender=sender,
+            estimate_gas=estimate_gas,
         )
 
         req = self._build_request_async(

compass_api_sdk/transaction_bundler.py

@@ -215,6 +215,7 @@ class TransactionBundler(BaseSDK):
         chain: models.MulticallExecuteRequestChain,
         sender: str,
         actions: Union[List[models.UserOperation], List[models.UserOperationTypedDict]],
+        estimate_gas: Optional[bool] = True,
         signed_authorization: OptionalNullable[
             Union[models.SignedAuthorization, models.SignedAuthorizationTypedDict]
         ] = UNSET,
@@ -236,6 +237,7 @@ class TransactionBundler(BaseSDK):
         :param chain:
         :param sender: The address of the transaction sender.
         :param actions: List of possible actions for multicall
+        :param estimate_gas: Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
         :param signed_authorization: EIP-7702 authorization
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -255,6 +257,7 @@ class TransactionBundler(BaseSDK):
         request = models.MulticallExecuteRequest(
             chain=chain,
             sender=sender,
+            estimate_gas=estimate_gas,
             signed_authorization=utils.get_pydantic_model(
                 signed_authorization, OptionalNullable[models.SignedAuthorization]
             ),
@@ -324,6 +327,7 @@ class TransactionBundler(BaseSDK):
         chain: models.MulticallExecuteRequestChain,
         sender: str,
         actions: Union[List[models.UserOperation], List[models.UserOperationTypedDict]],
+        estimate_gas: Optional[bool] = True,
         signed_authorization: OptionalNullable[
             Union[models.SignedAuthorization, models.SignedAuthorizationTypedDict]
         ] = UNSET,
@@ -345,6 +349,7 @@ class TransactionBundler(BaseSDK):
         :param chain:
         :param sender: The address of the transaction sender.
         :param actions: List of possible actions for multicall
+        :param estimate_gas: Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
         :param signed_authorization: EIP-7702 authorization
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -364,6 +369,7 @@ class TransactionBundler(BaseSDK):
         request = models.MulticallExecuteRequest(
             chain=chain,
             sender=sender,
+            estimate_gas=estimate_gas,
             signed_authorization=utils.get_pydantic_model(
                 signed_authorization, OptionalNullable[models.SignedAuthorization]
             ),
@@ -432,8 +438,8 @@ class TransactionBundler(BaseSDK):
         *,
         chain: models.AaveLoopRequestChain,
         sender: str,
-        collateral_token: models.TokenEnum,
-        borrow_token: models.TokenEnum,
+        collateral_token: str,
+        borrow_token: str,
         initial_collateral_amount: Union[
             models.InitialCollateralAmount, models.InitialCollateralAmountTypedDict
         ],
@@ -442,6 +448,7 @@ class TransactionBundler(BaseSDK):
             models.MaxSlippagePercent, models.MaxSlippagePercentTypedDict
         ],
         loan_to_value: Union[models.LoanToValue, models.LoanToValueTypedDict],
+        estimate_gas: Optional[bool] = True,
         signed_authorization: OptionalNullable[
             Union[models.SignedAuthorization, models.SignedAuthorizationTypedDict]
         ] = UNSET,
@@ -467,12 +474,13 @@ class TransactionBundler(BaseSDK):
 
         :param chain:
         :param sender: The address of the transaction sender.
-        :param collateral_token: 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.
-        :param borrow_token: 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.
+        :param collateral_token: Symbol or address of token to supply to Aave..
+        :param borrow_token: Symbol or address of token to borrow from Aave..
         :param initial_collateral_amount: Amount of collateral token to supply to Aave
         :param multiplier: Leverage multiplier. Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount`
         :param max_slippage_percent: Maximum allowed slippage for token swaps in percentage
         :param loan_to_value: Loan To Value percentage of the loop
+        :param estimate_gas: Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
         :param signed_authorization: EIP-7702 authorization. Required when `is_account_abstraction` is False.
         :param is_account_abstraction: Whether to use account abstraction for the transaction.
         :param retries: Override the default retry configuration for this method
@@ -493,6 +501,7 @@ class TransactionBundler(BaseSDK):
         request = models.AaveLoopRequest(
             chain=chain,
             sender=sender,
+            estimate_gas=estimate_gas,
             signed_authorization=utils.get_pydantic_model(
                 signed_authorization, OptionalNullable[models.SignedAuthorization]
             ),
@@ -569,8 +578,8 @@ class TransactionBundler(BaseSDK):
         *,
         chain: models.AaveLoopRequestChain,
         sender: str,
-        collateral_token: models.TokenEnum,
-        borrow_token: models.TokenEnum,
+        collateral_token: str,
+        borrow_token: str,
         initial_collateral_amount: Union[
             models.InitialCollateralAmount, models.InitialCollateralAmountTypedDict
         ],
@@ -579,6 +588,7 @@ class TransactionBundler(BaseSDK):
             models.MaxSlippagePercent, models.MaxSlippagePercentTypedDict
         ],
         loan_to_value: Union[models.LoanToValue, models.LoanToValueTypedDict],
+        estimate_gas: Optional[bool] = True,
         signed_authorization: OptionalNullable[
             Union[models.SignedAuthorization, models.SignedAuthorizationTypedDict]
         ] = UNSET,
@@ -604,12 +614,13 @@ class TransactionBundler(BaseSDK):
 
         :param chain:
         :param sender: The address of the transaction sender.
-        :param collateral_token: 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.
-        :param borrow_token: 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.
+        :param collateral_token: Symbol or address of token to supply to Aave..
+        :param borrow_token: Symbol or address of token to borrow from Aave..
         :param initial_collateral_amount: Amount of collateral token to supply to Aave
         :param multiplier: Leverage multiplier. Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount`
         :param max_slippage_percent: Maximum allowed slippage for token swaps in percentage
         :param loan_to_value: Loan To Value percentage of the loop
+        :param estimate_gas: Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
         :param signed_authorization: EIP-7702 authorization. Required when `is_account_abstraction` is False.
         :param is_account_abstraction: Whether to use account abstraction for the transaction.
         :param retries: Override the default retry configuration for this method
@@ -630,6 +641,7 @@ class TransactionBundler(BaseSDK):
         request = models.AaveLoopRequest(
             chain=chain,
             sender=sender,
+            estimate_gas=estimate_gas,
             signed_authorization=utils.get_pydantic_model(
                 signed_authorization, OptionalNullable[models.SignedAuthorization]
             ),