From d5fb8b8da8f3972b1d2601f03719f0b0ed902b96 Mon Sep 17 00:00:00 2001 From: Gustavo Stingelin Date: Tue, 14 Jul 2026 10:17:51 -0300 Subject: [PATCH] cmd/loop: clarify traditional swap command scope --- cmd/loop/swaps.go | 15 +++++++++------ docs/loop.1 | 4 ++-- docs/loop.md | 8 ++++---- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/cmd/loop/swaps.go b/cmd/loop/swaps.go index 9323f6ce..419522b6 100644 --- a/cmd/loop/swaps.go +++ b/cmd/loop/swaps.go @@ -15,9 +15,10 @@ import ( var listSwapsCommand = &cli.Command{ Name: "listswaps", - Usage: "list all swaps in the local database", - Description: "Allows the user to get a list of all swaps that are " + - "currently stored in the database", + Usage: "list traditional Loop In and Loop Out swaps", + Description: "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.", Action: listSwaps, Flags: []cli.Flag{ &cli.BoolFlag{ @@ -128,10 +129,12 @@ func listSwaps(ctx context.Context, cmd *cli.Command) error { var swapInfoCommand = &cli.Command{ Name: "swapinfo", - Usage: "show the status of a swap", + Usage: "show the status of a traditional swap", ArgsUsage: "id", - Description: "Allows the user to get the status of a single swap " + - "currently stored in the database", + Description: "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.", Flags: []cli.Flag{ &cli.Uint64Flag{ Name: "id", diff --git a/docs/loop.1 b/docs/loop.1 index b100a83b..1e21905b 100644 --- a/docs/loop.1 +++ b/docs/loop.1 @@ -203,7 +203,7 @@ fetches a new L402 authentication token from the server \fB--help, -h\fP: show help .SH listswaps -list all swaps in the local database +list traditional Loop In and Loop Out swaps .PP \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) .SH swapinfo -show the status of a swap +show the status of a traditional swap .PP \fB--help, -h\fP: show help diff --git a/docs/loop.md b/docs/loop.md index 688d3776..316cebdc 100644 --- a/docs/loop.md +++ b/docs/loop.md @@ -235,9 +235,9 @@ The following flags are supported: ### `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: @@ -261,9 +261,9 @@ The following flags are supported: ### `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: