crypticorn 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

crypticorn/cli/init.py

@@ -92,6 +92,9 @@ def init_auth(output, force):
     and the docker-compose.yml file with:
         environment:
             - IS_DOCKER=1
+    and the .github/workflows/main.yaml file with:
+        env:
+            API_ENV: ${{ github.ref == 'refs/heads/main' && 'prod' || 'dev' }}
     """,
         fg="yellow",
     )

crypticorn/common/__init__.py

@@ -7,3 +7,4 @@ from crypticorn.common.auth import *
 from crypticorn.common.enums import *
 from crypticorn.common.utils import *
 from crypticorn.common.exceptions import *
+from crypticorn.common.status_router import router as status_router

crypticorn/common/enums.py

@@ -1,5 +1,7 @@
 from enum import StrEnum
 from crypticorn.common.mixins import ValidateEnumMixin, ExcludeEnumMixin
+
+
 class Exchange(ValidateEnumMixin, ExcludeEnumMixin, StrEnum):
     """Supported exchanges for trading"""
 
@@ -24,4 +26,4 @@ class MarketType(ValidateEnumMixin, ExcludeEnumMixin, StrEnum):
     """
 
     SPOT = "spot"
-    FUTURES = "futures"
+    FUTURES = "futures"

crypticorn/common/errors.py

@@ -1,22 +1,7 @@
 from enum import Enum, EnumMeta, StrEnum
 import logging
 from fastapi import status
-from crypticorn.common.mixins import ExcludeEnumMixin
-
-logger = logging.getLogger(__name__)
-
-
-class Fallback(EnumMeta):
-    """Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI."""
-
-    def __getattr__(cls, name):
-        # Let Pydantic/internal stuff pass silently ! fragile
-        if name.startswith("__"):
-            raise AttributeError(name)
-        logger.warning(
-            f"Unknown error code '{name}' - update crypticorn package or check for typos"
-        )
-        return cls.UNKNOWN_ERROR
+from crypticorn.common.mixins import ExcludeEnumMixin, ApiErrorFallback
 
 
 class ApiErrorType(ExcludeEnumMixin, StrEnum):
@@ -42,6 +27,7 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
     BOT_ALREADY_DELETED = "bot_already_deleted"
     BOT_DISABLED = "bot_disabled"
     BOT_STOPPING_COMPLETED = "bot_stopping_completed"
+    BOT_STOPPING_STARTED = "bot_stopping_started"
     CLIENT_ORDER_ID_REPEATED = "client_order_id_already_exists"
     CONTENT_TYPE_ERROR = "invalid_content_type"
     DELETE_BOT_ERROR = "delete_bot_error"
@@ -77,8 +63,11 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
     LIQUIDATION_PRICE_VIOLATION = "order_violates_liquidation_price_constraints"
     NO_CREDENTIALS = "no_credentials"
     NOW_API_DOWN = "now_api_down"
-    OBJECT_NOT_FOUND = "object_not_found"
     OBJECT_ALREADY_EXISTS = "object_already_exists"
+    OBJECT_CREATED = "object_created"
+    OBJECT_DELETED = "object_deleted"
+    OBJECT_NOT_FOUND = "object_not_found"
+    OBJECT_UPDATED = "object_updated"
     ORDER_ALREADY_FILLED = "order_is_already_filled"
     ORDER_IN_PROCESS = "order_is_being_processed"
     ORDER_LIMIT_EXCEEDED = "order_quantity_limit_exceeded"
@@ -94,6 +83,7 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
     RISK_LIMIT_EXCEEDED = "risk_limit_exceeded"
     RPC_TIMEOUT = "rpc_timeout"
     SETTLEMENT_IN_PROGRESS = "system_settlement_in_process"
+    STRATEGY_ALREADY_EXISTS = "strategy_already_exists"
     STRATEGY_DISABLED = "strategy_disabled"
     STRATEGY_LEVERAGE_MISMATCH = "strategy_leverage_mismatch"
     STRATEGY_NOT_SUPPORTING_EXCHANGE = "strategy_not_supporting_exchange"
@@ -121,7 +111,7 @@ class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
     WARNING = "warning"
 
 
-class ApiError(ExcludeEnumMixin, Enum, metaclass=Fallback):
+class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
     """API error codes. Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI."""
 
     ALLOCATION_BELOW_EXPOSURE = (
@@ -159,6 +149,11 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=Fallback):
         ApiErrorType.NO_ERROR,
         ApiErrorLevel.INFO,
     )
+    BOT_STOPPING_STARTED = (
+        ApiErrorIdentifier.BOT_STOPPING_STARTED,
+        ApiErrorType.NO_ERROR,
+        ApiErrorLevel.INFO,
+    )
     CLIENT_ORDER_ID_REPEATED = (
         ApiErrorIdentifier.CLIENT_ORDER_ID_REPEATED,
         ApiErrorType.SERVER_ERROR,
@@ -334,15 +329,30 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=Fallback):
         ApiErrorType.SERVER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    OBJECT_ALREADY_EXISTS = (
+        ApiErrorIdentifier.OBJECT_ALREADY_EXISTS,
+        ApiErrorType.SERVER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
+    OBJECT_CREATED = (
+        ApiErrorIdentifier.OBJECT_CREATED,
+        ApiErrorType.SERVER_ERROR,
+        ApiErrorLevel.INFO,
+    )
+    OBJECT_DELETED = (
+        ApiErrorIdentifier.OBJECT_DELETED,
+        ApiErrorType.SERVER_ERROR,
+        ApiErrorLevel.INFO,
+    )
     OBJECT_NOT_FOUND = (
         ApiErrorIdentifier.OBJECT_NOT_FOUND,
         ApiErrorType.SERVER_ERROR,
         ApiErrorLevel.ERROR,
     )
-    OBJECT_ALREADY_EXISTS = (
-        ApiErrorIdentifier.OBJECT_ALREADY_EXISTS,
+    OBJECT_UPDATED = (
+        ApiErrorIdentifier.OBJECT_UPDATED,
         ApiErrorType.SERVER_ERROR,
-        ApiErrorLevel.ERROR,
+        ApiErrorLevel.INFO,
     )
     ORDER_ALREADY_FILLED = (
         ApiErrorIdentifier.ORDER_ALREADY_FILLED,
@@ -419,6 +429,11 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=Fallback):
         ApiErrorType.EXCHANGE_ERROR,
         ApiErrorLevel.ERROR,
     )
+    STRATEGY_ALREADY_EXISTS = (
+        ApiErrorIdentifier.STRATEGY_ALREADY_EXISTS,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     STRATEGY_DISABLED = (
         ApiErrorIdentifier.STRATEGY_DISABLED,
         ApiErrorType.USER_ERROR,
@@ -494,6 +509,7 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=Fallback):
 
 class HttpStatusMapper:
     """Map API errors to HTTP status codes."""
+
     _mapping = {
         # Authentication/Authorization
         ApiError.EXPIRED_BEARER: status.HTTP_401_UNAUTHORIZED,
@@ -517,6 +533,7 @@ class HttpStatusMapper:
         ApiError.OBJECT_ALREADY_EXISTS: status.HTTP_409_CONFLICT,
         ApiError.EXCHANGE_KEY_ALREADY_EXISTS: status.HTTP_409_CONFLICT,
         ApiError.BOT_ALREADY_DELETED: status.HTTP_409_CONFLICT,
+        ApiError.STRATEGY_ALREADY_EXISTS: status.HTTP_409_CONFLICT,
         # Invalid Content
         ApiError.CONTENT_TYPE_ERROR: status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
         ApiError.INVALID_DATA_REQUEST: status.HTTP_422_UNPROCESSABLE_ENTITY,
@@ -574,6 +591,10 @@ class HttpStatusMapper:
         # Success cases
         ApiError.SUCCESS: status.HTTP_200_OK,
         ApiError.BOT_STOPPING_COMPLETED: status.HTTP_200_OK,
+        ApiError.BOT_STOPPING_STARTED: status.HTTP_200_OK,
+        ApiError.OBJECT_CREATED: status.HTTP_201_CREATED,
+        ApiError.OBJECT_UPDATED: status.HTTP_200_OK,
+        ApiError.OBJECT_DELETED: status.HTTP_204_NO_CONTENT,
     }
 
     @classmethod

crypticorn/common/mixins.py

@@ -1,3 +1,9 @@
+from enum import EnumMeta
+import logging
+
+logger = logging.getLogger("uvicorn")
+
+
 class ValidateEnumMixin:
     """
     Mixin for validating enum values manually.
@@ -26,6 +32,7 @@ class ValidateEnumMixin:
         except ValueError:
             return False
 
+
 class ExcludeEnumMixin:
     """Mixin to exclude enum from OpenAPI schema. We use this to avoid duplicating enums when generating client code from the openapi spec."""
 
@@ -34,3 +41,16 @@ class ExcludeEnumMixin:
         schema = handler(core_schema)
         schema.pop("enum", None)
         return schema
+
+
+class ApiErrorFallback(EnumMeta):
+    """Fallback for enum members that are not yet published to PyPI."""
+
+    def __getattr__(cls, name):
+        # Let Pydantic/internal stuff pass silently ! fragile
+        if name.startswith("__"):
+            raise AttributeError(name)
+        logger.warning(
+            f"Unknown enum member '{name}' - update crypticorn package or check for typos"
+        )
+        return cls.UNKNOWN_ERROR

crypticorn/common/scopes.py

@@ -1,25 +1,6 @@
-from enum import StrEnum, EnumMeta
+from enum import StrEnum
 import logging
 
-logger = logging.getLogger("uvicorn")
-
-
-class Fallback(EnumMeta):
-    """Fallback to no scope for unknown scopes."""
-
-    # Note: This is a workaround to avoid the AttributeError when an unknown scope is accessed.
-    # As soon as we have stable scopes, we can remove this.
-
-    def __getattr__(cls, name):
-        # Let Pydantic/internal stuff pass silently ! fragile
-        if name.startswith("__"):
-            raise AttributeError(name)
-        logger.warning(
-            f"Unknown scope '{name}' - falling back to no scope - update crypticorn package or check for typos"
-        )
-        return None
-
-
 class Scope(StrEnum):
     """
     The permission scopes for the API.
@@ -68,3 +49,6 @@ class Scope(StrEnum):
     READ_METRICS_EXCHANGES = "read:metrics:exchanges"
     READ_METRICS_TOKENS = "read:metrics:tokens"
     READ_METRICS_MARKETS = "read:metrics:markets"
+
+    # Sentiment scopes
+    READ_SENTIMENT = "read:sentiment"

crypticorn/common/status_router.py

@@ -0,0 +1,44 @@
+from datetime import datetime
+from typing import Literal
+from fastapi import APIRouter
+
+router = APIRouter(tags=["Status"], prefix="")
+
+
+@router.get("/", operation_id="ping")
+async def ping() -> str:
+    """
+    Returns 'OK' if the API is running.
+    """
+    return "OK"
+
+
+@router.get("/time", operation_id="getTime")
+async def time(type: Literal["iso", "unix"] = "iso") -> str:
+    """
+    Returns the current time in the specified format.
+    """
+    if type == "iso":
+        return datetime.now().isoformat()
+    else:
+        return str(int(datetime.now().timestamp()))
+
+
+@router.get("/config", operation_id="getConfig")
+async def config() -> dict:
+    """
+    Returns the version of the crypticorn library and the environment.
+    """
+    import importlib.metadata
+    import os
+    from dotenv import load_dotenv
+
+    load_dotenv()
+    try:
+        crypticorn_version = importlib.metadata.version("crypticorn")
+    except importlib.metadata.PackageNotFoundError:
+        crypticorn_version = "not installed"
+    return {
+        "crypticorn": f"v{crypticorn_version}",
+        "environment": os.getenv("API_ENV", "not set"),
+    }

crypticorn/common/utils.py

@@ -2,29 +2,28 @@ from typing import Any, Union
 from decimal import Decimal
 import string
 import random
-from fastapi import HTTPException
 from fastapi import status
 from typing_extensions import deprecated
 
-from crypticorn.common import ApiError
+from crypticorn.common import ApiError, HTTPException, ExceptionContent
 
 
-def throw_if_none(value: Any, message: Union[ApiError, str]) -> None:
-    """Throws an FastAPI HTTPException if the value is None."""
+def throw_if_none(
+    value: Any,
+    exception: ExceptionContent = ExceptionContent(error=ApiError.OBJECT_NOT_FOUND),
+) -> None:
+    """Throws an FastAPI HTTPException if the value is None. https://docs.python.org/3/library/stdtypes.html#truth-value-testing"""
     if value is None:
-        raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND,
-            detail=message.identifier if isinstance(message, ApiError) else message,
-        )
+        raise HTTPException(content=exception)
 
 
-def throw_if_falsy(value: Any, message: Union[ApiError, str]) -> None:
-    """Throws an FastAPI HTTPException if the value is False."""
+def throw_if_falsy(
+    value: Any,
+    exception: ExceptionContent = ExceptionContent(error=ApiError.OBJECT_NOT_FOUND),
+) -> None:
+    """Throws an FastAPI HTTPException if the value is False. https://docs.python.org/3/library/stdtypes.html#truth-value-testing"""
     if not value:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail=message.identifier if isinstance(message, ApiError) else message,
-        )
+        raise HTTPException(content=exception)
 
 
 def gen_random_id(length: int = 20) -> str:

crypticorn/hive/client/__init__.py

@@ -43,15 +43,11 @@ from crypticorn.hive.client.models.data_version import DataVersion
 from crypticorn.hive.client.models.download_links import DownloadLinks
 from crypticorn.hive.client.models.evaluation import Evaluation
 from crypticorn.hive.client.models.evaluation_response import EvaluationResponse
+from crypticorn.hive.client.models.exception_detail import ExceptionDetail
 from crypticorn.hive.client.models.feature_size import FeatureSize
-from crypticorn.hive.client.models.http_validation_error import HTTPValidationError
 from crypticorn.hive.client.models.model import Model
 from crypticorn.hive.client.models.model_create import ModelCreate
 from crypticorn.hive.client.models.model_status import ModelStatus
 from crypticorn.hive.client.models.model_update import ModelUpdate
 from crypticorn.hive.client.models.target import Target
 from crypticorn.hive.client.models.target_type import TargetType
-from crypticorn.hive.client.models.validation_error import ValidationError
-from crypticorn.hive.client.models.validation_error_loc_inner import (
-    ValidationErrorLocInner,
-)

crypticorn/hive/client/api/data_api.py

@@ -16,7 +16,7 @@ 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
+from pydantic import Field, StrictInt
 from typing import Optional
 from typing_extensions import Annotated
 from crypticorn.hive.client.models.data_download_response import DataDownloadResponse
@@ -52,7 +52,6 @@ class DataApi:
         feature_size: Annotated[
             Optional[FeatureSize], Field(description="Feature size")
         ] = None,
-        access_token: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -75,8 +74,6 @@ class DataApi:
         :type version: DataVersion
         :param feature_size: Feature size
         :type feature_size: FeatureSize
-        :param access_token:
-        :type access_token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -103,7 +100,6 @@ class DataApi:
             model_id=model_id,
             version=version,
             feature_size=feature_size,
-            access_token=access_token,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -112,7 +108,6 @@ class DataApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             "200": "DataDownloadResponse",
-            "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -134,7 +129,6 @@ class DataApi:
         feature_size: Annotated[
             Optional[FeatureSize], Field(description="Feature size")
         ] = None,
-        access_token: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -157,8 +151,6 @@ class DataApi:
         :type version: DataVersion
         :param feature_size: Feature size
         :type feature_size: FeatureSize
-        :param access_token:
-        :type access_token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -185,7 +177,6 @@ class DataApi:
             model_id=model_id,
             version=version,
             feature_size=feature_size,
-            access_token=access_token,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -194,7 +185,6 @@ class DataApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             "200": "DataDownloadResponse",
-            "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -216,7 +206,6 @@ class DataApi:
         feature_size: Annotated[
             Optional[FeatureSize], Field(description="Feature size")
         ] = None,
-        access_token: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -239,8 +228,6 @@ class DataApi:
         :type version: DataVersion
         :param feature_size: Feature size
         :type feature_size: FeatureSize
-        :param access_token:
-        :type access_token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -267,7 +254,6 @@ class DataApi:
             model_id=model_id,
             version=version,
             feature_size=feature_size,
-            access_token=access_token,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -276,7 +262,6 @@ class DataApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             "200": "DataDownloadResponse",
-            "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -288,7 +273,6 @@ class DataApi:
         model_id,
         version,
         feature_size,
-        access_token,
         _request_auth,
         _content_type,
         _headers,
@@ -353,7 +337,6 @@ class DataApi:
     @validate_call
     async def get_data_info(
         self,
-        access_token: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -370,8 +353,6 @@ class DataApi:
 
         Get information about available data and options for the latest data version
 
-        :param access_token:
-        :type access_token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -395,7 +376,6 @@ class DataApi:
         """  # noqa: E501
 
         _param = self._get_data_info_serialize(
-            access_token=access_token,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -404,7 +384,6 @@ class DataApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             "200": "DataInfo",
-            "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -418,7 +397,6 @@ class DataApi:
     @validate_call
     async def get_data_info_with_http_info(
         self,
-        access_token: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -435,8 +413,6 @@ class DataApi:
 
         Get information about available data and options for the latest data version
 
-        :param access_token:
-        :type access_token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -460,7 +436,6 @@ class DataApi:
         """  # noqa: E501
 
         _param = self._get_data_info_serialize(
-            access_token=access_token,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -469,7 +444,6 @@ class DataApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             "200": "DataInfo",
-            "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -483,7 +457,6 @@ class DataApi:
     @validate_call
     async def get_data_info_without_preload_content(
         self,
-        access_token: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -500,8 +473,6 @@ class DataApi:
 
         Get information about available data and options for the latest data version
 
-        :param access_token:
-        :type access_token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -525,7 +496,6 @@ class DataApi:
         """  # noqa: E501
 
         _param = self._get_data_info_serialize(
-            access_token=access_token,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -534,7 +504,6 @@ class DataApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             "200": "DataInfo",
-            "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -543,7 +512,6 @@ class DataApi:
 
     def _get_data_info_serialize(
         self,
-        access_token,
         _request_auth,
         _content_type,
         _headers,