Merge pull request #6481 from torkelrogstad/2022-04-30-chain-notifier

chainrpc: clarify documentation
lightningnetwork · May 2, 2022 · aca2299 · aca2299
2 parents 9bbee09 + d6db386
commit aca2299
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 10 deletions.
diff --git a/docs/release-notes/release-notes-0.15.0.md b/docs/release-notes/release-notes-0.15.0.md
@@ -206,6 +206,9 @@ close to continue after a peer disconnect](https://github.com/lightningnetwork/l
   options](https://github.com/lightningnetwork/lnd/pull/6064) to allow
   specifying non-default paths for the configuration and RPC cookie files.
 
+* [Clarify comment](https://github.com/lightningnetwork/lnd/pull/6481) on 
+  `chainnotifier.RegisterConfirmationsNtfn`.
+
 ## RPC Server
 
 * [Add value to the field

diff --git a/lnrpc/chainrpc/chainnotifier.proto b/lnrpc/chainrpc/chainnotifier.proto
@@ -12,9 +12,11 @@ service ChainNotifier {
     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.
     */
     rpc RegisterConfirmationsNtfn (ConfRequest) returns (stream ConfEvent);
 

diff --git a/lnrpc/chainrpc/chainnotifier.swagger.json b/lnrpc/chainrpc/chainnotifier.swagger.json
@@ -62,7 +62,7 @@
     "/v2/chainnotifier/register/confirmations": {
       "post": {
         "summary": "RegisterConfirmationsNtfn is a synchronous response-streaming RPC that\nregisters an intent for a client to be notified once a confirmation request\nhas reached its required number of confirmations on-chain.",
-        "description": "A client can specify whether the confirmation request should be for a\nparticular transaction by its hash or for an output script by specifying a\nzero hash.",
+        "description": "A confirmation request must have a valid output script. It is also possible\nto give a transaction ID. If the transaction ID is not set, a notification\nis sent once the output script confirms. If the transaction ID is also set,\na notification is sent once the output script confirms in the given\ntransaction.",
         "operationId": "ChainNotifier_RegisterConfirmationsNtfn",
         "responses": {
           "200": {

diff --git a/lnrpc/chainrpc/chainnotifier_grpc.pb.go b/lnrpc/chainrpc/chainnotifier_grpc.pb.go