api

type APIService ¶ added in v1.4.2

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

Api ... Indexer API struct TODO : Structured error responses

func NewApi(ctx context.Context, log log.Logger, cfg *Config) (*APIService, error)

func (a *APIService) Addr() string

func (a *APIService) Start(ctx context.Context) error

func (a *APIService) Stop(ctx context.Context) error

func (a *APIService) Stopped() bool

type Config ¶ added in v1.4.2

type Config struct {
	DB            DBConnector
	HTTPServer    config.ServerConfig
	MetricsServer config.ServerConfig
}

Config for the API service

type DB ¶ added in v1.4.2

type DB struct {
	BridgeTransfers database.BridgeTransfersView
	Closer          func() error
}

DB represents the abstract DB access the API has.

type DBConfigConnector ¶ added in v1.4.2

type DBConfigConnector struct {
	config.DBConfig
}

DBConfigConnector implements a fully config based DBConnector

func (cfg *DBConfigConnector) OpenDB(ctx context.Context, log log.Logger) (*DB, error)

type DBConnector ¶ added in v1.4.2

type DBConnector interface {
	OpenDB(ctx context.Context, log log.Logger) (*DB, error)
}

DBConnector is an interface: the config may provide different ways to access the DB. This is implemented in tests to provide custom DB views, or share the DB with other services.

type TestDBConnector ¶ added in v1.4.2

type TestDBConnector struct {
	BridgeTransfers database.BridgeTransfersView
}

func (tdb *TestDBConnector) OpenDB(ctx context.Context, log log.Logger) (*DB, error)