utils

Documentation

Index

• func AfterDay(date1, date2 time.Time) bool
• func Average(series []float64) (average float64)
• func CheckWeekDay(date time.Time) bool
• func CloseHTTPResp(resp *http.Response)
• func ComputeMedian(samples []float64) (median float64)
• func Contains(s *[]string, str string) bool
• func ContainsDay(s []time.Time, date time.Time) bool
• func CountDays(dateInit, dateFinal time.Time, business bool) (days int, err error)
• func DiscardOutliers(prices []float64, volumes []float64, basispoints float64) (newPrices []float64, newVolumes []float64, discarded []int, err error)
• func DownloadResource(filepath, url string) (err error)
• func GetCoinPrice(coin string) (float64, error)
• func GetHolidays(workdays []time.Time, dateInit, dateFinal time.Time) []time.Time
• func GetRequest(url string) ([]byte, int, error)
• func GetRequestWithStatus(url string) ([]byte, int, error)
• func GetTomorrow(date, layout string) string
• func GetYesterday(date, layout string) string
• func Getenv(key, fallback string) string
• func GraphQLGet(url string, query []byte, bearer string) ([]byte, int, error)
• func HTTPRequest(request *http.Request) (body []byte, statusCode int, err error)
• func IsEnvExist(key string) bool
• func MakeTimeRanges(timeInit, timeFinal time.Time, numRanges int) (starttimes, endtimes []time.Time)
• func MakeTimerange(starttimeString string, endtimeString string, timeRange time.Duration) (starttime time.Time, endtime time.Time, err error)
• func MaxString(sl []string) (string, int64)
• func MinString(sl []string) (string, int64)
• func OpenseaGetRequest(OpenseaURL string) ([]byte, int, error)
• func PostRequest(url string, body io.Reader) ([]byte, error)
• func SameDays(date1, date2 time.Time) bool
• func SliceDifference(slice1, slice2 []string) []string
• func StandardDeviation(series []float64) float64
• func StrToUnixtime(s string) (t time.Time, err error)
• func UniqueStrings(s []string) []string
• func Variance(series []float64) (variance float64)
• func Vwap(prices []float64, volumes []float64) (float64, error)
• type ArgsortableSlice
  • func NewFloat64Slice(sf sort.Float64Slice) *ArgsortableSlice
  • func (as ArgsortableSlice) Ind() []int
  • func (s ArgsortableSlice) Swap(i, j int)
• type EthFilteredTx
• type EthTxFilterCriteria
• type EthTxFilterResult
  • func EthFilterTXs(ctx context.Context, ethClient *ethclient.Client, filter EthTxFilterCriteria) (*EthTxFilterResult, error)

Functions

func AfterDay

func AfterDay(date1, date2 time.Time) bool

AfterDay returns true if date1 is a date after date2, irrespective of the daytime. The go method "After" respects daytime.

func Average

func Average(series []float64) (average float64)

Average returns the average of @samples.

func CheckWeekDay

func CheckWeekDay(date time.Time) bool

CheckWeekDay returns true if @date is not weekend and false otherwise.

func CloseHTTPResp

func CloseHTTPResp(resp *http.Response)

CloseHTTPResp is a wrapper for closing http response bodies while complying with the linter.

func ComputeMedian

func ComputeMedian(samples []float64) (median float64)

ComputeMedian returns the median of @samples.

func Contains

func Contains(s *[]string, str string) bool

Contains takes a slice of strings and a string and checks if it is contained in the slice.

func ContainsDay

func ContainsDay(s []time.Time, date time.Time) bool

ContainsDay returns true if day @date is contained in slice @s, independent of the daytime. As a consequence, be cautious when comparing days in different timezones.

func CountDays

func CountDays(dateInit, dateFinal time.Time, business bool) (days int, err error)

CountDays returns the number of days between @dateInit and @dateFinal, both given as converted from a string in the format yyyy-mm-dd, excluding the last day. @bool If true only business days are counted.

func DiscardOutliers

func DiscardOutliers(prices []float64, volumes []float64, basispoints float64) (newPrices []float64, newVolumes []float64, discarded []int, err error)

DiscardOutliers discards every data point from @prices and @volumes that deviates from the price median by more than @basispoints basis points.

func DownloadResource

func DownloadResource(filepath, url string) (err error)

DownloadResource is a simple utility that downloads a resource from @url and stores it into @filepath.

func GetCoinPrice

func GetCoinPrice(coin string) (float64, error)

GetCoinPrice Gets the price in USD of coin through our API. Looks it up on coingecko in case it doesn't find it there.

func GetHolidays

func GetHolidays(workdays []time.Time, dateInit, dateFinal time.Time) []time.Time

GetHolidays returns "holidays" as non-weekend complement of given days @workdays

func GetRequest

func GetRequest(url string) ([]byte, int, error)

GetRequest performs a get request on @url and returns the response body as a slice of byte data.

func GetRequestWithStatus

func GetRequestWithStatus(url string) ([]byte, int, error)

GetRequest performs a get request on @url and returns the response body as a slice of byte data.

func GetTomorrow

func GetTomorrow(date, layout string) string

GetTomorrow returns the day before @date in the world of strings, formatted as @layout

func GetYesterday

func GetYesterday(date, layout string) string

GetYesterday returns the day before @date in the world of strings, formatted as @layout

func Getenv

func Getenv(key, fallback string) string

func GraphQLGet

func GraphQLGet(url string, query []byte, bearer string) ([]byte, int, error)

GraphQLGet returns the body of the result of a graphQL GET query. @url is the base url of the graphQL API @query is a byte slice representing the graphQL query message @bearer contains the API key if present

func HTTPRequest

func HTTPRequest(request *http.Request) (body []byte, statusCode int, err error)

HTTPRequest returns the request body and defers the closing compliant to linting.

func IsEnvExist

func IsEnvExist(key string) bool

func MakeTimeRanges

func MakeTimeRanges(timeInit, timeFinal time.Time, numRanges int) (starttimes, endtimes []time.Time)

MakeTimeRanges returns @numRanges start- and endtimes partitioning [@timeInit, @timeFinal] in intervals of identical size.

func MakeTimerange

func MakeTimerange(starttimeString string, endtimeString string, timeRange time.Duration) (starttime time.Time, endtime time.Time, err error)

MakeTimerange parses Unix timestamps given as strings. In case one of the two is empty, it returns a time-range based on @timeRange.

func MaxString

func MaxString(sl []string) (string, int64)

MaxString return the maximum of a slice of strings along with its index

func MinString

func MinString(sl []string) (string, int64)

MinString return the maximum of a slice of strings along with its index

func OpenseaGetRequest

func OpenseaGetRequest(OpenseaURL string) ([]byte, int, error)

OpenseaGetRequest returns the data for a get request on @url with an Opensea API key.

func PostRequest

func PostRequest(url string, body io.Reader) ([]byte, error)

PostRequest performs a POST request on @url and returns the response body as a slice of byte data.

func SameDays

func SameDays(date1, date2 time.Time) bool

SameDays returns true if @date1 is the same date as @date2, independent of the daytime.

func SliceDifference

func SliceDifference(slice1, slice2 []string) []string

SliceDifference returns the elements in @slice1 that aren't in @slice2.

func StandardDeviation

func StandardDeviation(series []float64) float64

func StrToUnixtime

func StrToUnixtime(s string) (t time.Time, err error)

StrToUnixtime converts a string corresponding to an int to Unix time

func UniqueStrings

func UniqueStrings(s []string) []string

UniqueStrings returns a subslice of @s such that each entry only appears once

func Variance

func Variance(series []float64) (variance float64)

func Vwap

func Vwap(prices []float64, volumes []float64) (float64, error)

vwap returns the volume weighted average price for the slices @prices and @volumes.

Types

type ArgsortableSlice

type ArgsortableSlice struct {
	sort.Interface
	// contains filtered or unexported fields
}

ArgsortableSlice is a wrapper struct around the sort interface. It allows for implemetation of argsort for all sortable types.

func NewFloat64Slice

func NewFloat64Slice(sf sort.Float64Slice) *ArgsortableSlice

NewFloat64Slice returns the wrapped float64slice that can be argsorted.

func (ArgsortableSlice) Ind

func (as ArgsortableSlice) Ind() []int

func (ArgsortableSlice) Swap

func (s ArgsortableSlice) Swap(i, j int)

Swap swaps the corresponding indices together with the values.

type EthFilteredTx

type EthFilteredTx struct {
	BlockNum  uint64
	BlockHash common.Hash
	TXIndex   uint
	TXHash    common.Hash
	Logs      []types.Log // list of matched log records if Events or EvAddrs were used, otherwise all logs of the transaction
}

EthFilteredTx holds limited info for found transactions

type EthTxFilterCriteria

type EthTxFilterCriteria struct {
	StartBlockNum      uint64           // inclusive. filter transactions from the specific block
	StartTxIndex       uint             // inclusive. filter transactions from specific index in the given StartBlockNum
	LimitBlocks        int              // filter transactions in the specific number of blocks, zero means up to highest possible block
	BehindHighestBlock int              // stay behind the highest synched block if StartBlockNum+LimitBlocks in excess of the head
	EvAddrs            []common.Address // list of addresses from which transaction events should originate
	Events             []common.Hash    // list of events from which transactions should contain
}

EthTxFilterCriteria used for filtering transaction records

type EthTxFilterResult

type EthTxFilterResult struct {
	Synced       bool             // it means the most recent inspected block matches the highest known block (see BehindHighestBlock)
	NumBlocks    int              // number of blocks found
	NumTXs       int              // number of transactions found
	NumLogs      int              // number of log records found
	TXs          []*EthFilteredTx // list of found transactions
	LastBlockNum uint64           // block number of most recent transaction inspected
}

EthTxFilterResult describes filter results and holds found transactions

func EthFilterTXs

func EthFilterTXs(ctx context.Context, ethClient *ethclient.Client, filter EthTxFilterCriteria) (*EthTxFilterResult, error)

EthFilterTXs returns transactions filtered by log records