crypticorn 1.0.1__py3-none-any.whl → 1.0.2rc1__py3-none-any.whl

crypticorn/{models → trade/client/models}/order_model.py

@@ -17,14 +17,14 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from crypticorn.models.api_error_identifier import ApiErrorIdentifier
-from crypticorn.models.exchange import Exchange
-from crypticorn.models.margin_mode import MarginMode
-from crypticorn.models.market_type import MarketType
-from crypticorn.models.order_status import OrderStatus
-from crypticorn.models.trading_action_type import TradingActionType
+from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.trade.client.models.exchange import Exchange
+from crypticorn.trade.client.models.margin_mode import MarginMode
+from crypticorn.trade.client.models.market_type import MarketType
+from crypticorn.trade.client.models.order_status import OrderStatus
+from crypticorn.trade.client.models.trading_action_type import TradingActionType
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -32,6 +32,8 @@ class OrderModel(BaseModel):
     """
     Response model for orders. All optional as the model is built step by step.
     """ # noqa: E501
+    created_at: Optional[StrictInt] = Field(default=1742340838, description="Timestamp of creation")
+    updated_at: Optional[StrictInt] = Field(default=1742340838, description="Timestamp of last update")
     id: Optional[StrictStr] = None
     trading_action_id: Optional[StrictStr] = None
     execution_id: Optional[StrictStr] = None
@@ -44,7 +46,6 @@ class OrderModel(BaseModel):
     exchange: Optional[Exchange] = None
     symbol: Optional[StrictStr] = None
     common_symbol: Optional[StrictStr] = None
-    timestamp: Optional[StrictInt] = None
     price: Optional[Union[StrictFloat, StrictInt]] = None
     action_type: Optional[TradingActionType] = None
     market_type: Optional[MarketType] = None
@@ -57,7 +58,7 @@ class OrderModel(BaseModel):
     leverage: Optional[Union[StrictFloat, StrictInt]] = None
     order_details: Optional[Dict[str, Any]] = None
     pnl: Optional[Union[StrictFloat, StrictInt]] = None
-    __properties: ClassVar[List[str]] = ["id", "trading_action_id", "execution_id", "exchange_order_id", "position_id", "api_key_id", "user_id", "bot_id", "client_order_id", "exchange", "symbol", "common_symbol", "timestamp", "price", "action_type", "market_type", "margin_mode", "status_code", "status", "filled_perc", "filled_qty", "fee", "leverage", "order_details", "pnl"]
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "trading_action_id", "execution_id", "exchange_order_id", "position_id", "api_key_id", "user_id", "bot_id", "client_order_id", "exchange", "symbol", "common_symbol", "price", "action_type", "market_type", "margin_mode", "status_code", "status", "filled_perc", "filled_qty", "fee", "leverage", "order_details", "pnl"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -158,11 +159,6 @@ class OrderModel(BaseModel):
         if self.common_symbol is None and "common_symbol" in self.model_fields_set:
             _dict['common_symbol'] = None
 
-        # set to None if timestamp (nullable) is None
-        # and model_fields_set contains the field
-        if self.timestamp is None and "timestamp" in self.model_fields_set:
-            _dict['timestamp'] = None
-
         # set to None if price (nullable) is None
         # and model_fields_set contains the field
         if self.price is None and "price" in self.model_fields_set:
@@ -235,6 +231,8 @@ class OrderModel(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "created_at": obj.get("created_at") if obj.get("created_at") is not None else 1742340838,
+            "updated_at": obj.get("updated_at") if obj.get("updated_at") is not None else 1742340838,
             "id": obj.get("id"),
             "trading_action_id": obj.get("trading_action_id"),
             "execution_id": obj.get("execution_id"),
@@ -247,7 +245,6 @@ class OrderModel(BaseModel):
             "exchange": obj.get("exchange"),
             "symbol": obj.get("symbol"),
             "common_symbol": obj.get("common_symbol"),
-            "timestamp": obj.get("timestamp"),
             "price": obj.get("price"),
             "action_type": obj.get("action_type"),
             "market_type": obj.get("market_type"),

crypticorn/{models → trade/client/models}/post_futures_action.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List
-from crypticorn.models.execution_ids import ExecutionIds
+from crypticorn.trade.client.models.execution_ids import ExecutionIds
 from typing import Optional, Set
 from typing_extensions import Self
 

crypticorn/{models → trade/client/models}/strategy_exchange_info.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
 from typing import Any, ClassVar, Dict, List, Union
-from crypticorn.models.exchange import Exchange
+from crypticorn.trade.client.models.exchange import Exchange
 from typing import Optional, Set
 from typing_extensions import Self
 

crypticorn/{models → trade/client/models}/strategy_model.py

@@ -20,7 +20,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing_extensions import Annotated
-from crypticorn.models.strategy_exchange_info import StrategyExchangeInfo
+from crypticorn.trade.client.models.strategy_exchange_info import StrategyExchangeInfo
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,6 +28,8 @@ class StrategyModel(BaseModel):
     """
     StrategyModel
     """ # noqa: E501
+    created_at: Optional[StrictInt] = Field(default=1742340838, description="Timestamp of creation")
+    updated_at: Optional[StrictInt] = Field(default=1742340838, description="Timestamp of last update")
     id: Optional[StrictStr] = None
     identifier: StrictStr = Field(description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'")
     name: StrictStr = Field(description="Name of the strategy")
@@ -36,7 +38,7 @@ class StrategyModel(BaseModel):
     enabled: StrictBool = Field(description="Whether the strategy is enabled")
     leverage: StrictInt = Field(description="Leverage for the strategy")
     performance_fee: Union[Annotated[float, Field(le=1.0, strict=True)], Annotated[int, Field(le=1, strict=True)]] = Field(description="Performance fee for the strategy")
-    __properties: ClassVar[List[str]] = ["id", "identifier", "name", "description", "exchanges", "enabled", "leverage", "performance_fee"]
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "identifier", "name", "description", "exchanges", "enabled", "leverage", "performance_fee"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -101,6 +103,8 @@ class StrategyModel(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "created_at": obj.get("created_at") if obj.get("created_at") is not None else 1742340838,
+            "updated_at": obj.get("updated_at") if obj.get("updated_at") is not None else 1742340838,
             "id": obj.get("id"),
             "identifier": obj.get("identifier"),
             "name": obj.get("name"),

crypticorn/{models → trade/client/models}/validation_error.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
-from crypticorn.models.validation_error_loc_inner import ValidationErrorLocInner
+from crypticorn.trade.client.models.validation_error_loc_inner import ValidationErrorLocInner
 from typing import Optional, Set
 from typing_extensions import Self
 

crypticorn/trade/client/rest.py

@@ -0,0 +1,257 @@
+# coding: utf-8
+
+"""
+    FastAPI
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from crypticorn.trade.client.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :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
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

crypticorn/trade/main.py

@@ -0,0 +1,38 @@
+from crypticorn.trade.client import (
+    BotsApi,
+    ExchangesApi,
+    NotificationsApi,
+    OrdersApi,
+    StatusApi,
+    StrategiesApi,
+    TradingActionsApi,
+    FuturesTradingPanelApi,
+    APIKeysApi,
+    ApiClient,
+    Configuration,
+)
+
+
+class TradeClient:
+    """
+    A client for interacting with the Crypticorn Trade API.
+    """
+
+    def __init__(self, base_url: str = None, api_key: str = None, jwt: str = None):
+        # Configure Trade client
+        self.host = f"{base_url}/v1/trade"
+        config = Configuration(
+            host=self.host,
+            access_token=jwt,  # at the moment we only support JWT auth
+        )
+        base_client = ApiClient(configuration=config)
+        # Instantiate all the endpoint clients
+        self.bots = BotsApi(base_client)
+        self.exchanges = ExchangesApi(base_client)
+        self.notifications = NotificationsApi(base_client)
+        self.orders = OrdersApi(base_client)
+        self.status = StatusApi(base_client)
+        self.strategies = StrategiesApi(base_client)
+        self.trading_actions = TradingActionsApi(base_client)
+        self.futures = FuturesTradingPanelApi(base_client)
+        self.api_keys = APIKeysApi(base_client)

crypticorn/trade/requirements.txt

@@ -0,0 +1,4 @@
+urllib3 >= 1.25.3, < 3.0.0
+python_dateutil >= 2.8.2
+pydantic >= 2
+typing-extensions >= 4.7.1

crypticorn/trade/test/test_action_model.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    FastAPI
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from crypticorn.trade.client.models.action_model import ActionModel
+
+class TestActionModel(unittest.TestCase):
+    """ActionModel unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> ActionModel:
+        """Test ActionModel
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `ActionModel`
+        """
+        model = ActionModel()
+        if include_optional:
+            return ActionModel(
+                id = '',
+                execution_id = '',
+                open_order_execution_id = '',
+                position_id = '',
+                client_order_id = '',
+                action_type = 'open_long',
+                market_type = 'spot',
+                strategy_id = '',
+                symbol = '',
+                is_limit = True,
+                limit_price = 1.337,
+                allocation = 1.337,
+                take_profit = [
+                    client.models.tpsl.TPSL(
+                        price_delta = 0.0, 
+                        price = 1.337, 
+                        allocation = 0.0, 
+                        execution_id = '', 
+                        client_order_id = '', )
+                    ],
+                stop_loss = [
+                    client.models.tpsl.TPSL(
+                        price_delta = 0.0, 
+                        price = 1.337, 
+                        allocation = 0.0, 
+                        execution_id = '', 
+                        client_order_id = '', )
+                    ],
+                expiry_timestamp = 56,
+                leverage = 1.0,
+                margin_mode = 'isolated',
+                timestamp = 56
+            )
+        else:
+            return ActionModel(
+                action_type = 'open_long',
+                market_type = 'spot',
+                strategy_id = '',
+                symbol = '',
+                leverage = 1.0,
+        )
+        """
+
+    def testActionModel(self):
+        """Test ActionModel"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/trade/test/test_api_error_identifier.py

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    FastAPI
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
+
+class TestApiErrorIdentifier(unittest.TestCase):
+    """ApiErrorIdentifier unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testApiErrorIdentifier(self):
+        """Test ApiErrorIdentifier"""
+        # inst = ApiErrorIdentifier()
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/trade/test/test_api_key_model.py

@@ -0,0 +1,61 @@
+# coding: utf-8
+
+"""
+    FastAPI
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from crypticorn.trade.client.models.api_key_model import APIKeyModel
+
+class TestAPIKeyModel(unittest.TestCase):
+    """APIKeyModel unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> APIKeyModel:
+        """Test APIKeyModel
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `APIKeyModel`
+        """
+        model = APIKeyModel()
+        if include_optional:
+            return APIKeyModel(
+                id = '',
+                exchange = '',
+                api_key = '',
+                secret = '',
+                passphrase = '',
+                label = '',
+                enabled = True,
+                created_at = 56,
+                user_id = ''
+            )
+        else:
+            return APIKeyModel(
+                exchange = '',
+                label = '',
+        )
+        """
+
+    def testAPIKeyModel(self):
+        """Test APIKeyModel"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()