crypticorn 2.11.8__py3-none-any.whl → 2.12.0__py3-none-any.whl

crypticorn/common/errors.py

@@ -68,7 +68,7 @@ class ApiErrorIdentifier(StrEnum):
     LEVERAGE_EXCEEDED = "leverage_limit_exceeded"
     LIQUIDATION_PRICE_VIOLATION = "order_violates_liquidation_price_constraints"
     MARGIN_MODE_CLASH = "margin_mode_clash"
-    MODEL_NAME_NOT_UNIQUE = "model_name_not_unique"
+    NAME_NOT_UNIQUE = "name_not_unique"
     NO_CREDENTIALS = "no_credentials"
     NOW_API_DOWN = "now_api_down"
     OBJECT_ALREADY_EXISTS = "object_already_exists"
@@ -333,8 +333,8 @@ class ApiError(Enum, metaclass=ApiErrorFallback):
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
-    MODEL_NAME_NOT_UNIQUE = (
-        ApiErrorIdentifier.MODEL_NAME_NOT_UNIQUE,
+    NAME_NOT_UNIQUE = (
+        ApiErrorIdentifier.NAME_NOT_UNIQUE,
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
@@ -623,7 +623,7 @@ class StatusCodeMapper:
             status.HTTP_409_CONFLICT,
             status.WS_1008_POLICY_VIOLATION,
         ),
-        ApiError.MODEL_NAME_NOT_UNIQUE: (
+        ApiError.NAME_NOT_UNIQUE: (
             status.HTTP_409_CONFLICT,
             status.WS_1008_POLICY_VIOLATION,
         ),

crypticorn/common/exceptions.py

@@ -154,3 +154,13 @@ def register_exception_handlers(app: FastAPI):
 exception_response = {
     "default": {"model": ExceptionDetail, "description": "Error response"}
 }
+
+class CrypticornException(Exception):
+    """A custom exception class for Crypticorn."""
+
+    def __init__(self, error: ApiError, message: str = None):
+        self.message = message
+        self.error = error
+
+    def __str__(self):
+        return f"{self.error.identifier}: {self.message}"

crypticorn/hive/client/__init__.py

@@ -37,6 +37,7 @@ from crypticorn.hive.client.exceptions import ApiException
 from crypticorn.hive.client.models.api_error_identifier import ApiErrorIdentifier
 from crypticorn.hive.client.models.api_error_level import ApiErrorLevel
 from crypticorn.hive.client.models.api_error_type import ApiErrorType
+from crypticorn.hive.client.models.coin_info import CoinInfo
 from crypticorn.hive.client.models.coins import Coins
 from crypticorn.hive.client.models.data_download_response import DataDownloadResponse
 from crypticorn.hive.client.models.data_info import DataInfo

crypticorn/hive/client/models/__init__.py

@@ -17,6 +17,7 @@ Do not edit the class manually.
 from crypticorn.hive.client.models.api_error_identifier import ApiErrorIdentifier
 from crypticorn.hive.client.models.api_error_level import ApiErrorLevel
 from crypticorn.hive.client.models.api_error_type import ApiErrorType
+from crypticorn.hive.client.models.coin_info import CoinInfo
 from crypticorn.hive.client.models.coins import Coins
 from crypticorn.hive.client.models.data_download_response import DataDownloadResponse
 from crypticorn.hive.client.models.data_info import DataInfo

crypticorn/hive/client/models/api_error_identifier.py

@@ -73,12 +73,14 @@ class ApiErrorIdentifier(str, Enum):
     ORDER_VIOLATES_LIQUIDATION_PRICE_CONSTRAINTS = (
         "order_violates_liquidation_price_constraints"
     )
+    MARGIN_MODE_CLASH = "margin_mode_clash"
     MODEL_NAME_NOT_UNIQUE = "model_name_not_unique"
     NO_CREDENTIALS = "no_credentials"
     NOW_API_DOWN = "now_api_down"
     OBJECT_ALREADY_EXISTS = "object_already_exists"
     OBJECT_CREATED = "object_created"
     OBJECT_DELETED = "object_deleted"
+    OBJECT_LOCKED = "object_locked"
     OBJECT_NOT_FOUND = "object_not_found"
     OBJECT_UPDATED = "object_updated"
     ORDER_IS_ALREADY_FILLED = "order_is_already_filled"

crypticorn/hive/client/models/coin_info.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+Hive AI API
+
+API for Hive AI model training and evaluation
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.hive.client.models.coins import Coins
+from crypticorn.hive.client.models.data_version import DataVersion
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class CoinInfo(BaseModel):
+    """
+    Information about a coin
+    """  # noqa: E501
+
+    identifier: Coins = Field(
+        description="The identifier of the coin. Obfuscated for public use."
+    )
+    version_added: DataVersion = Field(
+        description="The data version the coin got introduced in"
+    )
+    version_removed: Optional[DataVersion] = None
+    __properties: ClassVar[List[str]] = [
+        "identifier",
+        "version_added",
+        "version_removed",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CoinInfo from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if version_removed (nullable) is None
+        # and model_fields_set contains the field
+        if self.version_removed is None and "version_removed" in self.model_fields_set:
+            _dict["version_removed"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CoinInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "identifier": obj.get("identifier"),
+                "version_added": obj.get("version_added"),
+                "version_removed": obj.get("version_removed"),
+            }
+        )
+        return _obj

crypticorn/hive/client/models/data_info.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
-from crypticorn.hive.client.models.coins import Coins
+from crypticorn.hive.client.models.coin_info import CoinInfo
 from crypticorn.hive.client.models.data_options import DataOptions
 from crypticorn.hive.client.models.data_version_info import DataVersionInfo
 from crypticorn.hive.client.models.feature_size import FeatureSize
@@ -36,14 +36,14 @@ class DataInfo(BaseModel):
     data: Dict[str, Dict[str, DataOptions]] = Field(
         description="The complete data information for all versions, coins, feature sizes and targets."
     )
-    coins: List[Coins] = Field(
-        description="The coins available on the latest data version."
+    coins: List[CoinInfo] = Field(
+        description="The coins available for all data versions."
     )
     feature_sizes: List[FeatureSize] = Field(
-        description="The feature sizes available on the latest data version."
+        description="The feature sizes available for all data versions."
     )
     targets: List[TargetInfo] = Field(
-        description="The targets available on the latest data version."
+        description="The targets available for all data versions."
     )
     all_versions: List[DataVersionInfo] = Field(
         description="All ever existing data versions. Some may not be publicly available yet."
@@ -104,6 +104,13 @@ class DataInfo(BaseModel):
                 if self.data[_key_data]:
                     _field_dict[_key_data] = self.data[_key_data].to_dict()
             _dict["data"] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each item in coins (list)
+        _items = []
+        if self.coins:
+            for _item_coins in self.coins:
+                if _item_coins:
+                    _items.append(_item_coins.to_dict())
+            _dict["coins"] = _items
         # override the default output from pydantic by calling `to_dict()` of each item in targets (list)
         _items = []
         if self.targets:
@@ -156,7 +163,11 @@ class DataInfo(BaseModel):
                     if obj.get("data") is not None
                     else None
                 ),
-                "coins": obj.get("coins"),
+                "coins": (
+                    [CoinInfo.from_dict(_item) for _item in obj["coins"]]
+                    if obj.get("coins") is not None
+                    else None
+                ),
                 "feature_sizes": obj.get("feature_sizes"),
                 "targets": (
                     [TargetInfo.from_dict(_item) for _item in obj["targets"]]

crypticorn/hive/client/models/target_info.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.hive.client.models.data_version import DataVersion
 from crypticorn.hive.client.models.target import Target
 from crypticorn.hive.client.models.target_type import TargetType
@@ -31,10 +31,18 @@ class TargetInfo(BaseModel):
     Information about a target
     """  # noqa: E501
 
-    name: Target = Field(description="Target name")
-    type: TargetType = Field(description="Target type")
-    version: DataVersion = Field(description="Data version")
-    __properties: ClassVar[List[str]] = ["name", "type", "version"]
+    name: Target = Field(description="The name of the target.")
+    type: TargetType = Field(description="The type of the target.")
+    version_added: DataVersion = Field(
+        description="The data version the target got introduced in."
+    )
+    version_removed: Optional[DataVersion] = None
+    __properties: ClassVar[List[str]] = [
+        "name",
+        "type",
+        "version_added",
+        "version_removed",
+    ]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -73,6 +81,11 @@ class TargetInfo(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if version_removed (nullable) is None
+        # and model_fields_set contains the field
+        if self.version_removed is None and "version_removed" in self.model_fields_set:
+            _dict["version_removed"] = None
+
         return _dict
 
     @classmethod
@@ -88,7 +101,8 @@ class TargetInfo(BaseModel):
             {
                 "name": obj.get("name"),
                 "type": obj.get("type"),
-                "version": obj.get("version"),
+                "version_added": obj.get("version_added"),
+                "version_removed": obj.get("version_removed"),
             }
         )
         return _obj

crypticorn/pay/client/__init__.py

@@ -35,16 +35,18 @@ from crypticorn.pay.client.exceptions import ApiAttributeError
 from crypticorn.pay.client.exceptions import ApiException
 
 # import models into sdk package
+from crypticorn.pay.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.pay.client.models.api_error_level import ApiErrorLevel
+from crypticorn.pay.client.models.api_error_type import ApiErrorType
 from crypticorn.pay.client.models.exception_detail import ExceptionDetail
 from crypticorn.pay.client.models.log_level import LogLevel
 from crypticorn.pay.client.models.now_create_invoice_req import NowCreateInvoiceReq
 from crypticorn.pay.client.models.now_create_invoice_res import NowCreateInvoiceRes
 from crypticorn.pay.client.models.payment import Payment
 from crypticorn.pay.client.models.payment_status import PaymentStatus
+from crypticorn.pay.client.models.product import Product
 from crypticorn.pay.client.models.product_create import ProductCreate
-from crypticorn.pay.client.models.product_read import ProductRead
-from crypticorn.pay.client.models.product_sub_read import ProductSubRead
 from crypticorn.pay.client.models.product_update import ProductUpdate
 from crypticorn.pay.client.models.provider import Provider
-from crypticorn.pay.client.models.response_getuptime import ResponseGetuptime
 from crypticorn.pay.client.models.scope import Scope
+from crypticorn.pay.client.models.subscription import Subscription

crypticorn/pay/client/api/admin_api.py

@@ -16,11 +16,10 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import Field, StrictInt, StrictStr, field_validator
-from typing import Any, Dict, List, Optional
+from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated
 from crypticorn.pay.client.models.log_level import LogLevel
-from crypticorn.pay.client.models.response_getuptime import ResponseGetuptime
 
 from crypticorn.pay.client.api_client import ApiClient, RequestSerialized
 from crypticorn.pay.client.api_response import ApiResponse
@@ -272,7 +271,7 @@ class AdminApi:
         include: Annotated[
             Optional[List[Optional[StrictStr]]],
             Field(
-                description="List of dependencies to include in the response. If not provided, all installed packages will be returned."
+                description="List of regex patterns to match against package names. If not provided, all installed packages will be returned."
             ),
         ] = None,
         _request_timeout: Union[
@@ -286,12 +285,12 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[object]:
+    ) -> Dict[str, Optional[str]]:
         """List Installed Packages
 
-        Return a list of installed packages and versions.
+        Return a list of installed packages and versions.  The include parameter accepts regex patterns to match against package names. For example: - crypticorn.* will match all packages starting with 'crypticorn' - .*tic.* will match all packages containing 'tic' in their name
 
-        :param include: List of dependencies to include in the response. If not provided, all installed packages will be returned.
+        :param include: List of regex patterns to match against package names. If not provided, all installed packages will be returned.
         :type include: List[Optional[str]]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -324,7 +323,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[object]",
+            "200": "Dict[str, Optional[str]]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -341,7 +340,7 @@ class AdminApi:
         include: Annotated[
             Optional[List[Optional[StrictStr]]],
             Field(
-                description="List of dependencies to include in the response. If not provided, all installed packages will be returned."
+                description="List of regex patterns to match against package names. If not provided, all installed packages will be returned."
             ),
         ] = None,
         _request_timeout: Union[
@@ -355,12 +354,12 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[object]]:
+    ) -> ApiResponse[Dict[str, Optional[str]]]:
         """List Installed Packages
 
-        Return a list of installed packages and versions.
+        Return a list of installed packages and versions.  The include parameter accepts regex patterns to match against package names. For example: - crypticorn.* will match all packages starting with 'crypticorn' - .*tic.* will match all packages containing 'tic' in their name
 
-        :param include: List of dependencies to include in the response. If not provided, all installed packages will be returned.
+        :param include: List of regex patterns to match against package names. If not provided, all installed packages will be returned.
         :type include: List[Optional[str]]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -393,7 +392,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[object]",
+            "200": "Dict[str, Optional[str]]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -410,7 +409,7 @@ class AdminApi:
         include: Annotated[
             Optional[List[Optional[StrictStr]]],
             Field(
-                description="List of dependencies to include in the response. If not provided, all installed packages will be returned."
+                description="List of regex patterns to match against package names. If not provided, all installed packages will be returned."
             ),
         ] = None,
         _request_timeout: Union[
@@ -427,9 +426,9 @@ class AdminApi:
     ) -> RESTResponseType:
         """List Installed Packages
 
-        Return a list of installed packages and versions.
+        Return a list of installed packages and versions.  The include parameter accepts regex patterns to match against package names. For example: - crypticorn.* will match all packages starting with 'crypticorn' - .*tic.* will match all packages containing 'tic' in their name
 
-        :param include: List of dependencies to include in the response. If not provided, all installed packages will be returned.
+        :param include: List of regex patterns to match against package names. If not provided, all installed packages will be returned.
         :type include: List[Optional[str]]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -462,7 +461,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[object]",
+            "200": "Dict[str, Optional[str]]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -542,9 +541,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> LogLevel:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -567,6 +566,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -602,9 +602,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[LogLevel]:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -627,6 +627,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -662,9 +663,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -687,6 +688,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -768,7 +770,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> int:
+    ) -> float:
         """Get Memory Usage
 
         Resident Set Size (RSS) in MB — the actual memory used by the process in RAM. Represents the physical memory footprint. Important for monitoring real usage.
@@ -803,7 +805,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -828,7 +830,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[int]:
+    ) -> ApiResponse[float]:
         """Get Memory Usage
 
         Resident Set Size (RSS) in MB — the actual memory used by the process in RAM. Represents the physical memory footprint. Important for monitoring real usage.
@@ -863,7 +865,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -923,7 +925,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1223,7 +1225,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ResponseGetuptime:
+    ) -> str:
         """Get Uptime
 
         Return the server uptime in seconds or human-readable form.
@@ -1261,7 +1263,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "ResponseGetuptime",
+            "200": "str",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1287,7 +1289,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[ResponseGetuptime]:
+    ) -> ApiResponse[str]:
         """Get Uptime
 
         Return the server uptime in seconds or human-readable form.
@@ -1325,7 +1327,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "ResponseGetuptime",
+            "200": "str",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1389,7 +1391,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "ResponseGetuptime",
+            "200": "str",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout