Documentation ¶
Index ¶
- Variables
- func RegisterClnPluginServer(s grpc.ServiceRegistrar, srv ClnPluginServer)
- type ClnPluginClient
- type ClnPluginServer
- type ClnPlugin_CustomMsgStreamClient
- type ClnPlugin_CustomMsgStreamServer
- type ClnPlugin_HtlcStreamClient
- type ClnPlugin_HtlcStreamServer
- type CustomMessage
- func (*CustomMessage) Descriptor() ([]byte, []int)deprecated
- func (x *CustomMessage) GetPayload() string
- func (x *CustomMessage) GetPeerId() string
- func (*CustomMessage) ProtoMessage()
- func (x *CustomMessage) ProtoReflect() protoreflect.Message
- func (x *CustomMessage) Reset()
- func (x *CustomMessage) String() string
- type CustomMessageRequest
- type Htlc
- func (*Htlc) Descriptor() ([]byte, []int)deprecated
- func (x *Htlc) GetAmountMsat() uint64
- func (x *Htlc) GetCltvExpiry() uint32
- func (x *Htlc) GetCltvExpiryRelative() int32
- func (x *Htlc) GetId() uint64
- func (x *Htlc) GetPaymentHash() string
- func (x *Htlc) GetShortChannelId() string
- func (*Htlc) ProtoMessage()
- func (x *Htlc) ProtoReflect() protoreflect.Message
- func (x *Htlc) Reset()
- func (x *Htlc) String() string
- type HtlcAccepted
- func (*HtlcAccepted) Descriptor() ([]byte, []int)deprecated
- func (x *HtlcAccepted) GetCorrelationid() string
- func (x *HtlcAccepted) GetForwardTo() string
- func (x *HtlcAccepted) GetHtlc() *Htlc
- func (x *HtlcAccepted) GetOnion() *Onion
- func (*HtlcAccepted) ProtoMessage()
- func (x *HtlcAccepted) ProtoReflect() protoreflect.Message
- func (x *HtlcAccepted) Reset()
- func (x *HtlcAccepted) String() string
- type HtlcContinue
- func (*HtlcContinue) Descriptor() ([]byte, []int)deprecated
- func (x *HtlcContinue) GetForwardTo() string
- func (x *HtlcContinue) GetPayload() string
- func (*HtlcContinue) ProtoMessage()
- func (x *HtlcContinue) ProtoReflect() protoreflect.Message
- func (x *HtlcContinue) Reset()
- func (x *HtlcContinue) String() string
- type HtlcFail
- func (*HtlcFail) Descriptor() ([]byte, []int)deprecated
- func (m *HtlcFail) GetFailure() isHtlcFail_Failure
- func (x *HtlcFail) GetFailureMessage() string
- func (x *HtlcFail) GetFailureOnion() string
- func (*HtlcFail) ProtoMessage()
- func (x *HtlcFail) ProtoReflect() protoreflect.Message
- func (x *HtlcFail) Reset()
- func (x *HtlcFail) String() string
- type HtlcFail_FailureMessage
- type HtlcFail_FailureOnion
- type HtlcResolution
- func (*HtlcResolution) Descriptor() ([]byte, []int)deprecated
- func (x *HtlcResolution) GetContinue() *HtlcContinue
- func (x *HtlcResolution) GetCorrelationid() string
- func (x *HtlcResolution) GetFail() *HtlcFail
- func (m *HtlcResolution) GetOutcome() isHtlcResolution_Outcome
- func (x *HtlcResolution) GetResolve() *HtlcResolve
- func (*HtlcResolution) ProtoMessage()
- func (x *HtlcResolution) ProtoReflect() protoreflect.Message
- func (x *HtlcResolution) Reset()
- func (x *HtlcResolution) String() string
- type HtlcResolution_Continue
- type HtlcResolution_Fail
- type HtlcResolution_Resolve
- type HtlcResolve
- type Onion
- func (*Onion) Descriptor() ([]byte, []int)deprecated
- func (x *Onion) GetForwardMsat() uint64
- func (x *Onion) GetNextOnion() string
- func (x *Onion) GetOutgoingCltvValue() uint32
- func (x *Onion) GetPayload() string
- func (x *Onion) GetSharedSecret() string
- func (x *Onion) GetShortChannelId() string
- func (*Onion) ProtoMessage()
- func (x *Onion) ProtoReflect() protoreflect.Message
- func (x *Onion) Reset()
- func (x *Onion) String() string
- type UnimplementedClnPluginServer
- type UnsafeClnPluginServer
Constants ¶
This section is empty.
Variables ¶
var ClnPlugin_ServiceDesc = grpc.ServiceDesc{ ServiceName: "ClnPlugin", HandlerType: (*ClnPluginServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "HtlcStream", Handler: _ClnPlugin_HtlcStream_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "CustomMsgStream", Handler: _ClnPlugin_CustomMsgStream_Handler, ServerStreams: true, }, }, Metadata: "cln_plugin.proto", }
ClnPlugin_ServiceDesc is the grpc.ServiceDesc for ClnPlugin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_cln_plugin_proto protoreflect.FileDescriptor
Functions ¶
func RegisterClnPluginServer ¶
func RegisterClnPluginServer(s grpc.ServiceRegistrar, srv ClnPluginServer)
Types ¶
type ClnPluginClient ¶
type ClnPluginClient interface { HtlcStream(ctx context.Context, opts ...grpc.CallOption) (ClnPlugin_HtlcStreamClient, error) CustomMsgStream(ctx context.Context, in *CustomMessageRequest, opts ...grpc.CallOption) (ClnPlugin_CustomMsgStreamClient, error) }
ClnPluginClient is the client API for ClnPlugin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewClnPluginClient ¶
func NewClnPluginClient(cc grpc.ClientConnInterface) ClnPluginClient
type ClnPluginServer ¶
type ClnPluginServer interface { HtlcStream(ClnPlugin_HtlcStreamServer) error CustomMsgStream(*CustomMessageRequest, ClnPlugin_CustomMsgStreamServer) error // contains filtered or unexported methods }
ClnPluginServer is the server API for ClnPlugin service. All implementations must embed UnimplementedClnPluginServer for forward compatibility
type ClnPlugin_CustomMsgStreamClient ¶
type ClnPlugin_CustomMsgStreamClient interface { Recv() (*CustomMessage, error) grpc.ClientStream }
type ClnPlugin_CustomMsgStreamServer ¶
type ClnPlugin_CustomMsgStreamServer interface { Send(*CustomMessage) error grpc.ServerStream }
type ClnPlugin_HtlcStreamClient ¶
type ClnPlugin_HtlcStreamClient interface { Send(*HtlcResolution) error Recv() (*HtlcAccepted, error) grpc.ClientStream }
type ClnPlugin_HtlcStreamServer ¶
type ClnPlugin_HtlcStreamServer interface { Send(*HtlcAccepted) error Recv() (*HtlcResolution, error) grpc.ServerStream }
type CustomMessage ¶
type CustomMessage struct { PeerId string `protobuf:"bytes,1,opt,name=peer_id,json=peerId,proto3" json:"peer_id,omitempty"` Payload string `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"` // contains filtered or unexported fields }
func (*CustomMessage) Descriptor
deprecated
func (*CustomMessage) Descriptor() ([]byte, []int)
Deprecated: Use CustomMessage.ProtoReflect.Descriptor instead.
func (*CustomMessage) GetPayload ¶
func (x *CustomMessage) GetPayload() string
func (*CustomMessage) GetPeerId ¶
func (x *CustomMessage) GetPeerId() string
func (*CustomMessage) ProtoMessage ¶
func (*CustomMessage) ProtoMessage()
func (*CustomMessage) ProtoReflect ¶
func (x *CustomMessage) ProtoReflect() protoreflect.Message
func (*CustomMessage) Reset ¶
func (x *CustomMessage) Reset()
func (*CustomMessage) String ¶
func (x *CustomMessage) String() string
type CustomMessageRequest ¶
type CustomMessageRequest struct {
// contains filtered or unexported fields
}
func (*CustomMessageRequest) Descriptor
deprecated
func (*CustomMessageRequest) Descriptor() ([]byte, []int)
Deprecated: Use CustomMessageRequest.ProtoReflect.Descriptor instead.
func (*CustomMessageRequest) ProtoMessage ¶
func (*CustomMessageRequest) ProtoMessage()
func (*CustomMessageRequest) ProtoReflect ¶
func (x *CustomMessageRequest) ProtoReflect() protoreflect.Message
func (*CustomMessageRequest) Reset ¶
func (x *CustomMessageRequest) Reset()
func (*CustomMessageRequest) String ¶
func (x *CustomMessageRequest) String() string
type Htlc ¶
type Htlc struct { ShortChannelId string `protobuf:"bytes,1,opt,name=short_channel_id,json=shortChannelId,proto3" json:"short_channel_id,omitempty"` Id uint64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"` AmountMsat uint64 `protobuf:"varint,3,opt,name=amount_msat,json=amountMsat,proto3" json:"amount_msat,omitempty"` CltvExpiry uint32 `protobuf:"varint,4,opt,name=cltv_expiry,json=cltvExpiry,proto3" json:"cltv_expiry,omitempty"` CltvExpiryRelative int32 `protobuf:"varint,5,opt,name=cltv_expiry_relative,json=cltvExpiryRelative,proto3" json:"cltv_expiry_relative,omitempty"` PaymentHash string `protobuf:"bytes,6,opt,name=payment_hash,json=paymentHash,proto3" json:"payment_hash,omitempty"` // contains filtered or unexported fields }
func (*Htlc) Descriptor
deprecated
func (*Htlc) GetAmountMsat ¶
func (*Htlc) GetCltvExpiry ¶
func (*Htlc) GetCltvExpiryRelative ¶
func (*Htlc) GetPaymentHash ¶
func (*Htlc) GetShortChannelId ¶
func (*Htlc) ProtoMessage ¶
func (*Htlc) ProtoMessage()
func (*Htlc) ProtoReflect ¶
func (x *Htlc) ProtoReflect() protoreflect.Message
type HtlcAccepted ¶
type HtlcAccepted struct { Correlationid string `protobuf:"bytes,1,opt,name=correlationid,proto3" json:"correlationid,omitempty"` Onion *Onion `protobuf:"bytes,2,opt,name=onion,proto3" json:"onion,omitempty"` Htlc *Htlc `protobuf:"bytes,3,opt,name=htlc,proto3" json:"htlc,omitempty"` ForwardTo string `protobuf:"bytes,4,opt,name=forward_to,json=forwardTo,proto3" json:"forward_to,omitempty"` // contains filtered or unexported fields }
func (*HtlcAccepted) Descriptor
deprecated
func (*HtlcAccepted) Descriptor() ([]byte, []int)
Deprecated: Use HtlcAccepted.ProtoReflect.Descriptor instead.
func (*HtlcAccepted) GetCorrelationid ¶
func (x *HtlcAccepted) GetCorrelationid() string
func (*HtlcAccepted) GetForwardTo ¶
func (x *HtlcAccepted) GetForwardTo() string
func (*HtlcAccepted) GetHtlc ¶
func (x *HtlcAccepted) GetHtlc() *Htlc
func (*HtlcAccepted) GetOnion ¶
func (x *HtlcAccepted) GetOnion() *Onion
func (*HtlcAccepted) ProtoMessage ¶
func (*HtlcAccepted) ProtoMessage()
func (*HtlcAccepted) ProtoReflect ¶
func (x *HtlcAccepted) ProtoReflect() protoreflect.Message
func (*HtlcAccepted) Reset ¶
func (x *HtlcAccepted) Reset()
func (*HtlcAccepted) String ¶
func (x *HtlcAccepted) String() string
type HtlcContinue ¶
type HtlcContinue struct { Payload *string `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"` ForwardTo *string `protobuf:"bytes,2,opt,name=forward_to,json=forwardTo,proto3,oneof" json:"forward_to,omitempty"` // contains filtered or unexported fields }
func (*HtlcContinue) Descriptor
deprecated
func (*HtlcContinue) Descriptor() ([]byte, []int)
Deprecated: Use HtlcContinue.ProtoReflect.Descriptor instead.
func (*HtlcContinue) GetForwardTo ¶
func (x *HtlcContinue) GetForwardTo() string
func (*HtlcContinue) GetPayload ¶
func (x *HtlcContinue) GetPayload() string
func (*HtlcContinue) ProtoMessage ¶
func (*HtlcContinue) ProtoMessage()
func (*HtlcContinue) ProtoReflect ¶
func (x *HtlcContinue) ProtoReflect() protoreflect.Message
func (*HtlcContinue) Reset ¶
func (x *HtlcContinue) Reset()
func (*HtlcContinue) String ¶
func (x *HtlcContinue) String() string
type HtlcFail ¶
type HtlcFail struct { // Types that are assignable to Failure: // // *HtlcFail_FailureMessage // *HtlcFail_FailureOnion Failure isHtlcFail_Failure `protobuf_oneof:"failure"` // contains filtered or unexported fields }
func (*HtlcFail) Descriptor
deprecated
func (*HtlcFail) GetFailure ¶
func (m *HtlcFail) GetFailure() isHtlcFail_Failure
func (*HtlcFail) GetFailureMessage ¶
func (*HtlcFail) GetFailureOnion ¶
func (*HtlcFail) ProtoMessage ¶
func (*HtlcFail) ProtoMessage()
func (*HtlcFail) ProtoReflect ¶
func (x *HtlcFail) ProtoReflect() protoreflect.Message
type HtlcFail_FailureMessage ¶
type HtlcFail_FailureMessage struct {
FailureMessage string `protobuf:"bytes,1,opt,name=failure_message,json=failureMessage,proto3,oneof"`
}
type HtlcFail_FailureOnion ¶
type HtlcFail_FailureOnion struct {
FailureOnion string `protobuf:"bytes,2,opt,name=failure_onion,json=failureOnion,proto3,oneof"`
}
type HtlcResolution ¶
type HtlcResolution struct { Correlationid string `protobuf:"bytes,1,opt,name=correlationid,proto3" json:"correlationid,omitempty"` // Types that are assignable to Outcome: // // *HtlcResolution_Fail // *HtlcResolution_Continue // *HtlcResolution_Resolve Outcome isHtlcResolution_Outcome `protobuf_oneof:"outcome"` // contains filtered or unexported fields }
func (*HtlcResolution) Descriptor
deprecated
func (*HtlcResolution) Descriptor() ([]byte, []int)
Deprecated: Use HtlcResolution.ProtoReflect.Descriptor instead.
func (*HtlcResolution) GetContinue ¶
func (x *HtlcResolution) GetContinue() *HtlcContinue
func (*HtlcResolution) GetCorrelationid ¶
func (x *HtlcResolution) GetCorrelationid() string
func (*HtlcResolution) GetFail ¶
func (x *HtlcResolution) GetFail() *HtlcFail
func (*HtlcResolution) GetOutcome ¶
func (m *HtlcResolution) GetOutcome() isHtlcResolution_Outcome
func (*HtlcResolution) GetResolve ¶
func (x *HtlcResolution) GetResolve() *HtlcResolve
func (*HtlcResolution) ProtoMessage ¶
func (*HtlcResolution) ProtoMessage()
func (*HtlcResolution) ProtoReflect ¶
func (x *HtlcResolution) ProtoReflect() protoreflect.Message
func (*HtlcResolution) Reset ¶
func (x *HtlcResolution) Reset()
func (*HtlcResolution) String ¶
func (x *HtlcResolution) String() string
type HtlcResolution_Continue ¶
type HtlcResolution_Continue struct {
Continue *HtlcContinue `protobuf:"bytes,3,opt,name=continue,proto3,oneof"`
}
type HtlcResolution_Fail ¶
type HtlcResolution_Fail struct {
Fail *HtlcFail `protobuf:"bytes,2,opt,name=fail,proto3,oneof"`
}
type HtlcResolution_Resolve ¶
type HtlcResolution_Resolve struct {
Resolve *HtlcResolve `protobuf:"bytes,4,opt,name=resolve,proto3,oneof"`
}
type HtlcResolve ¶
type HtlcResolve struct { PaymentKey string `protobuf:"bytes,1,opt,name=payment_key,json=paymentKey,proto3" json:"payment_key,omitempty"` // contains filtered or unexported fields }
func (*HtlcResolve) Descriptor
deprecated
func (*HtlcResolve) Descriptor() ([]byte, []int)
Deprecated: Use HtlcResolve.ProtoReflect.Descriptor instead.
func (*HtlcResolve) GetPaymentKey ¶
func (x *HtlcResolve) GetPaymentKey() string
func (*HtlcResolve) ProtoMessage ¶
func (*HtlcResolve) ProtoMessage()
func (*HtlcResolve) ProtoReflect ¶
func (x *HtlcResolve) ProtoReflect() protoreflect.Message
func (*HtlcResolve) Reset ¶
func (x *HtlcResolve) Reset()
func (*HtlcResolve) String ¶
func (x *HtlcResolve) String() string
type Onion ¶
type Onion struct { Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"` ShortChannelId *string `protobuf:"bytes,2,opt,name=short_channel_id,json=shortChannelId,proto3,oneof" json:"short_channel_id,omitempty"` ForwardMsat *uint64 `protobuf:"varint,3,opt,name=forward_msat,json=forwardMsat,proto3,oneof" json:"forward_msat,omitempty"` OutgoingCltvValue *uint32 `protobuf:"varint,4,opt,name=outgoing_cltv_value,json=outgoingCltvValue,proto3,oneof" json:"outgoing_cltv_value,omitempty"` NextOnion *string `protobuf:"bytes,6,opt,name=next_onion,json=nextOnion,proto3,oneof" json:"next_onion,omitempty"` // contains filtered or unexported fields }
func (*Onion) Descriptor
deprecated
func (*Onion) GetForwardMsat ¶
func (*Onion) GetNextOnion ¶
func (*Onion) GetOutgoingCltvValue ¶
func (*Onion) GetPayload ¶
func (*Onion) GetSharedSecret ¶
func (*Onion) GetShortChannelId ¶
func (*Onion) ProtoMessage ¶
func (*Onion) ProtoMessage()
func (*Onion) ProtoReflect ¶
func (x *Onion) ProtoReflect() protoreflect.Message
type UnimplementedClnPluginServer ¶
type UnimplementedClnPluginServer struct { }
UnimplementedClnPluginServer must be embedded to have forward compatible implementations.
func (UnimplementedClnPluginServer) CustomMsgStream ¶
func (UnimplementedClnPluginServer) CustomMsgStream(*CustomMessageRequest, ClnPlugin_CustomMsgStreamServer) error
func (UnimplementedClnPluginServer) HtlcStream ¶
func (UnimplementedClnPluginServer) HtlcStream(ClnPlugin_HtlcStreamServer) error
type UnsafeClnPluginServer ¶
type UnsafeClnPluginServer interface {
// contains filtered or unexported methods
}
UnsafeClnPluginServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ClnPluginServer will result in compilation errors.