v1

Documentation

Index

• Constants
• type HealthZResponse
• type Metrics
• type Oracle
• type PricesPerProviderResponse
• type PricesResponse
• type Router
  • func New(logger zerolog.Logger, cfg config.Config, oracle Oracle, metrics Metrics) *Router
  • func (r *Router) RegisterRoutes(rtr *mux.Router, prefix string)

Constants

const (
	APIPathPrefix = "/api/v1"
)

const (
	StatusAvailable = "available"
)

Response constants

Types

type HealthZResponse

type HealthZResponse struct {
	Status string `json:"status" yaml:"status"`
	Oracle struct {
		LastSync string `json:"last_sync"`
	} `json:"oracle"`
}

HealthZResponse defines the response type for the healthy API handler.

type Metrics

type Metrics interface {
	Gather(format string) (telemetry.GatherResponse, error)
}

type Oracle

type Oracle interface {
	GetLastPriceSyncTimestamp() time.Time
	GetPrices() types.CurrencyPairDec
	GetTvwapPrices() types.CurrencyPairDecByProvider
	GetVwapPrices() types.CurrencyPairDecByProvider
}

Oracle defines the Oracle interface contract that the v1 router depends on.

type PricesPerProviderResponse

type PricesPerProviderResponse struct {
	Prices types.CurrencyPairDecByProvider `json:"providers"`
}

type PricesResponse

type PricesResponse struct {
	Prices types.CurrencyPairDec `json:"prices"`
}

PricesResponse defines the response type for getting the latest exchange rates from the oracle.

type Router

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

Router defines a router wrapper used for registering v1 API routes.

func New

func New(logger zerolog.Logger, cfg config.Config, oracle Oracle, metrics Metrics) *Router

func (*Router) RegisterRoutes

func (r *Router) RegisterRoutes(rtr *mux.Router, prefix string)

RegisterRoutes register v1 API routes on the provided sub-router.