mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-14 07:26:47 +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
20 lines
1.2 KiB
Cheetah
20 lines
1.2 KiB
Cheetah
{{define "engine sync_manager" -}}
|
|
{{template "header" .}}
|
|
## Current Features for {{.CapitalName}}
|
|
+ The currency pair syncer subsystem is used to keep all trades, tickers and orderbooks up to date for all enabled exchange asset currency pairs
|
|
+ It can sync data via a websocket connection or REST and will switch between them if there has been no updates
|
|
+ In order to modify the behaviour of the currency pair syncer subsystem, you can change runtime parameters as detailed below:
|
|
|
|
| Config | Description | Example |
|
|
| ------ | ----------- | ------- |
|
|
| syncmanager | Determines whether the subsystem is enabled | `true` |
|
|
| tickersync | Enables ticker syncing for all enabled exchanges | `true`|
|
|
| orderbooksync | Enables orderbook syncing for all enabled exchanges | `true` |
|
|
| tradesync | Enables trade syncing for all enabled exchanges | `true` |
|
|
| syncworkers | The amount of workers (goroutines) to use for syncing exchange data | `15` |
|
|
| synccontinuously | Whether to sync exchange data continuously (ticker, orderbook and trades) | `true` |
|
|
| synctimeout | The amount of time in golang `time.Duration` format before the syncer will switch from one protocol to the other (e.g. from REST to websocket) | `15000000000` |
|
|
|
|
{{template "donations" .}}
|
|
{{end}}
|