api

Documentation

Index

• func NewServer(bench Benchmark, log *zap.Logger) http.Handler
• type Benchmark
• type ScanRequest

Functions

func NewServer

func NewServer(bench Benchmark, log *zap.Logger) http.Handler

NewServer initializes the API

Types

type Benchmark

type Benchmark interface {
	ScanHost(ctx context.Context, hostAddr string, hostKey types.PublicKey) (benchmark.Settings, error)
	PingHost(ctx context.Context, hostAddr string, hostKey types.PublicKey) benchmark.PingResult
}

A Benchmark benchmarks hosts and manages contracts

type ScanRequest

type ScanRequest struct {
	Address string          `json:"address"`
	HostKey types.PublicKey `json:"hostKey"`
}

A ScanRequest scans a host's settings and price table