mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-30 15:10:40 +00:00
docs: Add CODING_GUIDELINES.md and other adjustments (#1988)
* 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
This commit is contained in:
Adrian Gallagher
GitHub
@@ -74,20 +74,6 @@ upper := strings.ToUpper(testString)
|
||||
|
||||
### ALL NEW UPDATES AND FILE SYSTEM ADDITIONS NEED A DOCUMENTATION UPDATE USING THIS TOOL OR PR MERGE REQUEST MAY BE POSTPONED.
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
## Contribution
|
||||
|
||||
Please feel free to submit any pull requests or suggest any desired features to be added.
|
||||
|
||||
When submitting a PR, please abide by our coding guidelines:
|
||||
|
||||
+ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
||||
+ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
||||
+ Code must adhere to our [coding style](https://github.com/thrasher-corp/gocryptotrader/blob/master/doc/coding_style.md).
|
||||
+ Pull requests need to be based on and opened against the `master` branch.
|
||||
|
||||
## Donations
|
||||
|
||||
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
||||
|
||||
@@ -11,7 +11,5 @@ For a list of commands, you can run the following
|
||||
go run .
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -55,7 +55,5 @@ buf generate
|
||||
|
||||
If any changes were made, ensure that the `rpc.proto` file is formatted correctly by using `buf format -w`
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -4,7 +4,5 @@
|
||||
|
||||
Common contains some basic data types which are used throughout.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -22,7 +22,5 @@
|
||||
### Want to make your own configs?
|
||||
Use the provided config builder under `/backtester/config/configbuilder` or modify tests under `/backtester/config/config_test.go` to generates strategy files quickly
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -268,7 +268,5 @@ See below for a set of tables and fields, expected values and what they can do
|
||||
|----------------|-------------------------------------------------------------------------|---------|
|
||||
| risk-free-rate | The risk free rate used in the calculation of sharpe and sortino ratios | `0.03` |
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -12,8 +12,5 @@ Once the config is created, when running the backtester, you can reference it vi
|
||||
### Anything else?
|
||||
The config builder will ask you all the necessary questions required to create a config file. If there is anything confusing, feel free to ask a question in our Slack group or open an issue!
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -7,7 +7,5 @@ This package uses existing GoCryptoTrader exchange implementations.
|
||||
|
||||
See individual exchange implementations [here](/exchanges) and the interface used [here](/exchanges/interfaces.go)
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -28,8 +28,5 @@ Additionally, you can view an example under `./testdata/binance_BTCUSDT_24h_2019
|
||||
|
||||
Additionally, you can view an example under `./testdata/binance_BTCUSDT_24h-trades_2020_11_16.csv`
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -13,7 +13,5 @@ The default database will be loaded from your GoCryptoTrader config. See [this](
|
||||
#### Overriding the GoCryptoTrader config
|
||||
Database configuration details can be overridden in the `.strat` config file to allow other sources to be used and not rely on existing GoCryptoTrader configuration. See [this readme](/backtester/config/README.md) for details on config customisation
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -7,7 +7,5 @@ This package will retrieve data for the backtester via continuous requests to li
|
||||
## Important notice
|
||||
Its incredibly risky to enable `real-orders`. *Past performance is no guarantee of future results*
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -8,8 +8,5 @@ Candle data represents the opening, closing, highest, lowest prices of a given t
|
||||
|
||||
Trade data represents the raw trading data on an exchange. Every buy or sell action for the given currency. When trading data is used for the GoCryptoTrader Backtester, it is converted into candle data at the interval you specify. This allows for custom candle intervals not provided by an exchange's API and thus has a greater amount of flexibility in backtesting strategies.
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -7,10 +7,5 @@ This is a base implementation, the more proper implementation that is used throu
|
||||
|
||||
This can also be used to implement other means to load data for the backtester to process, however kline is currently the only supported method.
|
||||
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -5,12 +5,8 @@
|
||||
The backtest package is responsible for handling all events. It is the engine which combines all elements.
|
||||
Data is converted into candles which are then analysed via the strategyhandler. From there, events can be passed through to other handlers such as the portfolio handler to determine whether or not to place an order
|
||||
|
||||
|
||||
A flow of the application is as follows:
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -4,7 +4,5 @@
|
||||
|
||||
The GRPC server is responsible for handling requests from the client. All GRPC functionality as defined in the proto file is implemented [here](/backtester/btrpc)
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -10,8 +10,5 @@ Live trading is only a proof of concept. Please do not risk your funds by using
|
||||
A flow of the application is as follows:
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -6,7 +6,5 @@ The event holder is a simple interface implementation which allows the backteste
|
||||
The event holder is based on the `EventHolder` interface and is implemented by `Holder`.
|
||||
It is used by `backtest.Backtester` and it accepts appending any struct which implements the `common.EventHandler` interface, eg `order.Order`
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -17,8 +17,5 @@ The following steps are taken for the `ExecuteOrder` function:
|
||||
- If `RealOrders` is set to `true` it will submit the order via the exchange's API and if successful, will be stored in the order manager
|
||||
- If an order is successfully placed, a snapshot of all existing orders in the run will be captured and store for statistical purposes
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -14,7 +14,5 @@ Slippage is calculated in two ways in the GoCryptoTrader Backtester
|
||||
- If it is a buy order, it will raise the price by a random percentage between the two values
|
||||
- If the order is a sell order, it will reduce the price by a random percentage between the two values
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -4,8 +4,5 @@
|
||||
|
||||
The compliance manager is used to store all events at each time interval. When debugging the backtester or wanting to audit backtesting results, you can inspect every single action that has occurred during the backtesting run
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -5,8 +5,5 @@
|
||||
Holdings are used to calculate the holdings at any given time for a given exchange, asset, currency pair. If an order is placed, funds are removed from funding and placed under assets.
|
||||
Every data event will update and calculate holdings value based on the new price. This will allow for statistics to be easily calculated at the end of a backtesting run
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -26,9 +26,5 @@ The following steps are taken for the `OnFill` function:
|
||||
The following steps are taken for the `Update` function:
|
||||
- The `Update` function is called when orders are not placed, this allows for the portfolio manager to still keep track of pricing and holding statistics, while not needing to process any orders
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -7,8 +7,5 @@ Risk is currently defined by ensuring that orders cannot have too much leverage
|
||||
|
||||
See config package [readme](/backtester/config/README.md) to view the risk related fields to customise
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -7,8 +7,5 @@ The sizing package ensures that all potential orders raised are within both the
|
||||
- When an order is sized under the limits, an order event cannot be raised an no order will be submitted by the exchange
|
||||
- The portfolio manager's sizing rules override any CurrencySettings' rules if the sizing is outside the portfolio manager's
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -6,8 +6,5 @@ Event handlers are responsible for taking in an event, analysing its contents an
|
||||
Below is an overview of how event handlers are used
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -36,8 +36,5 @@ Both! We calculate ratios where an average is required using both types. The rea
|
||||
## USD total tracking
|
||||
If the strategy config setting `DisableUSDTracking` is `false`, then the GoCryptoTrader Backtester will automatically retrieve USD data that matches your backtesting currencies, eg pair BTC/LTC will track BTC/USD and LTC/USD as well. This allows for tracking overall strategic performance against one currency. This can allow for much easier performance calculations and comparisons
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -4,8 +4,5 @@
|
||||
|
||||
The strategy base file has basic implementations of the `strategies.Handler` interface. Add any functions that can be used across all strategies here.
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -31,8 +31,6 @@ This strategy does support strategy customisation in the following ways:
|
||||
### External Resources
|
||||
- [This](https://ftxcashandcarry.com/) is a very informative site on describing what a cash and carry trade will look like
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
|
||||
@@ -6,8 +6,5 @@ The dollar cost average is a strategy which is designed to purchase on _every_ d
|
||||
This strategy supports simultaneous signal processing, aka `config.StrategySettings.SimultaneousSignalProcessing` set to true will use the function `OnSignals(d []data.Handler, p portfolio.Handler) ([]signal.Event, error)`. This function, like the basic `OnSignal` function, will signal to buy on every iteration.
|
||||
This strategy does not support customisation
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -21,7 +21,5 @@ It allows for complex strategical decisions to be made when you consider the sco
|
||||
### Loading strategies
|
||||
Each strategy has a unique name and is to be added to the function `getStrategies()` in order to be recognised.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -12,7 +12,5 @@ This strategy does support strategy customisation in the following ways:
|
||||
|rsi-low| The lower bounds of RSI that when met, will trigger a Buy signal | 30 |
|
||||
|rsi-period| The consecutive candle periods used in order to generate a value. All values less than this number cannot output a buy or sell signal | 14 |
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -15,7 +15,5 @@ This strategy does support strategy customisation in the following ways:
|
||||
|mfi-low| The lower bounds of MFI that when met, will trigger a Buy signal | 30 |
|
||||
|mfi-period| The consecutive candle periods used in order to generate a value. All values less than this number cannot output a buy or sell signal | 14 |
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -4,8 +4,5 @@
|
||||
|
||||
The event event type is an important base for all other events. It allows for consistent information to be used across all events in order to track and make decisions. Any information that is shared between events should be added to this struct
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -17,7 +17,5 @@ SetAmount(float64)
|
||||
GetOrder() *order.Detail
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -4,7 +4,5 @@
|
||||
|
||||
The Kline event type is used to store the candle data of an individual data event. It can be utilised to understand market conditions at a point in time and make decisions from there
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -17,7 +17,5 @@ The Order Event Type is based on `common.EventHandler` and `common.Directioner`
|
||||
IsLeveraged() bool
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -6,8 +6,5 @@ Event types are created after retrieving candle data. An individual candle is tu
|
||||
Below is an overview of how events are used
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -5,7 +5,5 @@
|
||||
The signal event is created as a result of a data event being analysed via a strategy. Typically, there are three types of signal that should be expected `buy`, `sell` and `donothing`. An example of this is demonstrated in the RSI strategy. However, other signals can be raised such as `MissingData`.
|
||||
The signal event will contain data such as price, the direction as well as the reasoning for the signal decision with the `GetWhy()` function
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -71,7 +71,5 @@ No. The already existing `CurrencySettings` will populate the funding manager wi
|
||||
| initial-funds | The initial funding for the currency | `1337` |
|
||||
| transfer-fee | If your strategy utilises transferring of funds via the Funding Manager, this is deducted upon doing so | `0.005` |
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -25,7 +25,5 @@ If you need to disable this functionality, for example, you are using Live, Data
|
||||
### Can I supply my own list of equivalent currencies instead of USD?
|
||||
This is currently not supported. If this is a feature you would like to have, please raise an issue on GitHub or in our Slack channel
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -24,13 +24,8 @@ This outputs a file named `{{.Name}}.so` which can be loaded by the backtester.
|
||||
|
||||
You must ensure that the plugin is built with the same version of code as the GoCryptoTrader Backtester. Otherwise the plugin will refuse to load.
|
||||
|
||||
|
||||
|
||||
#### Installing Golang in WSL
|
||||
See the following for instructions on installing Golang in WSL: [here](https://ao.ms/how-to-install-golang-on-wsl-wsl2/)
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -30,8 +30,5 @@ To run this specific example strategy, use:
|
||||
|
||||
Upon startup, the GoCryptoTrader Backtester will load the strategy and run it for all events.
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -23,8 +23,5 @@ To run a strategy you will need to use the following flags when running the GoCr
|
||||
|
||||
Upon startup, the GoCryptoTrader Backtester will load the strategy and run it for all events.
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -89,9 +89,5 @@ Creating strategies requires programming skills. [Here](/backtester/eventhandler
|
||||
- While an experimental feature, it is **not** recommended to **ever** use live trading and real orders
|
||||
- **Past performance is no guarantee of future results**
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -14,8 +14,5 @@ The report utilises the following sweet technologies:
|
||||
Output example:
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -56,8 +56,5 @@ upper := strings.ToUpper(testString)
|
||||
|
||||
### ALL NEW UPDATES AND FILE SYSTEM ADDITIONS NEED A DOCUMENTATION UPDATE USING THIS TOOL OR PR MERGE REQUEST MAY BE POSTPONED.
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -16,8 +16,5 @@ upper := strings.ToUpper(testString)
|
||||
// upper == "AAAAA"
|
||||
```
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -6,7 +6,5 @@
|
||||
|
||||
+ Used to enforce standard variables and methods across the communication packages
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -20,7 +20,5 @@ to be exported out to a defined communication medium
|
||||
+ Please view the individual readme documentation inside the specific package
|
||||
for more details
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -49,7 +49,5 @@ via Slack:
|
||||
!settings - Displays current settings
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -39,7 +39,5 @@ err := s.Connect
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -41,7 +41,5 @@ err := s.Connect
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -54,7 +54,5 @@ via Telegram:
|
||||
/help - Displays current command list
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -243,7 +243,5 @@ servers are configured by the pool array and attempted first to last allowedDiff
|
||||
},
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -16,7 +16,5 @@ newPair := currency.NewPairFromStrings("BTC", "USD")
|
||||
bitcoinString := newPair.GetFirstCurrency
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -8,7 +8,5 @@
|
||||
- Symbol mapping
|
||||
- Translation between currencies that have similar strings e.g. XBT, BTC
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -15,7 +15,5 @@ symbol := symbol.GetSymbolByCurrencyName(chineseYen)
|
||||
// symbol == "¥"
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -14,7 +14,5 @@ b := translation.HasTranslation("BTC")
|
||||
// b == true; translation = XBT
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -8,7 +8,5 @@
|
||||
+ Fixer.io support
|
||||
+ Open Exchange Rates support
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -5,7 +5,5 @@
|
||||
+ This package enforces standard variables and methods for the foreign exchange
|
||||
providers.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -34,7 +34,5 @@ mapstringfloat, err := c.GetRates("USD", "EUR,CHY")
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -34,7 +34,5 @@ mapstringfloat, err := c.GetRates("USD", "EUR,CHY")
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -34,7 +34,5 @@ mapstringfloat, err := c.GetRates("USD", "EUR,CHY")
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{- end}}
|
||||
@@ -34,7 +34,5 @@ mapstringfloat, err := c.GetRates("USD", "EUR,CHY")
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -34,7 +34,5 @@ mapstringfloat, err := c.GetRates("USD", "EUR,CHY")
|
||||
// Handle error
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -22,7 +22,5 @@
|
||||
| maxAuthFailures | For authenticated endpoints, the amount of failed attempts allowed before disconnection | `3` |
|
||||
| allowInsecureOrigin | Allows use of insecure connections | `true` |
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -48,9 +48,5 @@
|
||||
| verbose | If enabled will log more details to your logger output | `false` |
|
||||
| verificationToken | The token generated by Telegram to allow you to send messages | `iamafaketoken` |
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -12,8 +12,5 @@
|
||||
| preferredDomainList | Is a string array of domains to periodically verify whether GoCryptoTrader is connected to the internet | `["www.google.com","www.cloudflare.com","www.facebook.com"]` |
|
||||
| checkInterval | A time period in golang `time.Duration` format to check whether GoCryptoTrader is connected to the internet | `1000000000` |
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -9,6 +9,5 @@
|
||||
+ This allows for an internal state check to compliment internal and external
|
||||
strategies.
|
||||
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -24,7 +24,5 @@
|
||||
| database | The name of the database | `database.db` |
|
||||
| sslmode | The connection type of the database for Postgres databases only | `disable` |
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -187,9 +187,5 @@ The candle table also has relationships to data history jobs. Only the relevant
|
||||
| validation_job_id | When job id for what job validated the candle data | `deadbeef-dead-beef-dead-beef13371337` |
|
||||
| validation_issues | If any discrepancies are found, the data will be written to the column | `issues found at 2020-07-08 00:00:00, Open api: 9262.62 db: 9262.69 diff: 3%, replacing database candle data with API data` |
|
||||
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -4,8 +4,5 @@
|
||||
+ The deposit address manager subsystem stores Exchange deposit addresses.
|
||||
+ On start of the application the engine Bot will retrieve deposit addresses from exchanges if you have API keys set
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -11,8 +11,5 @@
|
||||
| eventmanagerdelay | Sets the event managers sleep delay between event checking by a Golang `time.Duration` | `0` |
|
||||
| verbose | Outputs debug messaging allowing for greater transparency for what the event manager is doing | `false` |
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -5,7 +5,5 @@
|
||||
+ The exchange manager itself is not customisable, it is always enabled.
|
||||
+ The exchange manager by default will load all exchanges that are enabled in your config, however, it will also load exchanges by request via GRPC commands
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -15,8 +15,5 @@
|
||||
| allowedDifference | A Golang time.Duration representation of the allowable time discrepancy between NTP server and your system time. Any discrepancy greater than this allowance will display an alert to your logging output | `50000000` |
|
||||
| allowedNegativeDifference | A Golang time.Duration representation of the allowable negative time discrepancy between NTP server and your system time. Any discrepancy greater than this allowance will display an alert to your logging output | `50000000` |
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -6,7 +6,5 @@
|
||||
+ All orders placed via GoCryptoTrader will be added to the order manager store
|
||||
+ Any futures based order will be tracked via the [futures positions controller](/exchanges/order/README.md) which can be used to track PNL. Use GRPC command [getfuturesposition](https://api.gocryptotrader.app/#gocryptotrader_getfuturesposition) to view position data for an exchange, asset, pair
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -25,8 +25,5 @@
|
||||
| ColdStorage | Describes whether the wallet address is a cold storage wallet eg Ledger | `false` |
|
||||
| SupportedExchanges | A comma delimited string of which exchanges are allowed to interact with this wallet | `"Binance"` |
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -7,7 +7,5 @@
|
||||
+ Subsystems which are designed to be switched off also have `Start(...) error`, `IsRunning() bool` and `Stop(...) error` functions to allow the main `engine.Engine` instance to manage them
|
||||
+ Common subsystem types such as errors can be found within the `subsystem.go` file
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -15,8 +15,5 @@
|
||||
| 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` |
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -7,8 +7,5 @@
|
||||
+ The websocket routine manager subsystem can be enabled or disabled via runtime command `-websocketroutine=false` defaulting to true
|
||||
+ Logs can be customised to display values the config value `fiatDisplayCurrency` under `currencyConfig`
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -8,8 +8,5 @@
|
||||
+ Will not process withdrawal events if `dryrun` is true
|
||||
+ The withdraw manager subsystem is always enabled
|
||||
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -4,7 +4,5 @@
|
||||
|
||||
+ The events package handles events from GoCryptoTrader bot.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -132,6 +132,5 @@ func (e *Exchange) Setup(exch *config.Exchange) error {
|
||||
}
|
||||
```
|
||||
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -86,7 +86,5 @@ func ABadExampleRoutineThatWaits(potentialChange *SomeChangingType) {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -99,7 +99,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -92,7 +92,5 @@ if err != nil {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -92,7 +92,5 @@ if err != nil {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -93,7 +93,5 @@ if err != nil {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -93,7 +93,5 @@ if err != nil {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -100,7 +100,5 @@ if err != nil {
|
||||
// supplied then
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -111,7 +111,5 @@ kline.Raw Interval configurable for a raw orderbook subscription when authentica
|
||||
|
||||
Subscriptions are subject to enabled assets and pairs.
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -171,7 +171,5 @@ func TestDummyTest(t *testing.T) {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -35,7 +35,5 @@ if err != nil {
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
@@ -16,7 +16,5 @@ implementation
|
||||
+ If contributing websocket improvements, please make sure order reports
|
||||
follow [these rules](../docs/WS_ORDER_EVENTS.md).
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
{{template "contributions"}}
|
||||
{{template "donations" .}}
|
||||
{{end}}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user