base

package
v0.0.0-...-ae86ed1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2022 License: MIT Imports: 5 Imported by: 0

README

GoCryptoTrader Backtester: Base package

Build Status Software License GoDoc Coverage Status Go Report Card

This base package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Base package overview

The strategy base file has basic implementations of the strategies.Handler interface. Add any functions that can be used across all strategies here.

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrCustomSettingsUnsupported          = errors.New("custom settings not supported")
	ErrSimultaneousProcessingNotSupported = errors.New("does not support simultaneous processing and could not be loaded")
	ErrStrategyNotFound                   = errors.New("not found. Please ensure the strategy-settings field 'name' is spelled properly in your .start config")
	ErrInvalidCustomSettings              = errors.New("invalid custom settings in config")
	ErrTooMuchBadData                     = errors.New("backtesting cannot continue as there is too much invalid data. Please review your dataset")
)

Error vars related to strategies and invalid config settings

Functions

This section is empty.

Types

type Strategy

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

Strategy is base implementation of the Handler interface

func (*Strategy) GetBaseData

func (s *Strategy) GetBaseData(d data.Handler) (signal.Signal, error)

GetBaseData returns the non-interface version of the Handler

func (*Strategy) SetSimultaneousProcessing

func (s *Strategy) SetSimultaneousProcessing(b bool)

SetSimultaneousProcessing sets whether multiple currencies can be assessed in one go

func (*Strategy) UseSimultaneousProcessing

func (s *Strategy) UseSimultaneousProcessing() bool

UseSimultaneousProcessing returns whether multiple currencies can be assessed in one go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL