compass_api_sdk 0.9.51__py3-none-any.whl → 1.0.0__py3-none-any.whl

compass_api_sdk/smart_account.py

@@ -9,10 +9,10 @@ from typing import Any, List, Mapping, Optional, Union
 
 
 class SmartAccount(BaseSDK):
-    def account_batched_user_operations(
+    def smart_account_batched_user_operations(
         self,
         *,
-        chain: models.Chain,
+        chain: models.BatchedUserOperationsRequestChain,
         sender: str,
         operations: Union[
             List[models.UserOperation], List[models.UserOperationTypedDict]
@@ -26,7 +26,7 @@ class SmartAccount(BaseSDK):
 
         Generate a list of user operations for smart account batching.
 
-        :param chain: The chain to use.
+        :param chain:
         :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
@@ -52,7 +52,7 @@ class SmartAccount(BaseSDK):
 
         req = self._build_request(
             method="POST",
-            path="/v0/smart_account/batched_user_operations",
+            path="/v1/smart_account/batched_user_operations",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -81,7 +81,7 @@ class SmartAccount(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="smart_account_batched_user_operations",
+                operation_id="v1_smart_account_batched_user_operations",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -109,10 +109,10 @@ class SmartAccount(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def account_batched_user_operations_async(
+    async def smart_account_batched_user_operations_async(
         self,
         *,
-        chain: models.Chain,
+        chain: models.BatchedUserOperationsRequestChain,
         sender: str,
         operations: Union[
             List[models.UserOperation], List[models.UserOperationTypedDict]
@@ -126,7 +126,7 @@ class SmartAccount(BaseSDK):
 
         Generate a list of user operations for smart account batching.
 
-        :param chain: The chain to use.
+        :param chain:
         :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
@@ -152,7 +152,7 @@ class SmartAccount(BaseSDK):
 
         req = self._build_request_async(
             method="POST",
-            path="/v0/smart_account/batched_user_operations",
+            path="/v1/smart_account/batched_user_operations",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -181,7 +181,7 @@ class SmartAccount(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="smart_account_batched_user_operations",
+                operation_id="v1_smart_account_batched_user_operations",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),

compass_api_sdk/swap.py

@@ -9,7 +9,7 @@ from typing import Any, Mapping, Optional, Union
 
 
 class Swap(BaseSDK):
-    def odos(
+    def swap_odos(
         self,
         *,
         token_in: Union[
@@ -22,20 +22,20 @@ class Swap(BaseSDK):
             models.OdosSwapRequestAmount, models.OdosSwapRequestAmountTypedDict
         ],
         max_slippage_percent: float,
-        chain: models.Chain,
+        chain: models.OdosSwapRequestChain,
         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:
+    ) -> models.TransactionResponse:
         r"""Odos Swap
 
         Swap between two tokens using Odos Smart Order Routing.
         <Info>
         **Required Allowances**
 
-        In order to make this transaction, token allowances need to be set on the following contracts.
+        In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `OdosRouter`
         </Info>
@@ -45,7 +45,7 @@ class Swap(BaseSDK):
         :param token_out: The symbol or address of the token that is to be bought.
         :param amount: The amount of token_in to be sold.
         :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
-        :param chain: The chain to use.
+        :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
@@ -73,7 +73,7 @@ class Swap(BaseSDK):
 
         req = self._build_request(
             method="POST",
-            path="/v0/swap/odos",
+            path="/v1/swap/odos",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -102,7 +102,7 @@ class Swap(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="swap_odos",
+                operation_id="v1_swap_odos",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -113,7 +113,7 @@ class Swap(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -128,7 +128,7 @@ class Swap(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def odos_async(
+    async def swap_odos_async(
         self,
         *,
         token_in: Union[
@@ -141,20 +141,20 @@ class Swap(BaseSDK):
             models.OdosSwapRequestAmount, models.OdosSwapRequestAmountTypedDict
         ],
         max_slippage_percent: float,
-        chain: models.Chain,
+        chain: models.OdosSwapRequestChain,
         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:
+    ) -> models.TransactionResponse:
         r"""Odos Swap
 
         Swap between two tokens using Odos Smart Order Routing.
         <Info>
         **Required Allowances**
 
-        In order to make this transaction, token allowances need to be set on the following contracts.
+        In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `OdosRouter`
         </Info>
@@ -164,7 +164,7 @@ class Swap(BaseSDK):
         :param token_out: The symbol or address of the token that is to be bought.
         :param amount: The amount of token_in to be sold.
         :param max_slippage_percent: The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
-        :param chain: The chain to use.
+        :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
@@ -192,7 +192,7 @@ class Swap(BaseSDK):
 
         req = self._build_request_async(
             method="POST",
-            path="/v0/swap/odos",
+            path="/v1/swap/odos",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -221,7 +221,7 @@ class Swap(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="swap_odos",
+                operation_id="v1_swap_odos",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -232,7 +232,7 @@ class Swap(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res

compass_api_sdk/token_sdk.py

@@ -9,11 +9,11 @@ from typing import Any, Mapping, Optional, Union
 
 
 class TokenSDK(BaseSDK):
-    def address(
+    def token_address(
         self,
         *,
-        chain: models.TokenAddressChain = models.TokenAddressChain.ARBITRUM_MAINNET,
-        token: models.TokenAddressToken = models.TokenAddressToken.WETH,
+        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,
@@ -23,7 +23,7 @@ class TokenSDK(BaseSDK):
 
         This endpoint retrieves the address for a token supported by us.
 
-        :param chain: The chain to use.
+        :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
@@ -40,14 +40,14 @@ class TokenSDK(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.TokenAddressRequest(
+        request = models.V1TokenAddressRequest(
             chain=chain,
             token=token,
         )
 
         req = self._build_request(
             method="GET",
-            path="/v0/token/address/get",
+            path="/v1/token/address",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -73,7 +73,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_address",
+                operation_id="v1_token_address",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -99,11 +99,11 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def address_async(
+    async def token_address_async(
         self,
         *,
-        chain: models.TokenAddressChain = models.TokenAddressChain.ARBITRUM_MAINNET,
-        token: models.TokenAddressToken = models.TokenAddressToken.WETH,
+        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,
@@ -113,7 +113,7 @@ class TokenSDK(BaseSDK):
 
         This endpoint retrieves the address for a token supported by us.
 
-        :param chain: The chain to use.
+        :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
@@ -130,14 +130,14 @@ class TokenSDK(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.TokenAddressRequest(
+        request = models.V1TokenAddressRequest(
             chain=chain,
             token=token,
         )
 
         req = self._build_request_async(
             method="GET",
-            path="/v0/token/address/get",
+            path="/v1/token/address",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -163,7 +163,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_address",
+                operation_id="v1_token_address",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -189,11 +189,11 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def price(
+    def token_price(
         self,
         *,
-        chain: models.TokenPriceChain = models.TokenPriceChain.ETHEREUM_MAINNET,
-        token: Union[models.TokenPriceToken, models.TokenPriceTokenTypedDict],
+        chain: models.V1TokenPriceChain = models.V1TokenPriceChain.ETHEREUM,
+        token: Union[models.V1TokenPriceToken, models.V1TokenPriceTokenTypedDict],
         block: OptionalNullable[int] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -208,7 +208,7 @@ class TokenSDK(BaseSDK):
         sources. This ensures the price is tamper-resistant but the price might be stale
         with the update frequency of the oracle.
 
-        :param chain: The chain to use.
+        :param chain:
         :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
@@ -226,7 +226,7 @@ class TokenSDK(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.TokenPriceRequest(
+        request = models.V1TokenPriceRequest(
             chain=chain,
             block=block,
             token=token,
@@ -234,7 +234,7 @@ class TokenSDK(BaseSDK):
 
         req = self._build_request(
             method="GET",
-            path="/v0/token/price/get",
+            path="/v1/token/price",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -260,7 +260,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_price",
+                operation_id="v1_token_price",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -286,11 +286,11 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def price_async(
+    async def token_price_async(
         self,
         *,
-        chain: models.TokenPriceChain = models.TokenPriceChain.ETHEREUM_MAINNET,
-        token: Union[models.TokenPriceToken, models.TokenPriceTokenTypedDict],
+        chain: models.V1TokenPriceChain = models.V1TokenPriceChain.ETHEREUM,
+        token: Union[models.V1TokenPriceToken, models.V1TokenPriceTokenTypedDict],
         block: OptionalNullable[int] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -305,7 +305,7 @@ class TokenSDK(BaseSDK):
         sources. This ensures the price is tamper-resistant but the price might be stale
         with the update frequency of the oracle.
 
-        :param chain: The chain to use.
+        :param chain:
         :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
@@ -323,7 +323,7 @@ class TokenSDK(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.TokenPriceRequest(
+        request = models.V1TokenPriceRequest(
             chain=chain,
             block=block,
             token=token,
@@ -331,7 +331,7 @@ class TokenSDK(BaseSDK):
 
         req = self._build_request_async(
             method="GET",
-            path="/v0/token/price/get",
+            path="/v1/token/price",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -357,7 +357,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_price",
+                operation_id="v1_token_price",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -383,12 +383,12 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def balance(
+    def token_balance(
         self,
         *,
-        chain: models.TokenBalanceChain = models.TokenBalanceChain.ARBITRUM_MAINNET,
+        chain: models.V1TokenBalanceChain = models.V1TokenBalanceChain.ARBITRUM,
         user: str = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Union[models.TokenBalanceToken, models.TokenBalanceTokenTypedDict],
+        token: Union[models.V1TokenBalanceToken, models.V1TokenBalanceTokenTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -398,7 +398,7 @@ class TokenSDK(BaseSDK):
 
         Returns the balance of a specific ERC20 token for a given user address.
 
-        :param chain: The chain to use.
+        :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 retries: Override the default retry configuration for this method
@@ -416,7 +416,7 @@ class TokenSDK(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.TokenBalanceRequest(
+        request = models.V1TokenBalanceRequest(
             chain=chain,
             user=user,
             token=token,
@@ -424,7 +424,7 @@ class TokenSDK(BaseSDK):
 
         req = self._build_request(
             method="GET",
-            path="/v0/token/balance/get",
+            path="/v1/token/balance",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -450,7 +450,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_balance",
+                operation_id="v1_token_balance",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -476,12 +476,12 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def balance_async(
+    async def token_balance_async(
         self,
         *,
-        chain: models.TokenBalanceChain = models.TokenBalanceChain.ARBITRUM_MAINNET,
+        chain: models.V1TokenBalanceChain = models.V1TokenBalanceChain.ARBITRUM,
         user: str = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Union[models.TokenBalanceToken, models.TokenBalanceTokenTypedDict],
+        token: Union[models.V1TokenBalanceToken, models.V1TokenBalanceTokenTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -491,7 +491,7 @@ class TokenSDK(BaseSDK):
 
         Returns the balance of a specific ERC20 token for a given user address.
 
-        :param chain: The chain to use.
+        :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 retries: Override the default retry configuration for this method
@@ -509,7 +509,7 @@ class TokenSDK(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.TokenBalanceRequest(
+        request = models.V1TokenBalanceRequest(
             chain=chain,
             user=user,
             token=token,
@@ -517,7 +517,7 @@ class TokenSDK(BaseSDK):
 
         req = self._build_request_async(
             method="GET",
-            path="/v0/token/balance/get",
+            path="/v1/token/balance",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -543,7 +543,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_balance",
+                operation_id="v1_token_balance",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -569,7 +569,7 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def transfer(
+    def token_transfer(
         self,
         *,
         amount: Union[
@@ -580,13 +580,13 @@ class TokenSDK(BaseSDK):
             models.TokenTransferRequestToken, models.TokenTransferRequestTokenTypedDict
         ],
         to: str,
-        chain: models.Chain,
+        chain: models.TokenTransferRequestChain,
         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:
+    ) -> models.TransactionResponse:
         r"""Transfer ETH or ERC20 Tokens
 
         Sends native ETH or ERC20 tokens from the sender's address to another address.
@@ -594,7 +594,7 @@ class TokenSDK(BaseSDK):
         :param amount: Amount of token to transfer
         :param token: The symbol of the token to transfer..
         :param to: The recipient of the tokens.
-        :param chain: The chain to use.
+        :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
@@ -621,7 +621,7 @@ class TokenSDK(BaseSDK):
 
         req = self._build_request(
             method="POST",
-            path="/v0/token/transfer",
+            path="/v1/token/transfer",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -650,7 +650,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_transfer",
+                operation_id="v1_token_transfer",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -661,7 +661,7 @@ class TokenSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -676,7 +676,7 @@ class TokenSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def transfer_async(
+    async def token_transfer_async(
         self,
         *,
         amount: Union[
@@ -687,13 +687,13 @@ class TokenSDK(BaseSDK):
             models.TokenTransferRequestToken, models.TokenTransferRequestTokenTypedDict
         ],
         to: str,
-        chain: models.Chain,
+        chain: models.TokenTransferRequestChain,
         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:
+    ) -> models.TransactionResponse:
         r"""Transfer ETH or ERC20 Tokens
 
         Sends native ETH or ERC20 tokens from the sender's address to another address.
@@ -701,7 +701,7 @@ class TokenSDK(BaseSDK):
         :param amount: Amount of token to transfer
         :param token: The symbol of the token to transfer..
         :param to: The recipient of the tokens.
-        :param chain: The chain to use.
+        :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
@@ -728,7 +728,7 @@ class TokenSDK(BaseSDK):
 
         req = self._build_request_async(
             method="POST",
-            path="/v0/token/transfer",
+            path="/v1/token/transfer",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -757,7 +757,7 @@ class TokenSDK(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="token_transfer",
+                operation_id="v1_token_transfer",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -768,7 +768,7 @@ class TokenSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res