269 lines
11 KiB
Python
269 lines
11 KiB
Python
""" Binance exchange subclass """
|
|
import json
|
|
import logging
|
|
from datetime import datetime
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List, Optional, Tuple
|
|
|
|
import arrow
|
|
import ccxt
|
|
|
|
from freqtrade.enums import Collateral, TradingMode
|
|
from freqtrade.exceptions import (DDosProtection, InsufficientFundsError, InvalidOrderException,
|
|
OperationalException, TemporaryError)
|
|
from freqtrade.exchange import Exchange
|
|
from freqtrade.exchange.common import retrier
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Binance(Exchange):
|
|
|
|
_ft_has: Dict = {
|
|
"stoploss_on_exchange": True,
|
|
"order_time_in_force": ['gtc', 'fok', 'ioc'],
|
|
"time_in_force_parameter": "timeInForce",
|
|
"ohlcv_candle_limit": 1000,
|
|
"trades_pagination": "id",
|
|
"trades_pagination_arg": "fromId",
|
|
"l2_limit_range": [5, 10, 20, 50, 100, 500, 1000],
|
|
}
|
|
funding_fee_times: List[int] = [0, 8, 16] # hours of the day
|
|
_funding_interest_rates: Dict = {} # TODO-lev: delete
|
|
|
|
def __init__(self, config: Dict[str, Any], validate: bool = True) -> None:
|
|
super().__init__(config, validate)
|
|
# TODO-lev: Uncomment once lev-exchange merged in
|
|
# if self.trading_mode == TradingMode.FUTURES:
|
|
# self._funding_interest_rates = self._get_funding_interest_rates()
|
|
|
|
_supported_trading_mode_collateral_pairs: List[Tuple[TradingMode, Collateral]] = [
|
|
# TradingMode.SPOT always supported and not required in this list
|
|
# (TradingMode.MARGIN, Collateral.CROSS), # TODO-lev: Uncomment once supported
|
|
# (TradingMode.FUTURES, Collateral.CROSS), # TODO-lev: Uncomment once supported
|
|
# (TradingMode.FUTURES, Collateral.ISOLATED) # TODO-lev: Uncomment once supported
|
|
]
|
|
|
|
@property
|
|
def _ccxt_config(self) -> Dict:
|
|
# Parameters to add directly to ccxt sync/async initialization.
|
|
if self.trading_mode == TradingMode.MARGIN:
|
|
return {
|
|
"options": {
|
|
"defaultType": "margin"
|
|
}
|
|
}
|
|
elif self.trading_mode == TradingMode.FUTURES:
|
|
return {
|
|
"options": {
|
|
"defaultType": "future"
|
|
}
|
|
}
|
|
else:
|
|
return {}
|
|
|
|
def stoploss_adjust(self, stop_loss: float, order: Dict, side: str) -> bool:
|
|
"""
|
|
Verify stop_loss against stoploss-order value (limit or price)
|
|
Returns True if adjustment is necessary.
|
|
:param side: "buy" or "sell"
|
|
"""
|
|
|
|
return order['type'] == 'stop_loss_limit' and (
|
|
(side == "sell" and stop_loss > float(order['info']['stopPrice'])) or
|
|
(side == "buy" and stop_loss < float(order['info']['stopPrice']))
|
|
)
|
|
|
|
@retrier(retries=0)
|
|
def stoploss(self, pair: str, amount: float, stop_price: float,
|
|
order_types: Dict, side: str, leverage: float) -> Dict:
|
|
"""
|
|
creates a stoploss limit order.
|
|
this stoploss-limit is binance-specific.
|
|
It may work with a limited number of other exchanges, but this has not been tested yet.
|
|
:param side: "buy" or "sell"
|
|
"""
|
|
# Limit price threshold: As limit price should always be below stop-price
|
|
limit_price_pct = order_types.get('stoploss_on_exchange_limit_ratio', 0.99)
|
|
if side == "sell":
|
|
# TODO: Name limit_rate in other exchange subclasses
|
|
rate = stop_price * limit_price_pct
|
|
else:
|
|
rate = stop_price * (2 - limit_price_pct)
|
|
|
|
ordertype = "stop_loss_limit"
|
|
|
|
stop_price = self.price_to_precision(pair, stop_price)
|
|
|
|
bad_stop_price = (stop_price <= rate) if side == "sell" else (stop_price >= rate)
|
|
|
|
# Ensure rate is less than stop price
|
|
if bad_stop_price:
|
|
raise OperationalException(
|
|
'In stoploss limit order, stop price should be better than limit price')
|
|
|
|
if self._config['dry_run']:
|
|
dry_order = self.create_dry_run_order(
|
|
pair, ordertype, side, amount, stop_price, leverage)
|
|
return dry_order
|
|
|
|
try:
|
|
params = self._params.copy()
|
|
params.update({'stopPrice': stop_price})
|
|
|
|
amount = self.amount_to_precision(pair, amount)
|
|
|
|
rate = self.price_to_precision(pair, rate)
|
|
|
|
self._lev_prep(pair, leverage)
|
|
order = self._api.create_order(symbol=pair, type=ordertype, side=side,
|
|
amount=amount, price=rate, params=params)
|
|
logger.info('stoploss limit order added for %s. '
|
|
'stop price: %s. limit: %s', pair, stop_price, rate)
|
|
self._log_exchange_response('create_stoploss_order', order)
|
|
return order
|
|
except ccxt.InsufficientFunds as e:
|
|
raise InsufficientFundsError(
|
|
f'Insufficient funds to create {ordertype} {side} order on market {pair}. '
|
|
f'Tried to {side} amount {amount} at rate {rate}. '
|
|
f'Message: {e}') from e
|
|
except ccxt.InvalidOrder as e:
|
|
# Errors:
|
|
# `binance Order would trigger immediately.`
|
|
raise InvalidOrderException(
|
|
f'Could not create {ordertype} {side} order on market {pair}. '
|
|
f'Tried to {side} amount {amount} at rate {rate}. '
|
|
f'Message: {e}') from e
|
|
except ccxt.DDoSProtection as e:
|
|
raise DDosProtection(e) from e
|
|
except (ccxt.NetworkError, ccxt.ExchangeError) as e:
|
|
raise TemporaryError(
|
|
f'Could not place {side} order due to {e.__class__.__name__}. Message: {e}') from e
|
|
except ccxt.BaseError as e:
|
|
raise OperationalException(e) from e
|
|
|
|
@retrier
|
|
def fill_leverage_brackets(self):
|
|
"""
|
|
Assigns property _leverage_brackets to a dictionary of information about the leverage
|
|
allowed on each pair
|
|
"""
|
|
if self.trading_mode == TradingMode.FUTURES:
|
|
try:
|
|
if self._config['dry_run']:
|
|
leverage_brackets_path = (
|
|
Path(__file__).parent / 'binance_leverage_brackets.json'
|
|
)
|
|
with open(leverage_brackets_path) as json_file:
|
|
leverage_brackets = json.load(json_file)
|
|
else:
|
|
leverage_brackets = self._api.load_leverage_brackets()
|
|
|
|
for pair, brackets in leverage_brackets.items():
|
|
self._leverage_brackets[pair] = [
|
|
[
|
|
min_amount,
|
|
float(margin_req)
|
|
] for [
|
|
min_amount,
|
|
margin_req
|
|
] in brackets
|
|
]
|
|
|
|
except ccxt.DDoSProtection as e:
|
|
raise DDosProtection(e) from e
|
|
except (ccxt.NetworkError, ccxt.ExchangeError) as e:
|
|
raise TemporaryError(f'Could not fetch leverage amounts due to'
|
|
f'{e.__class__.__name__}. Message: {e}') from e
|
|
except ccxt.BaseError as e:
|
|
raise OperationalException(e) from e
|
|
|
|
def get_max_leverage(self, pair: Optional[str], nominal_value: Optional[float]) -> float:
|
|
"""
|
|
Returns the maximum leverage that a pair can be traded at
|
|
:param pair: The base/quote currency pair being traded
|
|
:nominal_value: The total value of the trade in quote currency (collateral + debt)
|
|
"""
|
|
pair_brackets = self._leverage_brackets[pair]
|
|
max_lev = 1.0
|
|
for [min_amount, margin_req] in pair_brackets:
|
|
if nominal_value >= min_amount:
|
|
max_lev = 1/margin_req
|
|
return max_lev
|
|
|
|
@retrier
|
|
def _set_leverage(
|
|
self,
|
|
leverage: float,
|
|
pair: Optional[str] = None,
|
|
trading_mode: Optional[TradingMode] = None
|
|
):
|
|
"""
|
|
Set's the leverage before making a trade, in order to not
|
|
have the same leverage on every trade
|
|
"""
|
|
trading_mode = trading_mode or self.trading_mode
|
|
|
|
if self._config['dry_run'] or trading_mode != TradingMode.FUTURES:
|
|
return
|
|
|
|
try:
|
|
self._api.set_leverage(symbol=pair, leverage=leverage)
|
|
except ccxt.DDoSProtection as e:
|
|
raise DDosProtection(e) from e
|
|
except (ccxt.NetworkError, ccxt.ExchangeError) as e:
|
|
raise TemporaryError(
|
|
f'Could not set leverage due to {e.__class__.__name__}. Message: {e}') from e
|
|
except ccxt.BaseError as e:
|
|
raise OperationalException(e) from e
|
|
|
|
def _get_mark_price(self, pair: str, date: datetime) -> float:
|
|
raise OperationalException(f'_get_mark_price has not been implemented on {self.name}')
|
|
|
|
def _get_funding_rate(self, pair: str, premium_index: float) -> Optional[float]:
|
|
"""
|
|
Get's the funding_rate for a pair at a specific date and time in the past
|
|
"""
|
|
raise OperationalException(f'_get_mark_price has not been implemented on {self.name}')
|
|
|
|
def _get_funding_fee(
|
|
self,
|
|
pair: str,
|
|
contract_size: float,
|
|
mark_price: float,
|
|
funding_rate: Optional[float],
|
|
) -> float:
|
|
"""
|
|
Calculates a single funding fee
|
|
:param contract_size: The amount/quanity
|
|
:param mark_price: The price of the asset that the contract is based off of
|
|
:param funding_rate: the interest rate and the premium
|
|
- interest rate: 0.03% daily, BNBUSDT, LINKUSDT, and LTCUSDT are 0%
|
|
- premium: varies by price difference between the perpetual contract and mark price
|
|
"""
|
|
if premium_index is None:
|
|
raise OperationalException("Premium index cannot be None for Binance._get_funding_fee")
|
|
nominal_value = mark_price * contract_size
|
|
funding_rate = self._calculate_funding_rate(pair, premium_index)
|
|
if funding_rate is None:
|
|
raise OperationalException("Funding rate should never be none on Binance")
|
|
return nominal_value * funding_rate
|
|
|
|
async def _async_get_historic_ohlcv(self, pair: str, timeframe: str,
|
|
since_ms: int, is_new_pair: bool
|
|
) -> List:
|
|
"""
|
|
Overwrite to introduce "fast new pair" functionality by detecting the pair's listing date
|
|
Does not work for other exchanges, which don't return the earliest data when called with "0"
|
|
"""
|
|
if is_new_pair:
|
|
x = await self._async_get_candle_history(pair, timeframe, 0)
|
|
if x and x[2] and x[2][0] and x[2][0][0] > since_ms:
|
|
# Set starting date to first available candle.
|
|
since_ms = x[2][0][0]
|
|
logger.info(f"Candle-data for {pair} available starting with "
|
|
f"{arrow.get(since_ms // 1000).isoformat()}.")
|
|
return await super()._async_get_historic_ohlcv(
|
|
pair=pair, timeframe=timeframe, since_ms=since_ms, is_new_pair=is_new_pair)
|