Skip to content

Commit 72d48e4

Browse files
hieblmihieblmi
committed
docs: update easy-exclude parameters
1 parent 981eac1 commit 72d48e4

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

‎docs/loop.md‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -328,34 +328,36 @@ $ loop [GLOBAL FLAGS] setparams [COMMAND FLAGS] [ARGUMENTS...]
328328

329329
The following flags are supported:
330330

331-
| Name | Description | Type | Default value |
332-
|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|:-------------:|
333-
| `--sweeplimit="…"` | the limit placed on our estimated sweep fee in sat/vByte | int | `0` |
334-
| `--feepercent="…"` | the maximum percentage of swap amount to be used across all fee categories | float | `0` |
335-
| `--maxswapfee="…"` | the maximum percentage of swap volume we are willing to pay in server fees | float | `0` |
336-
| `--maxroutingfee="…"` | the maximum percentage of off-chain payment volume that we are willing to pay in routingfees | float | `0` |
337-
| `--maxprepayfee="…"` | the maximum percentage of off-chain prepay volume that we are willing to pay in routing fees | float | `0` |
338-
| `--maxprepay="…"` | the maximum no-show (prepay) in satoshis that swap suggestions should be limited to | uint | `0` |
339-
| `--maxminer="…"` | the maximum miner fee in satoshis that swap suggestions should be limited to | uint | `0` |
340-
| `--sweepconf="…"` | the number of blocks from htlc height that swap suggestion sweeps should target, used to estimate max miner fee | int | `0` |
341-
| `--failurebackoff="…"` | the amount of time, in seconds, that should pass before a channel that previously had a failed swap will be included in suggestions | uint | `0` |
342-
| `--autoloop` | set to true to enable automated dispatch of swaps, limited to the budget set by autobudget | bool | `false` |
343-
| `--destaddr="…"` | custom address to be used as destination for autoloop loop out, set to "default" in order to revert to default behavior | string |
344-
| `--account="…"` | the name of the account to generate a new address from. You can list the names of valid accounts in your backing lnd instance with "lncli wallet accounts list" | string |
345-
| `--account_addr_type="…"` | the address type of the extended public key specified in account. Currently only pay-to-taproot-pubkey(p2tr) is supported | string | `p2tr` |
346-
| `--autobudget="…"` | the maximum amount of fees in satoshis that automatically dispatched loop out swaps may spend | uint | `0` |
331+
| Name | Description | Type | Default value |
332+
|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|:-------------:|
333+
| `--sweeplimit="…"` | the limit placed on our estimated sweep fee in sat/vByte | int | `0` |
334+
| `--feepercent="…"` | the maximum percentage of swap amount to be used across all fee categories | float | `0` |
335+
| `--maxswapfee="…"` | the maximum percentage of swap volume we are willing to pay in server fees | float | `0` |
336+
| `--maxroutingfee="…"` | the maximum percentage of off-chain payment volume that we are willing to pay in routingfees | float | `0` |
337+
| `--maxprepayfee="…"` | the maximum percentage of off-chain prepay volume that we are willing to pay in routing fees | float | `0` |
338+
| `--maxprepay="…"` | the maximum no-show (prepay) in satoshis that swap suggestions should be limited to | uint | `0` |
339+
| `--maxminer="…"` | the maximum miner fee in satoshis that swap suggestions should be limited to | uint | `0` |
340+
| `--sweepconf="…"` | the number of blocks from htlc height that swap suggestion sweeps should target, used to estimate max miner fee | int | `0` |
341+
| `--failurebackoff="…"` | the amount of time, in seconds, that should pass before a channel that previously had a failed swap will be included in suggestions | uint | `0` |
342+
| `--autoloop` | set to true to enable automated dispatch of swaps, limited to the budget set by autobudget | bool | `false` |
343+
| `--destaddr="…"` | custom address to be used as destination for autoloop loop out, set to "default" in order to revert to default behavior | string |
344+
| `--account="…"` | the name of the account to generate a new address from. You can list the names of valid accounts in your backing lnd instance with "lncli wallet accounts list" | string |
345+
| `--account_addr_type="…"` | the address type of the extended public key specified in account. Currently only pay-to-taproot-pubkey(p2tr) is supported | string | `p2tr` |
346+
| `--autobudget="…"` | the maximum amount of fees in satoshis that automatically dispatched loop out swaps may spend | uint | `0` |
347347
| `--autobudgetrefreshperiod="…"` | the time period over which the automated loop budget is refreshed | duration | `0s` |
348-
| `--autoinflight="…"` | the maximum number of automatically dispatched swaps that we allow to be in flight | uint | `0` |
349-
| `--minamt="…"` | the minimum amount in satoshis that the autoloop client will dispatch per-swap | uint | `0` |
350-
| `--maxamt="…"` | the maximum amount in satoshis that the autoloop client will dispatch per-swap | uint | `0` |
351-
| `--htlc_conf="…"` | the confirmation target for loop in on-chain htlcs | int | `0` |
352-
| `--easyautoloop` | set to true to enable easy autoloop, which will automatically dispatch swaps in order to meet the target local balance | bool | `false` |
353-
| `--localbalancesat="…"` | the target size of total local balance in satoshis, used by easy autoloop | uint | `0` |
354-
| `--asset_easyautoloop` | set to true to enable asset easy autoloop, which will automatically dispatch asset swaps in order to meet the target local balance | bool | `false` |
355-
| `--asset_id="…"` | If set to a valid asset ID, the easyautoloop and localbalancesat flags will be set for the specified asset | string |
356-
| `--asset_localbalance="…"` | the target size of total local balance in asset units, used by asset easy autoloop | uint | `0` |
357-
| `--fast` | if set new swaps are expected to be published immediately, paying a potentially higher fee. If not set the swap server might choose to wait up to 30 minutes before publishing swap HTLCs on-chain, to save on chain fees. Not setting this flag therefore might result in a lower swap fees | bool | `false` |
358-
| `--help` (`-h`) | show help | bool | `false` |
348+
| `--autoinflight="…"` | the maximum number of automatically dispatched swaps that we allow to be in flight | uint | `0` |
349+
| `--minamt="…"` | the minimum amount in satoshis that the autoloop client will dispatch per-swap | uint | `0` |
350+
| `--maxamt="…"` | the maximum amount in satoshis that the autoloop client will dispatch per-swap | uint | `0` |
351+
| `--htlc_conf="…"` | the confirmation target for loop in on-chain htlcs | int | `0` |
352+
| `--easyautoloop` | set to true to enable easy autoloop, which will automatically dispatch swaps in order to meet the target local balance | bool | `false` |
353+
| `--localbalancesat="…"` | the target size of total local balance in satoshis, used by easy autoloop | uint | `0` |
354+
| `--excludeeasypeer="…"` | list of peer pubkeys (hex) to exclude from easy autoloop channel selection. Repeat --excludeeasypeer for multiple peers | string | |
355+
| `--includealleasypeers="…"` | include all peers back into easy autoloop by clearing the exclusion list. It cannot be combined with --excludeeasypeer. | string | |
356+
| `--asset_easyautoloop` | set to true to enable asset easy autoloop, which will automatically dispatch asset swaps in order to meet the target local balance | bool | `false` |
357+
| `--asset_id="…"` | If set to a valid asset ID, the easyautoloop and localbalancesat flags will be set for the specified asset | string |
358+
| `--asset_localbalance="…"` | the target size of total local balance in asset units, used by asset easy autoloop | uint | `0` |
359+
| `--fast` | if set new swaps are expected to be published immediately, paying a potentially higher fee. If not set the swap server might choose to wait up to 30 minutes before publishing swap HTLCs on-chain, to save on chain fees. Not setting this flag therefore might result in a lower swap fees | bool | `false` |
360+
| `--help` (`-h`) | show help | bool | `false` |
359361

360362
### `getinfo` command
361363

0 commit comments

Comments
 (0)