base

README

GoCryptoTrader package Forexprovider

This forexprovider 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 forexprovider

• 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

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

• type Base
  • func (b *Base) GetName() string
  • func (b *Base) IsEnabled() bool
  • func (b *Base) IsPrimaryProvider() bool
• type IFXProvider
• type IFXProviders
  • func (fxp IFXProviders) GetCurrencyData(baseCurrency, symbols string) (map[string]float64, error)
• type Settings

Types

type Base

type Base struct {
	Settings `json:"settings"`
}

Base enforces standard variables across the provider packages

func (*Base) GetName

func (b *Base) GetName() string

GetName returns name of provider

func (*Base) IsEnabled

func (b *Base) IsEnabled() bool

IsEnabled returns true if enabled

func (*Base) IsPrimaryProvider

func (b *Base) IsPrimaryProvider() bool

IsPrimaryProvider returns true if primary provider

type IFXProvider

type IFXProvider interface {
	Setup(config Settings)
	GetRates(baseCurrency, symbols string) (map[string]float64, error)
	GetName() string
	IsEnabled() bool
	IsPrimaryProvider() bool
}

IFXProvider enforces standard functions for all foreign exchange providers supported in GoCryptoTrader

type IFXProviders

type IFXProviders []IFXProvider

IFXProviders contains an array of foreign exchange interfaces

func (IFXProviders) GetCurrencyData

func (fxp IFXProviders) GetCurrencyData(baseCurrency, symbols string) (map[string]float64, error)

GetCurrencyData returns currency data from enabled FX providers

type Settings

type Settings struct {
	Name             string        `json:"name"`
	Enabled          bool          `json:"enabled"`
	Verbose          bool          `json:"verbose"`
	RESTPollingDelay time.Duration `json:"restPollingDelay"`
	APIKey           string        `json:"apiKey"`
	APIKeyLvl        int           `json:"apiKeyLvl"`
	PrimaryProvider  bool          `json:"primaryProvider"`
}

Settings enforces standard variables across the provider packages