lnrpc: update custom message API to explain ability to override

This commit is contained in:
Carla Kirk-Cohen
2022-07-06 09:26:48 +02:00
parent c2ce8635e7
commit 1cb08e42ef
4 changed files with 20 additions and 1 deletions

View File

@@ -392,6 +392,10 @@ type LightningClient interface {
// lncli: `subscribecustom`
// SubscribeCustomMessages subscribes to a stream of incoming custom peer
// messages.
//
// To include messages with type outside of the custom range (>= 32768) lnd
// needs to be compiled with the `dev` build tag, and the message type to
// override should be specified in lnd's experimental protocol configuration.
SubscribeCustomMessages(ctx context.Context, in *SubscribeCustomMessagesRequest, opts ...grpc.CallOption) (Lightning_SubscribeCustomMessagesClient, error)
// lncli: `listaliases`
// ListAliases returns the set of all aliases that have ever existed with
@@ -1687,6 +1691,10 @@ type LightningServer interface {
// lncli: `subscribecustom`
// SubscribeCustomMessages subscribes to a stream of incoming custom peer
// messages.
//
// To include messages with type outside of the custom range (>= 32768) lnd
// needs to be compiled with the `dev` build tag, and the message type to
// override should be specified in lnd's experimental protocol configuration.
SubscribeCustomMessages(*SubscribeCustomMessagesRequest, Lightning_SubscribeCustomMessagesServer) error
// lncli: `listaliases`
// ListAliases returns the set of all aliases that have ever existed with