Merge pull request #623 from Liongrass/master

Correct loop setrule command and styling in Autoloop guide

Author: hieblmi

docs/autoloop.md

@@ -1,9 +1,9 @@
 # Autoloop
-The loop client contains functionality to dispatch loop out swaps automatically,
+The Loop client contains functionality to dispatch Loop Out swaps automatically,
 according to a set of rules configured for your node's channels, within a 
 budget of your choosing. 
 
-The autoloop functionality is disabled by default, and can be enabled using the 
+The Autoloop functionality is disabled by default, and can be enabled using the 
 following command:
 ```
 loop setparams --autoloop=true
@@ -12,43 +12,43 @@ loop setparams --autoloop=true
 ## Easy Autoloop
 
 If you don't want to bother with setting up specific rules for each of your
-channels and peers you can use easy autoloop. This mode of autoloop requires
+channels and peers you can use easy Autoloop. This mode of Autoloop requires
 for you to set only the overall channel balance that you don't wish to exceed
-on your lightning node. For example, if you want to keep your node's total
+on your Lightning node. For example, if you want to keep your node's total
 channel balance below 1 million satoshis you can set the following
 ```
 loop setparams --autoloop=true --easyautoloop=true --localbalancesat=1000000
 ```
 
-This will automatically start dispatching loop-outs whenever you exceed total
+This will automatically start dispatching Loop Outs whenever you exceed a total
 channel balance of 1M sats. Keep in mind that on first time use this will use
 the default budget parameters. If you wish to configure a custom budget you can
-find more info in the [Budget](#budget) section.
+find more information in the [Budget](#budget) section.
 
 In addition, if you want to control the maximum amount of fees you're willing to
 spend per swap, as a percentage of the total swap amount, you can use the
 `feepercent` parameter as explained in the [Fees](#fees) section.
 
 ## Liquidity Rules
 
-At present, autoloop can be configured to either acquire incoming liquidity 
-using loop out, or acquire outgoing liquidity using loop in. It cannot support
+At present, Autoloop can be configured to either acquire incoming liquidity 
+using Loop Out, or acquire outgoing liquidity using Loop In. It cannot support
 automated swaps in both directions. To set the type of swaps you would like 
 to automatically dispatch, use:
 ```
-loop setparams --type={in|out}
+loop setrule --type={in|out}
 ```
 
-Autoloop will perform loop out swaps *by default*.
+Autoloop will perform Loop Out swaps *by default*.
 
-Swaps that are dispatched by the autolooper can be identified in the output of 
+Swaps that are dispatched by Autoloop can be identified in the output of 
 `ListSwaps` by their label field, which will contain: `[reserved]: autoloop-out`.
 
-Even if you do not choose to enable the autolooper, we encourage you to 
+Even if you do not choose to enable Autoloop, we encourage you to 
 experiment with setting the parameters described in this document because the 
 client will log the actions that it would have taken to provide visibility into 
 its functionality. Alternatively, the `SuggestSwaps` rpc (`loop suggestswaps` 
-on the CLI) provides a set of swaps that the autolooper currently recommends, 
+on the CLI) provides a set of swaps that Autoloop currently recommends, 
 which you can use to manually execute swaps if you'd like.
 
 Note that autoloop parameters and rules are not persisted, so must be set on 
@@ -64,7 +64,7 @@ set a liquidity rule for a peer, you cannot also set a specific rule for one of
 its channels.
 
 ### Liquidity Thresholds 
-To setup the autolooper to dispatch swaps on your behalf, you need to set the 
+To setup Autoloop to dispatch swaps on your behalf, you need to set the 
 liquidity balance you would like for each channel or peer. Desired liquidity 
 balance is expressed using threshold incoming and outgoing percentages of 
 capacity. The incoming threshold you specify indicates the minimum percentage 
@@ -73,7 +73,7 @@ threshold allows you to reserve a percentage of your balance for outgoing
 capacity, but may be set to zero if you are only concerned with incoming 
 capacity.
 
-The autolooper will perform swaps that push your incoming capacity to at least 
+Autoloop will perform swaps that push your incoming capacity to at least 
 the incoming threshold you specify, while reserving at least the outgoing 
 capacity threshold. Rules can be set as follows:
 
@@ -93,14 +93,14 @@ to a percentage of the swap amount using the fee percentage parameter:
 loop setparams --feepercent={percentage of swap amount}
 ```
 
-If you are not using easyautoloop and you would like finer grained control over
-swap fees, there are multiple fee related settings which can be used to tune the
-autolooper to your preference. The sections that follow explain these settings
+If you are not using Easy Autoloop and you would like finer grained control over
+swap fees, there are multiple fee related settings which can be used to tune
+Autoloop to your preference. The sections that follow explain these settings
 in detail. Note that these fees are expressed on a per-swap basis, rather than
 as an overall budget. 
 
 ### On-Chain Fees
-When performing a successful loop out swap, the loop client needs to sweep the 
+When performing a successful Loop Out swap, the Loop client needs to sweep the 
 on-chain HTLC sent by the server back into its own wallet. 
 
 #### Sweep Confirmation Target
@@ -116,11 +116,11 @@ loop setparams --sweepconf={target in blocks}
 
 #### Fee Market Awareness
 The mempool often clears overnight, or on the weekends when fewer people are 
-using chain space. This is an opportune time for the autolooper to dispatch a 
-swap on your behalf while you sleep! Before dispatching a swap, the autolooper 
+using chain space. This is an opportune time for Autoloop to dispatch a 
+swap on your behalf while you sleep! Before dispatching a swap, Autoloop 
 will get a fee estimate for your on-chain sweep transaction (using its 
 `sweepconftarget`), and check it against the limit that has been configured. 
-The `sweeplimit` parameter can be set to configure the autolooper to only 
+The `sweeplimit` parameter can be set to configure Autoloop to only 
 dispatch in low-fee environments.
 
 ```
@@ -130,7 +130,7 @@ loop setparams --sweeplimit={limit in sat/vbyte}
 
 #### Miner Fee
 In the event where fees spike dramatically right after a swap is dispatched, 
-it may not be worthwhile to proceed with the swap. The loop client always uses 
+it may not be worthwhile to proceed with the swap. The Loop client always uses 
 the latest fee estimation to sweep your swap within the desired target, but to 
 account for this edge case where fees dramatically spike for an extended period 
 of time, a maximum miner fee can be set to cap the amount that will be paid for 
@@ -141,7 +141,7 @@ loop setparams --maxminer={limit in satoshis}
 
 ### Server Fees
 #### Swap Fee
-The server charges a fee for facilitating swaps. The autolooper can be limited 
+The server charges a fee for facilitating swaps. Autoloop can be limited 
 to a set swap fee, expressed as a percentage of the total swap amount, using 
 the following command:
 ```
@@ -154,13 +154,13 @@ costs. This value will only be charged if your client goes offline for a long
 period of time after the server has published an on-chain HTLC and never 
 completes the swap, or if it decides to abort the swap due to high on-chain 
 fees. Both of these cases are unlikely, but this value can still be capped in 
-the autolooper. 
+Autoloop. 
 ```
 loop setparams --maxprepay={limit in satoshis}
 ```
 
 ### Off-Chain Fees
-The loop client dispatches two off-chain payments to the loop server - one for 
+The Loop client dispatches two off-chain payments to the Loop server - one for 
 the swap prepayment, and one for the swap itself. The amount that the client 
 will pay in off-chain fees for each of these payments can be limited to a 
 percentage of the payment amount using the following commands:
@@ -176,7 +176,7 @@ Swap routing fees:
  ```
 
 ## Budget
-The autolooper operates within a set budget, and will stop executing swaps when 
+Autoloop operates within a set budget, and will stop executing swaps when 
 this budget is reached. This budget includes the fees paid to the swap server, 
 on-chain sweep costs and off-chain routing fees. Note that the budget does not 
 include the actual swap amount, as this balance is simply shifted from off-chain 
@@ -188,33 +188,33 @@ loop command:
 loop setparams --autobudget={budget in satoshis}
 ```
 
-Your autoloop budget is refreshed based on a configurable interval. You can
+Your Autoloop budget is refreshed based on a configurable interval. You can
 specify how often the budget is going to refresh by using the `setparams` loop
 command:
 ```
 loop setparams --autobudgetrefreshperiod={duration}
 ```
 
 
-If your autolooper has used up its budget, and you would like to top it up, you 
+If Autoloop has used up its budget, and you would like to top it up, you 
 can do so by either increasing the overall budget amount, or by decreasing the 
-refresh interval. For example, if you want to set your autolooper to 
+refresh interval. For example, if you want to set Autoloop to 
 have a budget of 100k sats every 168 hours, you could set the following:
 ```
 loop setparams --autobudget=100000 --autobudgetrefreshperiod=168h
 ```
 
 ## Dispatch Control
 Configuration options are also exposed to allow you to control the rate at 
-which swaps are automatically dispatched, and the autolooper's propensity to 
+which swaps are automatically dispatched, and Autoloop's propensity to 
 retry channels that have previously failed. 
 
-### In Flight Limit
-The number of swaps that the autolooper will dispatch at a time is controlled 
+### In-flight Limit
+The number of swaps that Autoloop will dispatch at a time is controlled 
 by the `autoinflight` parameter. The default value for this parameter is 1, and 
 can be increased if you would like to perform more automated swaps simultaneously. 
 If you have set a very high sweep target for your automatically dispatched swaps, 
-you may want to increase this value, because the autolooper will wait for the 
+you may want to increase this value, because Autoloop will wait for the 
 swap to fully complete, including the sweep confirming, before it dispatches 
 another swap. 
 
@@ -223,25 +223,25 @@ loop setparams --autoinflight=2
 ```
 
 ### Failure Backoff
-Sometimes loop out swaps fail because they cannot find an off-chain route to the 
+Sometimes Loop Out swaps fail because they cannot find an off-chain route to the 
 server. This may happen because there is a temporary lack of liquidity along the 
 route, or because the peer that you need to perform a swap with simply does not 
-have a route to the loop server's node. These swap attempts cost you nothing, 
-but we set a backoff period so that the autolooper will not continuously attempt 
+have a route to the Loop server's node. These swap attempts cost you nothing, 
+but we set a backoff period so that Autoloop will not continuously attempt 
 to perform swaps through a very unbalanced channel that cannot facilitate a swap. 
 
-The default value for this parameter is 24hours, and it can be updated as follows:
+The default value for this parameter is 24 hours, and it can be updated as follows:
 ```
 loop setparams --failurebackoff={backoff in seconds}
 ```
 
 ### Swap Size
-By default, the autolooper will execute a swap when the amount that needs to be
+By default, Autoloop will execute a swap when the amount that needs to be
 rebalanced within a channel is equal to the swap server's minimum swap size. 
 This means that it will dispatch swaps more regularly, and ensure that channels 
 are not run down too far below their configured threshold. If you are willing 
 to allow your liquidity to drop further than the minimum swap amount below your 
-threshold, a custom minimum swap size can be set. If autolooper is configured 
+threshold, a custom minimum swap size can be set. If Autoloop is configured 
 with a larger minimum swap size, it will allow channels to drop further below
 their target threshold, but will perform fewer swaps, potentially saving on 
 fees.
@@ -251,26 +251,26 @@ loop setparams --minamt={amount in satoshis}
 ```
 
 Swaps are also limited to the maximum swap amount advertised by the server. If
-you would like to reduce the size of swap that autoloop created, this value can 
+you would like to reduce the size of swap that Autoloop created, this value can 
 also be configured. 
 
 ```
 loop setparams --maxamt={amount in satoshis}
 ```
 
-The server's current terms are provided by the `loop terms` cli command. The 
+The server's current terms are provided by the `loop terms` CLI command. The 
 values set for minimum and maximum swap amount must be within the range that
 the server supports. 
 
 ## Manual Swap Interaction
-The autolooper will not dispatch swaps over channels that are already included 
-in manually dispatched swaps - for loop out, this would mean the channel is 
+Autoloop will not dispatch swaps over channels that are already included 
+in manually dispatched swaps - for Loop Out, this would mean the channel is 
 specified in the outgoing channel swap, and for loop in the channel's peer is 
 specified as the last hop for an ongoing swap. This check is put in place to 
-prevent the autolooper from interfering with swaps you have created yourself. 
+prevent Autoloop from interfering with swaps you have created yourself. 
 
 ## Disqualified Swaps
-There are various restrictions placed on the client's autoloop functionality.
+There are various restrictions placed on the client's Autoloop functionality.
 If a channel is not eligible for a swap at present, or it does not need one
 based on the current set of liquidity rules, it will be listed in the 
 `Disqualified` section of the output of the `SuggestSwaps` API. One of the 
@@ -279,35 +279,35 @@ following reasons will be displayed:
 * Budget not started: if the start date for your budget is in the future,
   no swaps will be executed until the start date is reached. See [budget](#budget) to
   update.
-* Budget elapsed: if the autolooper has elapsed the budget assigned to it for 
+* Budget elapsed: if Autoloop has elapsed the budget assigned to it for 
   fees, this reason will be returned. See [budget](#budget) to update.
 * Sweep fees: this reason will be displayed if the estimated chain fee rate for
   sweeping a loop out swap is higher than the current limit. See [sweep fees](#fee-market-awareness) 
   to update.
-* In flight: there is a limit to the number of automatically dispatched swaps
+* In-flight: there is a limit to the number of automatically dispatched swaps
   that the client allows. If this limit has been reached, no further swaps
   will be automatically dispatched until the in-flight swaps complete. See 
-  [in flight limit](#in-flight-limit) to update.
+  [in-flight limit](#in-flight-limit) to update.
 * Budget insufficient: if there is not enough remaining budget for a swap, 
-  including the amount currently reserved for in flight swaps, an insufficient
+  including the amount currently reserved for in-flight swaps, an insufficient
   reason will be displayed. This differs from budget elapsed because there is
   still budget remaining, just not enough to execute a specific swap.
 * Swap fee: there is a limit placed on the fee that the client will pay to the
   server for automatically dispatched swaps. The swap fee reason will be shown 
   if the fees advertised by the server are too high. See [swap fee](#swap-fee)
   to update.
-* Miner fee: if the estimated on-chain fees for a swap are too high, autoloop
+* Miner fee: if the estimated on-chain fees for a swap are too high, Autoloop
   will display a miner fee reason. See [miner fee](#miner-fee) to update. 
 * Prepay: if the no-show fee that the server will pay in the unlikely event 
   that the client fails to complete a swap is too high, a prepay reason will
   be returned. See [no show fees](#no-show-fee) to update. 
 * Backoff: if an automatically dispatched swap has recently failed for a channel,
-  autoloop will backoff for a period before retrying. See [failure backoff](#failure-backoff) 
+  Autoloop will backoff for a period before retrying. See [failure backoff](#failure-backoff) 
   to update. 
-* Loop out: if there is currently a loop out swap in-flight on a channel, it 
+* Loop Out: if there is currently a Loop Out swap in-flight on a channel, it 
   will not be used for automated swaps. This issue will resolve itself once the 
   in-flight swap completes.
-* Loop in: if there is currently a loop in swap in-flight for a peer, it will 
+* Loop In: if there is currently a Loop In swap in-flight for a peer, it will 
   not be used for automated swaps. This will resolve itself once the swap is 
   completed.
 * Liquidity ok: if a channel's current liquidity balance is within the bound set
@@ -316,7 +316,7 @@ following reasons will be displayed:
 * Fee insufficient: if the fees that a swap will cost are more than the
   percentage of total swap amount that we allow, this reason will be displayed.
   See [fees](#fees) to update this value.
-* Loop in unreachable: if the client node is unreachable by the server 
+* Loop In unreachable: if the client node is unreachable by the server 
   off-chain, this reason will be displayed. Try improving the connectivity of
   your node so that it is reachable by the loop server.