doc: Update doc with the new parameter supported

Changelog-Added: Support to listpays the status parameter to filter the payments by status.

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
This commit is contained in:
Vincenzo Palazzo 2021-07-22 09:24:18 +02:00 committed by Rusty Russell
parent 98623aaff8
commit 62ef403d20
6 changed files with 153 additions and 4 deletions

View file

@ -3,12 +3,13 @@
lightning-listpays - Command for querying payment status
.SH SYNOPSIS
\fBlistpays\fR [bolt11] [payment_hash]
\fBlistpays\fR [bolt11] [payment_hash] [status]
.SH DESCRIPTION
The \fBlistpay\fR RPC command gets the status of all \fIpay\fR commands, or a
single one if either \fIbolt11\fR or \fIpayment_hash\fR was specified\.
It is possible filter the payments also by status\.
.SH RETURN VALUE
@ -74,4 +75,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:29837ba48de2dd29a3630fc4717cd8a3a8abf3e8f4d8e75fd6fc4f2e7467b455
\" SHA256STAMP:4cea0f219c2a99fed2db9b95ec4f0210ed4dfa903660849c74238b25d45a637a

View file

@ -4,13 +4,14 @@ lightning-listpays -- Command for querying payment status
SYNOPSIS
--------
**listpays** \[bolt11\] \[payment_hash\]
**listpays** \[bolt11\] \[payment_hash\] \[status\]
DESCRIPTION
-----------
The **listpay** RPC command gets the status of all *pay* commands, or a
single one if either *bolt11* or *payment_hash* was specified.
It is possible filter the payments also by status.
RETURN VALUE
------------

View file

@ -4630,7 +4630,7 @@ def test_listpays_with_filter_by_status(node_factory, bitcoind):
wait_for(lambda: l2.rpc.listpays(inv['bolt11'])['pays'][0]['status'] == 'complete')
# test if the node is still ready
payments = l2.rpc.call("listpays", {"status": 'failed'})
payments = l2.rpc.listpays(status='failed')
assert len(payments['pays']) == 0

View file

@ -2094,52 +2094,71 @@ struct db_query db_postgres_queries[] = {
#endif /* LIGHTNINGD_WALLET_GEN_DB_POSTGRES */
<<<<<<< refs/remotes/ElementsProject/master
<<<<<<< refs/remotes/ElementsProject/master
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:d812809c7895cea0ed904084e48c523ea01a8cd9525e4b6be1b4e05bec2a90d1
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:e356b7327b760559f9a7c31a7ea4a09d50194c7aacc6daef6ba9fb5caf43ae83
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:a70af01d3b2f3a7003703b7feb0b2ef12359e0d2850bde1697a53780e2f5dbae
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:f929ee6db13bdf55b5e0cdf54840091948b664a61c63a4aaaef403dc7e6f23ad
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:219fccaaf2391eeabadd4cc15b4a3431c7ecab9d17755582e6962a34c74982c5
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:1808964024bcccbd2787e723881f263b1a77ea33c302ac2b6d61dae20486a7e4
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:411593f0957475d832c02cd75a8b0eed30b00fc6178797262ae7dd697de22383
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:be7e5cedcb61a9b96566d4531bb25f2db4e5a344b0d884eec3fc3adf7a4fe242
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:df06b800543e6bb886100ca428247ac1097f749098779dae43ba875154700f58
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:27a166e040e517422e91cf7ffbd12426b34337b8d75f82d7aa4c448beae5e821
=======
@ -2184,12 +2203,42 @@ struct db_query db_postgres_queries[] = {
// SHA256STAMP:2af9ace16d4db060e649c3e078271504fce5a7c5661a25464a551aa7cc7029d0
>>>>>>> wallet db: Support the query on database with status and payment hash.
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
=======
=======
=======
=======
=======
=======
=======
=======
=======
// SHA256STAMP:c08699eae7d8de418f7b197aad5682203ebbae633ce8888b9b4797a2db8ce106
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported

View file

@ -2094,52 +2094,71 @@ struct db_query db_sqlite3_queries[] = {
#endif /* LIGHTNINGD_WALLET_GEN_DB_SQLITE3 */
<<<<<<< refs/remotes/ElementsProject/master
<<<<<<< refs/remotes/ElementsProject/master
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:d812809c7895cea0ed904084e48c523ea01a8cd9525e4b6be1b4e05bec2a90d1
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:e356b7327b760559f9a7c31a7ea4a09d50194c7aacc6daef6ba9fb5caf43ae83
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:a70af01d3b2f3a7003703b7feb0b2ef12359e0d2850bde1697a53780e2f5dbae
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:f929ee6db13bdf55b5e0cdf54840091948b664a61c63a4aaaef403dc7e6f23ad
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:219fccaaf2391eeabadd4cc15b4a3431c7ecab9d17755582e6962a34c74982c5
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:1808964024bcccbd2787e723881f263b1a77ea33c302ac2b6d61dae20486a7e4
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:411593f0957475d832c02cd75a8b0eed30b00fc6178797262ae7dd697de22383
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:be7e5cedcb61a9b96566d4531bb25f2db4e5a344b0d884eec3fc3adf7a4fe242
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:df06b800543e6bb886100ca428247ac1097f749098779dae43ba875154700f58
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
// SHA256STAMP:27a166e040e517422e91cf7ffbd12426b34337b8d75f82d7aa4c448beae5e821
=======
@ -2184,12 +2203,42 @@ struct db_query db_sqlite3_queries[] = {
// SHA256STAMP:2af9ace16d4db060e649c3e078271504fce5a7c5661a25464a551aa7cc7029d0
>>>>>>> wallet db: Support the query on database with status and payment hash.
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
=======
=======
=======
=======
=======
=======
=======
=======
=======
// SHA256STAMP:c08699eae7d8de418f7b197aad5682203ebbae633ce8888b9b4797a2db8ce106
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported

View file

@ -1641,50 +1641,69 @@ msgid "INSERT INTO channels (id) VALUES (1);"
msgstr ""
<<<<<<< refs/remotes/ElementsProject/master
<<<<<<< refs/remotes/ElementsProject/master
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:826f40774d133dbfa18209685ab964d2915e303346b964107ac4974275910111
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:0b3b17a4eb95067fdebc9d90c962c46e40fdef2002f92856cc31800ab37fbe59
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:651a6c15e8780351cd32a4e6dc3011b1c5fc2af6308b0e65a442dda2a3874e19
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:35e10cb3ec34af54b6d78d9eea1aefa0861ef9acbfe0e78745d24b8e49e50b05
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:d098fea63dcba84aefff5cf924cbc455caf9d2ec13cb28ad9ab929bb001a12e6
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:e7f23b938c7ee86b0178ca11d8d3df3f08dec52e205e0778be1f5a0b607f52f6
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:8878e1ee71d04ea6302c18aeb02f59c56e086a7e5a4647ddbe67bc2ef7c07275
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:51fa10c40312c4845f05157420486d57cc8c5ace7b7da7a92c8e496f48ff0dcc
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:d0ba3b9e4e392f7327662f333f4712582f7553a819d588ebb3641b229215e90f
=======
=======
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
>>>>>>> doc: Update doc with the new parameter supported
<<<<<<< refs/remotes/ElementsProject/master
# SHA256STAMP:3652b5850f08383c0f0c01a7f11c1a22ec2b4ac16018152d2770a73674fb05ec
=======
@ -1729,12 +1748,42 @@ msgstr ""
# SHA256STAMP:697c27016716f435d1ecb4ec3fca117316f779d88c02dbde7ea3214b4bc0a2c7
>>>>>>> wallet db: Support the query on database with status and payment hash.
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
<<<<<<< refs/remotes/ElementsProject/master
>>>>>>> wallet db: Support the query on database with status and payment hash.
=======
=======
=======
=======
=======
=======
=======
=======
=======
=======
# SHA256STAMP:de612e43f4a76fed487047d802d20cc7185cf5650ed31bc01efb89c495bfbb14
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported
>>>>>>> doc: Update doc with the new parameter supported