template

README

bbgo-template

This is an example of how to deploy your BBGO strategy on GitHub self-hosted runner.

Usage

1. Fork this repository.
2. Edit bbgo.yaml, which is the strategy configuration file, and deploy.yaml, which is the deployment configuration file located in the .github/workflows directory.
3. Follow the instructions to add the self-hosted runner to your repository.

Documentation

Index

• Constants
• type Strategy
  • func (s *Strategy) ID() string
  • func (s *Strategy) Initialize() error
  • func (s *Strategy) Run(ctx context.Context, orderExecutor bbgo.OrderExecutor, ...) error
  • func (s *Strategy) Subscribe(session *bbgo.ExchangeSession)
  • func (s *Strategy) Validate() error

Constants

const ID = "template"

Types

type Strategy

type Strategy struct {
	Symbol   string         `json:"symbol"`
	Interval types.Interval `json:"interval"`
}

func (*Strategy) ID

func (s *Strategy) ID() string

func (*Strategy) Initialize

func (s *Strategy) Initialize() error

func (*Strategy) Run

func (s *Strategy) Run(ctx context.Context, orderExecutor bbgo.OrderExecutor, session *bbgo.ExchangeSession) error

func (*Strategy) Subscribe

func (s *Strategy) Subscribe(session *bbgo.ExchangeSession)

func (*Strategy) Validate

func (s *Strategy) Validate() error