From 23a1e33dfc8bf5954f7cd6a4d277d78d59c509f9 Mon Sep 17 00:00:00 2001
From: Joost Jager <joost.jager@gmail.com>
Date: Tue, 19 May 2020 17:58:04 +0200
Subject: [PATCH] lndclient: document SendPaymentRequest fields

---
 lndclient/router_client.go | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lndclient/router_client.go b/lndclient/router_client.go
index 8fb62e6..80eaeac 100644
--- a/lndclient/router_client.go
+++ b/lndclient/router_client.go
@@ -64,13 +64,19 @@ type SendPaymentRequest struct {
 	// are only processed when the Invoice field is empty.
 	Invoice string
 
-	MaxFee  btcutil.Amount
+	// MaxFee is the fee limit for this payment.
+	MaxFee btcutil.Amount
+
+	// MaxCltv is the maximum timelock for this payment. If nil, there is no
+	// maximum.
 	MaxCltv *int32
 
 	// OutgoingChanIds is a restriction on the set of possible outgoing
 	// channels. If nil or empty, there is no restriction.
 	OutgoingChanIds []uint64
 
+	// Timeout is the payment loop timeout. After this time, no new payment
+	// attempts will be started.
 	Timeout time.Duration
 
 	// Target is the node in which the payment should be routed towards.