crypticorn 2.15.0__tar.gz → 2.16.0__tar.gz

{crypticorn-2.15.0 → crypticorn-2.16.0}/CHANGELOG.md

@@ -1,6 +1,24 @@
 # CHANGELOG
 
 
+## v2.16.0 (2025-05-31)
+
+### Features
+
+- Add new scope for DEX AI Signals
+  ([`8b566f1`](https://github.com/crypticorn-ai/api-client/commit/8b566f1203268bfa898e9b03e32468f4611ebccc))
+
+### Refactoring
+
+- Make order field in pagination model optional and improve the data validation
+  ([`d3e3a6f`](https://github.com/crypticorn-ai/api-client/commit/d3e3a6f8e1752f38ab51d1fbc74d976968ef3c1c))
+
+### Testing
+
+- Update pagination tests
+  ([`1692b8d`](https://github.com/crypticorn-ai/api-client/commit/1692b8d02c99c9592c19e612c82ed128de95213d))
+
+
 ## v2.15.0 (2025-05-27)
 
 ### Features

{crypticorn-2.15.0/crypticorn.egg-info → crypticorn-2.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.15.0
+Version: 2.16.0
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/common/pagination.py

@@ -1,6 +1,6 @@
 """Utilities for handling paginated API responses and cursor-based pagination."""
 
-from typing import Generic, Type, TypeVar, List, Optional, Literal
+from typing import Generic, Type, TypeVar, Optional, Literal
 from pydantic import BaseModel, Field, model_validator
 
 T = TypeVar("T")
@@ -11,7 +11,7 @@ class PaginatedResponse(BaseModel, Generic[T]):
     >>> PaginatedResponse[ItemModel](data=items, total=total_items, page=1, size=10, prev=None, next=2)
     """
 
-    data: List[T]
+    data: list[T]
     total: int = Field(description="The total number of items")
     page: int = Field(description="The current page number")
     size: int = Field(description="The number of items per page")
@@ -28,9 +28,7 @@ class PaginationParams(BaseModel, Generic[T]):
 
     page: int = Field(default=1, description="The current page number")
     size: int = Field(default=10, description="The number of items per page")
-    order: Literal["asc", "desc"] = Field(
-        default="asc", description="The order to sort by"
-    )
+    order: Optional[Literal["asc", "desc"]] = Field(None, description="The order to sort by")
     sort: Optional[str] = Field(None, description="The field to sort by")
 
     @model_validator(mode="after")
@@ -48,4 +46,8 @@ class PaginationParams(BaseModel, Generic[T]):
                 raise ValueError(
                     f"Invalid sort field: '{self.sort}' — must be one of: {list(model.model_fields)}"
                 )
+        if self.order and self.order not in ["asc", "desc"]:
+            raise ValueError(f"Invalid order: '{self.order}' — must be one of: ['asc', 'desc']")
+        if self.order and not self.sort or self.sort and not self.order:
+            raise ValueError("Sort and order must be provided together")
         return self

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/common/scopes.py

@@ -16,6 +16,7 @@ class Scope(StrEnum):
 
     # Scopes that can be purchased - these actually exist in the jwt token
     READ_PREDICTIONS = "read:predictions"
+    READ_DEXSIGNALS = "read:dexsignals"
 
     # Hive scopes
     READ_HIVE_MODEL = "read:hive:model"
@@ -87,4 +88,5 @@ class Scope(StrEnum):
             cls.READ_METRICS_MARKETS,
             cls.READ_KLINES,
             cls.READ_SENTIMENT,
+            cls.READ_DEXSIGNALS,
         ]

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/common/warnings.py

@@ -55,6 +55,7 @@ class CrypticornDeprecatedSince28(CrypticornDeprecationWarning):
     def __init__(self, message: str, *args: object) -> None:
         super().__init__(message, *args, since=(2, 8), expected_removal=(3, 0))
 
+
 class CrypticornDeprecatedSince215(CrypticornDeprecationWarning):
     """A specific `CrypticornDeprecationWarning` subclass defining functionality deprecated since Crypticorn 2.15."""
 

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/trade/client/models/api_error_identifier.py

@@ -28,15 +28,17 @@ class ApiErrorIdentifier(str, Enum):
     """
     ALLOCATION_BELOW_CURRENT_EXPOSURE = "allocation_below_current_exposure"
     ALLOCATION_BELOW_MIN_AMOUNT = "allocation_below_min_amount"
+    ALLOCATION_LIMIT_EXCEEDED = "allocation_limit_exceeded"
     BLACK_SWAN = "black_swan"
     BOT_ALREADY_DELETED = "bot_already_deleted"
-    BOT_DISABLED = "bot_disabled"
     BOT_STOPPING_COMPLETED = "bot_stopping_completed"
     BOT_STOPPING_STARTED = "bot_stopping_started"
     CANCELLED_OPEN_ORDER = "cancelled_open_order"
     CLIENT_ORDER_ID_ALREADY_EXISTS = "client_order_id_already_exists"
     INVALID_CONTENT_TYPE = "invalid_content_type"
     DELETE_BOT_ERROR = "delete_bot_error"
+    EXCHANGE_HTTP_REQUEST_ERROR = "exchange_http_request_error"
+    EXCHANGE_INVALID_PARAMETER = "exchange_invalid_parameter"
     EXCHANGE_INVALID_SIGNATURE = "exchange_invalid_signature"
     EXCHANGE_INVALID_TIMESTAMP = "exchange_invalid_timestamp"
     EXCHANGE_IP_ADDRESS_IS_NOT_AUTHORIZED = "exchange_ip_address_is_not_authorized"
@@ -56,10 +58,9 @@ class ApiErrorIdentifier(str, Enum):
     EXCHANGE_USER_ACCOUNT_IS_FROZEN = "exchange_user_account_is_frozen"
     API_KEY_EXPIRED = "api_key_expired"
     BEARER_TOKEN_EXPIRED = "bearer_token_expired"
-    OPEN_ORDER_EXPIRED = "open_order_expired"
+    FAILED_OPEN_ORDER = "failed_open_order"
     FORBIDDEN = "forbidden"
     HEDGE_MODE_NOT_ACTIVE = "hedge_mode_not_active"
-    HTTP_REQUEST_ERROR = "http_request_error"
     INSUFFICIENT_BALANCE = "insufficient_balance"
     INSUFFICIENT_MARGIN = "insufficient_margin"
     INSUFFICIENT_SCOPES = "insufficient_scopes"
@@ -68,15 +69,15 @@ class ApiErrorIdentifier(str, Enum):
     INVALID_DATA = "invalid_data"
     INVALID_DATA_RESPONSE = "invalid_data_response"
     INVALID_EXCHANGE_KEY = "invalid_exchange_key"
-    INVALID_MARGIN_MODE = "invalid_margin_mode"
     INVALID_MODEL_NAME = "invalid_model_name"
-    INVALID_PARAMETER_PROVIDED = "exchange_invalid_parameter"
     LEVERAGE_LIMIT_EXCEEDED = "leverage_limit_exceeded"
     ORDER_VIOLATES_LIQUIDATION_PRICE_CONSTRAINTS = (
         "order_violates_liquidation_price_constraints"
     )
     MARGIN_MODE_CLASH = "margin_mode_clash"
     NAME_NOT_UNIQUE = "name_not_unique"
+    NO_API_KEY = "no_api_key"
+    NO_BEARER = "no_bearer"
     NO_CREDENTIALS = "no_credentials"
     NOW_API_DOWN = "now_api_down"
     OBJECT_ALREADY_EXISTS = "object_already_exists"
@@ -102,14 +103,13 @@ class ApiErrorIdentifier(str, Enum):
     RISK_LIMIT_EXCEEDED = "risk_limit_exceeded"
     RPC_TIMEOUT = "rpc_timeout"
     SYSTEM_SETTLEMENT_IN_PROCESS = "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"
     SUCCESS = "success"
     SYMBOL_DOES_NOT_EXIST = "symbol_does_not_exist"
     TRADING_ACTION_EXPIRED = "trading_action_expired"
-    TRADING_ACTION_SKIPPED_BOT_STOPPING = "TRADING_ACTION_SKIPPED_BOT_STOPPING"
+    TRADING_ACTION_SKIPPED_BOT_STOPPING = "trading_action_skipped_bot_stopping"
     TRADING_HAS_BEEN_LOCKED = "trading_has_been_locked"
     TRADING_IS_SUSPENDED = "trading_is_suspended"
     UNKNOWN_ERROR_OCCURRED = "unknown_error_occurred"

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/trade/client/models/futures_trading_action.py

@@ -33,8 +33,12 @@ class FuturesTradingAction(BaseModel):
     Model for futures trading actions
     """  # noqa: E501
 
-    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]]
-    margin_mode: Optional[MarginMode] = None
+    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(
+        default=1, description="Leverage to use for futures trades. Default is 1."
+    )
+    margin_mode: Optional[MarginMode] = Field(
+        default=None, description="Margin mode for futures trades. Default is isolated."
+    )
     created_at: Optional[StrictInt] = Field(
         default=None, description="Timestamp of creation"
     )
@@ -60,8 +64,6 @@ class FuturesTradingAction(BaseModel):
     take_profit: Optional[List[TPSL]] = None
     stop_loss: Optional[List[TPSL]] = None
     expiry_timestamp: Optional[StrictInt] = None
-    client_order_id: Optional[StrictStr] = None
-    position_id: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = [
         "leverage",
         "margin_mode",
@@ -80,8 +82,6 @@ class FuturesTradingAction(BaseModel):
         "take_profit",
         "stop_loss",
         "expiry_timestamp",
-        "client_order_id",
-        "position_id",
     ]
 
     model_config = ConfigDict(
@@ -135,16 +135,6 @@ class FuturesTradingAction(BaseModel):
                 if _item_stop_loss:
                     _items.append(_item_stop_loss.to_dict())
             _dict["stop_loss"] = _items
-        # set to None if leverage (nullable) is None
-        # and model_fields_set contains the field
-        if self.leverage is None and "leverage" in self.model_fields_set:
-            _dict["leverage"] = None
-
-        # set to None if margin_mode (nullable) is None
-        # and model_fields_set contains the field
-        if self.margin_mode is None and "margin_mode" in self.model_fields_set:
-            _dict["margin_mode"] = None
-
         # set to None if execution_id (nullable) is None
         # and model_fields_set contains the field
         if self.execution_id is None and "execution_id" in self.model_fields_set:
@@ -186,16 +176,6 @@ class FuturesTradingAction(BaseModel):
         ):
             _dict["expiry_timestamp"] = None
 
-        # set to None if client_order_id (nullable) is None
-        # and model_fields_set contains the field
-        if self.client_order_id is None and "client_order_id" in self.model_fields_set:
-            _dict["client_order_id"] = None
-
-        # set to None if position_id (nullable) is None
-        # and model_fields_set contains the field
-        if self.position_id is None and "position_id" in self.model_fields_set:
-            _dict["position_id"] = None
-
         return _dict
 
     @classmethod
@@ -236,8 +216,6 @@ class FuturesTradingAction(BaseModel):
                     else None
                 ),
                 "expiry_timestamp": obj.get("expiry_timestamp"),
-                "client_order_id": obj.get("client_order_id"),
-                "position_id": obj.get("position_id"),
             }
         )
         return _obj

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/trade/client/models/futures_trading_action_create.py

@@ -33,12 +33,19 @@ class FuturesTradingActionCreate(BaseModel):
     Model for sending futures trading actions
     """  # noqa: E501
 
-    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]]
-    margin_mode: Optional[MarginMode] = None
+    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(
+        default=1, description="Leverage to use for futures trades. Default is 1."
+    )
+    margin_mode: Optional[MarginMode] = Field(
+        default=None, description="Margin mode for futures trades. Default is isolated."
+    )
     execution_id: Optional[StrictStr] = None
     open_order_execution_id: Optional[StrictStr] = None
     action_type: TradingActionType = Field(description="The type of action.")
-    market_type: MarketType = Field(description="The type of market the action is for.")
+    market_type: Optional[MarketType] = Field(
+        default=None,
+        description="The type of market the action is for. Must be set to futures.",
+    )
     strategy_id: StrictStr = Field(description="UID for the strategy.")
     symbol: StrictStr = Field(
         description="Trading symbol or asset pair in format: 'symbol/quote_currency' (see market service for valid symbols)"
@@ -119,16 +126,6 @@ class FuturesTradingActionCreate(BaseModel):
                 if _item_stop_loss:
                     _items.append(_item_stop_loss.to_dict())
             _dict["stop_loss"] = _items
-        # set to None if leverage (nullable) is None
-        # and model_fields_set contains the field
-        if self.leverage is None and "leverage" in self.model_fields_set:
-            _dict["leverage"] = None
-
-        # set to None if margin_mode (nullable) is None
-        # and model_fields_set contains the field
-        if self.margin_mode is None and "margin_mode" in self.model_fields_set:
-            _dict["margin_mode"] = None
-
         # set to None if execution_id (nullable) is None
         # and model_fields_set contains the field
         if self.execution_id is None and "execution_id" in self.model_fields_set:

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/trade/client/models/order.py

@@ -65,7 +65,7 @@ class Order(BaseModel):
     sent_qty: Optional[StrictStr] = None
     fee: Optional[StrictStr] = None
     leverage: Optional[StrictInt] = None
-    order_details: Optional[Any] = Field(
+    order_details: Optional[Dict[str, Any]] = Field(
         default=None, description="Exchange specific details of the order"
     )
     pnl: Optional[StrictStr] = None
@@ -138,9 +138,6 @@ class Order(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of order_details
-        if self.order_details:
-            _dict["order_details"] = self.order_details.to_dict()
         # set to None if trading_action_id (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -257,11 +254,6 @@ class Order(BaseModel):
         if self.leverage is None and "leverage" in self.model_fields_set:
             _dict["leverage"] = None
 
-        # set to None if order_details (nullable) is None
-        # and model_fields_set contains the field
-        if self.order_details is None and "order_details" in self.model_fields_set:
-            _dict["order_details"] = None
-
         # set to None if pnl (nullable) is None
         # and model_fields_set contains the field
         if self.pnl is None and "pnl" in self.model_fields_set:
@@ -310,11 +302,7 @@ class Order(BaseModel):
                 "sent_qty": obj.get("sent_qty"),
                 "fee": obj.get("fee"),
                 "leverage": obj.get("leverage"),
-                "order_details": (
-                    AnyOf.from_dict(obj["order_details"])
-                    if obj.get("order_details") is not None
-                    else None
-                ),
+                "order_details": obj.get("order_details"),
                 "pnl": obj.get("pnl"),
                 "order_time": obj.get("order_time"),
             }

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/trade/client/models/spot_trading_action_create.py

@@ -34,7 +34,10 @@ class SpotTradingActionCreate(BaseModel):
     execution_id: Optional[StrictStr] = None
     open_order_execution_id: Optional[StrictStr] = None
     action_type: TradingActionType = Field(description="The type of action.")
-    market_type: MarketType = Field(description="The type of market the action is for.")
+    market_type: Optional[MarketType] = Field(
+        default=None,
+        description="The type of market the action is for. Must be set to spot.",
+    )
     strategy_id: StrictStr = Field(description="UID for the strategy.")
     symbol: StrictStr = Field(
         description="Trading symbol or asset pair in format: 'symbol/quote_currency' (see market service for valid symbols)"

{crypticorn-2.15.0 → crypticorn-2.16.0}/crypticorn/trade/client/models/tpsl.py

@@ -34,13 +34,11 @@ class TPSL(BaseModel):
         description="Percentage of the open order to sell. All allocations must sum up to 1. Use this allocation again when closing the order."
     )
     execution_id: Optional[StrictStr] = None
-    client_order_id: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = [
         "price_delta",
         "price",
         "allocation",
         "execution_id",
-        "client_order_id",
     ]
 
     model_config = ConfigDict(
@@ -95,11 +93,6 @@ class TPSL(BaseModel):
         if self.execution_id is None and "execution_id" in self.model_fields_set:
             _dict["execution_id"] = None
 
-        # set to None if client_order_id (nullable) is None
-        # and model_fields_set contains the field
-        if self.client_order_id is None and "client_order_id" in self.model_fields_set:
-            _dict["client_order_id"] = None
-
         return _dict
 
     @classmethod
@@ -117,7 +110,6 @@ class TPSL(BaseModel):
                 "price": obj.get("price"),
                 "allocation": obj.get("allocation"),
                 "execution_id": obj.get("execution_id"),
-                "client_order_id": obj.get("client_order_id"),
             }
         )
         return _obj

{crypticorn-2.15.0 → crypticorn-2.16.0/crypticorn.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.15.0
+Version: 2.16.0
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT

{crypticorn-2.15.0 → crypticorn-2.16.0}/pyproject.toml

@@ -5,7 +5,7 @@ readme = "README.md"
 license = "MIT"
 requires-python = ">=3.9"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.15.0"
+version = "2.16.0"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]
 

crypticorn-2.16.0/tests/test_pagination.py

@@ -0,0 +1,62 @@
+import pytest
+from pydantic import BaseModel, ValidationError
+from crypticorn.common import PaginationParams
+
+
+class Item(BaseModel):
+    name: str
+    value: int
+
+
+@pytest.mark.asyncio
+async def test_pagination():
+    with pytest.raises(TypeError, match="PaginationParams must be used with a Pydantic BaseModel as a generic parameter"):
+        PaginationParams[int]()
+    with pytest.raises(ValueError, match="Invalid sort field: 'foo' — must be one of: \\['name', 'value'\\]"):
+        PaginationParams[Item](sort="foo")
+
+    pagination_params = PaginationParams[Item](sort="name", order="asc")
+    assert pagination_params.sort == "name"
+    assert pagination_params.order == "asc"
+    assert pagination_params.page == 1
+    assert pagination_params.size == 10
+
+
+@pytest.mark.asyncio
+async def test_pagination_order_validation():
+    # Test invalid order values
+    with pytest.raises(ValidationError):
+        PaginationParams[Item](order="invalid")
+
+
+@pytest.mark.asyncio
+async def test_pagination_sort_order_interaction():
+    # Test that sort and order must be provided together
+    with pytest.raises(ValueError, match="Sort and order must be provided together"):
+        PaginationParams[Item](sort="name")
+    
+    with pytest.raises(ValueError, match="Sort and order must be provided together"):
+        PaginationParams[Item](order="asc")
+    
+    # Test valid combination
+    params = PaginationParams[Item](sort="name", order="asc")
+    assert params.sort == "name"
+    assert params.order == "asc"
+
+
+@pytest.mark.asyncio
+async def test_pagination_default_values():
+    params = PaginationParams[Item]()
+    assert params.page == 1
+    assert params.size == 10
+    assert params.sort is None
+    assert params.order is None
+
+
+@pytest.mark.asyncio
+async def test_pagination_custom_values():
+    params = PaginationParams[Item](page=2, size=20, sort="value", order="desc")
+    assert params.page == 2
+    assert params.size == 20
+    assert params.sort == "value"
+    assert params.order == "desc"

crypticorn-2.15.0/tests/test_pagination.py

@@ -1,19 +0,0 @@
-import pytest
-from pydantic import BaseModel
-from crypticorn.common import PaginationParams
-
-
-class Item(BaseModel):
-    name: str
-    value: int
-
-
-@pytest.mark.asyncio
-async def test_pagination():
-    with pytest.raises(TypeError):
-        PaginationParams[int]()
-    with pytest.raises(ValueError):
-        PaginationParams[Item](sort="foo")
-
-    assert PaginationParams[Item](sort="name").sort == "name"
-    assert PaginationParams[Item]().sort == None