2022-11-29 07:20:39 +00:00
|
|
|
from abc import ABC, abstractmethod
|
|
|
|
|
2022-11-10 07:20:14 +00:00
|
|
|
from alpaca.common.exceptions import APIError
|
2022-11-02 18:25:34 +00:00
|
|
|
from glom import glom
|
2022-11-10 07:20:14 +00:00
|
|
|
from oandapyV20.exceptions import V20Error
|
2022-10-30 19:11:07 +00:00
|
|
|
|
2022-11-02 18:25:34 +00:00
|
|
|
from core.lib import schemas
|
2022-10-30 10:57:53 +00:00
|
|
|
from core.util import logs
|
|
|
|
|
2022-11-04 09:15:09 +00:00
|
|
|
# Return error if the schema for the message type is not found
|
2022-11-02 19:11:32 +00:00
|
|
|
STRICT_VALIDATION = False
|
2022-11-04 09:15:09 +00:00
|
|
|
|
|
|
|
# Raise exception if the conversion schema is not found
|
2022-11-04 07:20:55 +00:00
|
|
|
STRICT_CONVERSION = False
|
2022-11-02 19:11:32 +00:00
|
|
|
|
2022-11-04 09:15:09 +00:00
|
|
|
# TODO: Set them to True when all message types are implemented
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-04 07:20:14 +00:00
|
|
|
log = logs.get_logger("exchanges")
|
|
|
|
|
2022-11-04 07:20:55 +00:00
|
|
|
|
|
|
|
class NoSchema(Exception):
|
|
|
|
"""
|
|
|
|
Raised when:
|
|
|
|
- The schema for the message type is not found
|
|
|
|
- The conversion schema is not found
|
|
|
|
- There is no schema library for the exchange
|
|
|
|
"""
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
class NoSuchMethod(Exception):
|
|
|
|
"""
|
|
|
|
Exchange library has no such method.
|
|
|
|
"""
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
class GenericAPIError(Exception):
|
|
|
|
"""
|
|
|
|
Generic API error.
|
|
|
|
"""
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
class ExchangeError(Exception):
|
|
|
|
"""
|
|
|
|
Exchange error.
|
|
|
|
"""
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
def is_camel_case(s):
|
|
|
|
return s != s.lower() and s != s.upper() and "_" not in s
|
|
|
|
|
|
|
|
|
|
|
|
def snake_to_camel(word):
|
|
|
|
if is_camel_case(word):
|
|
|
|
return word
|
|
|
|
return "".join(x.capitalize() or "_" for x in word.split("_"))
|
|
|
|
|
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
class BaseExchange(ABC):
|
2022-10-30 10:57:53 +00:00
|
|
|
def __init__(self, account):
|
|
|
|
name = self.__class__.__name__
|
2022-11-02 18:25:34 +00:00
|
|
|
self.name = name.replace("Exchange", "").lower()
|
2022-10-30 10:57:53 +00:00
|
|
|
self.account = account
|
|
|
|
self.client = None
|
|
|
|
|
|
|
|
self.connect()
|
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def connect(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-04 07:20:55 +00:00
|
|
|
@property
|
|
|
|
def schema(self):
|
|
|
|
"""
|
|
|
|
Get the schema library for the exchange.
|
|
|
|
"""
|
2022-11-02 18:25:34 +00:00
|
|
|
# Does the schemas library have a library for this exchange name?
|
|
|
|
if hasattr(schemas, f"{self.name}_s"):
|
|
|
|
schema_instance = getattr(schemas, f"{self.name}_s")
|
|
|
|
else:
|
2022-11-04 07:20:14 +00:00
|
|
|
log.error(f"No schema library for {self.name}")
|
|
|
|
raise Exception(f"No schema library for exchange {self.name}")
|
2022-11-04 07:20:55 +00:00
|
|
|
|
|
|
|
return schema_instance
|
|
|
|
|
|
|
|
def get_schema(self, method, convert=False):
|
|
|
|
if isinstance(method, str):
|
|
|
|
to_camel = snake_to_camel(method)
|
|
|
|
else:
|
|
|
|
to_camel = snake_to_camel(method.__class__.__name__)
|
|
|
|
if convert:
|
2022-11-04 07:20:14 +00:00
|
|
|
to_camel = f"{to_camel}Schema"
|
2022-11-04 07:20:55 +00:00
|
|
|
# if hasattr(self.schema, method):
|
|
|
|
# schema = getattr(self.schema, method)
|
|
|
|
if hasattr(self.schema, to_camel):
|
|
|
|
schema = getattr(self.schema, to_camel)
|
2022-11-02 18:25:34 +00:00
|
|
|
else:
|
2022-11-04 07:20:14 +00:00
|
|
|
raise NoSchema(f"Could not get schema: {to_camel}")
|
2022-11-04 07:20:55 +00:00
|
|
|
return schema
|
|
|
|
|
|
|
|
def call_method(self, method, *args, **kwargs):
|
|
|
|
"""
|
|
|
|
Get a method from the exchange library.
|
|
|
|
"""
|
|
|
|
if hasattr(self.client, method):
|
|
|
|
response = getattr(self.client, method)(*args, **kwargs)
|
|
|
|
if isinstance(response, list):
|
|
|
|
response = {"itemlist": response}
|
2022-11-02 18:25:34 +00:00
|
|
|
return response
|
2022-11-04 07:20:55 +00:00
|
|
|
else:
|
|
|
|
raise NoSuchMethod
|
|
|
|
|
|
|
|
def convert_spec(self, response, method):
|
|
|
|
"""
|
|
|
|
Convert an API response to the requested spec.
|
|
|
|
:raises NoSchema: If the conversion schema is not found
|
|
|
|
"""
|
|
|
|
schema = self.get_schema(method, convert=True)
|
2022-11-02 18:25:34 +00:00
|
|
|
|
|
|
|
# Use glom to convert the response to the schema
|
|
|
|
converted = glom(response, schema)
|
|
|
|
return converted
|
|
|
|
|
2022-11-04 07:20:14 +00:00
|
|
|
def validate_response(self, response, method):
|
|
|
|
schema = self.get_schema(method)
|
|
|
|
# Return a dict of the validated response
|
|
|
|
response_valid = schema(**response).dict()
|
|
|
|
return response_valid
|
|
|
|
|
2022-11-04 07:20:55 +00:00
|
|
|
def call(self, method, *args, **kwargs):
|
|
|
|
"""
|
|
|
|
Call the exchange API and validate the response
|
|
|
|
:raises NoSchema: If the method is not in the schema mapping
|
|
|
|
:raises ValidationError: If the response cannot be validated
|
|
|
|
"""
|
2022-11-10 07:20:14 +00:00
|
|
|
try:
|
|
|
|
response = self.call_method(method, *args, **kwargs)
|
|
|
|
except (APIError, V20Error) as e:
|
|
|
|
log.error(f"Error calling method {method}: {e}")
|
|
|
|
raise GenericAPIError(e)
|
2022-11-04 07:20:14 +00:00
|
|
|
try:
|
|
|
|
response_valid = self.validate_response(response, method)
|
|
|
|
except NoSchema as e:
|
|
|
|
log.error(f"{e} - {response}")
|
|
|
|
response_valid = response
|
|
|
|
# Convert the response to a format that we can use
|
2022-11-04 07:20:55 +00:00
|
|
|
try:
|
|
|
|
response_converted = self.convert_spec(response_valid, method)
|
2022-11-04 07:20:14 +00:00
|
|
|
except NoSchema as e:
|
|
|
|
log.error(f"{e} - {response}")
|
|
|
|
response_converted = response_valid
|
2022-11-10 07:20:14 +00:00
|
|
|
|
2022-11-04 07:20:14 +00:00
|
|
|
# return (True, response_converted)
|
|
|
|
return response_converted
|
|
|
|
|
2022-11-04 07:20:12 +00:00
|
|
|
# except Exception as e:
|
2022-11-04 07:20:14 +00:00
|
|
|
# log.error(f"Error calling method: {e}")
|
2022-11-04 07:20:12 +00:00
|
|
|
# raise GenericAPIError(e)
|
2022-10-30 19:11:07 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 11:21:48 +00:00
|
|
|
def get_account(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 11:21:48 +00:00
|
|
|
|
2022-11-10 19:27:46 +00:00
|
|
|
def extract_instrument(self, instruments, instrument):
|
|
|
|
for x in instruments["itemlist"]:
|
|
|
|
if x["name"] == instrument:
|
|
|
|
return x
|
|
|
|
return None
|
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-11-10 19:27:46 +00:00
|
|
|
def get_currencies(self, symbols):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-11-10 19:27:46 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-11-10 19:27:46 +00:00
|
|
|
def get_instruments(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-11-10 19:27:46 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def get_supported_assets(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def get_balance(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def get_market_value(self, symbol):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def post_trade(self, trade):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def get_trade(self, trade_id):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def update_trade(self, trade):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def cancel_trade(self, trade_id):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-11-02 18:25:34 +00:00
|
|
|
def get_position_info(self, symbol):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-10-30 10:57:53 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-10-30 10:57:53 +00:00
|
|
|
def get_all_positions(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|
2022-11-14 18:29:07 +00:00
|
|
|
|
2022-11-29 07:20:39 +00:00
|
|
|
@abstractmethod
|
2022-11-14 18:29:07 +00:00
|
|
|
def close_all_positions(self):
|
2022-11-29 07:20:39 +00:00
|
|
|
pass
|