akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cmd/lncli: update listinvoices docs with new pagination support

Browse Source
This commit is contained in:
Wilmer Paulino 2018-09-13 14:49:47 -07:00 committed by Olaoluwa Osuntokun
parent 9e99f13f8d
commit fe17adc519
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
cmd/lncli/commands.go
View File

@ -2309,16 +2309,23 @@ func lookupInvoice(ctx *cli.Context) error {
var listInvoicesCommand = cli.Command{ var listInvoicesCommand = cli.Command{
Name: "listinvoices", Name: "listinvoices",
Category: "Payments", Category: "Payments",
Usage: "List all invoices currently stored.", Usage: "List all invoices currently stored within the database. Any " +
"active debug invoices are ingnored.",
Description: ` Description: `
This command enables the retrieval of all invoices currently stored This command enables the retrieval of all invoices currently stored
within the database. It has full support for pagination-style responses, within the database. It has full support for paginationed responses,
allowing users to query for specific invoices through their add_index. allowing users to query for specific invoices through their add_index.
This can be done by using either the first_index_offset or This can be done by using either the first_index_offset or
last_index_offset fields included in the response. The reversed flag is last_index_offset fields included in the response as the index_offset of
set by default in order to paginate backwards. If you wish to paginate the next request. The reversed flag is set by default in order to
forwards, you must explicitly set the flag to false. If none of the paginate backwards. If you wish to paginate forwards, you must
parameters are specified, then the last 100 invoices will be returned.`, explicitly set the flag to false. If none of the parameters are
specified, then the last 100 invoices will be returned.
For example: if you have 200 invoices, "lncli listinvoices" will return
the last 100 created. If you wish to retrieve the previous 100, the
first_offset_index of the response can be used as the index_offset of
the next listinvoices request.`,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "pending_only", Name: "pending_only",
@ -2327,7 +2334,10 @@ var listInvoicesCommand = cli.Command{
}, },
cli.Uint64Flag{ cli.Uint64Flag{
Name: "index_offset", Name: "index_offset",
Usage: "the number of invoices to skip", Usage: "the index of an invoice that will be used as " +
"either the start or end of a query to " +
"determine which invoices should be returned " +
"in the response",
}, },
cli.Uint64Flag{ cli.Uint64Flag{
Name: "max_invoices", Name: "max_invoices",