mirror of
https://github.com/c9s/bbgo.git
synced 2024-09-20 08:11:08 +00:00
bollmaker: refactor trailing stop snippet
This commit is contained in:
c9s
parent
bcb33f6887
commit
67bc5d523a
25
pkg/bbgo/quantity_amount.go
Normal file
25
pkg/bbgo/quantity_amount.go
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
package bbgo
|
||||
|
||||
import "github.com/c9s/bbgo/pkg/fixedpoint"
|
||||
|
||||
// QuantityOrAmount is a setting structure used for quantity/amount settings
|
||||
// You can embed this struct into your strategy to share the setting methods
|
||||
type QuantityOrAmount struct {
|
||||
// Quantity is the base order quantity for your buy/sell order.
|
||||
// when quantity is set, the amount option will be not used.
|
||||
Quantity fixedpoint.Value `json:"quantity"`
|
||||
|
||||
// Amount is the order quote amount for your buy/sell order.
|
||||
Amount fixedpoint.Value `json:"amount"`
|
||||
}
|
||||
|
||||
// CalculateQuantity calculates the equivalent quantity of the given price when amount is set
|
||||
// it returns the quantity if the quantity is set
|
||||
func (qa *QuantityOrAmount) CalculateQuantity(currentPrice fixedpoint.Value) fixedpoint.Value {
|
||||
if qa.Amount > 0 {
|
||||
quantity := qa.Amount.Div(currentPrice)
|
||||
return quantity
|
||||
}
|
||||
|
||||
return qa.Quantity
|
||||
}
|
||||
|
|
@ -1,24 +1,2 @@
|
|||
package bollmaker
|
||||
|
||||
import "github.com/c9s/bbgo/pkg/fixedpoint"
|
||||
|
||||
// QuantityOrAmount is a setting structure used for quantity/amount settings
|
||||
type QuantityOrAmount struct {
|
||||
// Quantity is the base order quantity for your buy/sell order.
|
||||
// when quantity is set, the amount option will be not used.
|
||||
Quantity fixedpoint.Value `json:"quantity"`
|
||||
|
||||
// Amount is the order quote amount for your buy/sell order.
|
||||
Amount fixedpoint.Value `json:"amount"`
|
||||
}
|
||||
|
||||
// CalculateQuantity calculates the equivalent quantity of the given price when amount is set
|
||||
// it returns the quantity if the quantity is set
|
||||
func (qa *QuantityOrAmount) CalculateQuantity(currentPrice fixedpoint.Value) fixedpoint.Value {
|
||||
if qa.Amount > 0 {
|
||||
quantity := qa.Amount.Div(currentPrice)
|
||||
return quantity
|
||||
}
|
||||
|
||||
return qa.Quantity
|
||||
}
|
||||
|
|
|
|||
233
pkg/strategy/bollmaker/stop.go
Normal file
233
pkg/strategy/bollmaker/stop.go
Normal file
|
|
@ -0,0 +1,233 @@
|
|||
package bollmaker
|
||||
|
||||
import (
|
||||
"context"
|
||||
"math"
|
||||
|
||||
"github.com/c9s/bbgo/pkg/bbgo"
|
||||
"github.com/c9s/bbgo/pkg/fixedpoint"
|
||||
"github.com/c9s/bbgo/pkg/types"
|
||||
)
|
||||
|
||||
type TrailingStop struct {
|
||||
// CallbackRate is the callback rate from the previous high price
|
||||
CallbackRate fixedpoint.Value `json:"callbackRate,omitempty"`
|
||||
|
||||
// ClosePosition is a percentage of the position to be closed
|
||||
ClosePosition fixedpoint.Value `json:"closePosition,omitempty"`
|
||||
|
||||
// MinProfit is the percentage of the minimum profit ratio.
|
||||
// Stop order will be activiated only when the price reaches above this threshold.
|
||||
MinProfit fixedpoint.Value `json:"minProfit,omitempty"`
|
||||
|
||||
// Interval is the time resolution to update the stop order
|
||||
// KLine per Interval will be used for updating the stop order
|
||||
Interval types.Interval `json:"interval,omitempty"`
|
||||
|
||||
// Virtual is used when you don't want to place the real order on the exchange and lock the balance.
|
||||
// You want to handle the stop order by the strategy itself.
|
||||
Virtual bool `json:"virtual,omitempty"`
|
||||
}
|
||||
|
||||
type TrailingStopController struct {
|
||||
*TrailingStop
|
||||
|
||||
Symbol string
|
||||
|
||||
position *types.Position
|
||||
latestHigh float64
|
||||
averageCost fixedpoint.Value
|
||||
}
|
||||
|
||||
func NewTrailingStopController(symbol string, config *TrailingStop) *TrailingStopController {
|
||||
return &TrailingStopController{
|
||||
TrailingStop: config,
|
||||
Symbol: symbol,
|
||||
}
|
||||
}
|
||||
|
||||
func (c *TrailingStopController) Subscribe(session *bbgo.ExchangeSession) {
|
||||
session.Subscribe(types.KLineChannel, c.Symbol, types.SubscribeOptions{
|
||||
Interval: c.Interval.String(),
|
||||
})
|
||||
}
|
||||
|
||||
func (c *TrailingStopController) Run(ctx context.Context, session *bbgo.ExchangeSession, tradeCollector *bbgo.TradeCollector) {
|
||||
// store the position
|
||||
c.position = tradeCollector.Position()
|
||||
c.averageCost = c.position.AverageCost
|
||||
|
||||
// Use trade collector to get the position update event
|
||||
tradeCollector.OnPositionUpdate(func(position *types.Position) {
|
||||
// update average cost if we have it.
|
||||
c.averageCost = position.AverageCost
|
||||
})
|
||||
|
||||
session.MarketDataStream.OnKLineClosed(func(kline types.KLine) {
|
||||
if kline.Symbol != c.Symbol || kline.Interval != c.Interval {
|
||||
return
|
||||
}
|
||||
|
||||
closePrice := kline.Close
|
||||
|
||||
// update the latest high
|
||||
c.latestHigh = math.Max(closePrice, c.latestHigh)
|
||||
|
||||
if c.Virtual {
|
||||
// if average cost is updated, we can check min profit
|
||||
if c.averageCost == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
// skip dust position
|
||||
if c.position.Base.Abs().Float64() < c.position.Market.MinQuantity || c.position.Base.Abs().Float64()*closePrice < c.position.Market.MinNotional {
|
||||
return
|
||||
}
|
||||
|
||||
// if it's in the callback rate, we don't want to trigger stop
|
||||
if closePrice < c.latestHigh && changeRate(closePrice, c.latestHigh) < c.CallbackRate.Float64() {
|
||||
return
|
||||
}
|
||||
|
||||
// if the profit rate is defined, and it is less than our minimum profit rate, we skip stop
|
||||
if c.MinProfit > 0 &&
|
||||
(closePrice < c.averageCost.Float64() ||
|
||||
changeRate(closePrice, c.averageCost.Float64()) < c.MinProfit.Float64()) {
|
||||
return
|
||||
}
|
||||
|
||||
log.Infof("trailing stop emitted, latest high: %f, closed price: %f, average cost: %f, profit spread: %f",
|
||||
c.latestHigh,
|
||||
closePrice,
|
||||
c.averageCost.Float64(),
|
||||
closePrice-c.averageCost.Float64())
|
||||
|
||||
log.Infof("current position: %s", c.position.String())
|
||||
|
||||
marketOrder := c.position.NewClosePositionOrder(c.ClosePosition.Float64())
|
||||
if marketOrder != nil {
|
||||
log.Infof("submitting market order to stop: %+v", marketOrder)
|
||||
|
||||
// skip dust order
|
||||
if marketOrder.Quantity*closePrice < c.position.Market.MinNotional {
|
||||
log.Warnf("market order quote quantity %f < min notional %f, skip placing order", marketOrder.Quantity*closePrice, c.position.Market.MinNotional)
|
||||
return
|
||||
}
|
||||
|
||||
createdOrders, err := session.Exchange.SubmitOrders(ctx, *marketOrder)
|
||||
if err != nil {
|
||||
log.WithError(err).Errorf("stop market order place error")
|
||||
return
|
||||
}
|
||||
tradeCollector.OrderStore().Add(createdOrders...)
|
||||
tradeCollector.Process()
|
||||
|
||||
// reset the state
|
||||
c.latestHigh = 0.0
|
||||
}
|
||||
} else {
|
||||
// place stop order only when the closed price is greater than the current average cost
|
||||
if c.position != nil && c.MinProfit > 0 && c.averageCost > 0 &&
|
||||
closePrice > c.averageCost.Float64() &&
|
||||
changeRate(closePrice, c.averageCost.Float64()) >= c.MinProfit.Float64() {
|
||||
|
||||
stopPrice := c.averageCost.MulFloat64(1.0 + c.MinProfit.Float64())
|
||||
orderForm := c.GenerateStopOrder(stopPrice.Float64(), c.averageCost.Float64())
|
||||
if orderForm != nil {
|
||||
log.Infof("updating stop limit order to simulate trailing stop order...")
|
||||
createdOrders, err := session.Exchange.SubmitOrders(ctx, *orderForm)
|
||||
if err != nil {
|
||||
log.WithError(err).Errorf("stop order place error")
|
||||
}
|
||||
tradeCollector.OrderStore().Add(createdOrders...)
|
||||
tradeCollector.Process()
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func (c *TrailingStopController) GenerateStopOrder(stopPrice, price float64) *types.SubmitOrder {
|
||||
base := c.position.GetBase()
|
||||
if base == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
quantity := math.Abs(base.Float64())
|
||||
quoteQuantity := price * quantity
|
||||
|
||||
if c.ClosePosition > 0 {
|
||||
quantity = quantity * c.ClosePosition.Float64()
|
||||
}
|
||||
|
||||
// skip dust orders
|
||||
if quantity < c.position.Market.MinQuantity || quoteQuantity < c.position.Market.MinNotional {
|
||||
return nil
|
||||
}
|
||||
|
||||
side := types.SideTypeSell
|
||||
if base < 0 {
|
||||
side = types.SideTypeBuy
|
||||
}
|
||||
|
||||
return &types.SubmitOrder{
|
||||
Symbol: c.Symbol,
|
||||
Market: c.position.Market,
|
||||
Type: types.OrderTypeStopLimit,
|
||||
Side: side,
|
||||
StopPrice: stopPrice,
|
||||
Price: price,
|
||||
Quantity: quantity,
|
||||
}
|
||||
}
|
||||
|
||||
type FixedStop struct{}
|
||||
|
||||
type Stop struct {
|
||||
TrailingStop *TrailingStop `json:"trailingStop,omitempty"`
|
||||
FixedStop *FixedStop `json:"fixedStop,omitempty"`
|
||||
}
|
||||
|
||||
// StopSettings shares the stop order logics between different strategies
|
||||
// To use the stop controllers, you can embed this struct into your Strategy struct
|
||||
|
||||
// func (s *Strategy) Initialize() error {
|
||||
// return s.StopSettings.SetupStopControllers(s.Symbol)
|
||||
// }
|
||||
// func (s *Strategy) Subscribe(session *bbgo.ExchangeSession) {
|
||||
// s.StopSettings.Subscribe(session)
|
||||
// }
|
||||
//
|
||||
// func (s *Strategy) Subscribe() {
|
||||
// }
|
||||
//
|
||||
// func (s *Strategy) Run() {
|
||||
// ...
|
||||
// s.StopSettings.RunStopControllers(ctx, session, s.tradeCollector)
|
||||
// ...
|
||||
// }
|
||||
type StopSettings struct {
|
||||
Stops []Stop `json:"stops,omitempty"`
|
||||
StopControllers []*TrailingStopController `json:"-"`
|
||||
}
|
||||
|
||||
func (s *StopSettings) SetupStopControllers(symbol string) error {
|
||||
for _, stop := range s.Stops {
|
||||
s.StopControllers = append(s.StopControllers,
|
||||
NewTrailingStopController(symbol, stop.TrailingStop),
|
||||
)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *StopSettings) RunStopControllers(ctx context.Context, session *bbgo.ExchangeSession, tradeCollector *bbgo.TradeCollector) {
|
||||
for _, stopController := range s.StopControllers {
|
||||
stopController.Run(ctx, session, tradeCollector)
|
||||
}
|
||||
}
|
||||
|
||||
func (s *StopSettings) Subscribe(session *bbgo.ExchangeSession) {
|
||||
for _, stopController := range s.StopControllers {
|
||||
stopController.Subscribe(session)
|
||||
}
|
||||
}
|
||||
|
|
@ -47,185 +47,6 @@ type BollingerSetting struct {
|
|||
BandWidth float64 `json:"bandWidth"`
|
||||
}
|
||||
|
||||
type TrailingStop struct {
|
||||
// CallbackRate is the callback rate from the previous high price
|
||||
CallbackRate fixedpoint.Value `json:"callbackRate,omitempty"`
|
||||
|
||||
// ClosePosition is a percentage of the position to be closed
|
||||
ClosePosition fixedpoint.Value `json:"closePosition,omitempty"`
|
||||
|
||||
// MinProfit is the percentage of the minimum profit ratio.
|
||||
// Stop order will be activiated only when the price reaches above this threshold.
|
||||
MinProfit fixedpoint.Value `json:"minProfit,omitempty"`
|
||||
|
||||
// Interval is the time resolution to update the stop order
|
||||
// KLine per Interval will be used for updating the stop order
|
||||
Interval types.Interval `json:"interval,omitempty"`
|
||||
|
||||
// Virtual is used when you don't want to place the real order on the exchange and lock the balance.
|
||||
// You want to handle the stop order by the strategy itself.
|
||||
Virtual bool `json:"virtual,omitempty"`
|
||||
}
|
||||
|
||||
type TrailingStopController struct {
|
||||
*TrailingStop
|
||||
|
||||
Symbol string
|
||||
|
||||
position *types.Position
|
||||
latestHigh float64
|
||||
averageCost fixedpoint.Value
|
||||
}
|
||||
|
||||
func NewTrailingStopController(symbol string, config *TrailingStop) *TrailingStopController {
|
||||
return &TrailingStopController{
|
||||
TrailingStop: config,
|
||||
Symbol: symbol,
|
||||
}
|
||||
}
|
||||
|
||||
func (c *TrailingStopController) Subscribe(session *bbgo.ExchangeSession) {
|
||||
session.Subscribe(types.KLineChannel, c.Symbol, types.SubscribeOptions{
|
||||
Interval: c.Interval.String(),
|
||||
})
|
||||
}
|
||||
|
||||
func (c *TrailingStopController) Run(ctx context.Context, session *bbgo.ExchangeSession, tradeCollector *bbgo.TradeCollector) {
|
||||
// store the position
|
||||
c.position = tradeCollector.Position()
|
||||
c.averageCost = c.position.AverageCost
|
||||
|
||||
// Use trade collector to get the position update event
|
||||
tradeCollector.OnPositionUpdate(func(position *types.Position) {
|
||||
// update average cost if we have it.
|
||||
c.averageCost = position.AverageCost
|
||||
})
|
||||
|
||||
session.MarketDataStream.OnKLineClosed(func(kline types.KLine) {
|
||||
if kline.Symbol != c.Symbol || kline.Interval != c.Interval {
|
||||
return
|
||||
}
|
||||
|
||||
closePrice := kline.Close
|
||||
|
||||
// update the latest high
|
||||
c.latestHigh = math.Max(closePrice, c.latestHigh)
|
||||
|
||||
if c.Virtual {
|
||||
// if average cost is updated, we can check min profit
|
||||
if c.averageCost == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
// skip dust position
|
||||
if c.position.Base.Abs().Float64() < c.position.Market.MinQuantity || c.position.Base.Abs().Float64()*closePrice < c.position.Market.MinNotional {
|
||||
return
|
||||
}
|
||||
|
||||
// if it's in the callback rate, we don't want to trigger stop
|
||||
if closePrice < c.latestHigh && changeRate(closePrice, c.latestHigh) < c.CallbackRate.Float64() {
|
||||
return
|
||||
}
|
||||
|
||||
// if the profit rate is defined, and it is less than our minimum profit rate, we skip stop
|
||||
if c.MinProfit > 0 &&
|
||||
(closePrice < c.averageCost.Float64() ||
|
||||
changeRate(closePrice, c.averageCost.Float64()) < c.MinProfit.Float64()) {
|
||||
return
|
||||
}
|
||||
|
||||
log.Infof("trailing stop emitted, latest high: %f, closed price: %f, average cost: %f, profit spread: %f",
|
||||
c.latestHigh,
|
||||
closePrice,
|
||||
c.averageCost.Float64(),
|
||||
closePrice-c.averageCost.Float64())
|
||||
|
||||
log.Infof("current position: %s", c.position.String())
|
||||
|
||||
marketOrder := c.position.NewClosePositionOrder(c.ClosePosition.Float64())
|
||||
if marketOrder != nil {
|
||||
log.Infof("submitting market order to stop: %+v", marketOrder)
|
||||
|
||||
// skip dust order
|
||||
if marketOrder.Quantity*closePrice < c.position.Market.MinNotional {
|
||||
log.Warnf("market order quote quantity %f < min notional %f, skip placing order", marketOrder.Quantity*closePrice, c.position.Market.MinNotional)
|
||||
return
|
||||
}
|
||||
|
||||
createdOrders, err := session.Exchange.SubmitOrders(ctx, *marketOrder)
|
||||
if err != nil {
|
||||
log.WithError(err).Errorf("stop market order place error")
|
||||
return
|
||||
}
|
||||
tradeCollector.OrderStore().Add(createdOrders...)
|
||||
tradeCollector.Process()
|
||||
|
||||
// reset the state
|
||||
c.latestHigh = 0.0
|
||||
}
|
||||
} else {
|
||||
// place stop order only when the closed price is greater than the current average cost
|
||||
if c.position != nil && c.MinProfit > 0 && c.averageCost > 0 &&
|
||||
closePrice > c.averageCost.Float64() &&
|
||||
changeRate(closePrice, c.averageCost.Float64()) >= c.MinProfit.Float64() {
|
||||
|
||||
stopPrice := c.averageCost.MulFloat64(1.0 + c.MinProfit.Float64())
|
||||
orderForm := c.GenerateStopOrder(stopPrice.Float64(), c.averageCost.Float64())
|
||||
if orderForm != nil {
|
||||
log.Infof("updating stop limit order to simulate trailing stop order...")
|
||||
createdOrders, err := session.Exchange.SubmitOrders(ctx, *orderForm)
|
||||
if err != nil {
|
||||
log.WithError(err).Errorf("stop order place error")
|
||||
}
|
||||
tradeCollector.OrderStore().Add(createdOrders...)
|
||||
tradeCollector.Process()
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func (c *TrailingStopController) GenerateStopOrder(stopPrice, price float64) *types.SubmitOrder {
|
||||
base := c.position.GetBase()
|
||||
if base == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
quantity := math.Abs(base.Float64())
|
||||
quoteQuantity := price * quantity
|
||||
|
||||
if c.ClosePosition > 0 {
|
||||
quantity = quantity * c.ClosePosition.Float64()
|
||||
}
|
||||
|
||||
// skip dust orders
|
||||
if quantity < c.position.Market.MinQuantity || quoteQuantity < c.position.Market.MinNotional {
|
||||
return nil
|
||||
}
|
||||
|
||||
side := types.SideTypeSell
|
||||
if base < 0 {
|
||||
side = types.SideTypeBuy
|
||||
}
|
||||
|
||||
return &types.SubmitOrder{
|
||||
Symbol: c.Symbol,
|
||||
Market: c.position.Market,
|
||||
Type: types.OrderTypeStopLimit,
|
||||
Side: side,
|
||||
StopPrice: stopPrice,
|
||||
Price: price,
|
||||
Quantity: quantity,
|
||||
}
|
||||
}
|
||||
|
||||
type FixedStop struct{}
|
||||
|
||||
type Stop struct {
|
||||
TrailingStop *TrailingStop `json:"trailingStop,omitempty"`
|
||||
FixedStop *FixedStop `json:"fixedStop,omitempty"`
|
||||
}
|
||||
|
||||
type Strategy struct {
|
||||
*bbgo.Graceful
|
||||
*bbgo.Notifiability
|
||||
|
|
@ -239,7 +60,7 @@ type Strategy struct {
|
|||
// Interval is how long do you want to update your order price and quantity
|
||||
Interval types.Interval `json:"interval"`
|
||||
|
||||
QuantityOrAmount
|
||||
bbgo.QuantityOrAmount
|
||||
|
||||
// Spread is the price spread from the middle price.
|
||||
// For ask orders, the ask price is ((bestAsk + bestBid) / 2 * (1.0 + spread))
|
||||
|
|
@ -308,7 +129,7 @@ type Strategy struct {
|
|||
ShadowProtection bool `json:"shadowProtection"`
|
||||
ShadowProtectionRatio fixedpoint.Value `json:"shadowProtectionRatio"`
|
||||
|
||||
Stops []Stop `json:"stops,omitempty"`
|
||||
StopSettings
|
||||
|
||||
session *bbgo.ExchangeSession
|
||||
book *types.StreamOrderBook
|
||||
|
|
@ -329,8 +150,6 @@ type Strategy struct {
|
|||
|
||||
// neutralBoll is the neutral price section
|
||||
neutralBoll *indicator.BOLL
|
||||
|
||||
stopControllers []*TrailingStopController
|
||||
}
|
||||
|
||||
func (s *Strategy) ID() string {
|
||||
|
|
@ -338,12 +157,7 @@ func (s *Strategy) ID() string {
|
|||
}
|
||||
|
||||
func (s *Strategy) Initialize() error {
|
||||
for _, stop := range s.Stops {
|
||||
s.stopControllers = append(s.stopControllers,
|
||||
NewTrailingStopController(s.Symbol, stop.TrailingStop),
|
||||
)
|
||||
}
|
||||
return nil
|
||||
return s.StopSettings.SetupStopControllers(s.Symbol)
|
||||
}
|
||||
|
||||
func (s *Strategy) Subscribe(session *bbgo.ExchangeSession) {
|
||||
|
|
@ -364,9 +178,7 @@ func (s *Strategy) Subscribe(session *bbgo.ExchangeSession) {
|
|||
})
|
||||
}
|
||||
|
||||
for _, stopController := range s.stopControllers {
|
||||
stopController.Subscribe(session)
|
||||
}
|
||||
s.StopSettings.Subscribe(session)
|
||||
}
|
||||
|
||||
func (s *Strategy) Validate() error {
|
||||
|
|
@ -743,9 +555,7 @@ func (s *Strategy) Run(ctx context.Context, orderExecutor bbgo.OrderExecutor, se
|
|||
|
||||
s.tradeCollector.BindStream(session.UserDataStream)
|
||||
|
||||
for _, stopController := range s.stopControllers {
|
||||
stopController.Run(ctx, session, s.tradeCollector)
|
||||
}
|
||||
s.StopSettings.RunStopControllers(ctx, session, s.tradeCollector)
|
||||
|
||||
session.UserDataStream.OnStart(func() {
|
||||
if s.UseTickerPrice {
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user