Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REFACTOR: daily data tracker #1658

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 17 additions & 36 deletions pkg/strategy/common/fee_budget.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@ package common

import (
"sync"
"time"

"github.com/c9s/bbgo/pkg/fixedpoint"
"github.com/c9s/bbgo/pkg/types"
"github.com/c9s/bbgo/pkg/util"
log "github.com/sirupsen/logrus"
)

type FeeBudget struct {
DailyFeeBudgets map[string]fixedpoint.Value `json:"dailyFeeBudgets,omitempty"`
State *State `persistence:"state"`
DailyFeeTracker *util.DailyDataTracker `persistence:"dailyFeeTracker"`

mu sync.Mutex
}

func (f *FeeBudget) Initialize() {
if f.State == nil {
f.State = &State{}
f.State.Reset()
if f.DailyFeeTracker == nil {
f.DailyFeeTracker = &util.DailyDataTracker{}
f.DailyFeeTracker.Reset()
}

if f.State.IsOver24Hours() {
if f.DailyFeeTracker.IsOver24Hours() {
log.Warn("[FeeBudget] state is over 24 hours, resetting to zero")
f.State.Reset()
f.DailyFeeTracker.Reset()
}
}

Expand All @@ -33,17 +33,17 @@ func (f *FeeBudget) IsBudgetAllowed() bool {
return true
}

if f.State.AccumulatedFees == nil {
if f.DailyFeeTracker.Data == nil {
return true
}

if f.State.IsOver24Hours() {
f.State.Reset()
if f.DailyFeeTracker.IsOver24Hours() {
f.DailyFeeTracker.Reset()
return true
}

for asset, budget := range f.DailyFeeBudgets {
if fee, ok := f.State.AccumulatedFees[asset]; ok {
if fee, ok := f.DailyFeeTracker.Data[asset]; ok {
if fee.Compare(budget) >= 0 {
log.Warnf("[FeeBudget] accumulative fee %s exceeded the fee budget %s, skipping...", fee.String(), budget.String())
return false
Expand All @@ -57,36 +57,17 @@ func (f *FeeBudget) IsBudgetAllowed() bool {
func (f *FeeBudget) HandleTradeUpdate(trade types.Trade) {
log.Infof("[FeeBudget] received trade %s", trade.String())

if f.State.IsOver24Hours() {
f.State.Reset()
if f.DailyFeeTracker.IsOver24Hours() {
f.DailyFeeTracker.Reset()
}

// safe check
if f.State.AccumulatedFees == nil {
if f.DailyFeeTracker.Data == nil {
f.mu.Lock()
f.State.AccumulatedFees = make(map[string]fixedpoint.Value)
f.DailyFeeTracker.Data = make(map[string]fixedpoint.Value)
f.mu.Unlock()
}

f.State.AccumulatedFees[trade.FeeCurrency] = f.State.AccumulatedFees[trade.FeeCurrency].Add(trade.Fee)
log.Infof("[FeeBudget] accumulated fee: %s %s", f.State.AccumulatedFees[trade.FeeCurrency].String(), trade.FeeCurrency)
}

type State struct {
AccumulatedFeeStartedAt time.Time `json:"accumulatedFeeStartedAt,omitempty"`
AccumulatedFees map[string]fixedpoint.Value `json:"accumulatedFees,omitempty"`
}

func (s *State) IsOver24Hours() bool {
return time.Since(s.AccumulatedFeeStartedAt) >= 24*time.Hour
}

func (s *State) Reset() {
t := time.Now()
dateTime := time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())

log.Infof("[State] resetting accumulated started time to: %s", dateTime)

s.AccumulatedFeeStartedAt = dateTime
s.AccumulatedFees = make(map[string]fixedpoint.Value)
f.DailyFeeTracker.Data[trade.FeeCurrency] = f.DailyFeeTracker.Data[trade.FeeCurrency].Add(trade.Fee)
log.Infof("[FeeBudget] accumulated fee: %s %s", f.DailyFeeTracker.Data[trade.FeeCurrency].String(), trade.FeeCurrency)
}
2 changes: 1 addition & 1 deletion pkg/strategy/common/fee_budget_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func TestFeeBudget(t *testing.T) {
assert.Equal(t, c.expected, feeBudget.IsBudgetAllowed())

// test reset
feeBudget.State.AccumulatedFeeStartedAt = feeBudget.State.AccumulatedFeeStartedAt.Add(-24 * time.Hour)
feeBudget.DailyFeeTracker.StartedAt = feeBudget.DailyFeeTracker.StartedAt.Add(-24 * time.Hour)
assert.True(t, feeBudget.IsBudgetAllowed())
}
}
35 changes: 35 additions & 0 deletions pkg/util/daily_data_tracker.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package util

import (
"time"

"github.com/c9s/bbgo/pkg/types"
log "github.com/sirupsen/logrus"
)

type DailyDataTracker struct {
StartedAt time.Time `json:"startedAt,omitempty"`
Data types.ValueMap `json:"data,omitempty"`
}

func (d *DailyDataTracker) IsOver24Hours() bool {
return time.Since(d.StartedAt) >= 24*time.Hour
}

func (d *DailyDataTracker) ResetTime() {
t := time.Now()
dateTime := time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())

log.Infof("[Countdown] resetting accumulated started time to: %s", dateTime)

d.StartedAt = dateTime
}

func (d *DailyDataTracker) ResetData() {
d.Data = make(types.ValueMap)
}

func (d *DailyDataTracker) Reset() {
d.ResetTime()
d.ResetData()
}
Loading