base

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
}

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
	Enabled          bool
	Verbose          bool
	RESTPollingDelay time.Duration
	APIKey           string
	APIKeyLvl        int
	PrimaryProvider  bool
}

Settings enforces standard variables across the provider packages