Skip to content

Commit f5fbf66

Browse files
committed
looprpc: clarify loop quote response
1 parent a57a294 commit f5fbf66

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

looprpc/client.pb.go

Lines changed: 8 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

looprpc/client.proto

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ message QuoteRequest {
412412
publishing the HTLC on chain. Setting this to a larger value will give the
413413
server the opportunity to batch multiple swaps together, and wait for
414414
low-fee periods before publishing the HTLC, potentially resulting in a
415-
lower total swap fee.
415+
lower total swap fee. This only has an effect on loop out quotes.
416416
*/
417417
uint64 swap_publication_deadline = 4;
418418
}
@@ -429,7 +429,13 @@ message QuoteResponse {
429429
int64 prepay_amt = 2;
430430

431431
/**
432-
An estimate of the on-chain fee that needs to be paid to sweep the HTLC.
432+
An estimate of the on-chain fee that needs to be paid to sweep the HTLC for
433+
a loop out or to pay to the HTLC for loop in. If a miner fee of 0 is
434+
returned, it means the external_htlc flag was set for a loop in and the fee
435+
estimation was skipped. If a miner fee of -1 is returned, it means lnd's
436+
wallet tried to estimate the fee but was unable to create a sample
437+
estimation transaction because not enough funds are available. An
438+
information message should be shown to the user in this case.
433439
*/
434440
int64 miner_fee = 3;
435441

looprpc/client.swagger.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
},
8282
{
8383
"name": "swap_publication_deadline",
84-
"description": "*\nThe latest time (in unix seconds) we allow the server to wait before\npublishing the HTLC on chain. Setting this to a larger value will give the\nserver the opportunity to batch multiple swaps together, and wait for\nlow-fee periods before publishing the HTLC, potentially resulting in a\nlower total swap fee.",
84+
"description": "*\nThe latest time (in unix seconds) we allow the server to wait before\npublishing the HTLC on chain. Setting this to a larger value will give the\nserver the opportunity to batch multiple swaps together, and wait for\nlow-fee periods before publishing the HTLC, potentially resulting in a\nlower total swap fee. This only has an effect on loop out quotes.",
8585
"in": "query",
8686
"required": false,
8787
"type": "string",
@@ -176,7 +176,7 @@
176176
},
177177
{
178178
"name": "swap_publication_deadline",
179-
"description": "*\nThe latest time (in unix seconds) we allow the server to wait before\npublishing the HTLC on chain. Setting this to a larger value will give the\nserver the opportunity to batch multiple swaps together, and wait for\nlow-fee periods before publishing the HTLC, potentially resulting in a\nlower total swap fee.",
179+
"description": "*\nThe latest time (in unix seconds) we allow the server to wait before\npublishing the HTLC on chain. Setting this to a larger value will give the\nserver the opportunity to batch multiple swaps together, and wait for\nlow-fee periods before publishing the HTLC, potentially resulting in a\nlower total swap fee. This only has an effect on loop out quotes.",
180180
"in": "query",
181181
"required": false,
182182
"type": "string",
@@ -424,7 +424,7 @@
424424
"miner_fee": {
425425
"type": "string",
426426
"format": "int64",
427-
"description": "*\nAn estimate of the on-chain fee that needs to be paid to sweep the HTLC."
427+
"description": "*\nAn estimate of the on-chain fee that needs to be paid to sweep the HTLC for\na loop out or to pay to the HTLC for loop in. If a miner fee of 0 is\nreturned, it means the external_htlc flag was set for a loop in and the fee\nestimation was skipped. If a miner fee of -1 is returned, it means lnd's\nwallet tried to estimate the fee but was unable to create a sample\nestimation transaction because not enough funds are available. An\ninformation message should be shown to the user in this case."
428428
},
429429
"swap_payment_dest": {
430430
"type": "string",

0 commit comments

Comments
 (0)