backend

Documentation

Index

• func InitBotNameRegex() (e error)
• func SetRoutes(r *chi.Mux, s *APIServer)
• type APIServer
  • func MakeAPIServer(kos *kelpos.KelpOS, botConfigsPath *kelpos.OSPath, botLogsPath *kelpos.OSPath, ...) (*APIServer, error)
  • func (s *APIServer) InitBackend() error
• type ErrorResponse
• type KelpError
  • func (ke *KelpError) String() string
• type KelpErrorListResponseWrapper
• type KelpErrorResponseWrapper
  • func (kerw *KelpErrorResponseWrapper) String() string
• type RemoveKelpErrorRequest
• type RemoveKelpErrorResponse

Functions

func InitBotNameRegex

func InitBotNameRegex() (e error)

InitBotNameRegex initializes the regex for bot names.

func SetRoutes

func SetRoutes(r *chi.Mux, s *APIServer)

SetRoutes

Types

type APIServer

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

APIServer is an instance of the API service

func MakeAPIServer

func MakeAPIServer(
	kos *kelpos.KelpOS,
	botConfigsPath *kelpos.OSPath,
	botLogsPath *kelpos.OSPath,
	horizonTestnetURI string,
	apiTestNet *horizonclient.Client,
	horizonPubnetURI string,
	apiPubNet *horizonclient.Client,
	ccxtRestUrl string,
	noHeaders bool,
	quitFn func(),
	metricsTracker *plugins.MetricsTracker,
) (*APIServer, error)

MakeAPIServer is a factory method

func (*APIServer) InitBackend

func (s *APIServer) InitBackend() error

InitBackend initializes anything required to get the backend ready to serve

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse represents an error (deprecated)

type KelpError

type KelpError struct {
	UUID       string     `json:"uuid"`
	ObjectType errorType  `json:"object_type"`
	ObjectName string     `json:"object_name"`
	Date       time.Time  `json:"date"`
	Level      errorLevel `json:"level"`
	Message    string     `json:"message"`
}

KelpError represents an error

func (*KelpError) String

func (ke *KelpError) String() string

String is the Stringer method

type KelpErrorListResponseWrapper

type KelpErrorListResponseWrapper struct {
	KelpErrorList []KelpError `json:"kelp_error_list"`
}

KelpErrorListResponseWrapper is the outer object that contains the Kelp Errors

type KelpErrorResponseWrapper

type KelpErrorResponseWrapper struct {
	KelpError KelpError `json:"kelp_error"`
}

KelpErrorResponseWrapper is the outer object that contains the Kelp Error

func (*KelpErrorResponseWrapper) String

func (kerw *KelpErrorResponseWrapper) String() string

String is the Stringer method

type RemoveKelpErrorRequest

type RemoveKelpErrorRequest struct {
	KelpErrorIDs []string `json:"kelp_error_ids"`
}

RemoveKelpErrorRequest is the outer object that contains the Kelp Error

type RemoveKelpErrorResponse

type RemoveKelpErrorResponse struct {
	RemovedMap map[string]bool `json:"removed_map"`
}

RemoveKelpErrorResponse is the outer object that contains the Kelp Error