cryptoasset

Documentation

Overview

Package cryptoasset contains the calculus for bitcoin variation day by day

Index

• Variables
• type BitcoinPrice
• type BitcoinPriceGetter
• type Variation
  • func GetBitcoinVariation(startDate, endDate string) (btcVars []Variation, err error)

Variables

var (
	// ErrStartDateAfterEndDate is the error returned when the start date is after the end date
	ErrStartDateAfterEndDate = errors.New("start date after end date")
)

Types

type BitcoinPrice

type BitcoinPrice struct {
	Date  string  `json:"date"`
	Price float64 `json:"price"`
}

BitcoinPrice represents the price of a bitcoin on a given date.

type BitcoinPriceGetter

type BitcoinPriceGetter interface {
	GetBitcoinPrice(date string) (btprice BitcoinPrice, err error)
}

BitcoinPriceGetter is the interface that wraps the GetBitcoinPrice method.

type Variation

type Variation struct {
	Date      string  `json:"date"`
	Variation float64 `json:"variation"`
}

Variation represents a single day variation of an asset

func GetBitcoinVariation

func GetBitcoinVariation(startDate, endDate string) (btcVars []Variation, err error)

GetBitcoinVariation returns the bitcoin variation on a given period. The expected format is YYYY-MM-DD.