Skip to content

Commit 23a1e33

Browse files
committed
lndclient: document SendPaymentRequest fields
1 parent ccec719 commit 23a1e33

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

lndclient/router_client.go

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,19 @@ type SendPaymentRequest struct {
6464
// are only processed when the Invoice field is empty.
6565
Invoice string
6666

67-
MaxFee btcutil.Amount
67+
// MaxFee is the fee limit for this payment.
68+
MaxFee btcutil.Amount
69+
70+
// MaxCltv is the maximum timelock for this payment. If nil, there is no
71+
// maximum.
6872
MaxCltv *int32
6973

7074
// OutgoingChanIds is a restriction on the set of possible outgoing
7175
// channels. If nil or empty, there is no restriction.
7276
OutgoingChanIds []uint64
7377

78+
// Timeout is the payment loop timeout. After this time, no new payment
79+
// attempts will be started.
7480
Timeout time.Duration
7581

7682
// Target is the node in which the payment should be routed towards.

0 commit comments

Comments
 (0)