config

type APIConfig struct {
	// Enabled is a flag that indicates whether the provider is API based.
	Enabled bool `json:"enabled"`

	// Timeout is the amount of time the provider should wait for a response from
	// its API before timing out.
	Timeout time.Duration `json:"timeout"`

	// Interval is the interval at which the provider should update the prices.
	Interval time.Duration `json:"interval"`

	// ReconnectTimeout is the amount of time the provider should wait before
	// reconnecting to the API.
	ReconnectTimeout time.Duration `json:"reconnectTimeout"`

	// MaxQueries is the maximum number of concurrent queries that the provider will make
	// within the interval.
	MaxQueries int `json:"maxQueries"`

	// Atomic is a flag that indicates whether the provider can fulfill its queries
	// in a single request.
	Atomic bool `json:"atomic"`

	// Endpoints is a list of endpoints that the provider can query.
	Endpoints []Endpoint `json:"endpoints"`

	// BatchSize is the maximum number of IDs that the provider can query in a single
	// request. This parameter must be 0 for atomic providers. Otherwise, the effective
	// value will be max(1, BatchSize). Notice, if numCPs > batchSize * maxQueries then
	// some currency-pairs may not be fetched each interval.
	BatchSize int `json:"batchSize"`

	// Name is the name of the provider that corresponds to this config.
	Name string `json:"name"`

	// MaxBlockHeightAge is the oldest an update from an on-chain data source can be without having its
	// block height incremented.  In the case where a data source has exceeded this limit and the block
	// height is not increasing, price reporting will be skipped until the block height increases.
	MaxBlockHeightAge time.Duration `json:"maxBlockHeightAge"`
}

type AppConfig struct {
	// Enabled indicates whether the oracle is enabled.
	Enabled bool `mapstructure:"enabled" toml:"enabled"`

	// OracleAddress is the URL of the out of process oracle sidecar. This is
	// used to connect to the oracle sidecar.
	OracleAddress string `mapstructure:"oracle_address" toml:"oracle_address"`

	// ClientTimeout is the time that the client is willing to wait for responses
	// from the oracle before timing out.
	ClientTimeout time.Duration `mapstructure:"client_timeout" toml:"client_timeout"`

	// MetricsEnabled is a flag that determines whether oracle metrics are enabled.
	MetricsEnabled bool `mapstructure:"metrics_enabled" toml:"metrics_enabled"`

	// PriceTTL is the maximum age of the latest price response before it is considered
	// stale.
	PriceTTL time.Duration `mapstructure:"price_ttl" toml:"price_ttl"`

	// Interval is the time between each price update request.
	Interval time.Duration `mapstructure:"interval" toml:"interval"`
}

type Authentication struct {
	// HTTPHeaderAPIKey is the API-key that will be set under the X-Api-Key header
	APIKey string `json:"apiKey"`

	// APIKeyHeader is the header that will be used to set the API key.
	APIKeyHeader string `json:"apiKeyHeader"`
}

type Endpoint struct {
	// URL is the URL that is used to fetch data from the API.
	URL string `json:"url"`

	// Authentication holds all data necessary for an API provider to authenticate with
	// an endpoint.
	Authentication Authentication `json:"authentication"`
}

type MetricsConfig struct {
	// PrometheusServerAddress is the address of the prometheus server that the oracle will expose
	// metrics to.
	PrometheusServerAddress string `json:"prometheusServerAddress"`

	// Enabled indicates whether metrics should be enabled.
	Enabled bool `json:"enabled"`
}

type OracleConfig struct {
	// UpdateInterval is the interval at which the oracle will fetch prices from providers.
	UpdateInterval time.Duration `json:"updateInterval"`

	// MaxPriceAge is the maximum age of a price that the oracle will consider valid. If a
	// price is older than this, the oracle will not consider it valid and will not return it in /prices
	// requests.
	MaxPriceAge time.Duration `json:"maxPriceAge"`

	// Providers is the list of providers that the oracle will fetch prices from.
	Providers map[string]ProviderConfig `json:"providers"`

	// Metrics is the metrics configurations for the oracle.
	Metrics MetricsConfig `json:"metrics"`

	// Host is the host that the oracle will listen on.
	Host string `json:"host"`

	// Port is the port that the oracle will listen on.
	Port string `json:"port"`
}

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

	// API is the config for the API based data provider. If the provider does not
	// support API based fetching, this field should be omitted.
	API APIConfig `json:"api"`

	// WebSocket is the config for the websocket based data provider. If the provider
	// does not support websocket based fetching, this field should be omitted.
	WebSocket WebSocketConfig `json:"webSocket"`

	// Type is the type of the provider (i.e. price, market map, other). This is used
	// to determine how to construct the provider.
	Type string `json:"type"`
}

type WebSocketConfig struct {
	// Enabled is a flag that indicates whether the provider is websocket based.
	Enabled bool `json:"enabled"`

	// MaxBufferSize is the maximum number of messages that the provider will buffer
	// at any given time. If the provider receives more messages than this, it will
	// block receiving messages until the buffer is cleared.
	MaxBufferSize int `json:"maxBufferSize"`

	// ReconnectionTimeout is the timeout for the provider to attempt to reconnect
	// to the websocket endpoint.
	ReconnectionTimeout time.Duration `json:"reconnectionTimeout"`

	// PostConnectionTimeout is the timeout for the provider to wait after a connection
	// is established before sending messages.
	PostConnectionTimeout time.Duration `json:"postConnectionTimeout"`

	// Endpoints are the websocket endpoints for the provider. At least one endpoint
	// must be specified.
	Endpoints []Endpoint `json:"endpoints"`

	// Name is the name of the provider that corresponds to this config.
	Name string `json:"name"`

	// ReadBufferSize specifies the I/O read buffer size. if a buffer size of 0 is
	// specified, then a default buffer size is used.
	ReadBufferSize int `json:"readBufferSize"`

	// WriteBufferSize specifies the I/O write buffer size. if a buffer size of 0 is
	// specified, then a default buffer size is used.
	WriteBufferSize int `json:"writeBufferSize"`

	// HandshakeTimeout specifies the duration for the handshake to complete.
	HandshakeTimeout time.Duration `json:"handshakeTimeout"`

	// EnableCompression specifies if the client should attempt to negotiate per
	// message compression (RFC 7692). Setting this value to true does not guarantee
	// that compression will be supported. Note that enabling compression may
	EnableCompression bool `json:"enableCompression"`

	// ReadTimeout sets the read deadline on the underlying network connection.
	// After a read has timed out, the websocket connection state is corrupt and
	// all future reads will return an error. A zero value for t means reads will
	// not time out.
	ReadTimeout time.Duration `json:"readTimeout"`

	// WriteTimeout sets the write deadline on the underlying network
	// connection. After a write has timed out, the websocket state is corrupt and
	// all future writes will return an error. A zero value for t means writes will
	// not time out.
	WriteTimeout time.Duration `json:"writeTimeout"`

	// PingInterval is the interval to ping the server. Note that a ping interval
	// of 0 disables pings.
	PingInterval time.Duration `json:"pingInterval"`

	// WriteInterval is the interval at which the provider should wait before sending
	// consecutive write messages to the server.
	WriteInterval time.Duration `json:"writeInterval"`

	// MaxReadErrorCount is the maximum number of read errors that the provider
	// will tolerate before closing the connection and attempting to reconnect.
	MaxReadErrorCount int `json:"maxReadErrorCount"`

	// MaxSubscriptionsPerConnection is the maximum amount of subscriptions that
	// can be assigned to a single connection for this provider.  The null value (0),
	// indicates that there is no limit per connection.
	MaxSubscriptionsPerConnection int `json:"maxSubscriptionsPerConnection"`

	// MaxSubscriptionsPerBatch is the maximum number of subscription messages that the
	// provider will send in a single batch/write.
	MaxSubscriptionsPerBatch int `json:"maxSubscriptionsPerBatch"`
}