Skip to content

Commit 48b16a1

Browse files
committed
walletrpc: document that min conf_target is 2
Without this notice a developer might think that 1 is a valid value, which can result in a rare bug. Example: lightninglabs/loop#898
1 parent c292acf commit 48b16a1

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

lnrpc/walletrpc/walletkit.pb.go

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

lnrpc/walletrpc/walletkit.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -841,6 +841,7 @@ message SendOutputsResponse {
841841
message EstimateFeeRequest {
842842
/*
843843
The number of confirmations to shoot for when estimating the fee.
844+
Must be greater than 1.
844845
*/
845846
int32 conf_target = 1;
846847
}
@@ -1396,6 +1397,7 @@ message FundPsbtRequest {
13961397
oneof fees {
13971398
/*
13981399
The target number of blocks that the transaction should be confirmed in.
1400+
Must be greater than 1.
13991401
*/
14001402
uint32 target_conf = 3;
14011403

lnrpc/walletrpc/walletkit.swagger.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@
325325
"parameters": [
326326
{
327327
"name": "conf_target",
328-
"description": "The number of confirmations to shoot for when estimating the fee.",
328+
"description": "The number of confirmations to shoot for when estimating the fee.\nMust be greater than 1.",
329329
"in": "path",
330330
"required": true,
331331
"type": "integer",
@@ -1577,7 +1577,7 @@
15771577
"target_conf": {
15781578
"type": "integer",
15791579
"format": "int64",
1580-
"description": "The target number of blocks that the transaction should be confirmed in."
1580+
"description": "The target number of blocks that the transaction should be confirmed in.\nMust be greater than 1."
15811581
},
15821582
"sat_per_vbyte": {
15831583
"type": "string",

0 commit comments

Comments
 (0)