mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 15:09:42 +00:00
bb122dcafa
* codebase: Remove web frontend and related services * refactor: Update StartPPROF to accept context and adjust related tests * refactor: Simplify SetIfZero functions and update related tests * config: Clarify DowngradeConfig method documentation regarding permanent removal of deprecated fields * refactor: Rename setIfZeroAndWarn to setDefaultIfZeroWarn for clarity and update related calls * refactor: Update error handling in DataHistoryManager and remove redundant error variable
271 lines
7.9 KiB
Markdown
271 lines
7.9 KiB
Markdown
# GoCryptoTrader package Config
|
|
|
|
<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/config)
|
|
[](https://codecov.io/gh/thrasher-corp/gocryptotrader)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
|
|
This config 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)
|
|
|
|
## Current Features for config
|
|
|
|
+ Handling of config encryption and verification of "configuration".json data.
|
|
|
|
+ Contains configurations for:
|
|
|
|
- Enable/Disable Exchanges. [See Example](#enable-exchange-via-config-example)
|
|
|
|
- Bank accounts for withdrawal and depositing FIAT between exchange and
|
|
your personal accounts. [See Example](#enable-bank-accounts-via-config-example)
|
|
|
|
- Portfolio to monitor online and offline accounts. [See Example](#enable-portfolio-via-config-example)
|
|
|
|
- Currency configurations to set your foreign exchange provider accounts,
|
|
your preferred display currency, suitable FIAT currency and suitable
|
|
cryptocurrency. [See Example](#enable-currency-via-config-example)
|
|
|
|
- Communication for utilisation of supported communication mediums e.g.
|
|
email events direct to your personal account. [See Example](#enable-communications-via-config-example)
|
|
|
|
- Websocket subscription channels. [See Example](#configure-exchange-websocket-subscriptions)
|
|
|
|
# Config Examples
|
|
|
|
#### Basic examples for enabling features on the GoCryptoTrader platform
|
|
|
|
+ Linux example for quickly creating and testing configuration file
|
|
```sh
|
|
cd ~/go/src/github.com/thrasher-corp/gocryptotrader
|
|
cp config_example.json config.json
|
|
# Test config
|
|
go build
|
|
./gocryptotrader
|
|
```
|
|
|
|
+ or custom config, can also pass in absolute path to "configuration".json file.
|
|
|
|
```sh
|
|
cd ~/go/src/github.com/thrasher-corp/gocryptotrader
|
|
cp config_example.json custom.json
|
|
# Test config
|
|
go build
|
|
./gocryptotrader -config custom.json
|
|
```
|
|
|
|
## Enable Exchange Via Config Example
|
|
|
|
+ To enable or disable an exchange via config proceed through the
|
|
"configuration".json file to exchanges and to the supported exchange e.g see
|
|
below. "Enabled" set to true or false will enable and disable the exchange,
|
|
if you set "APIKey" && "APISecret" you must set "AuthenticatedAPISupport" to
|
|
true or the bot will not be able to send authenticated http requests. If needed
|
|
you can set the exchanges bank details for depositing FIAT options. Some banks
|
|
have multiple deposit accounts for different FIAT deposit currencies.
|
|
|
|
```js
|
|
"Exchanges": [
|
|
{
|
|
"Name": "Bitfinex",
|
|
"Enabled": true,
|
|
"Verbose": false,
|
|
"Websocket": false,
|
|
"UseSandbox": false,
|
|
"RESTPollingDelay": 10,
|
|
"websocketResponseCheckTimeout": 30000000,
|
|
"websocketResponseMaxLimit": 7000000000,
|
|
"httpTimeout": 15000000000,
|
|
"APIKey": "Key",
|
|
"APISecret": "Secret",
|
|
"AvailablePairs": "ATENC_GBP,ATENC_NZD,BTC_AUD,BTC_SGD,LTC_BTC,START_GBP,...",
|
|
"EnabledPairs": "BTC_USD,BTC_HKD,BTC_EUR,BTC_CAD,BTC_AUD,BTC_SGD,BTC_JPY,...",
|
|
"BaseCurrencies": "USD,HKD,EUR,CAD,AUD,SGD,JPY,GBP,NZD",
|
|
"AssetTypes": "SPOT",
|
|
"SupportsAutoPairUpdates": true,
|
|
"ConfigCurrencyPairFormat": {
|
|
"Uppercase": true,
|
|
"Delimiter": "_"
|
|
},
|
|
"RequestCurrencyPairFormat": {
|
|
"Uppercase": true
|
|
},
|
|
"BankAccounts": [
|
|
{
|
|
"BankName": "",
|
|
"BankAddress": "",
|
|
"AccountName": "",
|
|
"AccountNumber": "",
|
|
"SWIFTCode": "",
|
|
"IBAN": "",
|
|
"SupportedCurrencies": "AUD,USD,EUR"
|
|
}
|
|
]
|
|
},
|
|
```
|
|
|
|
## Enable Bank Accounts Via Config Example
|
|
|
|
+ To enable bank accounts simply proceed through "configuration".json file to
|
|
"BankAccounts" and input your account information example below.
|
|
|
|
```js
|
|
"BankAccounts": [
|
|
{
|
|
"BankName": "test",
|
|
"BankAddress": "test",
|
|
"AccountName": "TestAccount",
|
|
"AccountNumber": "0234",
|
|
"SWIFTCode": "91272837",
|
|
"IBAN": "98218738671897",
|
|
"SupportedCurrencies": "USD",
|
|
"SupportedExchanges": "Kraken,Bitstamp"
|
|
}
|
|
]
|
|
```
|
|
|
|
## Enable Portfolio Via Config Example
|
|
|
|
+ To enable the GoCryptoTrader platform to monitor your addresses please
|
|
specify, "configuration".json file example below.
|
|
|
|
```js
|
|
"PortfolioAddresses": {
|
|
"Addresses": [
|
|
{
|
|
"Address": "1JCe8z4jJVNXSjohjM4i9Hh813dLCNx2Sy",
|
|
"CoinType": "BTC",
|
|
"Balance": 53000.01310358,
|
|
"Description": ""
|
|
},
|
|
{
|
|
"Address": "3Nxwenay9Z8Lc9JBiywExpnEFiLp6Afp8v",
|
|
"CoinType": "BTC",
|
|
"Balance": 101848.28376405,
|
|
"Description": ""
|
|
}
|
|
]
|
|
```
|
|
|
|
## Enable Currency Via Config Example
|
|
|
|
+ To Enable foreign exchange providers set "Enabled" to true and add in your
|
|
account API keys example below.
|
|
|
|
```js
|
|
"ForexProviders": [
|
|
{
|
|
"Name": "CurrencyConverter",
|
|
"Enabled": true,
|
|
"Verbose": false,
|
|
"RESTPollingDelay": 600,
|
|
"APIKey": "",
|
|
"APIKeyLvl": -1,
|
|
"PrimaryProvider": true
|
|
},
|
|
]
|
|
```
|
|
|
|
+ To define the cryptocurrency you want the platform to use set them here
|
|
example below.
|
|
|
|
```js
|
|
"Cryptocurrencies": "BTC,LTC,ETH,XRP,NMC,NVC,PPC,XBT,DOGE,DASH",
|
|
```
|
|
|
|
+ To define the currency you want to everything to be valued against example
|
|
below.
|
|
|
|
```js
|
|
"FiatDisplayCurrency": "USD"
|
|
```
|
|
|
|
## Enable Communications Via Config Example
|
|
|
|
+ To set the desired platform communication medium proceed to "Communications"
|
|
in the "configuration".json file and set your account details to the preferred
|
|
comm method and add in your contact list if available.
|
|
|
|
```js
|
|
"SMSGlobal": {
|
|
"Name": "SMSGlobal",
|
|
"Enabled": false,
|
|
"Verbose": false,
|
|
"Username": "Username",
|
|
"Password": "Password",
|
|
"Contacts": [
|
|
{
|
|
"Name": "Bob",
|
|
"Number": "12345",
|
|
"Enabled": false
|
|
}
|
|
]
|
|
},
|
|
```
|
|
|
|
## Configure exchange websocket subscriptions
|
|
|
|
+ Websocket subscriptions provide a stream of data from an exchange.
|
|
Whilst subscriptions are specific to each exchange, some common examples are: candles, orderbook, ticker and allTrades.
|
|
You can configure any supported channels in your exchange, but most likely you just want to disable some of the defaults, or change the default intervals.
|
|
You cannot configure an empty list of subscriptions, instead set all of the subscriptions to enabled: false.
|
|
|
|
See the section `exchange.features.enabled.subscriptions` for configuring subscriptions:
|
|
|
|
```js
|
|
"subscriptions": [
|
|
{
|
|
"enabled": true,
|
|
"channel": "ticker"
|
|
},
|
|
{
|
|
"enabled": false,
|
|
"channel": "allTrades"
|
|
},
|
|
{
|
|
"enabled": true,
|
|
"channel": "candles",
|
|
"interval": "1m"
|
|
},
|
|
{
|
|
"enabled": true,
|
|
"channel": "orderbook",
|
|
"interval": "100ms"
|
|
}
|
|
]
|
|
```
|
|
|
|
|
|
## Configure Network Time Server
|
|
|
|
+ To configure and enable a NTP server you need to set the "enabled" field to one of 3 values -1 is disabled 0 is enabled and alert at start up 1 is enabled and warn at start up
|
|
servers are configured by the pool array and attempted first to last allowedDifference and allowedNegativeDifference are how far ahead and behind is acceptable for the time to be out in nanoseconds
|
|
|
|
```js
|
|
"ntpclient": {
|
|
"enabled": 0,
|
|
"pool": [
|
|
"pool.ntp.org:123"
|
|
],
|
|
"allowedDifference": 0,
|
|
"allowedNegativeDifference": 0
|
|
},
|
|
```
|
|
|
|
## Donations
|
|
|
|
<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:
|
|
|
|
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***
|