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

docs: regenerate loop CLI reference

Browse source
This commit is contained in:
Boris Nagaev 2026-04-06 16:15:22 -05:00
parent 659d812634
commit ad7b92e839
No known key found for this signature in database
2 changed files with 22 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/loop.1
View file

@ -567,6 +567,12 @@ Loop in funds from static address deposits.
.PP
\fB--last_hop\fP="": the pubkey of the last hop to use for this swap
.PP
\fB--max_swap_fee_ppm\fP="": the maximum swap fee expressed in parts per million of the swap amount. If set together with --max_swap_fee_sat the tighter cap is used. (default: 0)
.PP
\fB--max_swap_fee_sat\fP="": the maximum swap fee in satoshis. If set, the swap is rejected when the quoted fee exceeds this cap. The maximum allowed value is 10000000. On-chain fees for creating static deposits are unaffected. (default: 0)
.PP
\fB--payment_timeout\fP="": 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. (default: 0s)

30
docs/loop.md
View file

@ -669,20 +669,22 @@ $ 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` |
| `--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` |
| 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` |
| `--max_swap_fee_sat="…"` | the maximum swap fee in satoshis. If set, the swap is rejected when the quoted fee exceeds this cap. The maximum allowed value is 10000000. On-chain fees for creating static deposits are unaffected | uint | `0` |
| `--max_swap_fee_ppm="…"` | the maximum swap fee expressed in parts per million of the swap amount. If set together with --max_swap_fee_sat the tighter cap is used | uint | `0` |
| `--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` |
### `static openchannel` subcommand