mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 15:09:42 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
27 lines
1.1 KiB
Cheetah
27 lines
1.1 KiB
Cheetah
{{define "backtester plugins strategies" -}}
|
|
{{template "backtester-header" .}}
|
|
## {{.CapitalName}} package overview
|
|
|
|
### Designing a strategy
|
|
- File must contain `main` package
|
|
- Custom strategy plugins must adhere to the strategy.Handler interface. See the [strategy.Handler interface documentation](./backtester/eventhandlers/strategies/README.md) 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](./backtester/plugins/README.md) 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 a strategy you will need to use the following flags when running the GoCryptoTrader Backtester:
|
|
|
|
```bash
|
|
./backtester -strategypluginpath="path/to/strategy/example.so"
|
|
```
|
|
|
|
Upon startup, the GoCryptoTrader Backtester will load the strategy and run it for all events.
|
|
|
|
{{template "donations" .}}
|
|
{{end}} |