thrasher-corp / gocryptotrader

A cryptocurrency trading bot and framework supporting multiple exchanges written in Golang.
MIT License
2.96k stars 792 forks source link

cmd/exchange_template: Update docs #1494

Open cranktakular opened 4 months ago

cranktakular commented 4 months ago

PR Description

If the exchange config isn't enabled, then the default setup function in the wrapper won't do anything with the config passed to it, causing any authentication to not be set. And thus, causing anything which uses authentication to fail.

Type of change

Please delete options that are not relevant and add an x in [] as item is complete.

How has this been tested

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration and also consider improving test coverage whilst working on a certain feature or package.

Checklist

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 35.90%. Comparing base (d518993) to head (c09f439). Report is 8 commits behind head on master.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/thrasher-corp/gocryptotrader/pull/1494/graphs/tree.svg?width=650&height=150&src=pr&token=41784B23TS&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thrasher-corp)](https://app.codecov.io/gh/thrasher-corp/gocryptotrader/pull/1494?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thrasher-corp) ```diff @@ Coverage Diff @@ ## master #1494 +/- ## ========================================== - Coverage 37.75% 35.90% -1.86% ========================================== Files 411 411 Lines 147817 177595 +29778 ========================================== + Hits 55815 63758 +7943 - Misses 84218 106055 +21837 + Partials 7784 7782 -2 ``` | [Files](https://app.codecov.io/gh/thrasher-corp/gocryptotrader/pull/1494?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thrasher-corp) | Coverage Δ | | |---|---|---| | [cmd/exchange\_template/exchange\_template.go](https://app.codecov.io/gh/thrasher-corp/gocryptotrader/pull/1494?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thrasher-corp#diff-Y21kL2V4Y2hhbmdlX3RlbXBsYXRlL2V4Y2hhbmdlX3RlbXBsYXRlLmdv) | `47.00% <0.00%> (-3.62%)` | :arrow_down: | ... and [386 files with indirect coverage changes](https://app.codecov.io/gh/thrasher-corp/gocryptotrader/pull/1494/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thrasher-corp)
thrasher- commented 3 months ago

Will be keeping this open for additional improvements to the exchange impl tools/docs up until Bitget is finished as @cranktakular goes through it

samuael commented 3 months ago

Thank you for this change, and for keeping the PR open. I have added small updates and created a PR here to this(👆) @cranktakular s PR.