Documentation
¶
Index ¶
- Variables
- func RegisterLightningServer(s grpc.ServiceRegistrar, srv LightningServer)
- type ChannelBalanceRequest
- type ChannelBalanceResponse
- func (*ChannelBalanceResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ChannelBalanceResponse) GetBalanceSats() uint64
- func (*ChannelBalanceResponse) ProtoMessage()
- func (x *ChannelBalanceResponse) ProtoReflect() protoreflect.Message
- func (x *ChannelBalanceResponse) Reset()
- func (x *ChannelBalanceResponse) String() string
- type ConnectPeerRequest
- func (*ConnectPeerRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ConnectPeerRequest) GetHost() string
- func (x *ConnectPeerRequest) GetPort() uint32
- func (x *ConnectPeerRequest) GetPubKey() []byte
- func (*ConnectPeerRequest) ProtoMessage()
- func (x *ConnectPeerRequest) ProtoReflect() protoreflect.Message
- func (x *ConnectPeerRequest) Reset()
- func (x *ConnectPeerRequest) String() string
- type ConnectPeerResponse
- type CreateInvoiceRequest
- func (*CreateInvoiceRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateInvoiceRequest) GetAmtSats() uint64
- func (*CreateInvoiceRequest) ProtoMessage()
- func (x *CreateInvoiceRequest) ProtoReflect() protoreflect.Message
- func (x *CreateInvoiceRequest) Reset()
- func (x *CreateInvoiceRequest) String() string
- type CreateInvoiceResponse
- func (*CreateInvoiceResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateInvoiceResponse) GetInvoice() string
- func (*CreateInvoiceResponse) ProtoMessage()
- func (x *CreateInvoiceResponse) ProtoReflect() protoreflect.Message
- func (x *CreateInvoiceResponse) Reset()
- func (x *CreateInvoiceResponse) String() string
- type LightningClient
- type LightningServer
- type OpenChannelRequest
- func (*OpenChannelRequest) Descriptor() ([]byte, []int)deprecated
- func (x *OpenChannelRequest) GetLocalAmtSats() uint64
- func (x *OpenChannelRequest) GetPubKey() []byte
- func (*OpenChannelRequest) ProtoMessage()
- func (x *OpenChannelRequest) ProtoReflect() protoreflect.Message
- func (x *OpenChannelRequest) Reset()
- func (x *OpenChannelRequest) String() string
- type OpenChannelResponse
- func (*OpenChannelResponse) Descriptor() ([]byte, []int)deprecated
- func (x *OpenChannelResponse) GetFundingTxId() []byte
- func (x *OpenChannelResponse) GetFundingTxOutputIndex() uint32
- func (*OpenChannelResponse) ProtoMessage()
- func (x *OpenChannelResponse) ProtoReflect() protoreflect.Message
- func (x *OpenChannelResponse) Reset()
- func (x *OpenChannelResponse) String() string
- type PayInvoiceRequest
- type PayInvoiceResponse
- func (*PayInvoiceResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PayInvoiceResponse) GetPaymentPreimage() []byte
- func (*PayInvoiceResponse) ProtoMessage()
- func (x *PayInvoiceResponse) ProtoReflect() protoreflect.Message
- func (x *PayInvoiceResponse) Reset()
- func (x *PayInvoiceResponse) String() string
- type PubKeyRequest
- type PubKeyResponse
- type UnimplementedLightningServer
- func (UnimplementedLightningServer) ChannelBalance(context.Context, *ChannelBalanceRequest) (*ChannelBalanceResponse, error)
- func (UnimplementedLightningServer) ConnectPeer(context.Context, *ConnectPeerRequest) (*ConnectPeerResponse, error)
- func (UnimplementedLightningServer) CreateInvoice(context.Context, *CreateInvoiceRequest) (*CreateInvoiceResponse, error)
- func (UnimplementedLightningServer) OpenChannel(context.Context, *OpenChannelRequest) (*OpenChannelResponse, error)
- func (UnimplementedLightningServer) PayInvoice(context.Context, *PayInvoiceRequest) (*PayInvoiceResponse, error)
- func (UnimplementedLightningServer) PubKey(context.Context, *PubKeyRequest) (*PubKeyResponse, error)
- type UnsafeLightningServer
Constants ¶
This section is empty.
Variables ¶
var File_lightning_client_proto protoreflect.FileDescriptor
var Lightning_ServiceDesc = grpc.ServiceDesc{ ServiceName: "Lightning", HandlerType: (*LightningServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "PubKey", Handler: _Lightning_PubKey_Handler, }, { MethodName: "ConnectPeer", Handler: _Lightning_ConnectPeer_Handler, }, { MethodName: "OpenChannel", Handler: _Lightning_OpenChannel_Handler, }, { MethodName: "CreateInvoice", Handler: _Lightning_CreateInvoice_Handler, }, { MethodName: "PayInvoice", Handler: _Lightning_PayInvoice_Handler, }, { MethodName: "ChannelBalance", Handler: _Lightning_ChannelBalance_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "lightning_client.proto", }
Lightning_ServiceDesc is the grpc.ServiceDesc for Lightning service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterLightningServer ¶
func RegisterLightningServer(s grpc.ServiceRegistrar, srv LightningServer)
Types ¶
type ChannelBalanceRequest ¶
type ChannelBalanceRequest struct {
// contains filtered or unexported fields
}
func (*ChannelBalanceRequest) Descriptor
deprecated
func (*ChannelBalanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use ChannelBalanceRequest.ProtoReflect.Descriptor instead.
func (*ChannelBalanceRequest) ProtoMessage ¶
func (*ChannelBalanceRequest) ProtoMessage()
func (*ChannelBalanceRequest) ProtoReflect ¶
func (x *ChannelBalanceRequest) ProtoReflect() protoreflect.Message
func (*ChannelBalanceRequest) Reset ¶
func (x *ChannelBalanceRequest) Reset()
func (*ChannelBalanceRequest) String ¶
func (x *ChannelBalanceRequest) String() string
type ChannelBalanceResponse ¶
type ChannelBalanceResponse struct { BalanceSats uint64 `protobuf:"varint,1,opt,name=balanceSats,proto3" json:"balanceSats,omitempty"` // contains filtered or unexported fields }
func (*ChannelBalanceResponse) Descriptor
deprecated
func (*ChannelBalanceResponse) Descriptor() ([]byte, []int)
Deprecated: Use ChannelBalanceResponse.ProtoReflect.Descriptor instead.
func (*ChannelBalanceResponse) GetBalanceSats ¶
func (x *ChannelBalanceResponse) GetBalanceSats() uint64
func (*ChannelBalanceResponse) ProtoMessage ¶
func (*ChannelBalanceResponse) ProtoMessage()
func (*ChannelBalanceResponse) ProtoReflect ¶
func (x *ChannelBalanceResponse) ProtoReflect() protoreflect.Message
func (*ChannelBalanceResponse) Reset ¶
func (x *ChannelBalanceResponse) Reset()
func (*ChannelBalanceResponse) String ¶
func (x *ChannelBalanceResponse) String() string
type ConnectPeerRequest ¶
type ConnectPeerRequest struct { PubKey []byte `protobuf:"bytes,1,opt,name=pubKey,proto3" json:"pubKey,omitempty"` Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"` Port uint32 `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"` // contains filtered or unexported fields }
func (*ConnectPeerRequest) Descriptor
deprecated
func (*ConnectPeerRequest) Descriptor() ([]byte, []int)
Deprecated: Use ConnectPeerRequest.ProtoReflect.Descriptor instead.
func (*ConnectPeerRequest) GetHost ¶
func (x *ConnectPeerRequest) GetHost() string
func (*ConnectPeerRequest) GetPort ¶
func (x *ConnectPeerRequest) GetPort() uint32
func (*ConnectPeerRequest) GetPubKey ¶
func (x *ConnectPeerRequest) GetPubKey() []byte
func (*ConnectPeerRequest) ProtoMessage ¶
func (*ConnectPeerRequest) ProtoMessage()
func (*ConnectPeerRequest) ProtoReflect ¶
func (x *ConnectPeerRequest) ProtoReflect() protoreflect.Message
func (*ConnectPeerRequest) Reset ¶
func (x *ConnectPeerRequest) Reset()
func (*ConnectPeerRequest) String ¶
func (x *ConnectPeerRequest) String() string
type ConnectPeerResponse ¶
type ConnectPeerResponse struct {
// contains filtered or unexported fields
}
func (*ConnectPeerResponse) Descriptor
deprecated
func (*ConnectPeerResponse) Descriptor() ([]byte, []int)
Deprecated: Use ConnectPeerResponse.ProtoReflect.Descriptor instead.
func (*ConnectPeerResponse) ProtoMessage ¶
func (*ConnectPeerResponse) ProtoMessage()
func (*ConnectPeerResponse) ProtoReflect ¶
func (x *ConnectPeerResponse) ProtoReflect() protoreflect.Message
func (*ConnectPeerResponse) Reset ¶
func (x *ConnectPeerResponse) Reset()
func (*ConnectPeerResponse) String ¶
func (x *ConnectPeerResponse) String() string
type CreateInvoiceRequest ¶
type CreateInvoiceRequest struct { AmtSats uint64 `protobuf:"varint,1,opt,name=amtSats,proto3" json:"amtSats,omitempty"` // contains filtered or unexported fields }
func (*CreateInvoiceRequest) Descriptor
deprecated
func (*CreateInvoiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateInvoiceRequest.ProtoReflect.Descriptor instead.
func (*CreateInvoiceRequest) GetAmtSats ¶
func (x *CreateInvoiceRequest) GetAmtSats() uint64
func (*CreateInvoiceRequest) ProtoMessage ¶
func (*CreateInvoiceRequest) ProtoMessage()
func (*CreateInvoiceRequest) ProtoReflect ¶
func (x *CreateInvoiceRequest) ProtoReflect() protoreflect.Message
func (*CreateInvoiceRequest) Reset ¶
func (x *CreateInvoiceRequest) Reset()
func (*CreateInvoiceRequest) String ¶
func (x *CreateInvoiceRequest) String() string
type CreateInvoiceResponse ¶
type CreateInvoiceResponse struct { Invoice string `protobuf:"bytes,1,opt,name=invoice,proto3" json:"invoice,omitempty"` // contains filtered or unexported fields }
func (*CreateInvoiceResponse) Descriptor
deprecated
func (*CreateInvoiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateInvoiceResponse.ProtoReflect.Descriptor instead.
func (*CreateInvoiceResponse) GetInvoice ¶
func (x *CreateInvoiceResponse) GetInvoice() string
func (*CreateInvoiceResponse) ProtoMessage ¶
func (*CreateInvoiceResponse) ProtoMessage()
func (*CreateInvoiceResponse) ProtoReflect ¶
func (x *CreateInvoiceResponse) ProtoReflect() protoreflect.Message
func (*CreateInvoiceResponse) Reset ¶
func (x *CreateInvoiceResponse) Reset()
func (*CreateInvoiceResponse) String ¶
func (x *CreateInvoiceResponse) String() string
type LightningClient ¶
type LightningClient interface { PubKey(ctx context.Context, in *PubKeyRequest, opts ...grpc.CallOption) (*PubKeyResponse, error) ConnectPeer(ctx context.Context, in *ConnectPeerRequest, opts ...grpc.CallOption) (*ConnectPeerResponse, error) OpenChannel(ctx context.Context, in *OpenChannelRequest, opts ...grpc.CallOption) (*OpenChannelResponse, error) CreateInvoice(ctx context.Context, in *CreateInvoiceRequest, opts ...grpc.CallOption) (*CreateInvoiceResponse, error) PayInvoice(ctx context.Context, in *PayInvoiceRequest, opts ...grpc.CallOption) (*PayInvoiceResponse, error) ChannelBalance(ctx context.Context, in *ChannelBalanceRequest, opts ...grpc.CallOption) (*ChannelBalanceResponse, error) }
LightningClient is the client API for Lightning 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 NewLightningClient ¶
func NewLightningClient(cc grpc.ClientConnInterface) LightningClient
type LightningServer ¶
type LightningServer interface { PubKey(context.Context, *PubKeyRequest) (*PubKeyResponse, error) ConnectPeer(context.Context, *ConnectPeerRequest) (*ConnectPeerResponse, error) OpenChannel(context.Context, *OpenChannelRequest) (*OpenChannelResponse, error) CreateInvoice(context.Context, *CreateInvoiceRequest) (*CreateInvoiceResponse, error) PayInvoice(context.Context, *PayInvoiceRequest) (*PayInvoiceResponse, error) ChannelBalance(context.Context, *ChannelBalanceRequest) (*ChannelBalanceResponse, error) // contains filtered or unexported methods }
LightningServer is the server API for Lightning service. All implementations must embed UnimplementedLightningServer for forward compatibility
type OpenChannelRequest ¶
type OpenChannelRequest struct { PubKey []byte `protobuf:"bytes,1,opt,name=pubKey,proto3" json:"pubKey,omitempty"` LocalAmtSats uint64 `protobuf:"varint,2,opt,name=localAmtSats,proto3" json:"localAmtSats,omitempty"` // contains filtered or unexported fields }
func (*OpenChannelRequest) Descriptor
deprecated
func (*OpenChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use OpenChannelRequest.ProtoReflect.Descriptor instead.
func (*OpenChannelRequest) GetLocalAmtSats ¶
func (x *OpenChannelRequest) GetLocalAmtSats() uint64
func (*OpenChannelRequest) GetPubKey ¶
func (x *OpenChannelRequest) GetPubKey() []byte
func (*OpenChannelRequest) ProtoMessage ¶
func (*OpenChannelRequest) ProtoMessage()
func (*OpenChannelRequest) ProtoReflect ¶
func (x *OpenChannelRequest) ProtoReflect() protoreflect.Message
func (*OpenChannelRequest) Reset ¶
func (x *OpenChannelRequest) Reset()
func (*OpenChannelRequest) String ¶
func (x *OpenChannelRequest) String() string
type OpenChannelResponse ¶
type OpenChannelResponse struct { FundingTxId []byte `protobuf:"bytes,1,opt,name=fundingTxId,proto3" json:"fundingTxId,omitempty"` FundingTxOutputIndex uint32 `protobuf:"varint,2,opt,name=fundingTxOutputIndex,proto3" json:"fundingTxOutputIndex,omitempty"` // contains filtered or unexported fields }
func (*OpenChannelResponse) Descriptor
deprecated
func (*OpenChannelResponse) Descriptor() ([]byte, []int)
Deprecated: Use OpenChannelResponse.ProtoReflect.Descriptor instead.
func (*OpenChannelResponse) GetFundingTxId ¶
func (x *OpenChannelResponse) GetFundingTxId() []byte
func (*OpenChannelResponse) GetFundingTxOutputIndex ¶
func (x *OpenChannelResponse) GetFundingTxOutputIndex() uint32
func (*OpenChannelResponse) ProtoMessage ¶
func (*OpenChannelResponse) ProtoMessage()
func (*OpenChannelResponse) ProtoReflect ¶
func (x *OpenChannelResponse) ProtoReflect() protoreflect.Message
func (*OpenChannelResponse) Reset ¶
func (x *OpenChannelResponse) Reset()
func (*OpenChannelResponse) String ¶
func (x *OpenChannelResponse) String() string
type PayInvoiceRequest ¶
type PayInvoiceRequest struct { Invoice string `protobuf:"bytes,1,opt,name=invoice,proto3" json:"invoice,omitempty"` // contains filtered or unexported fields }
func (*PayInvoiceRequest) Descriptor
deprecated
func (*PayInvoiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use PayInvoiceRequest.ProtoReflect.Descriptor instead.
func (*PayInvoiceRequest) GetInvoice ¶
func (x *PayInvoiceRequest) GetInvoice() string
func (*PayInvoiceRequest) ProtoMessage ¶
func (*PayInvoiceRequest) ProtoMessage()
func (*PayInvoiceRequest) ProtoReflect ¶
func (x *PayInvoiceRequest) ProtoReflect() protoreflect.Message
func (*PayInvoiceRequest) Reset ¶
func (x *PayInvoiceRequest) Reset()
func (*PayInvoiceRequest) String ¶
func (x *PayInvoiceRequest) String() string
type PayInvoiceResponse ¶
type PayInvoiceResponse struct { PaymentPreimage []byte `protobuf:"bytes,2,opt,name=paymentPreimage,proto3" json:"paymentPreimage,omitempty"` // contains filtered or unexported fields }
func (*PayInvoiceResponse) Descriptor
deprecated
func (*PayInvoiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use PayInvoiceResponse.ProtoReflect.Descriptor instead.
func (*PayInvoiceResponse) GetPaymentPreimage ¶
func (x *PayInvoiceResponse) GetPaymentPreimage() []byte
func (*PayInvoiceResponse) ProtoMessage ¶
func (*PayInvoiceResponse) ProtoMessage()
func (*PayInvoiceResponse) ProtoReflect ¶
func (x *PayInvoiceResponse) ProtoReflect() protoreflect.Message
func (*PayInvoiceResponse) Reset ¶
func (x *PayInvoiceResponse) Reset()
func (*PayInvoiceResponse) String ¶
func (x *PayInvoiceResponse) String() string
type PubKeyRequest ¶
type PubKeyRequest struct {
// contains filtered or unexported fields
}
func (*PubKeyRequest) Descriptor
deprecated
func (*PubKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use PubKeyRequest.ProtoReflect.Descriptor instead.
func (*PubKeyRequest) ProtoMessage ¶
func (*PubKeyRequest) ProtoMessage()
func (*PubKeyRequest) ProtoReflect ¶
func (x *PubKeyRequest) ProtoReflect() protoreflect.Message
func (*PubKeyRequest) Reset ¶
func (x *PubKeyRequest) Reset()
func (*PubKeyRequest) String ¶
func (x *PubKeyRequest) String() string
type PubKeyResponse ¶
type PubKeyResponse struct { PubKey []byte `protobuf:"bytes,1,opt,name=pubKey,proto3" json:"pubKey,omitempty"` // contains filtered or unexported fields }
func (*PubKeyResponse) Descriptor
deprecated
func (*PubKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use PubKeyResponse.ProtoReflect.Descriptor instead.
func (*PubKeyResponse) GetPubKey ¶
func (x *PubKeyResponse) GetPubKey() []byte
func (*PubKeyResponse) ProtoMessage ¶
func (*PubKeyResponse) ProtoMessage()
func (*PubKeyResponse) ProtoReflect ¶
func (x *PubKeyResponse) ProtoReflect() protoreflect.Message
func (*PubKeyResponse) Reset ¶
func (x *PubKeyResponse) Reset()
func (*PubKeyResponse) String ¶
func (x *PubKeyResponse) String() string
type UnimplementedLightningServer ¶
type UnimplementedLightningServer struct { }
UnimplementedLightningServer must be embedded to have forward compatible implementations.
func (UnimplementedLightningServer) ChannelBalance ¶
func (UnimplementedLightningServer) ChannelBalance(context.Context, *ChannelBalanceRequest) (*ChannelBalanceResponse, error)
func (UnimplementedLightningServer) ConnectPeer ¶
func (UnimplementedLightningServer) ConnectPeer(context.Context, *ConnectPeerRequest) (*ConnectPeerResponse, error)
func (UnimplementedLightningServer) CreateInvoice ¶
func (UnimplementedLightningServer) CreateInvoice(context.Context, *CreateInvoiceRequest) (*CreateInvoiceResponse, error)
func (UnimplementedLightningServer) OpenChannel ¶
func (UnimplementedLightningServer) OpenChannel(context.Context, *OpenChannelRequest) (*OpenChannelResponse, error)
func (UnimplementedLightningServer) PayInvoice ¶
func (UnimplementedLightningServer) PayInvoice(context.Context, *PayInvoiceRequest) (*PayInvoiceResponse, error)
func (UnimplementedLightningServer) PubKey ¶
func (UnimplementedLightningServer) PubKey(context.Context, *PubKeyRequest) (*PubKeyResponse, error)
type UnsafeLightningServer ¶
type UnsafeLightningServer interface {
// contains filtered or unexported methods
}
UnsafeLightningServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to LightningServer will result in compilation errors.