example

README

GoCryptoTrader Backtester: Example package

This example 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

Example package overview

This is a custom strategy for the GoCryptoTrader Backtester. It is a simple example of a strategy that trades a pair of assets and is used to highlight how strategies can be loaded from external sources.

Designing a strategy

• File must contain main package.
• Custom strategy plugins must adhere to the strategy.Handler interface. See the strategy.Handler interface documentation for more information.
• Must contain function func GetStrategies() []strategy.Handler to return a slice of implemented strategy.Handler.
  • If only using one custom strategy, can simply return []strategy.Handler{&customStrategy{}}.

Building

See here for details on how to build the plugin file.

Running

Plugins can only be loaded via Linux, macOS and WSL. Windows itself is not supported.

To run this strategy you will need to use the following flags when running the GoCryptoTrader Backtester:

./backtester -strategypluginpath="path/to/strategy/example.so"

To run this specific example strategy, use:

./backtester --strategypluginpath="./plugins/strategies/example/example.so"

Upon startup, the GoCryptoTrader Backtester will load the strategy and run it for all events.

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