Merge pull request #3840 from joostjager/queryroutes-padding-comment

lnrpc: clarify block padding requirement for QueryRoutes
lightningnetwork · Dec 16, 2019 · 77fde0f · 77fde0f
2 parents 2c92b75 + 9ae0279
commit 77fde0f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/lnrpc/rpc.pb.go b/lnrpc/rpc.pb.go
diff --git a/lnrpc/rpc.proto b/lnrpc/rpc.proto
@@ -1824,7 +1824,13 @@ message QueryRoutesRequest {
 
     reserved 3;
 
-    /// An optional CLTV delta from the current height that should be used for the timelock of the final hop
+    /**
+    An optional CLTV delta from the current height that should be used for the
+    timelock of the final hop. Note that unlike SendPayment, QueryRoutes does
+    not add any additional block padding on top of final_ctlv_delta. This
+    padding of a few blocks needs to be added manually or otherwise failures may
+    happen when a block comes in while the payment is in flight.
+    */
     int32 final_cltv_delta = 4;
 
     /**

diff --git a/lnrpc/rpc.swagger.json b/lnrpc/rpc.swagger.json
@@ -748,7 +748,7 @@
           },
           {
             "name": "final_cltv_delta",
-            "description": "/ An optional CLTV delta from the current height that should be used for the timelock of the final hop.",
+            "description": "*\nAn optional CLTV delta from the current height that should be used for the\ntimelock of the final hop. Note that unlike SendPayment, QueryRoutes does\nnot add any additional block padding on top of final_ctlv_delta. This\npadding of a few blocks needs to be added manually or otherwise failures may\nhappen when a block comes in while the payment is in flight.",
             "in": "query",
             "required": false,
             "type": "integer",