compass_api_sdk 1.1.1rc0__py3-none-any.whl → 1.1.3rc0__py3-none-any.whl

compass_api_sdk/pendle.py

@@ -568,9 +568,7 @@ class Pendle(BaseSDK):
         *,
         market_address: str,
         action: models.PendleTradePtRequestAction,
-        token: Union[
-            models.PendleTradePtRequestToken, models.PendleTradePtRequestTokenTypedDict
-        ],
+        token: str,
         amount_in: Union[
             models.PendleTradePtRequestAmountIn,
             models.PendleTradePtRequestAmountInTypedDict,
@@ -694,9 +692,7 @@ class Pendle(BaseSDK):
         *,
         market_address: str,
         action: models.PendleTradePtRequestAction,
-        token: Union[
-            models.PendleTradePtRequestToken, models.PendleTradePtRequestTokenTypedDict
-        ],
+        token: str,
         amount_in: Union[
             models.PendleTradePtRequestAmountIn,
             models.PendleTradePtRequestAmountInTypedDict,
@@ -820,9 +816,7 @@ class Pendle(BaseSDK):
         *,
         market_address: str,
         action: models.PendleTradeYtRequestAction,
-        token: Union[
-            models.PendleTradeYtRequestToken, models.PendleTradeYtRequestTokenTypedDict
-        ],
+        token: str,
         amount_in: Union[
             models.PendleTradeYtRequestAmountIn,
             models.PendleTradeYtRequestAmountInTypedDict,
@@ -946,9 +940,7 @@ class Pendle(BaseSDK):
         *,
         market_address: str,
         action: models.PendleTradeYtRequestAction,
-        token: Union[
-            models.PendleTradeYtRequestToken, models.PendleTradeYtRequestTokenTypedDict
-        ],
+        token: str,
         amount_in: Union[
             models.PendleTradeYtRequestAmountIn,
             models.PendleTradeYtRequestAmountInTypedDict,
@@ -1072,10 +1064,7 @@ class Pendle(BaseSDK):
         *,
         market_address: str,
         action: models.PendleManageLiquidityRequestAction,
-        token: Union[
-            models.PendleManageLiquidityRequestToken,
-            models.PendleManageLiquidityRequestTokenTypedDict,
-        ],
+        token: str,
         amount_in: Union[
             models.PendleManageLiquidityRequestAmountIn,
             models.PendleManageLiquidityRequestAmountInTypedDict,
@@ -1202,10 +1191,7 @@ class Pendle(BaseSDK):
         *,
         market_address: str,
         action: models.PendleManageLiquidityRequestAction,
-        token: Union[
-            models.PendleManageLiquidityRequestToken,
-            models.PendleManageLiquidityRequestTokenTypedDict,
-        ],
+        token: str,
         amount_in: Union[
             models.PendleManageLiquidityRequestAmountIn,
             models.PendleManageLiquidityRequestAmountInTypedDict,

compass_api_sdk/sdk.py

@@ -24,7 +24,7 @@ if TYPE_CHECKING:
     from compass_api_sdk.sky import Sky
     from compass_api_sdk.smart_account import SmartAccount
     from compass_api_sdk.swap import Swap
-    from compass_api_sdk.token_sdk import TokenSDK
+    from compass_api_sdk.token import Token
     from compass_api_sdk.transaction_bundler import TransactionBundler
     from compass_api_sdk.uniswap_v3 import UniswapV3
     from compass_api_sdk.universal import Universal
@@ -37,7 +37,7 @@ class CompassAPI(BaseSDK):
     aerodrome_slipstream: "AerodromeSlipstream"
     morpho: "Morpho"
     sky: "Sky"
-    token: "TokenSDK"
+    token: "Token"
     uniswap_v3: "UniswapV3"
     universal: "Universal"
     pendle: "Pendle"
@@ -54,7 +54,7 @@ class CompassAPI(BaseSDK):
         ),
         "morpho": ("compass_api_sdk.morpho", "Morpho"),
         "sky": ("compass_api_sdk.sky", "Sky"),
-        "token": ("compass_api_sdk.token_sdk", "TokenSDK"),
+        "token": ("compass_api_sdk.token", "Token"),
         "uniswap_v3": ("compass_api_sdk.uniswap_v3", "UniswapV3"),
         "universal": ("compass_api_sdk.universal", "Universal"),
         "pendle": ("compass_api_sdk.pendle", "Pendle"),

compass_api_sdk/sky.py

@@ -12,8 +12,8 @@ class Sky(BaseSDK):
     def sky_position(
         self,
         *,
-        user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
-        chain: Optional[models.V1SkyPositionChain] = models.V1SkyPositionChain.ETHEREUM,
+        chain: models.V1SkyPositionChain = models.V1SkyPositionChain.ETHEREUM,
+        user_address: str = "0xacCEE9C7A5a759f814C7A770e2D8F78d662b1F60",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -23,8 +23,8 @@ class Sky(BaseSDK):
 
         Check the USDS overall position.
 
-        :param user_address: The user-address of the desired position.
         :param chain:
+        :param user_address: The user-address of the desired position.
         :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
@@ -102,8 +102,8 @@ class Sky(BaseSDK):
     async def sky_position_async(
         self,
         *,
-        user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
-        chain: Optional[models.V1SkyPositionChain] = models.V1SkyPositionChain.ETHEREUM,
+        chain: models.V1SkyPositionChain = models.V1SkyPositionChain.ETHEREUM,
+        user_address: str = "0xacCEE9C7A5a759f814C7A770e2D8F78d662b1F60",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -113,8 +113,8 @@ class Sky(BaseSDK):
 
         Check the USDS overall position.
 
-        :param user_address: The user-address of the desired position.
         :param chain:
+        :param user_address: The user-address of the desired position.
         :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
@@ -216,6 +216,7 @@ class Sky(BaseSDK):
         In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `SkyUsdcUsdsConverter`
+        - `SkyDaiUsdsConverter`
         </Info>
 
 
@@ -329,6 +330,7 @@ class Sky(BaseSDK):
         In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `SkyUsdcUsdsConverter`
+        - `SkyDaiUsdsConverter`
         </Info>
 
 
@@ -422,10 +424,8 @@ class Sky(BaseSDK):
         amount: Union[
             models.SkySellRequestAmount, models.SkySellRequestAmountTypedDict
         ],
+        chain: models.SkySellRequestChain,
         sender: str,
-        chain: Optional[
-            models.SkySellRequestChain
-        ] = models.SkySellRequestChain.ETHEREUM,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -446,13 +446,14 @@ class Sky(BaseSDK):
         In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `SkyUsdcUsdsConverter`
+        - `SkyDaiUsdsConverter`
         </Info>
 
 
         :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
-        :param sender: The address of the transaction sender.
         :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
@@ -539,10 +540,8 @@ class Sky(BaseSDK):
         amount: Union[
             models.SkySellRequestAmount, models.SkySellRequestAmountTypedDict
         ],
+        chain: models.SkySellRequestChain,
         sender: str,
-        chain: Optional[
-            models.SkySellRequestChain
-        ] = models.SkySellRequestChain.ETHEREUM,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -563,13 +562,14 @@ class Sky(BaseSDK):
         In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `SkyUsdcUsdsConverter`
+        - `SkyDaiUsdsConverter`
         </Info>
 
 
         :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
-        :param sender: The address of the transaction sender.
         :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
@@ -905,7 +905,6 @@ class Sky(BaseSDK):
 
         In order to make this transaction, token allowances need to be set for the following contracts.
 
-        - `SkyUsdcUsdsConverter`
         - `SkyUsdsVault`
         </Info>
 
@@ -1019,7 +1018,6 @@ class Sky(BaseSDK):
 
         In order to make this transaction, token allowances need to be set for the following contracts.
 
-        - `SkyUsdcUsdsConverter`
         - `SkyUsdsVault`
         </Info>
 

compass_api_sdk/swap.py

@@ -12,12 +12,8 @@ class Swap(BaseSDK):
     def swap_odos(
         self,
         *,
-        token_in: Union[
-            models.OdosSwapRequestTokenIn, models.OdosSwapRequestTokenInTypedDict
-        ],
-        token_out: Union[
-            models.OdosSwapRequestTokenOut, models.OdosSwapRequestTokenOutTypedDict
-        ],
+        token_in: str,
+        token_out: str,
         amount: Union[
             models.OdosSwapRequestAmount, models.OdosSwapRequestAmountTypedDict
         ],
@@ -131,12 +127,8 @@ class Swap(BaseSDK):
     async def swap_odos_async(
         self,
         *,
-        token_in: Union[
-            models.OdosSwapRequestTokenIn, models.OdosSwapRequestTokenInTypedDict
-        ],
-        token_out: Union[
-            models.OdosSwapRequestTokenOut, models.OdosSwapRequestTokenOutTypedDict
-        ],
+        token_in: str,
+        token_out: str,
         amount: Union[
             models.OdosSwapRequestAmount, models.OdosSwapRequestAmountTypedDict
         ],

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,9 +393,7 @@ class TokenSDK(BaseSDK):
         self,
         *,
         to: str,
-        token: Union[
-            models.TokenTransferRequestToken, models.TokenTransferRequestTokenTypedDict
-        ],
+        token: str,
         amount: Union[
             models.TokenTransferRequestAmount,
             models.TokenTransferRequestAmountTypedDict,
@@ -680,9 +498,7 @@ class TokenSDK(BaseSDK):
         self,
         *,
         to: str,
-        token: Union[
-            models.TokenTransferRequestToken, models.TokenTransferRequestTokenTypedDict
-        ],
+        token: str,
         amount: Union[
             models.TokenTransferRequestAmount,
             models.TokenTransferRequestAmountTypedDict,

compass_api_sdk/transaction_bundler.py

@@ -432,8 +432,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
         ],
@@ -467,8 +467,8 @@ 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
@@ -569,8 +569,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
         ],
@@ -604,8 +604,8 @@ 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