proxy

Documentation

Index

• Constants
• func EnsureAuthenticated(ar auth.Result, w http.ResponseWriter) bool
• func Handle(w http.ResponseWriter, r *http.Request)
• func HandleCORS(w http.ResponseWriter, r *http.Request)
• func MethodNeedsAuth(method string) bool
• type Caller
  • func NewCaller(endpoint string, userID int) *Caller
  • func (c *Caller) Call(req *jsonrpc.RPCRequest) []byte
  • func (c *Caller) CallRaw(rawQuery []byte) []byte
• type Query
  • func NewQuery(req *jsonrpc.RPCRequest) (*Query, error)
  • func (q *Query) Method() string
  • func (q *Query) Params() interface{}
  • func (q *Query) ParamsAsMap() map[string]interface{}
• type RPCError
  • func NewAuthRequiredError(e error) RPCError
  • func NewForbiddenError(e error) RPCError
  • func NewInternalError(e error) RPCError
  • func NewInvalidParamsError(e error) RPCError
  • func NewJSONParseError(e error) RPCError
  • func NewMethodNotAllowedError(e error) RPCError
  • func NewSDKError(e error) RPCError
  • func (e RPCError) Code() int
  • func (e RPCError) Error() string
  • func (e RPCError) JSON() []byte
  • func (e RPCError) Unwrap() error

Constants

const MethodAccountBalance = "account_balance"

const MethodAccountList = "account_list"

const MethodClaimSearch = "claim_search"

const MethodFileList = "file_list"

const MethodGet = "get"

const MethodResolve = "resolve"

const MethodStatus = "status"

Functions

func EnsureAuthenticated

func EnsureAuthenticated(ar auth.Result, w http.ResponseWriter) bool

func Handle

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

Handle forwards client JSON-RPC request to proxy.

func HandleCORS

func HandleCORS(w http.ResponseWriter, r *http.Request)

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

func MethodNeedsAuth

func MethodNeedsAuth(method string) bool

Types

type Caller

type Caller struct {
	// Preprocessor is applied to query before it's sent to the SDK.
	Preprocessor func(q *Query)
	// contains filtered or unexported fields
}

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

func NewCaller

func NewCaller(endpoint string, userID int) *Caller

func (*Caller) Call

func (c *Caller) Call(req *jsonrpc.RPCRequest) []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) CallRaw

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

type Query

type Query struct {
	Request  *jsonrpc.RPCRequest
	WalletID string
}

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

func NewQuery

func NewQuery(req *jsonrpc.RPCRequest) (*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.

type RPCError

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

func NewAuthRequiredError

func NewAuthRequiredError(e error) RPCError

func NewForbiddenError

func NewForbiddenError(e error) RPCError

func NewInternalError

func NewInternalError(e error) RPCError

func NewInvalidParamsError

func NewInvalidParamsError(e error) RPCError

func NewJSONParseError

func NewJSONParseError(e error) RPCError

func NewMethodNotAllowedError

func NewMethodNotAllowedError(e error) RPCError

func NewSDKError

func NewSDKError(e error) RPCError

func (RPCError) Code

func (e RPCError) Code() int

func (RPCError) Error

func (e RPCError) Error() string

func (RPCError) JSON

func (e RPCError) JSON() []byte

func (RPCError) Unwrap

func (e RPCError) Unwrap() error