types

type AggregateFn func(providers AggregatedProviderPrices) map[types.CurrencyPair]*uint256.Int

type AggregatedProviderPrices map[string]map[types.CurrencyPair]QuotePrice

type PriceAggregator struct {
	// contains filtered or unexported fields
}

type Provider interface {
	// Name returns the name of the provider.
	Name() string

	// GetPrices returns the aggregated prices based on the provided currency pairs.
	GetPrices(context.Context) (map[types.CurrencyPair]QuotePrice, error)

	// SetPairs sets the pairs that the provider should fetch prices for.
	SetPairs(...types.CurrencyPair)

	// GetPairs returns the pairs that the provider is fetching prices for.
	GetPairs() []types.CurrencyPair
}

type ProviderConfig struct {
	// Name identifies which provider this config is for
	Name string `mapstructure:"name" toml:"name"`

	// Apikey is the api-key accompanying requests to the provider's API.
	Apikey string `mapstructure:"apikey" toml:"apikey"`

	// TokenNameToSymbol is a map of token names to their symbols, i.e how each token in the CurrencyPair should
	// map to the token references in the queried provider's API.
	TokenNameToSymbol map[string]string `mapstructure:"token_name_to_symbol"`

	// ProviderTimeout is the maximum amount of time to wait for a response from the provider.
	ProviderTimeout time.Duration `mapstructure:"provider_timeout"`
}

type QuotePrice struct {
	// Price tracks the quote price for a given CurrencyPair.
	Price *uint256.Int

	// Timestamp tracks the time at which the price was fetched.
	Timestamp time.Time
}