config

package
v0.0.0-...-f4766fb Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 12, 2018 License: MIT Imports: 21 Imported by: 0

README

GoCryptoTrader package Config

Build Status Software License GoDoc Coverage Status Go Report Card

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 progresss on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for config

  • Handling of config encryption and verification of "configuration".json data.

  • Contains configurations for:

    • Exchanges for utilisation of a broad or minimal amount of enabled exchanges Example for enabling an exchange.

    • Bank accounts for withdrawal and depositing FIAT between exchange and your personal accounts Example.

    • Portfolio to monitor online and offline accounts Example.

    • Currency configurations to set your foreign exchange provider accounts, your preferred display currency, suitable FIAT currency and suitable cryptocurrency Example.

    • Communication for utilisation of supported communication mediums e.g. email events direct to your personal account Example.

Config Examples

Basic examples for enabling features on the GoCryptoTrader platform
  • Linux example for quickly creating and testing configuration file
cd ~/go/src/github.com/thrasher-/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.
cd ~/go/src/github.com/thrasher-/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.
"Exchanges": [
 {
  "Name": "ANX",
  "Enabled": true,
  "Verbose": false,
  "Websocket": false,
  "UseSandbox": false,
  "RESTPollingDelay": 10,
  "HTTPTimeout": 15000000000,
  "AuthenticatedAPISupport": false,
  "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.
"BankAccounts": [
 {
  "BankName": "test",
  "BankAddress": "test",
  "AccountName": "TestAccount",
  "AccountNumber": "0234",
  "SWIFTCode": "91272837",
  "IBAN": "98218738671897",
  "SupportedCurrencies": "USD",
  "SupportedExchanges": "ANX,Kraken"
 }
]

Enable Portfolio Via Config Example

  • To enable the GoCryptoTrader platform to monitor your addresses please specify, "configuration".json file example below.
"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.
"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.
"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.
"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.
"SMSGlobal": {
 "Name": "SMSGlobal",
 "Enabled": false,
 "Verbose": false,
 "Username": "Username",
 "Password": "Password",
 "Contacts": [
  {
   "Name": "Bob",
   "Number": "12345",
   "Enabled": false
  }
 ]
},
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 guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB

Documentation

Index

Constants

View Source 
const (
	FXProviderFixer     = "fixer"
	EncryptedConfigFile = "config.dat"
	ConfigFile          = "config.json"
	ConfigTestFile      = "../testdata/configtest.json"
)

Constants declared here are filename strings and test strings

View Source 
const (
	ErrExchangeNameEmpty                            = "Exchange #%d in config: Exchange name is empty."
	ErrExchangeAvailablePairsEmpty                  = "Exchange %s: Available pairs is empty."
	ErrExchangeEnabledPairsEmpty                    = "Exchange %s: Enabled pairs is empty."
	ErrExchangeBaseCurrenciesEmpty                  = "Exchange %s: Base currencies is empty."
	ErrExchangeNotFound                             = "Exchange %s: Not found."
	ErrNoEnabledExchanges                           = "No Exchanges enabled."
	ErrCryptocurrenciesEmpty                        = "Cryptocurrencies variable is empty."
	ErrFailureOpeningConfig                         = "Fatal error opening %s file. Error: %s"
	ErrCheckingConfigValues                         = "Fatal error checking config values. Error: %s"
	ErrSavingConfigBytesMismatch                    = "Config file %q bytes comparison doesn't match, read %s expected %s."
	WarningSMSGlobalDefaultOrEmptyValues            = "WARNING -- SMS Support disabled due to default or empty Username/Password values."
	WarningSSMSGlobalSMSContactDefaultOrEmptyValues = "WARNING -- SMS contact #%d Name/Number disabled due to default or empty values."
	WarningSSMSGlobalSMSNoContacts                  = "WARNING -- SMS Support disabled due to no enabled contacts."
	WarningWebserverCredentialValuesEmpty           = "WARNING -- Webserver support disabled due to empty Username/Password values."
	WarningWebserverListenAddressInvalid            = "WARNING -- Webserver support disabled due to invalid listen address."
	WarningWebserverRootWebFolderNotFound           = "WARNING -- Webserver support disabled due to missing web folder."
	WarningExchangeAuthAPIDefaultOrEmptyValues      = "WARNING -- Exchange %s: Authenticated API support disabled due to default/empty APIKey/Secret/ClientID values."
	WarningCurrencyExchangeProvider                 = "WARNING -- Currency exchange provider invalid valid. Reset to Fixer."
	WarningPairsLastUpdatedThresholdExceeded        = "WARNING -- Exchange %s: Last manual update of available currency pairs has exceeded %d days. Manual update required!"
	APIURLDefaultMessage                            = "NON_DEFAULT_HTTP_LINK_TO_EXCHANGE_API"
)

Constants here hold some messages

View Source 
const (
	// EncryptConfirmString has a the general confirmation string to allow us to
	// see if the file is correctly encrypted
	EncryptConfirmString = "THORS-HAMMER"
	// SaltPrefix string
	SaltPrefix = "~GCT~SO~SALTY~"
	// SaltRandomLength is the number of random bytes to append after the prefix string
	SaltRandomLength = 12
)

Variables

View Source 
var (
	Cfg            Config
	IsInitialSetup bool
)

Variables here are used for configuration

Functions

func ConfirmConfigJSON 

func ConfirmConfigJSON(file []byte, result interface{}) error

ConfirmConfigJSON confirms JSON in file

func ConfirmECS 

func ConfirmECS(file []byte) bool

ConfirmECS confirms that the encryption confirmation string is found

func ConfirmSalt 

func ConfirmSalt(file []byte) bool

ConfirmSalt checks whether the encrypted data contains a salt

func DecryptConfigFile 

func DecryptConfigFile(configData, key []byte) ([]byte, error)

DecryptConfigFile decrypts configuration data with the supplied key and returns the un-encrypted file as a byte array with an error

func EncryptConfigFile 

func EncryptConfigFile(configData, key []byte) ([]byte, error)

EncryptConfigFile encrypts configuration data that is parsed in with a key and returns it as a byte array with an error

func GetFilePath 

func GetFilePath(file string) (string, error)

GetFilePath returns the desired config file or the default config file name based on if the application is being run under test or normal mode.

func PromptForConfigKey 

func PromptForConfigKey(initialSetup bool) ([]byte, error)

PromptForConfigKey asks for configuration key

func RemoveECS 

func RemoveECS(file []byte) []byte

RemoveECS removes encryption confirmation string

Types

type BankAccount 

type BankAccount struct {
	Enabled             bool   `json:"enabled,omitempty"`
	BankName            string `json:"bankName"`
	BankAddress         string `json:"bankAddress"`
	AccountName         string `json:"accountName"`
	AccountNumber       string `json:"accountNumber"`
	SWIFTCode           string `json:"swiftCode"`
	IBAN                string `json:"iban"`
	BSBNumber           string `json:"bsbNumber,omitempty"`
	SupportedCurrencies string `json:"supportedCurrencies"`
	SupportedExchanges  string `json:"supportedExchanges,omitempty"`
}

BankAccount holds differing bank account details by supported funding currency

type BankTransaction 

type BankTransaction struct {
	ReferenceNumber     string `json:"referenceNumber"`
	TransactionNumber   string `json:"transactionNumber"`
	PaymentInstructions string `json:"paymentInstructions"`
}

BankTransaction defines a related banking transaction

type CommunicationsConfig 

type CommunicationsConfig struct {
	SlackConfig     SlackConfig     `json:"slack"`
	SMSGlobalConfig SMSGlobalConfig `json:"smsGlobal"`
	SMTPConfig      SMTPConfig      `json:"smtp"`
	TelegramConfig  TelegramConfig  `json:"telegram"`
}

CommunicationsConfig holds all the information needed for each enabled communication package

type Config 

type Config struct {
	Name              string               `json:"name"`
	EncryptConfig     int                  `json:"encryptConfig"`
	GlobalHTTPTimeout time.Duration        `json:"globalHTTPTimeout"`
	Currency          CurrencyConfig       `json:"currencyConfig"`
	Communications    CommunicationsConfig `json:"communications"`
	Portfolio         portfolio.Base       `json:"portfolioAddresses"`
	Webserver         WebserverConfig      `json:"webserver"`
	Exchanges         []ExchangeConfig     `json:"exchanges"`
	BankAccounts      []BankAccount        `json:"bankAccounts"`

	// Deprecated config settings, will be removed at a future date
	CurrencyPairFormat  *CurrencyPairFormatConfig `json:"currencyPairFormat,omitempty"`
	FiatDisplayCurrency string                    `json:"fiatDispayCurrency,omitempty"`
	Cryptocurrencies    string                    `json:"cryptocurrencies,omitempty"`
	SMS                 *SMSGlobalConfig          `json:"smsGlobal,omitempty"`
}

Config is the overarching object that holds all the information for prestart management of Portfolio, Communications, Webserver and Enabled Exchanges

func GetConfig 

func GetConfig() *Config

GetConfig returns a pointer to a configuration object

func (*Config) CheckClientBankAccounts 

func (c *Config) CheckClientBankAccounts() error

CheckClientBankAccounts checks client bank details

func (*Config) CheckCommunicationsConfig 

func (c *Config) CheckCommunicationsConfig() error

CheckCommunicationsConfig checks to see if the variables are set correctly from config.json

func (*Config) CheckConfig 

func (c *Config) CheckConfig() error

CheckConfig checks all config settings

func (*Config) CheckCurrencyConfigValues 

func (c *Config) CheckCurrencyConfigValues() error

CheckCurrencyConfigValues checks to see if the currency config values are correct or not

func (*Config) CheckExchangeConfigValues 

func (c *Config) CheckExchangeConfigValues() error

CheckExchangeConfigValues returns configuation values for all enabled exchanges

func (*Config) CheckPairConsistency 

func (c *Config) CheckPairConsistency(exchName string) error

CheckPairConsistency checks to see if the enabled pair exists in the available pairs list

func (*Config) CheckWebserverConfigValues 

func (c *Config) CheckWebserverConfigValues() error

CheckWebserverConfigValues checks information before webserver starts and returns an error if values are incorrect.

func (*Config) CountEnabledExchanges 

func (c *Config) CountEnabledExchanges() int

CountEnabledExchanges returns the number of exchanges that are enabled.

func (*Config) GetAllExchangeConfigs 

func (c *Config) GetAllExchangeConfigs() []ExchangeConfig

GetAllExchangeConfigs returns all exchange configurations

func (*Config) GetAvailablePairs 

func (c *Config) GetAvailablePairs(exchName string) ([]pair.CurrencyPair, error)

GetAvailablePairs returns a list of currency pairs for a specifc exchange

func (*Config) GetClientBankAccounts 

func (c *Config) GetClientBankAccounts(exchangeName string, targetCurrency string) (BankAccount, error)

GetClientBankAccounts returns banking details used for a given exchange and currency

func (*Config) GetCommunicationsConfig 

func (c *Config) GetCommunicationsConfig() CommunicationsConfig

GetCommunicationsConfig returns the communications configuration

func (*Config) GetConfigCurrencyPairFormat 

func (c *Config) GetConfigCurrencyPairFormat(exchName string) (*CurrencyPairFormatConfig, error)

GetConfigCurrencyPairFormat returns the config currency pair format for a specific exchange

func (*Config) GetCurrencyConfig 

func (c *Config) GetCurrencyConfig() CurrencyConfig

GetCurrencyConfig returns currency configurations

func (*Config) GetCurrencyPairDisplayConfig 

func (c *Config) GetCurrencyPairDisplayConfig() *CurrencyPairFormatConfig

GetCurrencyPairDisplayConfig retrieves the currency pair display preference

func (*Config) GetDisabledExchanges 

func (c *Config) GetDisabledExchanges() []string

GetDisabledExchanges returns a list of disabled exchanges

func (*Config) GetEnabledExchanges 

func (c *Config) GetEnabledExchanges() []string

GetEnabledExchanges returns a list of enabled exchanges

func (*Config) GetEnabledPairs 

func (c *Config) GetEnabledPairs(exchName string) ([]pair.CurrencyPair, error)

GetEnabledPairs returns a list of currency pairs for a specifc exchange

func (*Config) GetExchangeBankAccounts 

func (c *Config) GetExchangeBankAccounts(exchangeName string, depositingCurrency string) (BankAccount, error)

GetExchangeBankAccounts returns banking details associated with an exchange for depositing funds

func (*Config) GetExchangeConfig 

func (c *Config) GetExchangeConfig(name string) (ExchangeConfig, error)

GetExchangeConfig returns exchange configurations by its indivdual name

func (*Config) GetForexProviderConfig 

func (c *Config) GetForexProviderConfig(name string) (base.Settings, error)

GetForexProviderConfig returns a forex provider configuration by its name

func (*Config) GetPrimaryForexProvider 

func (c *Config) GetPrimaryForexProvider() string

GetPrimaryForexProvider returns the primary forex provider

func (*Config) GetRequestCurrencyPairFormat 

func (c *Config) GetRequestCurrencyPairFormat(exchName string) (*CurrencyPairFormatConfig, error)

GetRequestCurrencyPairFormat returns the request currency pair format for a specific exchange

func (*Config) LoadConfig 

func (c *Config) LoadConfig(configPath string) error

LoadConfig loads your configuration file into your configuration object

func (*Config) PromptForConfigEncryption 

func (c *Config) PromptForConfigEncryption() bool

PromptForConfigEncryption asks for encryption key

func (*Config) ReadConfig 

func (c *Config) ReadConfig(configPath string) error

ReadConfig verifies and checks for encryption and verifies the unencrypted file contains JSON.

func (*Config) RetrieveConfigCurrencyPairs 

func (c *Config) RetrieveConfigCurrencyPairs(enabledOnly bool) error

RetrieveConfigCurrencyPairs splits, assigns and verifies enabled currency pairs either cryptoCurrencies or fiatCurrencies

func (*Config) SaveConfig 

func (c *Config) SaveConfig(configPath string) error

SaveConfig saves your configuration to your desired path

func (*Config) SupportsPair 

func (c *Config) SupportsPair(exchName string, p pair.CurrencyPair) (bool, error)

SupportsPair returns true or not whether the exchange supports the supplied pair

func (*Config) UpdateClientBankAccounts 

func (c *Config) UpdateClientBankAccounts(bankCfg BankAccount) error

UpdateClientBankAccounts updates the configuration for a bank

func (*Config) UpdateCommunicationsConfig 

func (c *Config) UpdateCommunicationsConfig(config CommunicationsConfig)

UpdateCommunicationsConfig sets a new updated version of a Communications configuration

func (*Config) UpdateConfig 

func (c *Config) UpdateConfig(configPath string, newCfg Config) error

UpdateConfig updates the config with a supplied config file

func (*Config) UpdateExchangeBankAccounts 

func (c *Config) UpdateExchangeBankAccounts(exchangeName string, bankCfg []BankAccount) error

UpdateExchangeBankAccounts updates the configuration for the associated exchange bank

func (*Config) UpdateExchangeConfig 

func (c *Config) UpdateExchangeConfig(e ExchangeConfig) error

UpdateExchangeConfig updates exchange configurations

type CurrencyConfig 

type CurrencyConfig struct {
	ForexProviders      []base.Settings           `json:"forexProviders"`
	Cryptocurrencies    string                    `json:"cryptocurrencies"`
	CurrencyPairFormat  *CurrencyPairFormatConfig `json:"currencyPairFormat"`
	FiatDisplayCurrency string                    `json:"fiatDisplayCurrency"`
}

CurrencyConfig holds all the information needed for currency related manipulation

type CurrencyPairFormatConfig 

type CurrencyPairFormatConfig struct {
	Uppercase bool   `json:"uppercase"`
	Delimiter string `json:"delimiter,omitempty"`
	Separator string `json:"separator,omitempty"`
	Index     string `json:"index,omitempty"`
}

CurrencyPairFormatConfig stores the users preferred currency pair display

type ExchangeConfig 

type ExchangeConfig struct {
	Name                      string                    `json:"name"`
	Enabled                   bool                      `json:"enabled"`
	Verbose                   bool                      `json:"verbose"`
	Websocket                 bool                      `json:"websocket"`
	UseSandbox                bool                      `json:"useSandbox"`
	RESTPollingDelay          time.Duration             `json:"restPollingDelay"`
	HTTPTimeout               time.Duration             `json:"httpTimeout"`
	HTTPUserAgent             string                    `json:"httpUserAgent"`
	AuthenticatedAPISupport   bool                      `json:"authenticatedApiSupport"`
	APIKey                    string                    `json:"apiKey"`
	APISecret                 string                    `json:"apiSecret"`
	APIAuthPEMKeySupport      bool                      `json:"apiAuthPemKeySupport,omitempty"`
	APIAuthPEMKey             string                    `json:"apiAuthPemKey,omitempty"`
	APIURL                    string                    `json:"apiUrl"`
	APIURLSecondary           string                    `json:"apiUrlSecondary"`
	ClientID                  string                    `json:"clientId,omitempty"`
	AvailablePairs            string                    `json:"availablePairs"`
	EnabledPairs              string                    `json:"enabledPairs"`
	BaseCurrencies            string                    `json:"baseCurrencies"`
	AssetTypes                string                    `json:"assetTypes"`
	SupportsAutoPairUpdates   bool                      `json:"supportsAutoPairUpdates"`
	PairsLastUpdated          int64                     `json:"pairsLastUpdated,omitempty"`
	ConfigCurrencyPairFormat  *CurrencyPairFormatConfig `json:"configCurrencyPairFormat"`
	RequestCurrencyPairFormat *CurrencyPairFormatConfig `json:"requestCurrencyPairFormat"`
	BankAccounts              []BankAccount             `json:"bankAccounts"`
}

ExchangeConfig holds all the information needed for each enabled Exchange.

type Post 

type Post struct {
	Data Config `json:"data"`
}

Post holds the bot configuration data

type SMSContact 

type SMSContact struct {
	Name    string `json:"name"`
	Number  string `json:"number"`
	Enabled bool   `json:"enabled"`
}

SMSContact stores the SMS contact info

type SMSGlobalConfig 

type SMSGlobalConfig struct {
	Name     string       `json:"name"`
	Enabled  bool         `json:"enabled"`
	Verbose  bool         `json:"verbose"`
	Username string       `json:"username"`
	Password string       `json:"password"`
	Contacts []SMSContact `json:"contacts"`
}

SMSGlobalConfig structure holds all the variables you need for instant messaging and broadcast used by SMSGlobal

type SMTPConfig 

type SMTPConfig struct {
	Name            string `json:"name"`
	Enabled         bool   `json:"enabled"`
	Verbose         bool   `json:"verbose"`
	Host            string `json:"host"`
	Port            string `json:"port"`
	AccountName     string `json:"accountName"`
	AccountPassword string `json:"accountPassword"`
	RecipientList   string `json:"recipientList"`
}

SMTPConfig holds all variables to start and run the SMTP package

type SlackConfig 

type SlackConfig struct {
	Name              string `json:"name"`
	Enabled           bool   `json:"enabled"`
	Verbose           bool   `json:"verbose"`
	TargetChannel     string `json:"targetChannel"`
	VerificationToken string `json:"verificationToken"`
}

SlackConfig holds all variables to start and run the Slack package

type TelegramConfig 

type TelegramConfig struct {
	Name              string `json:"name"`
	Enabled           bool   `json:"enabled"`
	Verbose           bool   `json:"verbose"`
	VerificationToken string `json:"verificationToken"`
}

TelegramConfig holds all variables to start and run the Telegram package

type WebserverConfig 

type WebserverConfig struct {
	Enabled                      bool   `json:"enabled"`
	AdminUsername                string `json:"adminUsername"`
	AdminPassword                string `json:"adminPassword"`
	ListenAddress                string `json:"listenAddress"`
	WebsocketConnectionLimit     int    `json:"websocketConnectionLimit"`
	WebsocketMaxAuthFailures     int    `json:"websocketMaxAuthFailures"`
	WebsocketAllowInsecureOrigin bool   `json:"websocketAllowInsecureOrigin"`
}

WebserverConfig struct holds the prestart variables for the webserver.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.