lnrpc: clarify block padding requirement for QueryRoutes

This commit is contained in:
Joost Jager 2019-12-16 13:37:50 +01:00
parent eae45f9ad9
commit 9ae02796fa
No known key found for this signature in database
GPG Key ID: A61B9D4C393C59C7
3 changed files with 14 additions and 3 deletions

@ -5197,7 +5197,12 @@ type QueryRoutesRequest struct {
// //
//The fields amt and amt_msat are mutually exclusive. //The fields amt and amt_msat are mutually exclusive.
AmtMsat int64 `protobuf:"varint,12,opt,name=amt_msat,json=amtMsat,proto3" json:"amt_msat,omitempty"` AmtMsat int64 `protobuf:"varint,12,opt,name=amt_msat,json=amtMsat,proto3" json:"amt_msat,omitempty"`
/// 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.
FinalCltvDelta int32 `protobuf:"varint,4,opt,name=final_cltv_delta,json=finalCltvDelta,proto3" json:"final_cltv_delta,omitempty"` FinalCltvDelta int32 `protobuf:"varint,4,opt,name=final_cltv_delta,json=finalCltvDelta,proto3" json:"final_cltv_delta,omitempty"`
//* //*
//The maximum number of satoshis that will be paid as a fee of the payment. //The maximum number of satoshis that will be paid as a fee of the payment.

@ -1821,7 +1821,13 @@ message QueryRoutesRequest {
reserved 3; 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; int32 final_cltv_delta = 4;
/** /**

@ -748,7 +748,7 @@
}, },
{ {
"name": "final_cltv_delta", "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", "in": "query",
"required": false, "required": false,
"type": "integer", "type": "integer",