mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-17 07:26:48 +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
81 lines
3.9 KiB
Markdown
81 lines
3.9 KiB
Markdown
# GoCryptoTrader package Subscription
|
|
|
|
<img src="/common/gctlogo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
|
|
[](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader/exchanges/subscription)
|
|
[](https://codecov.io/gh/thrasher-corp/gocryptotrader)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
|
|
This subscription 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 our [GoCryptoTrader Kanban board](https://github.com/orgs/thrasher-corp/projects/3).
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/zt-38z8abs3l-gH8AAOk8XND6DP5NfCiG_g)
|
|
|
|
# Exchange Subscriptions
|
|
|
|
Exchange Subscriptions are streams of data delivered via websocket.
|
|
|
|
GoCryptoTrader engine will subscribe automatically to configured channels.
|
|
A subset of exchanges currently support user configured channels, with the remaining using hardcoded defaults.
|
|
See configuration Features.Subscriptions for whether an exchange is configurable.
|
|
|
|
## Templating
|
|
|
|
Exchange Contributors should implement `GetSubscriptionTemplate` to return a text/template Template.
|
|
|
|
Exchanges are free to implement template caching, a map or a mono-template, inline or file templates.
|
|
|
|
The template is provided with a single context structure:
|
|
```go
|
|
S *subscription.Subscription
|
|
AssetPairs map[asset.Item]currency.Pairs
|
|
AssetSeparator string
|
|
PairSeparator string
|
|
BatchSize string
|
|
```
|
|
|
|
Subscriptions may fan out many channels for assets and pairs, to support exchanges which require individual subscriptions.
|
|
To allow the template to communicate how to handle its output it should use the provided directives:
|
|
- AssetSeparator should be added at the end of each section related to assets
|
|
- PairSeparator should be added at the end of each pair
|
|
- BatchSize should be added with a number directly before AssetSeparator to indicate pairs have been batched
|
|
|
|
Example:
|
|
```
|
|
{{- range $asset, $pairs := $.AssetPairs }}
|
|
{{- range $b := batch $pairs 30 -}}
|
|
{{- $.S.Channel -}} : {{- $b.Join -}}
|
|
{{ $.PairSeparator }}
|
|
{{- end -}}
|
|
{{- $.BatchSize -}} 30
|
|
{{- $.AssetSeparator }}
|
|
{{- end }}
|
|
```
|
|
|
|
Assets and pairs should be output in the sequence in AssetPairs since text/template range function uses an sorted order for map keys.
|
|
|
|
Template functions may modify AssetPairs to update the subscription's pairs, e.g. Filtering out margin pairs already in spot subscription.
|
|
|
|
We use separators like this because it allows mono-templates to decide at runtime whether to fan out.
|
|
|
|
See exchanges/subscription/testdata/subscriptions.tmpl for an example mono-template showcasing various features.
|
|
|
|
Templates do not need to worry about joining around separators; Trailing separators will be stripped automatically.
|
|
|
|
Template functions should panic to handle errors. They are caught by text/template and turned into errors for use in `subscription.expandTemplate`.
|
|
|
|
## Donations
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
|
|
|
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
|
|
|
|
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***
|