forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lightning-waitsendpay.7.txt
89 lines (72 loc) · 2.89 KB
/
lightning-waitsendpay.7.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
LIGHTNING-WAITSENDPAY(7)
========================
:doctype: manpage
NAME
----
lightning-waitsendpay - Command for sending a payment via a route.
SYNOPSIS
--------
*waitsendpay* 'payment_hash' ['timeout']
DESCRIPTION
-----------
The *waitsendpay* RPC command polls or waits for the status of
an outgoing payment that was initiated by a previous *sendpay*
invocation.
Optionally the client may provide a 'timeout', an integer in
seconds, for this RPC command to return.
If the 'timeout' is provided and the given amount of time
passes without the payment definitely succeeding or definitely
failing, this command returns with a 200 error code (payment
still in progress).
If 'timeout' is not provided this call will wait indefinitely.
Indicating a 'timeout' of 0 effectively makes this call a
pollable query of the status of the payment.
If the payment completed with success, this command returns
with success.
Otherwise, if the payment completed with failure, this command
returns an error.
RETURN VALUE
------------
On success, an object similar to the output of *listsendpays* will
be returned.
This object will have a 'status' field that is the
string '"complete"'.
On error, and even if the error occurred from a node other than the
final destination, the route table will no longer be updated. Use
the 'exclude' parameter of the `getroute` command to ignore the
failing route.
The following error codes may occur:
* -1. Catchall nonspecific error.
* 200. Timed out before the payment could complete.
* 202. Unparseable onion reply. The 'data' field of the error
will have an 'onionreply' field, a hex string representation
of the raw onion reply.
* 203. Permanent failure at destination. The 'data' field of
the error will be routing failure object.
* 204. Failure along route; retry a different route. The 'data'
field of the error will be routing failure object.
* 208. A payment for 'payment_hash' was never made and there is
nothing to wait for.
* 209. The payment already failed, but the reason for failure
was not stored. This should only occur when querying failed
payments on very old databases.
A routing failure object has the fields below:
* 'erring_index'. The index of the node along the route that
reported the error. 0 for the local node, 1 for the first
hop, and so on.
* 'erring_node'. The hex string of the pubkey id of the node
that reported the error.
* 'erring_channel'. The short channel ID of the channel that
has the error (or the final channel if the destination raised the error).
* 'erring_direction'. The direction of traversing the 'erring_channel'.
* 'failcode'. The failure code, as per BOLT #4.
* 'failcodename'. The human-readable name corresponding to 'failcode', if known.
AUTHOR
------
ZmnSCPxj <[email protected]> is mainly responsible.
SEE ALSO
--------
lightning-sendpay(7), lightning-pay(7).
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning