Documentation
¶
Index ¶
- func RestHandlers(c *RpcContext) *mux.Router
- func RestHandlersHelp(router *mux.Router)
- type RestEmptyResponse
- func (*RestEmptyResponse) Descriptor() ([]byte, []int)
- func (*RestEmptyResponse) ProtoMessage()
- func (m *RestEmptyResponse) Reset()
- func (m *RestEmptyResponse) String() string
- func (m *RestEmptyResponse) XXX_DiscardUnknown()
- func (m *RestEmptyResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RestEmptyResponse) XXX_Merge(src proto.Message)
- func (m *RestEmptyResponse) XXX_Size() int
- func (m *RestEmptyResponse) XXX_Unmarshal(b []byte) error
- type RpcContext
- type RpcFunc
- type SimpleHandler
- type WebSocketError
- func (*WebSocketError) Descriptor() ([]byte, []int)
- func (m *WebSocketError) GetHttpCode() uint32
- func (m *WebSocketError) GetMessage() string
- func (*WebSocketError) ProtoMessage()
- func (m *WebSocketError) Reset()
- func (m *WebSocketError) String() string
- func (m *WebSocketError) XXX_DiscardUnknown()
- func (m *WebSocketError) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *WebSocketError) XXX_Merge(src proto.Message)
- func (m *WebSocketError) XXX_Size() int
- func (m *WebSocketError) XXX_Unmarshal(b []byte) error
- type WebSocketJSonRequest
- type WebSocketJSonResponse
- type WebSocketProtobufRequest
- func (*WebSocketProtobufRequest) Descriptor() ([]byte, []int)
- func (m *WebSocketProtobufRequest) GetEndpoint() string
- func (m *WebSocketProtobufRequest) GetHasMore() bool
- func (m *WebSocketProtobufRequest) GetPayload() *anypb.Any
- func (m *WebSocketProtobufRequest) GetRequestId() string
- func (*WebSocketProtobufRequest) ProtoMessage()
- func (m *WebSocketProtobufRequest) Reset()
- func (m *WebSocketProtobufRequest) String() string
- func (m *WebSocketProtobufRequest) XXX_DiscardUnknown()
- func (m *WebSocketProtobufRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *WebSocketProtobufRequest) XXX_Merge(src proto.Message)
- func (m *WebSocketProtobufRequest) XXX_Size() int
- func (m *WebSocketProtobufRequest) XXX_Unmarshal(b []byte) error
- type WebSocketProtobufResponse
- func (*WebSocketProtobufResponse) Descriptor() ([]byte, []int)
- func (m *WebSocketProtobufResponse) GetError() *WebSocketError
- func (m *WebSocketProtobufResponse) GetHasMore() bool
- func (m *WebSocketProtobufResponse) GetOk() *anypb.Any
- func (m *WebSocketProtobufResponse) GetPayload() isWebSocketProtobufResponse_Payload
- func (m *WebSocketProtobufResponse) GetRequestId() string
- func (*WebSocketProtobufResponse) ProtoMessage()
- func (m *WebSocketProtobufResponse) Reset()
- func (m *WebSocketProtobufResponse) String() string
- func (m *WebSocketProtobufResponse) XXX_DiscardUnknown()
- func (m *WebSocketProtobufResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *WebSocketProtobufResponse) XXX_Merge(src proto.Message)
- func (*WebSocketProtobufResponse) XXX_OneofWrappers() []interface{}
- func (m *WebSocketProtobufResponse) XXX_Size() int
- func (m *WebSocketProtobufResponse) XXX_Unmarshal(b []byte) error
- type WebSocketProtobufResponse_Error
- type WebSocketProtobufResponse_Ok
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RestHandlers ¶
func RestHandlers(c *RpcContext) *mux.Router
func RestHandlersHelp ¶
add the REST master help HTTP handler
Types ¶
type RestEmptyResponse ¶
type RestEmptyResponse struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*RestEmptyResponse) Descriptor ¶
func (*RestEmptyResponse) Descriptor() ([]byte, []int)
func (*RestEmptyResponse) ProtoMessage ¶
func (*RestEmptyResponse) ProtoMessage()
func (*RestEmptyResponse) Reset ¶
func (m *RestEmptyResponse) Reset()
func (*RestEmptyResponse) String ¶
func (m *RestEmptyResponse) String() string
func (*RestEmptyResponse) XXX_DiscardUnknown ¶
func (m *RestEmptyResponse) XXX_DiscardUnknown()
func (*RestEmptyResponse) XXX_Marshal ¶
func (m *RestEmptyResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RestEmptyResponse) XXX_Merge ¶
func (m *RestEmptyResponse) XXX_Merge(src proto.Message)
func (*RestEmptyResponse) XXX_Size ¶
func (m *RestEmptyResponse) XXX_Size() int
func (*RestEmptyResponse) XXX_Unmarshal ¶
func (m *RestEmptyResponse) XXX_Unmarshal(b []byte) error
type RpcContext ¶
type RpcContext struct { MaybeCC *chainreg.ChainControl MaybeNeutrino *neutrino.ChainService MaybeWallet *wallet.Wallet MaybeRpcServer lnrpc.LightningServer MaybeWalletUnlocker *walletunlocker.UnlockerService MaybeMetaService lnrpc.MetaServiceServer MaybeVerRPCServer verrpc.VersionerServer MaybeRouterServer routerrpc.RouterServer MaybeWatchTowerClient wtclientrpc.WatchtowerClientClient }
type SimpleHandler ¶
type SimpleHandler struct {
// contains filtered or unexported fields
}
func (*SimpleHandler) ServeHTTP ¶
func (s *SimpleHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
func (*SimpleHandler) ServeHttpOrErr ¶
func (s *SimpleHandler) ServeHttpOrErr(w http.ResponseWriter, r *http.Request, isJson bool) er.R
type WebSocketError ¶
type WebSocketError struct { HttpCode uint32 `protobuf:"varint,1,opt,name=http_code,json=httpCode,proto3" json:"http_code,omitempty"` Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
WebSocket request and response JSon messages
func (*WebSocketError) Descriptor ¶
func (*WebSocketError) Descriptor() ([]byte, []int)
func (*WebSocketError) GetHttpCode ¶
func (m *WebSocketError) GetHttpCode() uint32
func (*WebSocketError) GetMessage ¶
func (m *WebSocketError) GetMessage() string
func (*WebSocketError) ProtoMessage ¶
func (*WebSocketError) ProtoMessage()
func (*WebSocketError) Reset ¶
func (m *WebSocketError) Reset()
func (*WebSocketError) String ¶
func (m *WebSocketError) String() string
func (*WebSocketError) XXX_DiscardUnknown ¶
func (m *WebSocketError) XXX_DiscardUnknown()
func (*WebSocketError) XXX_Marshal ¶
func (m *WebSocketError) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*WebSocketError) XXX_Merge ¶
func (m *WebSocketError) XXX_Merge(src proto.Message)
func (*WebSocketError) XXX_Size ¶
func (m *WebSocketError) XXX_Size() int
func (*WebSocketError) XXX_Unmarshal ¶
func (m *WebSocketError) XXX_Unmarshal(b []byte) error
type WebSocketJSonRequest ¶
type WebSocketJSonRequest struct { Endpoint string `json:"endpoint,omitempty"` RequestId string `json:"request_id,omitempty"` HasMore bool `json:"has_more,omitempty"` Payload json.RawMessage `json:"payload,omitempty"` }
type WebSocketJSonResponse ¶
type WebSocketJSonResponse struct { RequestId string `json:"request_id,omitempty"` HasMore bool `json:"has_more,omitempty"` Payload json.RawMessage `json:"payload,omitempty"` Error WebSocketError `json:"error,omitempty"` }
type WebSocketProtobufRequest ¶
type WebSocketProtobufRequest struct { // The rest endpoint to send the request to Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"` // An arbitrary string which will be reflected back in the response RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"` HasMore bool `protobuf:"varint,3,opt,name=has_more,json=hasMore,proto3" json:"has_more,omitempty"` // The data to post to the REST endpoint, if any. // Make sure this is the correct data structure based on the endpoint you are posting to. Payload *anypb.Any `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
WebSocket request and response protobuf messages
func (*WebSocketProtobufRequest) Descriptor ¶
func (*WebSocketProtobufRequest) Descriptor() ([]byte, []int)
func (*WebSocketProtobufRequest) GetEndpoint ¶
func (m *WebSocketProtobufRequest) GetEndpoint() string
func (*WebSocketProtobufRequest) GetHasMore ¶
func (m *WebSocketProtobufRequest) GetHasMore() bool
func (*WebSocketProtobufRequest) GetPayload ¶
func (m *WebSocketProtobufRequest) GetPayload() *anypb.Any
func (*WebSocketProtobufRequest) GetRequestId ¶
func (m *WebSocketProtobufRequest) GetRequestId() string
func (*WebSocketProtobufRequest) ProtoMessage ¶
func (*WebSocketProtobufRequest) ProtoMessage()
func (*WebSocketProtobufRequest) Reset ¶
func (m *WebSocketProtobufRequest) Reset()
func (*WebSocketProtobufRequest) String ¶
func (m *WebSocketProtobufRequest) String() string
func (*WebSocketProtobufRequest) XXX_DiscardUnknown ¶
func (m *WebSocketProtobufRequest) XXX_DiscardUnknown()
func (*WebSocketProtobufRequest) XXX_Marshal ¶
func (m *WebSocketProtobufRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*WebSocketProtobufRequest) XXX_Merge ¶
func (m *WebSocketProtobufRequest) XXX_Merge(src proto.Message)
func (*WebSocketProtobufRequest) XXX_Size ¶
func (m *WebSocketProtobufRequest) XXX_Size() int
func (*WebSocketProtobufRequest) XXX_Unmarshal ¶
func (m *WebSocketProtobufRequest) XXX_Unmarshal(b []byte) error
type WebSocketProtobufResponse ¶
type WebSocketProtobufResponse struct { RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"` HasMore bool `protobuf:"varint,2,opt,name=has_more,json=hasMore,proto3" json:"has_more,omitempty"` // Types that are valid to be assigned to Payload: // *WebSocketProtobufResponse_Ok // *WebSocketProtobufResponse_Error Payload isWebSocketProtobufResponse_Payload `protobuf_oneof:"payload"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*WebSocketProtobufResponse) Descriptor ¶
func (*WebSocketProtobufResponse) Descriptor() ([]byte, []int)
func (*WebSocketProtobufResponse) GetError ¶
func (m *WebSocketProtobufResponse) GetError() *WebSocketError
func (*WebSocketProtobufResponse) GetHasMore ¶
func (m *WebSocketProtobufResponse) GetHasMore() bool
func (*WebSocketProtobufResponse) GetOk ¶
func (m *WebSocketProtobufResponse) GetOk() *anypb.Any
func (*WebSocketProtobufResponse) GetPayload ¶
func (m *WebSocketProtobufResponse) GetPayload() isWebSocketProtobufResponse_Payload
func (*WebSocketProtobufResponse) GetRequestId ¶
func (m *WebSocketProtobufResponse) GetRequestId() string
func (*WebSocketProtobufResponse) ProtoMessage ¶
func (*WebSocketProtobufResponse) ProtoMessage()
func (*WebSocketProtobufResponse) Reset ¶
func (m *WebSocketProtobufResponse) Reset()
func (*WebSocketProtobufResponse) String ¶
func (m *WebSocketProtobufResponse) String() string
func (*WebSocketProtobufResponse) XXX_DiscardUnknown ¶
func (m *WebSocketProtobufResponse) XXX_DiscardUnknown()
func (*WebSocketProtobufResponse) XXX_Marshal ¶
func (m *WebSocketProtobufResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*WebSocketProtobufResponse) XXX_Merge ¶
func (m *WebSocketProtobufResponse) XXX_Merge(src proto.Message)
func (*WebSocketProtobufResponse) XXX_OneofWrappers ¶
func (*WebSocketProtobufResponse) XXX_OneofWrappers() []interface{}
XXX_OneofWrappers is for the internal use of the proto package.
func (*WebSocketProtobufResponse) XXX_Size ¶
func (m *WebSocketProtobufResponse) XXX_Size() int
func (*WebSocketProtobufResponse) XXX_Unmarshal ¶
func (m *WebSocketProtobufResponse) XXX_Unmarshal(b []byte) error
type WebSocketProtobufResponse_Error ¶
type WebSocketProtobufResponse_Error struct {
Error *WebSocketError `protobuf:"bytes,4,opt,name=error,proto3,oneof"`
}
Click to show internal directories.
Click to hide internal directories.