loop: rename autoloop specific parameters

Author: carlaKC

cmd/loop/liquidity.go

@@ -225,10 +225,10 @@ var setParamsCommand = cli.Command{
 				"included in suggestions.",
 		},
 		cli.BoolFlag{
-			Name: "autoout",
+			Name: "autoloop",
 			Usage: "set to true to enable automated dispatch " +
-				"of loop out swaps, limited to the budget " +
-				"set by autobudget",
+				"of swaps, limited to the budget set by " +
+				"autobudget",
 		},
 		cli.Uint64Flag{
 			Name: "autobudget",
@@ -338,18 +338,18 @@ func setParams(ctx *cli.Context) error {
 		flagSet = true
 	}
 
-	if ctx.IsSet("autoout") {
-		params.AutoLoopOut = ctx.Bool("autoout")
+	if ctx.IsSet("autoloop") {
+		params.Autoloop = ctx.Bool("autoloop")
 		flagSet = true
 	}
 
 	if ctx.IsSet("autobudget") {
-		params.AutoOutBudgetSat = ctx.Uint64("autobudget")
+		params.AutoloopBudgetSat = ctx.Uint64("autobudget")
 		flagSet = true
 	}
 
 	if ctx.IsSet("budgetstart") {
-		params.AutoOutBudgetStartSec = ctx.Uint64("budgetstart")
+		params.AutoloopBudgetStartSec = ctx.Uint64("budgetstart")
 		flagSet = true
 	}
 

docs/autoloop.md

@@ -6,7 +6,7 @@ budget of your choosing.
 The autoloop functionality is disabled by default, and can be enabled using the 
 following command:
 ```
-loop setparams --autoout=true
+loop setparams --autoloop=true
 ```
 
 Swaps that are dispatched by the autolooper can be identified in the output of 

loopd/swapclient_server.go

@@ -581,8 +581,8 @@ func (s *swapClientServer) GetLiquidityParams(_ context.Context,
 		SweepFeeRateSatPerVbyte: uint64(satPerByte),
 		SweepConfTarget:         cfg.SweepConfTarget,
 		FailureBackoffSec:       uint64(cfg.FailureBackOff.Seconds()),
-		AutoLoopOut:             cfg.Autoloop,
-		AutoOutBudgetSat:        uint64(cfg.AutoFeeBudget),
+		Autoloop:                cfg.Autoloop,
+		AutoloopBudgetSat:       uint64(cfg.AutoFeeBudget),
 		AutoMaxInFlight:         uint64(cfg.MaxAutoInFlight),
 		Rules: make(
 			[]*looprpc.LiquidityRule, 0, len(cfg.ChannelRules),
@@ -594,7 +594,7 @@ func (s *swapClientServer) GetLiquidityParams(_ context.Context,
 	// Zero golang time is different to a zero unix time, so we only set
 	// our start date if it is non-zero.
 	if !cfg.AutoFeeStartDate.IsZero() {
-		rpcCfg.AutoOutBudgetStartSec = uint64(
+		rpcCfg.AutoloopBudgetStartSec = uint64(
 			cfg.AutoFeeStartDate.Unix(),
 		)
 	}
@@ -633,8 +633,8 @@ func (s *swapClientServer) SetLiquidityParams(ctx context.Context,
 		SweepConfTarget:            in.Parameters.SweepConfTarget,
 		FailureBackOff: time.Duration(in.Parameters.FailureBackoffSec) *
 			time.Second,
-		Autoloop:        in.Parameters.AutoLoopOut,
-		AutoFeeBudget:   btcutil.Amount(in.Parameters.AutoOutBudgetSat),
+		Autoloop:        in.Parameters.Autoloop,
+		AutoFeeBudget:   btcutil.Amount(in.Parameters.AutoloopBudgetSat),
 		MaxAutoInFlight: int(in.Parameters.AutoMaxInFlight),
 		ChannelRules: make(
 			map[lnwire.ShortChannelID]*liquidity.ThresholdRule,
@@ -647,9 +647,9 @@ func (s *swapClientServer) SetLiquidityParams(ctx context.Context,
 	}
 
 	// Zero unix time is different to zero golang time.
-	if in.Parameters.AutoOutBudgetStartSec != 0 {
+	if in.Parameters.AutoloopBudgetStartSec != 0 {
 		params.AutoFeeStartDate = time.Unix(
-			int64(in.Parameters.AutoOutBudgetStartSec), 0,
+			int64(in.Parameters.AutoloopBudgetStartSec), 0,
 		)
 	}
 

looprpc/client.pb.go

@@ -783,25 +783,25 @@ message LiquidityParameters {
     uint64 failure_backoff_sec = 9;
 
     /*
-    Set to true to enable automatic dispatch of loop out swaps. All swaps will
-    be limited to the fee categories set by these parameters, and total
-    expenditure will be limited to the auto out budget.
+    Set to true to enable automatic dispatch of swaps. All swaps will be limited 
+    to the fee categories set by these parameters, and total expenditure will 
+    be limited to the autoloop budget.
     */
-    bool auto_loop_out = 10;
+    bool autoloop = 10;
 
     /*
     The total budget for automatically dispatched swaps since the budget start
     time, expressed in satoshis.
     */
-    uint64 auto_out_budget_sat = 11;
+    uint64 autoloop_budget_sat = 11;
 
     /*
-    The start time for auto-out budget, expressed as a unix timestamp in
+    The start time for autoloop budget, expressed as a unix timestamp in
     seconds. If this value is 0, the budget will be applied for all
     automatically dispatched swaps. Swaps that were completed before this date
     will not be included in budget calculations.
     */
-    uint64 auto_out_budget_start_sec = 12;
+    uint64 autoloop_budget_start_sec = 12;
 
     /*
     The maximum number of automatically dispatched swaps that we allow to be in

looprpc/client.proto

@@ -494,20 +494,20 @@
           "format": "uint64",
           "description": "The amount of time we require pass since a channel was part of a failed\nswap due to off chain payment failure until it will be considered for swap\nsuggestions again, expressed in seconds."
         },
-        "auto_loop_out": {
+        "autoloop": {
           "type": "boolean",
           "format": "boolean",
-          "description": "Set to true to enable automatic dispatch of loop out swaps. All swaps will\nbe limited to the fee categories set by these parameters, and total\nexpenditure will be limited to the auto out budget."
+          "description": "Set to true to enable automatic dispatch of swaps. All swaps will be limited \nto the fee categories set by these parameters, and total expenditure will \nbe limited to the autoloop budget."
         },
-        "auto_out_budget_sat": {
+        "autoloop_budget_sat": {
           "type": "string",
           "format": "uint64",
           "description": "The total budget for automatically dispatched swaps since the budget start\ntime, expressed in satoshis."
         },
-        "auto_out_budget_start_sec": {
+        "autoloop_budget_start_sec": {
           "type": "string",
           "format": "uint64",
-          "description": "The start time for auto-out budget, expressed as a unix timestamp in\nseconds. If this value is 0, the budget will be applied for all\nautomatically dispatched swaps. Swaps that were completed before this date\nwill not be included in budget calculations."
+          "description": "The start time for autoloop budget, expressed as a unix timestamp in\nseconds. If this value is 0, the budget will be applied for all\nautomatically dispatched swaps. Swaps that were completed before this date\nwill not be included in budget calculations."
         },
         "auto_max_in_flight": {
           "type": "string",

looprpc/client.swagger.json

@@ -20,5 +20,10 @@ This file tracks release notes for the loop client.
   unlocked. Previous versions would exit with an error. 
 
 #### Breaking Changes
+* The `AutoOut`, `AutoOutBudgetSat` and `AutoOutBudgetStartSec` fields in the
+  `LiquidityParameters` message used in the experimental autoloop API have 
+  been renamed to `Autoloop`, `AutoloopBudgetSat` and `AutoloopBudgetStartSec`. 
+* The `autoout` flag for enabling automatic dispatch of loop out swaps has been
+  renamed to `autoloop` so that it can cover loop out and loop in.
 
 #### Bug Fixes