highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-09-14 02:15:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

chainrpc: clarify documentation

Browse Source 
Clarify the comment on RegisterConfirmationsNtfn. The output script
is in fact mandatory, not optional.
This commit is contained in:
Torkel Rogstad
2022-04-30 10:37:54 +02:00
parent 9bbee09497
commit d6db386663
4 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
lnrpc/chainrpc/chainnotifier_grpc.pb.go
View File

@@ -23,9 +23,11 @@ type ChainNotifierClient interface {
//registers an intent for a client to be notified once a confirmation request
//has reached its required number of confirmations on-chain.
//
//A client can specify whether the confirmation request should be for a
//particular transaction by its hash or for an output script by specifying a
//zero hash.
//A confirmation request must have a valid output script. It is also possible
//to give a transaction ID. If the transaction ID is not set, a notification
//is sent once the output script confirms. If the transaction ID is also set,
//a notification is sent once the output script confirms in the given
//transaction.
RegisterConfirmationsNtfn(ctx context.Context, in *ConfRequest, opts ...grpc.CallOption) (ChainNotifier_RegisterConfirmationsNtfnClient, error)
//
//RegisterSpendNtfn is a synchronous response-streaming RPC that registers an
@@ -161,9 +163,11 @@ type ChainNotifierServer interface {
//registers an intent for a client to be notified once a confirmation request
//has reached its required number of confirmations on-chain.
//
//A client can specify whether the confirmation request should be for a
//particular transaction by its hash or for an output script by specifying a
//zero hash.
//A confirmation request must have a valid output script. It is also possible
//to give a transaction ID. If the transaction ID is not set, a notification
//is sent once the output script confirms. If the transaction ID is also set,
//a notification is sent once the output script confirms in the given
//transaction.
RegisterConfirmationsNtfn(*ConfRequest, ChainNotifier_RegisterConfirmationsNtfnServer) error
//
//RegisterSpendNtfn is a synchronous response-streaming RPC that registers an