rest

Documentation

Overview

Package rest implements the rest driver

Index

• Constants
• type APIServer
  • func NewRestAPIServer(ctx context.Context, cfg *config.Config) (*APIServer, error)
  • func (r *APIServer) Authenticate(c *gin.Context, q *models.Quote) (err error)
  • func (r *APIServer) Run(ctx context.Context) error
  • func (r *APIServer) Setup()

Constants

const (
	QUOTE_ROUTE = "/quote"
)

Types

type APIServer

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

APIServer is the server object. TODO: this should be an interface.

func NewRestAPIServer

func NewRestAPIServer(ctx context.Context, cfg *config.Config) (*APIServer, error)

NewRestAPIServer creates a new instance of the rest api server.

func (*APIServer) Authenticate

func (r *APIServer) Authenticate(c *gin.Context, q *models.Quote) (err error)

Authenticate checks request header for EIP191 signature for a valid relayer. TODO: this should be moved to a middleware package.

func (*APIServer) Run

func (r *APIServer) Run(ctx context.Context) error

Run runs the rest api server.

func (*APIServer) Setup

func (r *APIServer) Setup()

Setup initializes rest api server routes. TODO: move this to constructor, I have no idea why this is a separate method called by the user