api

package

v0.6.0-RC2 Latest Latest Go to latest Published: Jun 11, 2025 License: Apache-2.0, MIT Imports: 38 Imported by: 0

Documentation ¶

This section is empty.

This section is empty.

func Run(c *cli.Context) error

type APIParams struct {
	Listener   net.Listener
	LotusAPI   string
	LotusToken string
	ConnString string
}

type HTTPError struct {
	Err string `json:"err"`
}

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

func InitServer(ctx context.Context, params APIParams) (*Server, error)

func (s *Server) Name() string

func (s *Server) Start(ctx context.Context, exitErr chan<- error) error

Start initializes the server, sets up routes and middlewares, and starts listening for incoming requests.

This method:

Initializes analytics.
Configures the echo server with recovery, logging, and CORS middleware.
Sets up various routes, including serving static files for the dashboard and a swagger UI.
Starts the echo server and manages its lifecycle with background goroutines.
Gracefully shuts down the server on context cancellation.
Closes database connections and other resources.

Parameters:

ctx: A context.Context used to control the server's lifecycle and propagate cancellation.

Returns:

A slice of channels (service.Done) that signal when different parts of the service have completed their work. This includes: 1. The main echo server's completion. 2. The host's completion. 3. Completion of analytics event flushing.
A channel (service.Fail) that reports errors that occur while the server is running.
An error if there is an issue during the initialization phase, otherwise nil.