GlcoinCore/loop
1
0
Fork 0
mirror of https://github.com/lightninglabs/loop.git synced 2026-08-13 12:33:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

cmd/loop: clarify traditional swap command scope

Browse source
This commit is contained in:
Gustavo Stingelin 2026-07-14 10:17:51 -03:00
parent 4a2bcb3374
commit d5fb8b8da8
No known key found for this signature in database
GPG key ID: 15CBADFE29F2017B
3 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

15
cmd/loop/swaps.go
View file

@ -15,9 +15,10 @@ import (
var listSwapsCommand = &cli.Command{ var listSwapsCommand = &cli.Command{
Name: "listswaps", Name: "listswaps",
Usage: "list all swaps in the local database", Usage: "list traditional Loop In and Loop Out swaps",
Description: "Allows the user to get a list of all swaps that are " + Description: "Lists traditional Loop In and Loop Out swaps that are " +
"currently stored in the database", "currently stored in the database. Static address loop-ins are not " +
"included; use `loop static listswaps` to view them.",
Action: listSwaps, Action: listSwaps,
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.BoolFlag{ &cli.BoolFlag{
@ -128,10 +129,12 @@ func listSwaps(ctx context.Context, cmd *cli.Command) error {
var swapInfoCommand = &cli.Command{ var swapInfoCommand = &cli.Command{
Name: "swapinfo", Name: "swapinfo",
Usage: "show the status of a swap", Usage: "show the status of a traditional swap",
ArgsUsage: "id", ArgsUsage: "id",
Description: "Allows the user to get the status of a single swap " + Description: "Shows the status of a traditional Loop In or Loop Out " +
"currently stored in the database", "swap currently stored in the database. Static address loop-ins " +
"must be viewed with `loop static listswaps`; there is no generic " +
"per-swap static lookup command.",
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.Uint64Flag{ &cli.Uint64Flag{
Name: "id", Name: "id",

4
docs/loop.1
View file

@ -203,7 +203,7 @@ fetches a new L402 authentication token from the server
\fB--help, -h\fP: show help \fB--help, -h\fP: show help
.SH listswaps .SH listswaps
list all swaps in the local database list traditional Loop In and Loop Out swaps
.PP .PP
\fB--channel\fP="": the comma-separated list of short channel IDs of the channels to loop out \fB--channel\fP="": the comma-separated list of short channel IDs of the channels to loop out
@ -233,7 +233,7 @@ list all swaps in the local database
\fB--start_time_ns\fP="": Unix timestamp in nanoseconds to select swaps initiated after this time (default: 0) \fB--start_time_ns\fP="": Unix timestamp in nanoseconds to select swaps initiated after this time (default: 0)
.SH swapinfo .SH swapinfo
show the status of a swap show the status of a traditional swap
.PP .PP
\fB--help, -h\fP: show help \fB--help, -h\fP: show help

8
docs/loop.md
View file

@ -235,9 +235,9 @@ The following flags are supported:
### `listswaps` command ### `listswaps` command
list all swaps in the local database. list traditional Loop In and Loop Out swaps.
Allows the user to get a list of all swaps that are currently stored in the database. Lists traditional Loop In and Loop Out swaps that are currently stored in the database. Static address loop-ins are not included; use `loop static listswaps` to view them.
Usage: Usage:
@ -261,9 +261,9 @@ The following flags are supported:
### `swapinfo` command ### `swapinfo` command
show the status of a swap. show the status of a traditional swap.
Allows the user to get the status of a single swap currently stored in the database. Shows the status of a traditional Loop In or Loop Out swap currently stored in the database. Static address loop-ins must be viewed with `loop static listswaps`; there is no generic per-swap static lookup command.
Usage: Usage: