crypticorn 2.17.0rc4__py3-none-any.whl → 2.17.0rc6__py3-none-any.whl

crypticorn/auth/client/models/get_api_keys200_response_inner.py

@@ -20,7 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/list_wallets200_response_balances_inner_sale_round.py

@@ -20,7 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/list_wallets200_response_balances_inner_wallet.py

@@ -22,7 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional, Union
 from crypticorn.auth.client.models.list_wallets200_response_balances_inner_wallet_vesting_wallets_inner import (
     ListWallets200ResponseBalancesInnerWalletVestingWalletsInner,
 )
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/list_wallets200_response_balances_inner_wallet_vesting_wallets_inner.py

@@ -27,7 +27,7 @@ from pydantic import (
     StrictStr,
 )
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/list_wallets200_response_data_inner.py

@@ -20,7 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/logout_default_response.py

@@ -22,7 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.auth.client.models.logout_default_response_issues_inner import (
     LogoutDefaultResponseIssuesInner,
 )
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/oauth_callback200_response_user.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/refresh_token_info200_response_user_session.py

@@ -20,7 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/rotate_tokens200_response.py

@@ -22,7 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional, Union
 from crypticorn.auth.client.models.verify_email200_response_auth_auth import (
     VerifyEmail200ResponseAuthAuth,
 )
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/token_info200_response.py

@@ -22,7 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.auth.client.models.verify_email200_response_auth_auth import (
     VerifyEmail200ResponseAuthAuth,
 )
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/update_user_request.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/user_by_username200_response.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/verify200_response.py

@@ -27,7 +27,7 @@ from pydantic import (
     StrictStr,
 )
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/verify_email200_response_auth.py

@@ -22,7 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.auth.client.models.verify_email200_response_auth_auth import (
     VerifyEmail200ResponseAuthAuth,
 )
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/verify_email200_response_auth_auth.py

@@ -27,7 +27,7 @@ from pydantic import (
     StrictStr,
 )
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/auth/client/models/whoami200_response.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
+from typing import Set
 from typing_extensions import Self
 
 

crypticorn/cli/init.py

@@ -33,7 +33,7 @@ def copy_template(template_name: str, target_path: Path):
 
 def check_file_exists(path: Path, force: bool):
     if path.exists() and not force:
-        click.secho(f"File already exists, use --force / -f to overwrite", fg="red")
+        click.secho("File already exists, use --force / -f to overwrite", fg="red")
         return False
     return True
 

crypticorn/cli/templates/.env.docker.temp

@@ -0,0 +1,3 @@
+# Specifies which API environment to use in docker builds: "0" if the API_ENV should be used, "1" for the internal host.
+# Any database connections would have to be overridden as well.
+IS_DOCKER=1

crypticorn/cli/templates/.env.example.temp

@@ -0,0 +1,4 @@
+# Specifies which API environment to use: "local", "dev", "prod", or "docker".
+# When running inside Docker, this defaults to "docker" (internal network host),
+# unless IS_DOCKER is set to 0 in .env.docker.
+API_ENV=local

crypticorn/cli/templates/Dockerfile

@@ -19,14 +19,17 @@ WORKDIR /code
 # and to the workflow:
 # env:
 #     API_ENV: ${{ github.ref == 'refs/heads/main' && 'prod' || 'dev' }}
-ARG API_ENV
+# and in the docker build:
+#     build-args: |
+#       CACHEBUST=${{ github.run_id }} # invalidates dependency cache on every workflow run
 
-RUN pip install --no-cache-dir -r requirements.txt
+ARG API_ENV
 
 RUN if [ "$API_ENV" != "prod" ]; then \
     pip install --pre crypticorn; \
     fi
 
+RUN pip install --no-cache-dir -r requirements.txt
 
 COPY ./src /code/src
 

crypticorn/client.py

@@ -1,5 +1,4 @@
 from typing import TypeVar, Optional
-import asyncio
 import warnings
 from aiohttp import ClientSession, ClientTimeout, TCPConnector
 from crypticorn.hive import HiveClient

crypticorn/common/auth.py

@@ -7,7 +7,6 @@ from crypticorn.common.exceptions import (
     ApiError,
     HTTPException,
     ExceptionContent,
-    WebSocketException,
 )
 from crypticorn.common.urls import BaseUrl, Service, ApiVersion
 from fastapi import Depends, Query
@@ -16,9 +15,11 @@ from fastapi.security import (
     SecurityScopes,
     HTTPBearer,
     APIKeyHeader,
+    HTTPBasic,
 )
 from typing_extensions import Annotated
 from typing import Union
+from fastapi.security import HTTPBasicCredentials
 
 # Auth Schemes
 http_bearer = HTTPBearer(
@@ -33,6 +34,12 @@ apikey_header = APIKeyHeader(
     description="The API key to use for authentication.",
 )
 
+basic_auth = HTTPBasic(
+    scheme_name="Basic",
+    auto_error=False,
+    description="The username and password to use for authentication. Only used in /admin/metrics",
+)
+
 
 # Auth Handler
 class AuthHandler:
@@ -151,6 +158,7 @@ class AuthHandler:
                         error=ApiError.NO_API_KEY,
                         message="No credentials provided. API key is required",
                     ),
+                    headers={"WWW-Authenticate": "X-API-Key"},
                 )
             raise e
 
@@ -176,6 +184,7 @@ class AuthHandler:
                         error=ApiError.NO_BEARER,
                         message="No credentials provided. Bearer token is required",
                     ),
+                    headers={"WWW-Authenticate": "Bearer"},
                 )
             raise e
 
@@ -223,6 +232,7 @@ class AuthHandler:
                     error=ApiError.NO_CREDENTIALS,
                     message="No credentials provided. Either API key or bearer token is required.",
                 ),
+                headers={"WWW-Authenticate": "Bearer, X-API-Key"},
             )
 
     async def ws_api_key_auth(
@@ -266,6 +276,23 @@ class AuthHandler:
             if bearer
             else None
         )
-        return await self.combined_auth(
-            bearer=credentials, api_key=api_key, sec=sec
-        )
+        return await self.combined_auth(bearer=credentials, api_key=api_key, sec=sec)
+    
+    async def basic_auth(
+        self,
+        credentials: Annotated[HTTPBasicCredentials, Depends(basic_auth)],
+    ):
+        """
+        Verifies the basic authentication credentials. This authentication method should just be used for special cases like /admin/metrics, where JWT and API key authentication are not desired or not possible.
+        """
+        try:
+            await self.client.login.verify_basic_auth(credentials.username, credentials.password)
+        except ApiException as e:
+            raise HTTPException(
+                content=ExceptionContent(
+                    error=ApiError.INVALID_BASIC_AUTH,
+                    message="Invalid basic authentication credentials",
+                ),
+                headers={"WWW-Authenticate": "Basic"},
+            )
+        return credentials.username

crypticorn/common/decorators.py

@@ -1,8 +1,7 @@
-from datetime import datetime
 from typing import Optional, Type, Any, Tuple
 from copy import deepcopy
 
-from pydantic import BaseModel, create_model, field_validator, BeforeValidator
+from pydantic import BaseModel, create_model
 from pydantic.fields import FieldInfo
 
 

crypticorn/common/enums.py

@@ -5,9 +5,7 @@ try:
 except ImportError:
     from strenum import StrEnum
 
-from enum import Enum
 import warnings
-import typing_extensions
 from crypticorn.common.mixins import ValidateEnumMixin
 from crypticorn.common.warnings import CrypticornDeprecatedSince215
 

crypticorn/common/errors.py

@@ -70,6 +70,7 @@ class ApiErrorIdentifier(StrEnum):
     INSUFFICIENT_MARGIN = "insufficient_margin"
     INSUFFICIENT_SCOPES = "insufficient_scopes"
     INVALID_API_KEY = "invalid_api_key"
+    INVALID_BASIC_AUTH = "invalid_basic_auth"
     INVALID_BEARER = "invalid_bearer"
     INVALID_DATA_REQUEST = "invalid_data"
     INVALID_DATA_RESPONSE = "invalid_data_response"
@@ -302,6 +303,11 @@ class ApiError(Enum, metaclass=ApiErrorFallback):
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    INVALID_BASIC_AUTH = (
+        ApiErrorIdentifier.INVALID_BASIC_AUTH,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     INVALID_BEARER = (
         ApiErrorIdentifier.INVALID_BEARER,
         ApiErrorType.USER_ERROR,
@@ -569,6 +575,10 @@ class StatusCodeMapper:
             status.HTTP_401_UNAUTHORIZED,
             status.WS_1008_POLICY_VIOLATION,
         ),
+        ApiError.INVALID_BASIC_AUTH: (
+            status.HTTP_401_UNAUTHORIZED,
+            status.WS_1008_POLICY_VIOLATION,
+        ),
         ApiError.INVALID_BEARER: (
             status.HTTP_401_UNAUTHORIZED,
             status.WS_1008_POLICY_VIOLATION,

crypticorn/common/metrics.py

@@ -1,5 +1,5 @@
 # metrics/registry.py
-from prometheus_client import Counter, Gauge, Histogram, Summary, CollectorRegistry
+from prometheus_client import Counter, Histogram, CollectorRegistry
 
 registry = CollectorRegistry()
 

crypticorn/common/middleware.py

@@ -2,7 +2,6 @@ import time
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from starlette.middleware.base import BaseHTTPMiddleware
-from starlette.requests import Request
 from crypticorn.common.logging import configure_logging
 from contextlib import asynccontextmanager
 from typing_extensions import deprecated

crypticorn/common/pagination.py

@@ -9,7 +9,20 @@ T = TypeVar("T")
 
 class PaginatedResponse(BaseModel, Generic[T]):
     """Pydantic model for paginated response
-    >>> PaginatedResponse[ItemModel](data=items, total=total_items, page=1, size=10, prev=None, next=2)
+    >>> @router.get("", operation_id="getOrders")
+    >>> async def get_orders(
+    >>>     params: Annotated[PaginationParams, Query()],
+    >>> ) -> PaginatedResponse[Order]:
+    >>>     ...
+    >>> return PaginatedResponse[Order](
+            data=orders,
+            total=count,
+            page=params.page,
+            page_size=params.page_size,
+            prev=PaginatedResponse.get_prev_page(params.page),
+            next=PaginatedResponse.get_next_page(count, params.page_size, params.page),
+            last=PaginatedResponse.get_last_page(count, params.page_size),
+        )
     """
 
     data: list[T]
@@ -26,14 +39,14 @@ class PaginatedResponse(BaseModel, Generic[T]):
         if page < math.ceil(total / page_size):
             return page + 1
         return None
-    
+
     @staticmethod
     def get_prev_page(page: int) -> Optional[int]:
         """Get the previous page number"""
         if page > 1:
             return page - 1
         return None
-    
+
     @staticmethod
     def get_last_page(total: int, page_size: int) -> int:
         """Get the last page number"""
@@ -42,16 +55,16 @@ class PaginatedResponse(BaseModel, Generic[T]):
 
 class PaginationParams(BaseModel, Generic[T]):
     """Standard pagination parameters for usage in API endpoints. Check the [fastapi docs](https://fastapi.tiangolo.com/tutorial/query-param-models/?h=qu#query-parameters-with-a-pydantic-model) for usage examples.
-    Can only be used isolated, not in combination with other parameters. If you need to combine with other parameters, use `FilterComboParams` or refer to this [workaround](https://github.com/fastapi/fastapi/discussions/13448#discussioncomment-12440374).
+    You should inherit from this class when adding additional parameters. You should use this class in combination with `PaginatedResponse` to return the paginated response.
     Usage:
     >>> @router.get("", operation_id="getOrders")
     >>> async def get_orders(
-    >>>     paginate: Annotated[PaginationParams[Order], Query()],
+    >>>     params: Annotated[PaginationParams[Order], Query()],
     >>> ) -> PaginatedResponse[Order]:
     >>>     ...
 
     The default size is 10 items per page and there is a `HeavyPaginationParams` class with 100 items per page. You can override this default:
-    >>> class LightPaginationParams(PaginationParams[T]):
+    >>> class LightPaginationParams(PaginationParams):
     >>>     page_size: int = Field(default=5, description="The number of items per page")
     """
 
@@ -71,11 +84,11 @@ class HeavyPaginationParams(PaginationParams[T]):
 
 class SortParams(BaseModel, Generic[T]):
     """Standard sort parameters for usage in API endpoints. Check the [fastapi docs](https://fastapi.tiangolo.com/tutorial/query-param-models/?h=qu#query-parameters-with-a-pydantic-model) for usage examples.
-    Can only be used isolated, not in combination with other parameters. If you need to combine with other parameters, use `FilterComboParams` or refer to this [workaround](https://github.com/fastapi/fastapi/discussions/13448#discussioncomment-12440374).
+    You should inherit from this class when adding additional parameters.
     Usage:
     >>> @router.get("", operation_id="getOrders")
     >>> async def get_orders(
-    >>>     sort: Annotated[SortParams[Order], Query()],
+    >>>     params: Annotated[SortParams[Order], Query()],
     >>> ) -> PaginatedResponse[Order]:
     >>>     ...
     """
@@ -91,7 +104,7 @@ class SortParams(BaseModel, Generic[T]):
         args: tuple = self.__pydantic_generic_metadata__.get("args")
         if not args or not issubclass(args[0], BaseModel):
             raise TypeError(
-                "PaginationParams must be used with a Pydantic BaseModel as a generic parameter"
+                "SortParams must be used with a Pydantic BaseModel as a generic parameter"
             )
         if self.sort_by:
             # check if the sort field is valid
@@ -104,24 +117,31 @@ class SortParams(BaseModel, Generic[T]):
             raise ValueError(
                 f"Invalid order: '{self.sort_order}' — must be one of: ['asc', 'desc']"
             )
-        if self.sort_order and self.sort_by is None or self.sort_by and self.sort_order is None:
+        if (
+            self.sort_order
+            and self.sort_by is None
+            or self.sort_by
+            and self.sort_order is None
+        ):
             raise ValueError("sort_order and sort_by must be provided together")
         return self
 
 
 class FilterParams(BaseModel, Generic[T]):
     """Standard filter parameters for usage in API endpoints. Check the [fastapi docs](https://fastapi.tiangolo.com/tutorial/query-param-models/?h=qu#query-parameters-with-a-pydantic-model) for usage examples.
-    Can only be used isolated, not in combination with other parameters. If you need to combine with other parameters, use `FilterComboParams` or refer to this [workaround](https://github.com/fastapi/fastapi/discussions/13448#discussioncomment-12440374).
+    You should inherit from this class when adding additional parameters.
     Usage:
     >>> @router.get("", operation_id="getOrders")
     >>> async def get_orders(
-    >>>     filter: Annotated[FilterParams[Order], Query()],
+    >>>     params: Annotated[FilterParams[Order], Query()],
     >>> ) -> PaginatedResponse[Order]:
     >>>     ...
     """
 
     filter_by: Optional[str] = Field(None, description="The field to filter by")
-    filter_value: Optional[Any] = Field(None, description="The value to filter with")
+    filter_value: Optional[str] = Field(None, description="The value to filter with")
+    # currently openapi-gen does not support typing.Any in combo with None, so we use str
+    # this is fine since the input is a string anyways from the request and the correct type is enforced by the model validator from the filter_by field
 
     @model_validator(mode="after")
     def validate_filter(self):
@@ -140,34 +160,104 @@ class FilterParams(BaseModel, Generic[T]):
                 raise ValueError(
                     f"Invalid field: '{self.filter_by}'. Must be one of: {list(model.model_fields)}"
                 )
-            self.filter_value = _enforce_field_type(model, self.filter_by, self.filter_value)
+            self.filter_value = _enforce_field_type(
+                model, self.filter_by, self.filter_value
+            )
+        return self
+
+
+class SortFilterParams(SortParams[T], FilterParams[T]):
+    """Combines sort and filter parameters. Just a convenience class for when you need to combine sort and filter parameters.
+    You should inherit from this class when adding additional parameters.
+    Usage:
+    >>> @router.get("", operation_id="getOrders")
+    >>> async def get_orders(
+    >>>     params: Annotated[SortFilterParams[Order], Query()],
+    >>> ) -> PaginatedResponse[Order]:
+    >>>     ...
+    """
+
+    @model_validator(mode="after")
+    def validate_sort_filter(self):
+        self.validate_sort()
+        self.validate_filter()
+        return self
+
+
+class PageFilterParams(PaginationParams[T], FilterParams[T]):
+    """Combines pagination and filter parameters. Just a convenience class for when you need to combine pagination and filter parameters.
+    You should inherit from this class when adding additional parameters.
+    Usage:
+    >>> @router.get("", operation_id="getOrders")
+    >>> async def get_orders(
+    >>>     params: Annotated[PageFilterParams[Order], Query()],
+    >>> ) -> PaginatedResponse[Order]:
+    >>>     ...
+    """
+
+    @model_validator(mode="after")
+    def validate_page_filter(self):
+        self.validate_filter()
+        return self
+
+
+class PageSortParams(PaginationParams[T], SortParams[T]):
+    """Combines pagination and sort parameters. Just a convenience class for when you need to combine pagination and sort parameters.
+    You should inherit from this class when adding additional parameters.
+    Usage:
+    >>> @router.get("", operation_id="getOrders")
+    >>> async def get_orders(
+    >>>     params: Annotated[PageSortParams[Order], Query()],
+    >>> ) -> PaginatedResponse[Order]:
+    >>>     ...
+    """
+
+    @model_validator(mode="after")
+    def validate_page_sort(self):
+        self.validate_sort()
         return self
 
 
-class FilterComboParams(PaginationParams[T], SortParams[T], FilterParams[T], ):
-    """Combines pagination, filter, and sort parameters.
+class PageSortFilterParams(
+    PaginationParams[T],
+    SortParams[T],
+    FilterParams[T],
+):
+    """Combines pagination, filter, and sort parameters. Just a convenience class for when you need to combine pagination, filter, and sort parameters.
+    You should inherit from this class when adding additional parameters.
     Usage:
     >>> @router.get("", operation_id="getOrders")
     >>> async def get_orders(
-    >>>     filter_combo: Annotated[FilterComboParams[Order], Query()],
+    >>>     params: Annotated[PageSortFilterParams[Order], Query()],
     >>> ) -> PaginatedResponse[Order]:
     >>>     ...
     """
 
-    pass
+    @model_validator(mode="after")
+    def validate_filter_combo(self):
+        self.validate_filter()
+        self.validate_sort()
+        return self
 
 
-class HeavyFilterComboParams(HeavyPaginationParams[T], FilterParams[T], SortParams[T]):
-    """Combines pagination, filter, and sort parameters.
+class HeavyPageSortFilterParams(
+    HeavyPaginationParams[T], FilterParams[T], SortParams[T]
+):
+    """Combines heavy pagination, filter, and sort parameters. Just a convenience class for when you need to combine heavy pagination, filter, and sort parameters.
+    You should inherit from this class when adding additional parameters.
     Usage:
     >>> @router.get("", operation_id="getOrders")
     >>> async def get_orders(
-    >>>     filter_combo: Annotated[HeavyFilterComboParams[Order], Query()],
+    >>>     params: Annotated[HeavyPageSortFilterParams[Order], Query()],
     >>> ) -> PaginatedResponse[Order]:
     >>>     ...
     """
 
-    pass
+    @model_validator(mode="after")
+    def validate_heavy_page_sort_filter(self):
+        self.validate_filter()
+        self.validate_sort()
+        return self
 
 
 def _enforce_field_type(model: Type[BaseModel], field_name: str, value: Any) -> Any:
@@ -189,5 +279,7 @@ def _enforce_field_type(model: Type[BaseModel], field_name: str, value: Any) ->
 
     try:
         return expected_type(value)
-    except Exception as e:
-        raise ValueError(f"Expected {expected_type} for field {field_name}, got {type(value)}")
+    except Exception:
+        raise ValueError(
+            f"Expected {expected_type} for field {field_name}, got {type(value)}"
+        )

crypticorn/common/router/admin_router.py

@@ -13,10 +13,8 @@ import psutil
 import re
 import logging
 from typing import Literal
-from fastapi import APIRouter, Query, Response
-from prometheus_client import generate_latest, CONTENT_TYPE_LATEST
+from fastapi import APIRouter, Query
 from crypticorn.common.logging import LogLevel
-from crypticorn.common.metrics import registry
 
 router = APIRouter(tags=["Admin"], prefix="/admin")
 
@@ -106,11 +104,3 @@ def list_installed_packages(
         or any(re.match(pattern, dist.metadata["Name"]) for pattern in include)
     }
     return dict(sorted(packages.items()))
-
-
-@router.get("/metrics", operation_id="getMetrics")
-def metrics():
-    """
-    Get Prometheus metrics for the application. Returns plain text.
-    """
-    return Response(generate_latest(registry), media_type=CONTENT_TYPE_LATEST)