api

Documentation

Overview

Package api provides the api for the explorer service.

Index

• func HandleJSONAmountStat(r *gqlClient.GetAmountStatistic) *model.ValueResult
• func HandleJSONDailyStat(r *gqlClient.GetDailyStatisticsByChain) []*model.DateResultByChain
• func InitDB(ctx context.Context, address string, readOnly bool, handler metrics.Handler) (db.ConsumerDB, error)
• func RehydrateCache(parentCtx context.Context, client *gqlClient.Client, service cache.Service, ...) (err error)
• func Start(ctx context.Context, cfg Config, handler metrics.Handler) error
• type Config

Functions

func HandleJSONAmountStat

func HandleJSONAmountStat(r *gqlClient.GetAmountStatistic) *model.ValueResult

HandleJSONAmountStat converts the gqlClient.GetAmountStatistic to model.ValueResul.

func HandleJSONDailyStat

func HandleJSONDailyStat(r *gqlClient.GetDailyStatisticsByChain) []*model.DateResultByChain

HandleJSONDailyStat converts the gqlClient.GetDailyStatisticsByChain to the []*model.DateResultByChain type.

func InitDB

func InitDB(ctx context.Context, address string, readOnly bool, handler metrics.Handler) (db.ConsumerDB, error)

InitDB initializes a database given a database type and path.

func RehydrateCache

func RehydrateCache(parentCtx context.Context, client *gqlClient.Client, service cache.Service, handler metrics.Handler) (err error)

RehydrateCache rehydrates the cache.

nolint:dupl,gocognit,cyclop,maintidx

func Start

func Start(ctx context.Context, cfg Config, handler metrics.Handler) error

Start starts the api server.

nolint:cyclop

Types

type Config

type Config struct {
	// HTTPPort is the http port for the api
	HTTPPort uint16
	// Address is the address of the database
	Address string
	// ScribeURL is the url of the scribe service
	ScribeURL string
	// HydrateCache is whether or not to hydrate the cache
	HydrateCache bool
}

Config contains the config for the api.