From 95b16524185d7edd155258b0162d219f6c0bee32 Mon Sep 17 00:00:00 2001 From: GitHub Date: Mon, 27 Oct 2025 00:28:34 +0000 Subject: [PATCH] update documentation --- docs/loop/loop.1 | 4 ++-- docs/loop/loop.md | 44 ++++++++++++++++++++++---------------------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/loop/loop.1 b/docs/loop/loop.1 index 3971105a..26f346e5 100644 --- a/docs/loop/loop.1 +++ b/docs/loop/loop.1 @@ -503,7 +503,7 @@ Withdraw from static address deposits. \fB--all\fP: withdraws all static address deposits. .PP -\fB--amount\fP="": the number of satoshis that should be withdrawn from the selected deposits. The change is sent back to the static address (default: 0) +\fB--amt, --amount\fP="": the number of satoshis that should be withdrawn from the selected deposits. The change is sent back to the static address (default: 0) .PP \fB--dest_addr\fP="": the optional address that the withdrawn funds should be sent to, if let blank the funds will go to lnd's wallet @@ -532,7 +532,7 @@ Loop in funds from static address deposits. \fB--all\fP: loop in all static address deposits. .PP -\fB--amount\fP="": the number of satoshis that should be swapped from the selected deposits. If thereis change it is sent back to the static address. (default: 0) +\fB--amt, --amount\fP="": the number of satoshis that should be swapped from the selected deposits. If thereis change it is sent back to the static address. (default: 0) .PP \fB--fast\fP: Usage: complete the swap faster by paying a higher fee, so the change output is available sooner diff --git a/docs/loop/loop.md b/docs/loop/loop.md index 99e55843..3908eed0 100644 --- a/docs/loop/loop.md +++ b/docs/loop/loop.md @@ -585,14 +585,14 @@ $ loop [GLOBAL FLAGS] static withdraw [COMMAND FLAGS] [ARGUMENTS...] The following flags are supported: -| Name | Description | Type | Default value | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------|--------|:-------------:| -| `--utxo="…"` | specify utxos as outpoints(tx:idx) which willbe withdrawn | string | `[]` | -| `--all` | withdraws all static address deposits | bool | `false` | -| `--dest_addr="…"` | the optional address that the withdrawn funds should be sent to, if let blank the funds will go to lnd's wallet | string | -| `--sat_per_vbyte="…"` | (optional) a manual fee expressed in sat/vbyte that should be used when crafting the transaction | uint | `0` | -| `--amount="…"` | the number of satoshis that should be withdrawn from the selected deposits. The change is sent back to the static address | uint | `0` | -| `--help` (`-h`) | show help | bool | `false` | +| Name | Description | Type | Default value | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------|--------|:-------------:| +| `--utxo="…"` | specify utxos as outpoints(tx:idx) which willbe withdrawn | string | `[]` | +| `--all` | withdraws all static address deposits | bool | `false` | +| `--dest_addr="…"` | the optional address that the withdrawn funds should be sent to, if let blank the funds will go to lnd's wallet | string | +| `--sat_per_vbyte="…"` | (optional) a manual fee expressed in sat/vbyte that should be used when crafting the transaction | uint | `0` | +| `--amt="…"` (`--amount`) | the number of satoshis that should be withdrawn from the selected deposits. The change is sent back to the static address | uint | `0` | +| `--help` (`-h`) | show help | bool | `false` | ### `static summary` subcommand (aliases: `s`) @@ -626,18 +626,18 @@ $ loop [GLOBAL FLAGS] static in [COMMAND FLAGS] [amt] [--all | --utxo xxx:xx] The following flags are supported: -| Name | Description | Type | Default value | -|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|:-------------:| -| `--utxo="…"` | specify the utxos of deposits as outpoints(tx:idx) that should be looped in | string | `[]` | -| `--all` | loop in all static address deposits | bool | `false` | -| `--payment_timeout="…"` | the maximum time in seconds that the server is allowed to take for the swap payment. The client can retry the swap with adjusted parameters after the payment timed out | duration | `0s` | -| `--amount="…"` | the number of satoshis that should be swapped from the selected deposits. If thereis change it is sent back to the static address | uint | `0` | -| `--fast` | Usage: complete the swap faster by paying a higher fee, so the change output is available sooner | bool | `false` | -| `--last_hop="…"` | the pubkey of the last hop to use for this swap | string | -| `--label="…"` | an optional label for this swap,limited to 500 characters. The label may not start with our reserved prefix: [reserved] | string | -| `--route_hints="…"` | route hints that can each be individually used to assist in reaching the invoice's destination | string | `[]` | -| `--private` | generates and passes routehints. Should be used if the connected node is only reachable via private channels | bool | `false` | -| `--force` | Assumes yes during confirmation. Using this option will result in an immediate swap | bool | `false` | -| `--verbose` (`-v`) | show expanded details | bool | `false` | -| `--help` (`-h`) | show help | bool | `false` | +| Name | Description | Type | Default value | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|:-------------:| +| `--utxo="…"` | specify the utxos of deposits as outpoints(tx:idx) that should be looped in | string | `[]` | +| `--all` | loop in all static address deposits | bool | `false` | +| `--payment_timeout="…"` | the maximum time in seconds that the server is allowed to take for the swap payment. The client can retry the swap with adjusted parameters after the payment timed out | duration | `0s` | +| `--amt="…"` (`--amount`) | the number of satoshis that should be swapped from the selected deposits. If thereis change it is sent back to the static address | uint | `0` | +| `--fast` | Usage: complete the swap faster by paying a higher fee, so the change output is available sooner | bool | `false` | +| `--last_hop="…"` | the pubkey of the last hop to use for this swap | string | +| `--label="…"` | an optional label for this swap,limited to 500 characters. The label may not start with our reserved prefix: [reserved] | string | +| `--route_hints="…"` | route hints that can each be individually used to assist in reaching the invoice's destination | string | `[]` | +| `--private` | generates and passes routehints. Should be used if the connected node is only reachable via private channels | bool | `false` | +| `--force` | Assumes yes during confirmation. Using this option will result in an immediate swap | bool | `false` | +| `--verbose` (`-v`) | show expanded details | bool | `false` | +| `--help` (`-h`) | show help | bool | `false` |