gateway

type ApiProxyMiddleware ¶ added in v1.4.1

type ApiProxyMiddleware struct {
	GatewayAddress  string
	ProxyAddress    string
	EndpointCreator EndpointFactory
	// contains filtered or unexported fields
}

ApiProxyMiddleware is a proxy between an Ethereum consensus API HTTP client and grpc-gateway. The purpose of the proxy is to handle HTTP requests and gRPC responses in such a way that:

• Ethereum consensus API requests can be handled by grpc-gateway correctly
• gRPC responses can be returned as spec-compliant Ethereum consensus API responses

func (m *ApiProxyMiddleware) PrepareRequestForProxying(endpoint Endpoint, req *http.Request) ErrorJson

func (m *ApiProxyMiddleware) Run() error

type CustomHandler ¶ added in v1.4.1

type CustomHandler = func(m *ApiProxyMiddleware, endpoint Endpoint, w http.ResponseWriter, req *http.Request) (handled bool)

CustomHandler is a function that can be invoked at the very beginning of the request, essentially replacing the whole default request/response logic with custom logic for a specific endpoint.

type DefaultErrorJson ¶ added in v1.4.1

type DefaultErrorJson struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

DefaultErrorJson is a JSON representation of a simple error value, containing only a message and an error code.

func InternalServerError(err error) *DefaultErrorJson

func InternalServerErrorWithMessage(err error, message string) *DefaultErrorJson

func (e *DefaultErrorJson) Msg() string

func (e *DefaultErrorJson) SetCode(code int)

func (e *DefaultErrorJson) StatusCode() int

type Endpoint ¶ added in v1.4.1

type Endpoint struct {
	Path                  string         // The path of the HTTP endpoint.
	PostRequest           interface{}    // The struct corresponding to the JSON structure used in a POST request.
	GetRequestURLLiterals []string       // Names of URL parameters that should not be base64-encoded.
	GetRequestQueryParams []QueryParam   // Query parameters of the GET request.
	GetResponse           interface{}    // The struct corresponding to the JSON structure used in a GET response.
	Err                   ErrorJson      // The struct corresponding to the error that should be returned in case of a request failure.
	Hooks                 HookCollection // A collection of functions that can be invoked at various stages of the request/response cycle.
}

Endpoint is a representation of an API HTTP endpoint that should be proxied by the middleware.

type EndpointFactory ¶ added in v1.4.1

type EndpointFactory interface {
	Create(path string) (*Endpoint, error)
	Paths() []string
	IsNil() bool
}

EndpointFactory is responsible for creating new instances of Endpoint values.

type ErrorJson ¶ added in v1.4.1

type ErrorJson interface {
	StatusCode() int
	SetCode(code int)
	Msg() string
}

ErrorJson describes common functionality of all JSON error representations.

func Cleanup(grpcResponseBody io.ReadCloser) ErrorJson

func DeserializeGrpcResponseBodyIntoContainer(body []byte, responseContainer interface{}) ErrorJson

func DeserializeGrpcResponseBodyIntoErrorJson(errJson ErrorJson, body []byte) ErrorJson

func DeserializeRequestBodyIntoContainer(body io.Reader, requestContainer interface{}) ErrorJson

func HandleQueryParameters(req *http.Request, params []QueryParam) ErrorJson

func HandleURLParameters(url string, req *http.Request, literals []string) ErrorJson

func ProcessMiddlewareResponseFields(responseContainer interface{}) ErrorJson

func ProcessRequestContainerFields(requestContainer interface{}) ErrorJson

func ProxyRequest(req *http.Request) (*http.Response, ErrorJson)

func ReadGrpcResponseBody(r io.Reader) ([]byte, ErrorJson)

func SerializeMiddlewareResponseIntoJson(responseContainer interface{}) (jsonResponse []byte, errJson ErrorJson)

func SetRequestBodyToRequestContainer(requestContainer interface{}, req *http.Request) ErrorJson

func WriteMiddlewareResponseHeadersAndBody(req *http.Request, grpcResp *http.Response, responseJson []byte, w http.ResponseWriter) ErrorJson

type Gateway ¶

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

Gateway is the gRPC gateway to serve HTTP JSON traffic as a proxy and forward it to the gRPC server.

func New(
	ctx context.Context,
	pbHandlers []PbMux,
	muxHandler MuxHandler,
	remoteAddr,
	gatewayAddress string,
) *Gateway

func (g *Gateway) Start()

func (g *Gateway) Status() error

func (g *Gateway) Stop() error

func (g *Gateway) WithAllowedOrigins(origins []string) *Gateway

func (g *Gateway) WithApiMiddleware(address string, endpointFactory EndpointFactory) *Gateway

func (g *Gateway) WithMaxCallRecvMsgSize(size uint64) *Gateway

func (g *Gateway) WithMux(m *http.ServeMux) *Gateway

func (g *Gateway) WithRemoteCert(cert string) *Gateway

type Hook ¶ added in v1.4.1

type Hook = func(endpoint Endpoint, w http.ResponseWriter, req *http.Request) ErrorJson

Hook is a function that can be invoked at various stages of the request/response cycle, leading to custom behaviour for a specific endpoint.

type HookCollection ¶ added in v1.4.1

type HookCollection struct {
	CustomHandlers                            []CustomHandler
	OnPostStart                               []Hook
	OnPostDeserializeRequestBodyIntoContainer []Hook
}

HookCollection contains handlers/hooks that can be used to amend the default request/response cycle with custom logic for a specific endpoint.

type MuxHandler ¶ added in v1.4.1

type MuxHandler func(http.Handler, http.ResponseWriter, *http.Request)

MuxHandler is a function that implements the mux handler functionality.

type PbHandlerRegistration ¶ added in v1.4.1

type PbHandlerRegistration func(context.Context, *gwruntime.ServeMux, *grpc.ClientConn) error

PbHandlerRegistration is a function that registers a protobuf handler.

type PbMux ¶ added in v1.4.1

type PbMux struct {
	Registrations []PbHandlerRegistration // Protobuf registrations to be registered in Mux.
	Patterns      []string                // URL patterns that will be handled by Mux.
	Mux           *gwruntime.ServeMux     // The mux that will be used for grpc-gateway requests.
}

PbMux serves grpc-gateway requests for selected patterns using registered protobuf handlers.

type QueryParam ¶ added in v1.4.1

type QueryParam struct {
	Name string
	Hex  bool
	Enum bool
}

QueryParam represents a single query parameter's metadata.