proxy

Documentation

Index

• Constants
• Variables
• func InitResponseCache(c ResponseCache)
• type AuthFailed
  • func (e AuthFailed) Code() int
  • func (e AuthFailed) Error() string
• type CallError
• type Caller
  • func (c *Caller) Call(rawQuery []byte) []byte
  • func (c *Caller) SetPreprocessor(p Preprocessor)
  • func (c *Caller) WalletID() string
• type GenericError
  • func NewError(e error) GenericError
  • func NewInternalError(e error) GenericError
  • func NewMethodError(e error) GenericError
  • func NewParamsError(e error) GenericError
  • func NewParseError(e error) GenericError
  • func (e GenericError) AsRPCResponse() *jsonrpc.RPCResponse
  • func (e GenericError) Code() int
  • func (e GenericError) Error() string
  • func (e GenericError) Unwrap() error
• type Opts
• type Preprocessor
• type ProxyService
  • func NewService(opts Opts) *ProxyService
  • func (ps *ProxyService) NewCaller(walletID string) *Caller
• type Query
  • func NewQuery(r []byte) (*Query, error)
  • func (q *Query) Method() string
  • func (q *Query) Params() interface{}
  • func (q *Query) ParamsAsMap() map[string]interface{}
  • func (q *Query) ParamsToStruct(targetStruct interface{}) error
  • func (q *Query) SetWalletID(id string)
• type RequestHandler
  • func NewRequestHandler(svc *ProxyService) *RequestHandler
  • func (rh *RequestHandler) Handle(w http.ResponseWriter, r *http.Request)
  • func (rh *RequestHandler) HandleOptions(w http.ResponseWriter, r *http.Request)
• type ResponseCache

Constants

const ErrAuthFailed int = -32085

ErrAuthFailed is when supplied auth_token / account_id is not present in the database.

const ErrInternal int = -32603

ErrInternal is a general server error code

const ErrInvalidParams int = -32602

ErrInvalidParams signifies a client-supplied params error

const ErrInvalidRequest int = -32600

ErrInvalidRequest signifies a general client error

const ErrJSONParse int = -32700

ErrJSONParse means invalid JSON was received by the server.

const ErrMethodUnavailable int = -32601

ErrMethodUnavailable means the client-requested method cannot be found

const ErrProxy int = -32080

ErrProxy is for general errors that originate inside the proxy module

const MethodAccountBalance = "account_balance"

const MethodAccountList = "account_list"

const MethodClaimSearch = "claim_search"

const MethodCommentList = "comment_list"

const MethodFileList = "file_list"

const MethodGet = "get"

const MethodResolve = "resolve"

const MethodStatus = "status"

Variables

var CacheLogger = monitor.NewModuleLogger("proxy_cache")

CacheLogger is for logging query cache-related messages

Functions

func InitResponseCache

func InitResponseCache(c ResponseCache)

InitResponseCache initializes module-level responseCache variable

Types

type AuthFailed

type AuthFailed struct {
	CallError
}

AuthFailed is for authentication failures when jsonrpc client has provided a token

func (AuthFailed) Code

func (e AuthFailed) Code() int

Code returns JSRON-RPC error code

func (AuthFailed) Error

func (e AuthFailed) Error() string

type CallError

type CallError interface {
	AsRPCResponse() *jsonrpc.RPCResponse
	Code() int
	Error() string
}

CallError is for whatever errors might occur when processing or forwarding client JSON-RPC request

type Caller

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

Caller patches through JSON-RPC requests from clients, doing pre/post-processing, account processing and validation.

func (*Caller) Call

func (c *Caller) Call(rawQuery []byte) []byte

Call method processes a raw query received from JSON-RPC client and forwards it to LbrynetServer. It returns a response that is ready to be sent back to the JSON-RPC client as is.

func (*Caller) SetPreprocessor

func (c *Caller) SetPreprocessor(p Preprocessor)

SetPreprocessor applies provided function to query before it's sent to the LbrynetServer.

func (*Caller) WalletID

func (c *Caller) WalletID() string

WalletID is an LbrynetServer wallet ID for the client this caller instance is serving.

type GenericError

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

func NewError

func NewError(e error) GenericError

NewError is for general internal errors

func NewInternalError

func NewInternalError(e error) GenericError

NewInternalError is for SDK-related errors (connection problems etc)

func NewMethodError

func NewMethodError(e error) GenericError

NewMethodError creates a call method error

func NewParamsError

func NewParamsError(e error) GenericError

NewParamsError signifies an error in method parameters

func NewParseError

func NewParseError(e error) GenericError

NewParseError is for json parsing errors

func (GenericError) AsRPCResponse

func (e GenericError) AsRPCResponse() *jsonrpc.RPCResponse

AsRPCResponse returns error as jsonrpc.RPCResponse

func (GenericError) Code

func (e GenericError) Code() int

Code returns JSRON-RPC error code

func (GenericError) Error

func (e GenericError) Error() string

func (GenericError) Unwrap

func (e GenericError) Unwrap() error

type Opts

type Opts struct {
	SDKRouter  router.SDKRouter
	RPCTimeout time.Duration
}

Opts is initialization parameters for NewService / proxy.ProxyService

type Preprocessor

type Preprocessor func(q *Query)

type ProxyService

type ProxyService struct {
	Router router.SDKRouter
	// contains filtered or unexported fields
}

ProxyService generates Caller objects and keeps execution time metrics for all calls proxied through those objects.

func NewService

func NewService(opts Opts) *ProxyService

NewService is the entry point to proxy module. Normally only one instance of ProxyService should be created per running server.

func (*ProxyService) NewCaller

func (ps *ProxyService) NewCaller(walletID string) *Caller

NewCaller returns an instance of Caller ready to proxy requests. Note that `SetWalletID` needs to be called if an authenticated user is making this call.

type Query

type Query struct {
	Request *jsonrpc.RPCRequest
	// contains filtered or unexported fields
}

Query is a wrapper around client JSON-RPC query for easier (un)marshaling and processing.

func NewQuery

func NewQuery(r []byte) (*Query, error)

NewQuery initializes Query object with JSON-RPC request supplied as bytes. The object is immediately usable and returns an error in case request parsing fails.

func (*Query) Method

func (q *Query) Method() string

Method is a shortcut for query method.

func (*Query) Params

func (q *Query) Params() interface{}

Params is a shortcut for query params.

func (*Query) ParamsAsMap

func (q *Query) ParamsAsMap() map[string]interface{}

ParamsAsMap returns query params converted to plain map.

func (*Query) ParamsToStruct

func (q *Query) ParamsToStruct(targetStruct interface{}) error

ParamsToStruct returns query params parsed into a supplied structure.

func (*Query) SetWalletID

func (q *Query) SetWalletID(id string)

type RequestHandler

type RequestHandler struct {
	*ProxyService
}

RequestHandler is a wrapper for passing proxy.ProxyService instance to proxy HTTP handler.

func NewRequestHandler

func NewRequestHandler(svc *ProxyService) *RequestHandler

NewRequestHandler initializes request handler with a provided Proxy ProxyService instance

func (*RequestHandler) Handle

func (rh *RequestHandler) Handle(w http.ResponseWriter, r *http.Request)

Handle forwards client JSON-RPC request to proxy.

func (*RequestHandler) HandleOptions

func (rh *RequestHandler) HandleOptions(w http.ResponseWriter, r *http.Request)

HandleOptions returns necessary CORS headers for pre-flight requests to proxy API

type ResponseCache

type ResponseCache interface {
	Save(method string, params interface{}, r interface{})
	Retrieve(method string, params interface{}) interface{}
	Count() int
	// contains filtered or unexported methods
}

ResponseCache interface describes methods for SDK response cache saving and retrieval