Merge pull request #289 from carlaKC/205-restrictsuggestions

suggestions: add fee and ongoing swap restrictions

Author: carlaKC

cmd/loop/liquidity.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strconv"
 
+	"github.com/lightninglabs/loop/liquidity"
 	"github.com/lightninglabs/loop/looprpc"
 	"github.com/urfave/cli"
 )
@@ -36,8 +37,8 @@ func getParams(ctx *cli.Context) error {
 	return nil
 }
 
-var setLiquidityParamCommand = cli.Command{
-	Name:        "setparam",
+var setLiquidityRuleCommand = cli.Command{
+	Name:        "setrule",
 	Usage:       "set liquidity manager rule for a channel",
 	Description: "Update or remove the liquidity rule for a channel.",
 	ArgsUsage:   "shortchanid",
@@ -58,10 +59,10 @@ var setLiquidityParamCommand = cli.Command{
 			Usage: "remove the rule currently set for the channel.",
 		},
 	},
-	Action: setParam,
+	Action: setRule,
 }
 
-func setParam(ctx *cli.Context) error {
+func setRule(ctx *cli.Context) error {
 	// We require that a channel ID is set for this rule update.
 	if ctx.NArg() != 1 {
 		return fmt.Errorf("please set a channel id for the rule " +
@@ -122,12 +123,11 @@ func setParam(ctx *cli.Context) error {
 				"flag")
 		}
 
+		params.Rules = otherRules
 		_, err = client.SetLiquidityParams(
 			context.Background(),
 			&looprpc.SetLiquidityParamsRequest{
-				Parameters: &looprpc.LiquidityParameters{
-					Rules: otherRules,
-				},
+				Parameters: params,
 			},
 		)
 		return err
@@ -158,19 +158,176 @@ func setParam(ctx *cli.Context) error {
 		)
 	}
 
+	// Just set the rules on our current set of parameters and leave the
+	// other values untouched.
+	otherRules = append(otherRules, newRule)
+	params.Rules = otherRules
+
 	// Update our parameters to the existing set, plus our new rule.
 	_, err = client.SetLiquidityParams(
 		context.Background(),
 		&looprpc.SetLiquidityParamsRequest{
-			Parameters: &looprpc.LiquidityParameters{
-				Rules: append(otherRules, newRule),
-			},
+			Parameters: params,
 		},
 	)
 
 	return err
 }
 
+var setParamsCommand = cli.Command{
+	Name:        "setparams",
+	Usage:       "update the parameters set for the liquidity manager",
+	Description: "Updates the parameters set for the liquidity manager.",
+	Flags: []cli.Flag{
+		cli.IntFlag{
+			Name: "sweeplimit",
+			Usage: "the limit placed on our estimated sweep fee " +
+				"in sat/vByte.",
+		},
+		cli.Float64Flag{
+			Name: "maxswapfee",
+			Usage: "the maximum percentage of swap volume we are " +
+				"willing to pay in server fees.",
+		},
+		cli.Float64Flag{
+			Name: "maxroutingfee",
+			Usage: "the maximum percentage of off-chain payment " +
+				"volume that are are willing to pay in " +
+				"routing fees.",
+		},
+		cli.Float64Flag{
+			Name: "maxprepayfee",
+			Usage: "the maximum percentage of off-chain prepay " +
+				"volume that are are willing to pay in " +
+				"routing fees.",
+		},
+		cli.Uint64Flag{
+			Name: "maxprepay",
+			Usage: "the maximum no-show (prepay) in satoshis that " +
+				"swap suggestions should be limited to.",
+		},
+		cli.Uint64Flag{
+			Name: "maxminer",
+			Usage: "the maximum miner fee in satoshis that swap " +
+				"suggestions should be limited to.",
+		},
+		cli.IntFlag{
+			Name: "sweepconf",
+			Usage: "the number of blocks from htlc height that " +
+				"swap suggestion sweeps should target, used " +
+				"to estimate max miner fee.",
+		},
+		cli.Uint64Flag{
+			Name: "failurebackoff",
+			Usage: "the amount of time, in seconds, that " +
+				"should pass before a channel that " +
+				"previously had a failed swap will be " +
+				"included in suggestions.",
+		},
+	},
+	Action: setParams,
+}
+
+func setParams(ctx *cli.Context) error {
+	client, cleanup, err := getClient(ctx)
+	if err != nil {
+		return err
+	}
+	defer cleanup()
+
+	// We need to set the full set of current parameters every time we call
+	// SetParameters. To allow users to set only individual fields on the
+	// cli, we lookup our current params, then update individual values.
+	params, err := client.GetLiquidityParams(
+		context.Background(), &looprpc.GetLiquidityParamsRequest{},
+	)
+	if err != nil {
+		return err
+	}
+
+	var flagSet bool
+
+	if ctx.IsSet("maxswapfee") {
+		feeRate := ctx.Float64("maxswapfee")
+		params.MaxSwapFeePpm, err = ppmFromPercentage(feeRate)
+		if err != nil {
+			return err
+		}
+
+		flagSet = true
+	}
+
+	if ctx.IsSet("sweeplimit") {
+		satPerVByte := ctx.Int("sweeplimit")
+		params.SweepFeeRateSatPerVbyte = uint64(satPerVByte)
+
+		flagSet = true
+	}
+
+	if ctx.IsSet("maxroutingfee") {
+		feeRate := ctx.Float64("maxroutingfee")
+		params.MaxRoutingFeePpm, err = ppmFromPercentage(feeRate)
+		if err != nil {
+			return err
+		}
+
+		flagSet = true
+	}
+
+	if ctx.IsSet("maxprepayfee") {
+		feeRate := ctx.Float64("maxprepayfee")
+		params.MaxPrepayRoutingFeePpm, err = ppmFromPercentage(feeRate)
+		if err != nil {
+			return err
+		}
+
+		flagSet = true
+	}
+
+	if ctx.IsSet("maxprepay") {
+		params.MaxPrepaySat = ctx.Uint64("maxprepay")
+		flagSet = true
+	}
+
+	if ctx.IsSet("maxminer") {
+		params.MaxMinerFeeSat = ctx.Uint64("maxminer")
+		flagSet = true
+	}
+
+	if ctx.IsSet("sweepconf") {
+		params.SweepConfTarget = int32(ctx.Int("sweepconf"))
+		flagSet = true
+	}
+
+	if ctx.IsSet("failurebackoff") {
+		params.FailureBackoffSec = ctx.Uint64("failurebackoff")
+		flagSet = true
+	}
+
+	if !flagSet {
+		return fmt.Errorf("at least one flag required to set params")
+	}
+
+	// Update our parameters to our mutated values.
+	_, err = client.SetLiquidityParams(
+		context.Background(), &looprpc.SetLiquidityParamsRequest{
+			Parameters: params,
+		},
+	)
+
+	return err
+}
+
+// ppmFromPercentage converts a percentage, expressed as a float, to parts
+// per million.
+func ppmFromPercentage(percentage float64) (uint64, error) {
+	if percentage <= 0 || percentage >= 100 {
+		return 0, fmt.Errorf("fee percentage must be in (0;100)")
+	}
+
+	return uint64(percentage / 100 * liquidity.FeeBase), nil
+}
+
 var suggestSwapCommand = cli.Command{
 	Name:  "suggestswaps",
 	Usage: "show a list of suggested swaps",

cmd/loop/main.go

@@ -129,7 +129,7 @@ func main() {
 		loopOutCommand, loopInCommand, termsCommand,
 		monitorCommand, quoteCommand, listAuthCommand,
 		listSwapsCommand, swapInfoCommand, getLiquidityParamsCommand,
-		setLiquidityParamCommand, suggestSwapCommand,
+		setLiquidityRuleCommand, suggestSwapCommand, setParamsCommand,
 	}
 
 	err := app.Run(os.Args)

go.mod

@@ -14,6 +14,7 @@ require (
 	github.com/lightninglabs/protobuf-hex-display v1.3.3-0.20191212020323-b444784ce75d
 	github.com/lightningnetwork/lnd v0.11.1-beta.rc3
 	github.com/lightningnetwork/lnd/cert v1.0.3
+	github.com/lightningnetwork/lnd/clock v1.0.1
 	github.com/lightningnetwork/lnd/queue v1.0.4
 	github.com/stretchr/testify v1.5.1
 	github.com/urfave/cli v1.20.0