common

Documentation

Index

• func SyncActiveOrder(ctx context.Context, ex types.Exchange, ...) (isOrderUpdated bool, err error)
• func SyncActiveOrders(ctx context.Context, opts SyncActiveOrdersOpts) error
• type FeeBudget
  • func (f *FeeBudget) HandleTradeUpdate(trade types.Trade)
  • func (f *FeeBudget) Initialize()
  • func (f *FeeBudget) IsBudgetAllowed() bool
• type InventorySkew
  • func (s *InventorySkew) CalculateBidAskRatios(quantity fixedpoint.Value, price fixedpoint.Value, ...) *InventorySkewBidAskRatios
  • func (s *InventorySkew) Validate() error
• type InventorySkewBidAskRatios
• type ProfitFixer
  • func NewProfitFixer() *ProfitFixer
  • func (f *ProfitFixer) AddExchange(sessionName string, service types.ExchangeTradeHistoryService)
  • func (f *ProfitFixer) Fix(ctx context.Context, symbol string, since, until time.Time, ...) error
  • func (f *ProfitFixer) FixFromTrades(allTrades []types.Trade, stats *types.ProfitStats, position *types.Position) error
• type ProfitFixerBundle
  • func (f *ProfitFixerBundle) Fix(ctx context.Context, symbol string, position *types.Position, ...) error
• type ProfitFixerConfig
• type RiskController
• type State
  • func (s *State) IsOver24Hours() bool
  • func (s *State) Reset()
• type StatusCallbacks
  • func (c *StatusCallbacks) EmitClosed()
  • func (c *StatusCallbacks) EmitError(err error)
  • func (c *StatusCallbacks) EmitReady()
  • func (c *StatusCallbacks) OnClosed(cb func())
  • func (c *StatusCallbacks) OnError(cb func(err error))
  • func (c *StatusCallbacks) OnReady(cb func())
• type Strategy
  • func (s *Strategy) Initialize(ctx context.Context, environ *bbgo.Environment, session *bbgo.ExchangeSession, ...)
  • func (s *Strategy) IsHalted(t time.Time) bool
• type SyncActiveOrdersOpts

Functions

func SyncActiveOrder

func SyncActiveOrder(ctx context.Context, ex types.Exchange, orderQueryService types.ExchangeOrderQueryService, activeOrderBook *bbgo.ActiveOrderBook, orderID uint64, syncBefore time.Time) (isOrderUpdated bool, err error)

func SyncActiveOrders

func SyncActiveOrders(ctx context.Context, opts SyncActiveOrdersOpts) error

Types

type FeeBudget

type FeeBudget struct {
	DailyFeeBudgets map[string]fixedpoint.Value `json:"dailyFeeBudgets,omitempty"`
	State           *State                      `persistence:"state"`
	// contains filtered or unexported fields
}

func (*FeeBudget) HandleTradeUpdate

func (f *FeeBudget) HandleTradeUpdate(trade types.Trade)

func (*FeeBudget) Initialize

func (f *FeeBudget) Initialize()

func (*FeeBudget) IsBudgetAllowed

func (f *FeeBudget) IsBudgetAllowed() bool

type InventorySkew

type InventorySkew struct {
	InventoryRangeMultiplier fixedpoint.Value `json:"inventoryRangeMultiplier"`
	TargetBaseRatio          fixedpoint.Value `json:"targetBaseRatio"`
}

https://hummingbot.org/strategy-configs/inventory-skew/ https://github.com/hummingbot/hummingbot/blob/31fc61d5e71b2c15732142d30983f3ea2be4d466/hummingbot/strategy/pure_market_making/inventory_skew_calculator.pyx

func (*InventorySkew) CalculateBidAskRatios

func (s *InventorySkew) CalculateBidAskRatios(quantity fixedpoint.Value, price fixedpoint.Value, baseBalance fixedpoint.Value, quoteBalance fixedpoint.Value) *InventorySkewBidAskRatios

func (*InventorySkew) Validate

func (s *InventorySkew) Validate() error

type InventorySkewBidAskRatios

type InventorySkewBidAskRatios struct {
	BidRatio fixedpoint.Value
	AskRatio fixedpoint.Value
}

type ProfitFixer

type ProfitFixer struct {
	core.ConverterManager
	// contains filtered or unexported fields
}

ProfitFixer implements a trade-history-based profit fixer

func NewProfitFixer

func NewProfitFixer() *ProfitFixer

func (*ProfitFixer) AddExchange

func (f *ProfitFixer) AddExchange(sessionName string, service types.ExchangeTradeHistoryService)

func (*ProfitFixer) Fix

func (f *ProfitFixer) Fix(
	ctx context.Context, symbol string, since, until time.Time, stats *types.ProfitStats, position *types.Position,
) error

func (*ProfitFixer) FixFromTrades

func (f *ProfitFixer) FixFromTrades(allTrades []types.Trade, stats *types.ProfitStats, position *types.Position) error

type ProfitFixerBundle

type ProfitFixerBundle struct {
	ProfitFixerConfig *ProfitFixerConfig `json:"profitFixer,omitempty"`
}

func (*ProfitFixerBundle) Fix

func (f *ProfitFixerBundle) Fix(
	ctx context.Context,
	symbol string,
	position *types.Position,
	profitStats *types.ProfitStats,
	sessions ...*bbgo.ExchangeSession,
) error

type ProfitFixerConfig

type ProfitFixerConfig struct {
	TradesSince types.Time `json:"tradesSince,omitempty"`
}

ProfitFixerConfig is used for fixing profitStats and position by re-playing the trade history

type RiskController

type RiskController struct {
	PositionHardLimit         fixedpoint.Value     `json:"positionHardLimit"`
	MaxPositionQuantity       fixedpoint.Value     `json:"maxPositionQuantity"`
	CircuitBreakLossThreshold fixedpoint.Value     `json:"circuitBreakLossThreshold"`
	CircuitBreakEMA           types.IntervalWindow `json:"circuitBreakEMA"`
	// contains filtered or unexported fields
}

type State

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

func (*State) IsOver24Hours

func (s *State) IsOver24Hours() bool

func (*State) Reset

func (s *State) Reset()

type StatusCallbacks

type StatusCallbacks struct {
	// contains filtered or unexported fields
}

func (*StatusCallbacks) EmitClosed

func (c *StatusCallbacks) EmitClosed()

func (*StatusCallbacks) EmitError

func (c *StatusCallbacks) EmitError(err error)

func (*StatusCallbacks) EmitReady

func (c *StatusCallbacks) EmitReady()

func (*StatusCallbacks) OnClosed

func (c *StatusCallbacks) OnClosed(cb func())

func (*StatusCallbacks) OnError

func (c *StatusCallbacks) OnError(cb func(err error))

func (*StatusCallbacks) OnReady

func (c *StatusCallbacks) OnReady(cb func())

type Strategy

type Strategy struct {
	Position    *types.Position    `json:"position,omitempty" persistence:"position"`
	ProfitStats *types.ProfitStats `json:"profitStats,omitempty" persistence:"profit_stats"`

	Environ       *bbgo.Environment
	Session       *bbgo.ExchangeSession
	OrderExecutor *bbgo.GeneralOrderExecutor

	RiskController
	// contains filtered or unexported fields
}

Strategy provides the core functionality that is required by a long/short strategy.

func (*Strategy) Initialize

func (s *Strategy) Initialize(ctx context.Context, environ *bbgo.Environment, session *bbgo.ExchangeSession, market types.Market, strategyID, instanceID string)

func (*Strategy) IsHalted

func (s *Strategy) IsHalted(t time.Time) bool

type SyncActiveOrdersOpts

type SyncActiveOrdersOpts struct {
	Logger            *logrus.Entry
	Exchange          types.Exchange
	OrderQueryService types.ExchangeOrderQueryService
	ActiveOrderBook   *bbgo.ActiveOrderBook
	OpenOrders        []types.Order
}