d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-13 15:09:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

cmd/exchange_template: Update wrapper template, improve documentation (#2009)

Browse Source 
* Updating wrapper template, updating documentation, regenerating documentation

* Renaming "streaming api" to "websocket"

* Context is now t

* Update docs/ADD_NEW_EXCHANGE.md

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

* Update cmd/documentation/root_templates/root_readme.tmpl

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

* Fixes an improper example and regenerates documentation

* Corrects typos

* Makes a table label consistent across files

---------

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>
This commit is contained in:
cranktakular
2025-11-11 11:07:26 +11:00
committed by GitHub
parent 6077707690
commit 2fd4f5ec5b
54 changed files with 145 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
CONTRIBUTORS
View File

@@ -10,33 +10,33 @@ xtda | https://github.com/xtda
lrascao | https://github.com/lrascao lrascao | https://github.com/lrascao
Beadko | https://github.com/Beadko Beadko | https://github.com/Beadko
samuael | https://github.com/samuael samuael | https://github.com/samuael
ydm | https://github.com/ydm
vazha | https://github.com/vazha vazha | https://github.com/vazha
ydm | https://github.com/ydm
Rots | https://github.com/Rots Rots | https://github.com/Rots
ermalguni | https://github.com/ermalguni ermalguni | https://github.com/ermalguni
MadCozBadd | https://github.com/MadCozBadd MadCozBadd | https://github.com/MadCozBadd
Copilot | https://github.com/apps/copilot-swe-agent
vadimzhukck | https://github.com/vadimzhukck vadimzhukck | https://github.com/vadimzhukck
junnplus | https://github.com/junnplus junnplus | https://github.com/junnplus
geseq | https://github.com/geseq geseq | https://github.com/geseq
marcofranssen | https://github.com/marcofranssen marcofranssen | https://github.com/marcofranssen
140am | https://github.com/140am 140am | https://github.com/140am
TaltaM | https://github.com/TaltaM
cranktakular | https://github.com/cranktakular cranktakular | https://github.com/cranktakular
TaltaM | https://github.com/TaltaM
dackroyd | https://github.com/dackroyd dackroyd | https://github.com/dackroyd
khcchiu | https://github.com/khcchiu khcchiu | https://github.com/khcchiu
yangrq1018 | https://github.com/yangrq1018 yangrq1018 | https://github.com/yangrq1018
crackcomm | https://github.com/crackcomm
romanornr | https://github.com/romanornr
woshidama323 | https://github.com/woshidama323 woshidama323 | https://github.com/woshidama323
Copilot | https://github.com/apps/copilot-swe-agent romanornr | https://github.com/romanornr
mshogin | https://github.com/mshogin crackcomm | https://github.com/crackcomm
herenow | https://github.com/herenow
tk42 | https://github.com/tk42
soxipy | https://github.com/soxipy
Asalei | https://github.com/Asalei
lozdog245 | https://github.com/lozdog245
if1live | https://github.com/if1live
azhang | https://github.com/azhang azhang | https://github.com/azhang
if1live | https://github.com/if1live
lozdog245 | https://github.com/lozdog245
Asalei | https://github.com/Asalei
soxipy | https://github.com/soxipy
tk42 | https://github.com/tk42
herenow | https://github.com/herenow
mshogin | https://github.com/mshogin
andreygrehov | https://github.com/andreygrehov andreygrehov | https://github.com/andreygrehov
bretep | https://github.com/bretep bretep | https://github.com/bretep
Christian-Achilli | https://github.com/Christian-Achilli Christian-Achilli | https://github.com/Christian-Achilli
@@ -44,8 +44,8 @@ dsinuela-taurus | https://github.com/dsinuela-taurus
cornelk | https://github.com/cornelk cornelk | https://github.com/cornelk
gam-phon | https://github.com/gam-phon gam-phon | https://github.com/gam-phon
MarkDzulko | https://github.com/MarkDzulko MarkDzulko | https://github.com/MarkDzulko
mortensorensen | https://github.com/mortensorensen MathieuCesbron | https://github.com/MathieuCesbron
cavapoo2 | https://github.com/cavapoo2 aidan-bailey | https://github.com/aidan-bailey
tongxiaofeng | https://github.com/tongxiaofeng tongxiaofeng | https://github.com/tongxiaofeng
tonywangcn | https://github.com/tonywangcn tonywangcn | https://github.com/tonywangcn
varunbhat | https://github.com/varunbhat varunbhat | https://github.com/varunbhat
@@ -55,17 +55,21 @@ vyloy | https://github.com/vyloy
arttobe | https://github.com/arttobe arttobe | https://github.com/arttobe
shoman4eg | https://github.com/shoman4eg shoman4eg | https://github.com/shoman4eg
cangqiaoyuzhuo | https://github.com/cangqiaoyuzhuo cangqiaoyuzhuo | https://github.com/cangqiaoyuzhuo
dazi005 | https://github.com/dazi005
gcmutator | https://github.com/gcmutator gcmutator | https://github.com/gcmutator
gopherorg | https://github.com/gopherorg gopherorg | https://github.com/gopherorg
yuhangcangqian | https://github.com/yuhangcangqian
whilei | https://github.com/whilei whilei | https://github.com/whilei
xiiiew | https://github.com/xiiiew yuhangcangqian | https://github.com/yuhangcangqian
keeghcet | https://github.com/keeghcet
mickychang9 | https://github.com/mickychang9
phieudu241 | https://github.com/phieudu241 phieudu241 | https://github.com/phieudu241
quantpoet | https://github.com/quantpoet
snipesjr | https://github.com/snipesjr snipesjr | https://github.com/snipesjr
snussik | https://github.com/snussik snussik | https://github.com/snussik
taewdy | https://github.com/taewdy taewdy | https://github.com/taewdy
threehonor | https://github.com/threehonor threehonor | https://github.com/threehonor
aidan-bailey | https://github.com/aidan-bailey xiiiew | https://github.com/xiiiew
youzichuan | https://github.com/youzichuan
antonzhukov | https://github.com/antonzhukov antonzhukov | https://github.com/antonzhukov
blombard | https://github.com/blombard blombard | https://github.com/blombard
CodeLingoBot | https://github.com/CodeLingoBot CodeLingoBot | https://github.com/CodeLingoBot
@@ -89,5 +93,8 @@ mattkanwisher | https://github.com/mattkanwisher
mgravitt | https://github.com/mgravitt mgravitt | https://github.com/mgravitt
mKurrels | https://github.com/mKurrels mKurrels | https://github.com/mKurrels
m1kola | https://github.com/m1kola m1kola | https://github.com/m1kola
mortensorensen | https://github.com/mortensorensen
Polizo96 | https://github.com/Polizo96
cavapoo2 | https://github.com/cavapoo2
idoall | https://github.com/idoall idoall | https://github.com/idoall
starit | https://github.com/starit starit | https://github.com/starit

56
README.md
View File

@@ -16,7 +16,8 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
## Exchange Support Table ## Exchange Support Table
| Exchange | REST API | Streaming API | FIX API | | Exchange | REST API | Websocket API | FIX API |
``
|----------|------|-----------|-----| |----------|------|-----------|-----|
| Binance.US| Yes | Yes | NA | | Binance.US| Yes | Yes | NA |
| Binance| Yes | Yes | NA | | Binance| Yes | Yes | NA |
@@ -149,43 +150,43 @@ Binaries will be published once the codebase reaches a stable condition.
|User|Contribution Amount| |User|Contribution Amount|
|--|--| |--|--|
| [thrasher-](https://github.com/thrasher-) | 731 | | [thrasher-](https://github.com/thrasher-) | 737 |
| [dependabot[bot]](https://github.com/apps/dependabot) | 386 | | [dependabot[bot]](https://github.com/apps/dependabot) | 415 |
| [shazbert](https://github.com/shazbert) | 374 | | [shazbert](https://github.com/shazbert) | 389 |
| [gloriousCode](https://github.com/gloriousCode) | 237 | | [gloriousCode](https://github.com/gloriousCode) | 240 |
| [gbjk](https://github.com/gbjk) | 133 | | [gbjk](https://github.com/gbjk) | 143 |
| [dependabot-preview[bot]](https://github.com/apps/dependabot-preview) | 88 | | [dependabot-preview[bot]](https://github.com/apps/dependabot-preview) | 88 |
| [xtda](https://github.com/xtda) | 47 | | [xtda](https://github.com/xtda) | 47 |
| [lrascao](https://github.com/lrascao) | 27 | | [lrascao](https://github.com/lrascao) | 27 |
| [Beadko](https://github.com/Beadko) | 24 | | [Beadko](https://github.com/Beadko) | 24 |
| [samuael](https://github.com/samuael) | 15 | | [samuael](https://github.com/samuael) | 16 |
| [ydm](https://github.com/ydm) | 15 |
| [vazha](https://github.com/vazha) | 15 | | [vazha](https://github.com/vazha) | 15 |
| [ydm](https://github.com/ydm) | 15 |
| [Rots](https://github.com/Rots) | 15 | | [Rots](https://github.com/Rots) | 15 |
| [ermalguni](https://github.com/ermalguni) | 14 | | [ermalguni](https://github.com/ermalguni) | 14 |
| [MadCozBadd](https://github.com/MadCozBadd) | 13 | | [MadCozBadd](https://github.com/MadCozBadd) | 13 |
| [Copilot](https://github.com/apps/copilot-swe-agent) | 13 |
| [vadimzhukck](https://github.com/vadimzhukck) | 10 | | [vadimzhukck](https://github.com/vadimzhukck) | 10 |
| [junnplus](https://github.com/junnplus) | 9 | | [junnplus](https://github.com/junnplus) | 9 |
| [geseq](https://github.com/geseq) | 8 | | [geseq](https://github.com/geseq) | 8 |
| [marcofranssen](https://github.com/marcofranssen) | 8 | | [marcofranssen](https://github.com/marcofranssen) | 8 |
| [140am](https://github.com/140am) | 8 | | [140am](https://github.com/140am) | 8 |
| [cranktakular](https://github.com/cranktakular) | 7 |
| [TaltaM](https://github.com/TaltaM) | 6 | | [TaltaM](https://github.com/TaltaM) | 6 |
| [cranktakular](https://github.com/cranktakular) | 6 |
| [dackroyd](https://github.com/dackroyd) | 5 | | [dackroyd](https://github.com/dackroyd) | 5 |
| [khcchiu](https://github.com/khcchiu) | 5 | | [khcchiu](https://github.com/khcchiu) | 5 |
| [yangrq1018](https://github.com/yangrq1018) | 4 | | [yangrq1018](https://github.com/yangrq1018) | 4 |
| [crackcomm](https://github.com/crackcomm) | 3 |
| [romanornr](https://github.com/romanornr) | 3 |
| [woshidama323](https://github.com/woshidama323) | 3 | | [woshidama323](https://github.com/woshidama323) | 3 |
| [Copilot](https://github.com/apps/copilot-swe-agent) | 3 | | [romanornr](https://github.com/romanornr) | 3 |
| [mshogin](https://github.com/mshogin) | 2 | | [crackcomm](https://github.com/crackcomm) | 3 |
| [herenow](https://github.com/herenow) | 2 |
| [tk42](https://github.com/tk42) | 2 |
| [soxipy](https://github.com/soxipy) | 2 |
| [Asalei](https://github.com/Asalei) | 2 |
| [lozdog245](https://github.com/lozdog245) | 2 |
| [if1live](https://github.com/if1live) | 2 |
| [azhang](https://github.com/azhang) | 2 | | [azhang](https://github.com/azhang) | 2 |
| [if1live](https://github.com/if1live) | 2 |
| [lozdog245](https://github.com/lozdog245) | 2 |
| [Asalei](https://github.com/Asalei) | 2 |
| [soxipy](https://github.com/soxipy) | 2 |
| [tk42](https://github.com/tk42) | 2 |
| [herenow](https://github.com/herenow) | 2 |
| [mshogin](https://github.com/mshogin) | 2 |
| [andreygrehov](https://github.com/andreygrehov) | 2 | | [andreygrehov](https://github.com/andreygrehov) | 2 |
| [bretep](https://github.com/bretep) | 2 | | [bretep](https://github.com/bretep) | 2 |
| [Christian-Achilli](https://github.com/Christian-Achilli) | 2 | | [Christian-Achilli](https://github.com/Christian-Achilli) | 2 |
@@ -193,8 +194,8 @@ Binaries will be published once the codebase reaches a stable condition.
| [cornelk](https://github.com/cornelk) | 2 | | [cornelk](https://github.com/cornelk) | 2 |
| [gam-phon](https://github.com/gam-phon) | 2 | | [gam-phon](https://github.com/gam-phon) | 2 |
| [MarkDzulko](https://github.com/MarkDzulko) | 2 | | [MarkDzulko](https://github.com/MarkDzulko) | 2 |
| [mortensorensen](https://github.com/mortensorensen) | 1 | | [MathieuCesbron](https://github.com/MathieuCesbron) | 2 |
| [cavapoo2](https://github.com/cavapoo2) | 1 | | [aidan-bailey](https://github.com/aidan-bailey) | 1 |
| [tongxiaofeng](https://github.com/tongxiaofeng) | 1 | | [tongxiaofeng](https://github.com/tongxiaofeng) | 1 |
| [tonywangcn](https://github.com/tonywangcn) | 1 | | [tonywangcn](https://github.com/tonywangcn) | 1 |
| [varunbhat](https://github.com/varunbhat) | 1 | | [varunbhat](https://github.com/varunbhat) | 1 |
@@ -204,17 +205,21 @@ Binaries will be published once the codebase reaches a stable condition.
| [arttobe](https://github.com/arttobe) | 1 | | [arttobe](https://github.com/arttobe) | 1 |
| [shoman4eg](https://github.com/shoman4eg) | 1 | | [shoman4eg](https://github.com/shoman4eg) | 1 |
| [cangqiaoyuzhuo](https://github.com/cangqiaoyuzhuo) | 1 | | [cangqiaoyuzhuo](https://github.com/cangqiaoyuzhuo) | 1 |
| [dazi005](https://github.com/dazi005) | 1 |
| [gcmutator](https://github.com/gcmutator) | 1 | | [gcmutator](https://github.com/gcmutator) | 1 |
| [gopherorg](https://github.com/gopherorg) | 1 | | [gopherorg](https://github.com/gopherorg) | 1 |
| [yuhangcangqian](https://github.com/yuhangcangqian) | 1 |
| [whilei](https://github.com/whilei) | 1 | | [whilei](https://github.com/whilei) | 1 |
| [xiiiew](https://github.com/xiiiew) | 1 | | [yuhangcangqian](https://github.com/yuhangcangqian) | 1 |
| [keeghcet](https://github.com/keeghcet) | 1 |
| [mickychang9](https://github.com/mickychang9) | 1 |
| [phieudu241](https://github.com/phieudu241) | 1 | | [phieudu241](https://github.com/phieudu241) | 1 |
| [quantpoet](https://github.com/quantpoet) | 1 |
| [snipesjr](https://github.com/snipesjr) | 1 | | [snipesjr](https://github.com/snipesjr) | 1 |
| [snussik](https://github.com/snussik) | 1 | | [snussik](https://github.com/snussik) | 1 |
| [taewdy](https://github.com/taewdy) | 1 | | [taewdy](https://github.com/taewdy) | 1 |
| [threehonor](https://github.com/threehonor) | 1 | | [threehonor](https://github.com/threehonor) | 1 |
| [aidan-bailey](https://github.com/aidan-bailey) | 1 | | [xiiiew](https://github.com/xiiiew) | 1 |
| [youzichuan](https://github.com/youzichuan) | 1 |
| [antonzhukov](https://github.com/antonzhukov) | 1 | | [antonzhukov](https://github.com/antonzhukov) | 1 |
| [blombard](https://github.com/blombard) | 1 | | [blombard](https://github.com/blombard) | 1 |
| [CodeLingoBot](https://github.com/CodeLingoBot) | 1 | | [CodeLingoBot](https://github.com/CodeLingoBot) | 1 |
@@ -238,5 +243,8 @@ Binaries will be published once the codebase reaches a stable condition.
| [mgravitt](https://github.com/mgravitt) | 1 | | [mgravitt](https://github.com/mgravitt) | 1 |
| [mKurrels](https://github.com/mKurrels) | 1 | | [mKurrels](https://github.com/mKurrels) | 1 |
| [m1kola](https://github.com/m1kola) | 1 | | [m1kola](https://github.com/m1kola) | 1 |
| [mortensorensen](https://github.com/mortensorensen) | 1 |
| [Polizo96](https://github.com/Polizo96) | 1 |
| [cavapoo2](https://github.com/cavapoo2) | 1 |
| [idoall](https://github.com/idoall) | 1 | | [idoall](https://github.com/idoall) | 1 |
| [starit](https://github.com/starit) | 1 | | [starit](https://github.com/starit) | 1 |

2
cmd/documentation/exchanges_templates/binance.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/binanceus.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/bitfinex.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/bitflyer.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/bithumb.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/bitmex.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/bitstamp.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/btcmarkets.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/btse.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/bybit.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/coinbase.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...) tradeID, err := c.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/coinut.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...) tradeID, err := c.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/deribit.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := d.Trade(...) tradeID, err := d.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/exmo.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := e.Trade(...) tradeID, err := e.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/gateio.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...) tradeID, err := g.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/gemini.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...) tradeID, err := g.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/hitbtc.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...) tradeID, err := h.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/huobi.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...) tradeID, err := h.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/kraken.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := k.Trade(...) tradeID, err := k.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/lbank.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := l.Trade(...) tradeID, err := l.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/okx.tmpl
View File

@@ -93,7 +93,7 @@ if err != nil {
// Private calls - make sure your APIKEY and APISECRET are set and // Private calls - make sure your APIKEY and APISECRET are set and
// AuthenticatedAPISupport is set to true // AuthenticatedAPISupport is set to true
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
orderID, err := ok.SubmitOrder(...) orderID, err := ok.SubmitOrder(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/poloniex.tmpl
View File

@@ -86,7 +86,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := p.PlaceOrder(...) tradeID, err := p.PlaceOrder(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
cmd/documentation/exchanges_templates/yobit.tmpl
View File

@@ -85,7 +85,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := y.Trade("BTCUSD", "MARKET", 1, 2) tradeID, err := y.Trade("BTCUSD", "MARKET", 1, 2)
if err != nil { if err != nil {
// Handle error // Handle error

3
cmd/documentation/root_templates/root_readme.tmpl
View File

@@ -17,7 +17,8 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
## Exchange Support Table ## Exchange Support Table
| Exchange | REST API | Streaming API | FIX API | | Exchange | REST API | Websocket API | FIX API |
``
|----------|------|-----------|-----| |----------|------|-----------|-----|
| Binance.US| Yes | Yes | NA | | Binance.US| Yes | Yes | NA |
| Binance| Yes | Yes | NA | | Binance| Yes | Yes | NA |

8
cmd/exchange_template/wrapper.tmpl
View File

@@ -53,14 +53,14 @@ func (e *Exchange) SetDefaults() {
fmt1 := currency.PairStore{ fmt1 := currency.PairStore{
AssetEnabled: true, AssetEnabled: true,
RequestFormat: &currency.PairFormat{Uppercase: true}, RequestFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
ConfigFormat: &currency.PairFormat{Uppercase: true}, ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
} }
fmt2 := currency.PairStore{ fmt2 := currency.PairStore{
AssetEnabled: true, AssetEnabled: true,
RequestFormat: &currency.PairFormat{Uppercase: true}, RequestFormat: &currency.PairFormat{Uppercase: true, Delimiter: "-"},
ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: ":"}, ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
} }
if err := e.SetAssetPairStore(asset.Spot, fmt1); err != nil { if err := e.SetAssetPairStore(asset.Spot, fmt1); err != nil {

2
dispatch/dispatch_types.go
View File

@@ -65,7 +65,7 @@ type job struct {
ID uuid.UUID ID uuid.UUID
} }
// Mux defines a new multiplexer for the dispatch system, these a generated // Mux defines a new multiplexer for the dispatch system, these are generated
// per subsystem // per subsystem
type Mux struct { type Mux struct {
// Reference to the main running dispatch service // Reference to the main running dispatch service

63
docs/ADD_NEW_EXCHANGE.md
View File

@@ -22,7 +22,7 @@ This document is from a perspective of adding a new exchange called Binance to t
#### Linux/macOS #### Linux/macOS
GoCryptoTrader is built using [Go Modules](https://github.com/golang/go/wiki/Modules) and requires Go 1.11 or above GoCryptoTrader is built using [Go Modules](https://go.dev/wiki/Modules) and requires Go 1.11 or above
Using Go Modules you now clone this repository **outside** your GOPATH Using Go Modules you now clone this repository **outside** your GOPATH
```console ```console
@@ -90,48 +90,34 @@ go build && gocryptotrader.exe --config=config_example.json
Similar to the configs, spot support is inbuilt but other asset types will need to be manually supported Similar to the configs, spot support is inbuilt but other asset types will need to be manually supported
```go ```go
spot := currency.PairStore{ fmt1 := currency.PairStore{
AssetEnabled: true, AssetEnabled: true,
RequestFormat: &currency.PairFormat{ RequestFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
Uppercase: true, ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
Delimiter: "/", }
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "/",
},
}
futures := currency.PairStore{
AssetEnabled: true,
RequestFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "-",
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "-",
},
}
err := e.SetAssetPairStore(asset.Spot, spot) fmt2 := currency.PairStore{
if err != nil { AssetEnabled: true,
log.Errorf(log.ExchangeSys, "%s error storing `spot` default asset formats: %s", bi.Name, err) RequestFormat: &currency.PairFormat{Uppercase: true, Delimiter: "-"},
} ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
}
err = e.SetAssetPairStore(asset.Futures, futures) if err := e.SetAssetPairStore(asset.Spot, fmt1); err != nil {
if err != nil { log.Errorf(log.ExchangeSys, "%s error storing %q default asset formats: %s", e.Name, asset.Spot, err)
log.Errorf(log.ExchangeSys, "%s error storing `futures` default asset formats: %s", bi.Name, err) }
} if err := e.SetAssetPairStore(asset.Futures, fmt2); err != nil {
log.Errorf(log.ExchangeSys, "%s error storing %q default asset formats: %s", e.Name, asset.Futures, err)
}
``` ```
### Document the addition of the new exchange (Binance exchange is used as an example below) ### Document the addition of the new exchange (Binance exchange is used as an example below)
**Yes** means supported, **No** means not yet implemented and **NA** means protocol unsupported **Yes** means supported, **No** means not yet implemented and **NA** means protocol unsupported by the exchange
#### Add exchange to the [root README template](/cmd/documentation/root_templates/root_readme.tmpl) file #### Add exchange to the [root README template](/cmd/documentation/root_templates/root_readme.tmpl) file
```go ```go
| Exchange | REST API | Streaming API | FIX API | | Exchange | REST API | Websocket API | FIX API |
|----------|------|-----------|-----| |----------|------|-----------|-----|
| Binance| Yes | Yes | NA | // <-------- new exchange | Binance| Yes | Yes | NA | // <-------- new exchange
| Bitfinex | Yes | Yes | NA | | Bitfinex | Yes | Yes | NA |
@@ -320,7 +306,7 @@ Modify existing constants or create new ones to define the API URL paths, as app
apiURL = "https://api.binance.com" apiURL = "https://api.binance.com"
``` ```
Create a get function in `rest.go` file and unmarshall the data in the created type: Create a get function in the `rest.go` file and unmarshal the data in the created type:
```go ```go
// GetExchangeInfo returns exchange information. Check types for more // GetExchangeInfo returns exchange information. Check types for more
@@ -336,11 +322,8 @@ Create a test function in `rest_test.go` to see if the data is received and unma
```go ```go
func TestGetExchangeInfo(t *testing.T) { func TestGetExchangeInfo(t *testing.T) {
t.Parallel() // adding t.Parallel() is preferred as it allows tests to run simultaneously, speeding up package test time t.Parallel() // adding t.Parallel() is preferred as it allows tests to run simultaneously, speeding up package test time
// Either set verbose to true for more detailed output as shown below:
e.Verbose = true e.Verbose = true
// Or alternatively you can use: result, err := e.GetExchangeInfo(t.Context())
// result, err := e.GetExchangeInfo(request.WithVerbose(context.Background()))
result, err := e.GetExchangeInfo(context.Background())
require.NoError(t, err) require.NoError(t, err)
t.Log(result) t.Log(result)
assert.NotNil(t, result) assert.NotNil(t, result)
@@ -349,10 +332,10 @@ func TestGetExchangeInfo(t *testing.T) {
Set `Verbose` to `true` to view received data during unmarshalling errors. Set `Verbose` to `true` to view received data during unmarshalling errors.
After testing, remove `Verbose`, the result variable, and `t.Log(result)`, or replace the log with `assert.NotNil(t, result)` to avoid unnecessary output when running GCT. After testing, remove `Verbose`, the result variable, and `t.Log(result)`, or replace the log with `assert.NotNil(t, result)` to avoid unnecessary output when running GCT.
Alternatively you can use `request.WithVerbose(context.Background())` as the `context` param to achieve the same result. Alternatively you can use `request.WithVerbose(t.Context())` as the `context` param to achieve the same result.
```go ```go
result, err := e.GetExchangeInfo(context.Background()) result, err := e.GetExchangeInfo(t.Context())
require.NoError(t, err) require.NoError(t, err)
assert.NotNil(t, result) assert.NotNil(t, result)
``` ```

2
docs/CODING_GUIDELINES.md
View File

@@ -193,7 +193,7 @@ Run the following tool to check for Go modernise issues:
make modernise make modernise
``` ```
Several other miscellaneous checks will be ran via [GitHub actions](/.github/workflows/misc.yml). Several other miscellaneous checks will be run via [GitHub actions](/.github/workflows/misc.yml).
- All lint warnings and errors must be resolved before merging. - All lint warnings and errors must be resolved before merging.
- Use `//nolint:linter-name` sparingly and always explain the reason in a comment next to the code. - Use `//nolint:linter-name` sparingly and always explain the reason in a comment next to the code.

22
engine/currency_state_manager.md
View File

@@ -17,20 +17,20 @@ This currency_state_manager package is part of the GoCryptoTrader codebase.
You can track ideas, planned features and what's in progress on our [GoCryptoTrader Kanban board](https://github.com/orgs/thrasher-corp/projects/3). 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) Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/zt-38z8abs3l-gH8AAOk8XND6DP5NfCiG_g)
## Current Features for Currency State Manager ## Current Features for Currency State Manager
+ The state manager keeps currency states up to date, which include: + The state manager keeps currency states up to date, which include:
* Withdrawal - Determines if the currency is allowed to be withdrawn from the exchange. * Withdrawal - Determines if the currency is allowed to be withdrawn from the exchange.
* Deposit - Determines if the currency is allowed to be deposited to an exchange. * Deposit - Determines if the currency is allowed to be deposited to an exchange.
* Trading - Determines if the currency is allowed to be traded on the exchange. * Trading - Determines if the currency is allowed to be traded on the exchange.
+ This allows for an internal state check to compliment internal and external + This allows for an internal state check to compliment internal and external
strategies. strategies.
## Donations ## Donations
<img src="/docs/assets/donate.png" hspace="70"> <img src="/docs/assets/donate.png" 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: If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc*** ***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***

2
exchanges/binance/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/binanceus/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/bitfinex/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/bitflyer/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/bithumb/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/bitmex/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/bitstamp/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/btcmarkets/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/btse/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/bybit/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...) tradeID, err := b.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

4
exchanges/coinbase/README.md
View File

@@ -5,7 +5,7 @@
[![Build Status](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml) [![Build Status](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/exchanges/Coinbase) [![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader/exchanges/coinbase)
[![Coverage Status](https://codecov.io/gh/thrasher-corp/gocryptotrader/graph/badge.svg?token=41784B23TS)](https://codecov.io/gh/thrasher-corp/gocryptotrader) [![Coverage Status](https://codecov.io/gh/thrasher-corp/gocryptotrader/graph/badge.svg?token=41784B23TS)](https://codecov.io/gh/thrasher-corp/gocryptotrader)
[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader) [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...) tradeID, err := c.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/coinut/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...) tradeID, err := c.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/deribit/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := d.Trade(...) tradeID, err := d.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/exmo/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := e.Trade(...) tradeID, err := e.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/gateio/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...) tradeID, err := g.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/gemini/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...) tradeID, err := g.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/hitbtc/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...) tradeID, err := h.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/huobi/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...) tradeID, err := h.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/kraken/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := k.Trade(...) tradeID, err := k.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/lbank/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := l.Trade(...) tradeID, err := l.Trade(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/okx/README.md
View File

@@ -111,7 +111,7 @@ if err != nil {
// Private calls - make sure your APIKEY and APISECRET are set and // Private calls - make sure your APIKEY and APISECRET are set and
// AuthenticatedAPISupport is set to true // AuthenticatedAPISupport is set to true
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
orderID, err := ok.SubmitOrder(...) orderID, err := ok.SubmitOrder(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/poloniex/README.md
View File

@@ -104,7 +104,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := p.PlaceOrder(...) tradeID, err := p.PlaceOrder(...)
if err != nil { if err != nil {
// Handle error // Handle error

2
exchanges/yobit/README.md
View File

@@ -103,7 +103,7 @@ if err != nil {
// Handle error // Handle error
} }
// Submits an order and the exchange and returns its tradeID // Submits an order to the exchange and returns its tradeID
tradeID, err := y.Trade("BTCUSD", "MARKET", 1, 2) tradeID, err := y.Trade("BTCUSD", "MARKET", 1, 2)
if err != nil { if err != nil {
// Handle error // Handle error