Merge pull request #295 from carlaKC/205-autoout

liquidity: add budget-limited autoloop

Author: carlaKC

cmd/loop/liquidity.go

@@ -224,6 +224,30 @@ var setParamsCommand = cli.Command{
 				"previously had a failed swap will be " +
 				"included in suggestions.",
 		},
+		cli.BoolFlag{
+			Name: "autoout",
+			Usage: "set to true to enable automated dispatch " +
+				"of loop out swaps, limited to the budget " +
+				"set by autobudget",
+		},
+		cli.Uint64Flag{
+			Name: "autobudget",
+			Usage: "the maximum amount of fees in satoshis that " +
+				"automatically dispatched loop out swaps may " +
+				"spend",
+		},
+		cli.Uint64Flag{
+			Name: "budgetstart",
+			Usage: "the start time for the automated loop " +
+				"out budget, expressed as a unix timestamp " +
+				"in seconds",
+		},
+		cli.Uint64Flag{
+			Name: "autoinflight",
+			Usage: "the maximum number of automatically " +
+				"dispatched swaps that we allow to be in " +
+				"flight",
+		},
 	},
 	Action: setParams,
 }
@@ -304,6 +328,26 @@ func setParams(ctx *cli.Context) error {
 		flagSet = true
 	}
 
+	if ctx.IsSet("autoout") {
+		params.AutoLoopOut = ctx.Bool("autoout")
+		flagSet = true
+	}
+
+	if ctx.IsSet("autobudget") {
+		params.AutoOutBudgetSat = ctx.Uint64("autobudget")
+		flagSet = true
+	}
+
+	if ctx.IsSet("budgetstart") {
+		params.AutoOutBudgetStartSec = ctx.Uint64("budgetstart")
+		flagSet = true
+	}
+
+	if ctx.IsSet("autoinflight") {
+		params.AutoMaxInFlight = ctx.Uint64("autoinflight")
+		flagSet = true
+	}
+
 	if !flagSet {
 		return fmt.Errorf("at least one flag required to set params")
 	}

go.mod

@@ -16,6 +16,7 @@ require (
 	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/lightningnetwork/lnd/ticker v1.0.0
 	github.com/stretchr/testify v1.5.1
 	github.com/urfave/cli v1.20.0
 	golang.org/x/net v0.0.0-20191002035440-2ec189313ef0

go.sum

@@ -1,10 +1,14 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
+git.schwanenlied.me/yawning/bsaes.git v0.0.0-20180720073208-c0276d75487e h1:F2x1bq7RaNCIuqYpswggh1+c1JmwdnkHNC9wy1KDip0=
 git.schwanenlied.me/yawning/bsaes.git v0.0.0-20180720073208-c0276d75487e/go.mod h1:BWqTsj8PgcPriQJGl7el20J/7TuT1d/hSyFDXMEpoEo=
 github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/NebulousLabs/fastrand v0.0.0-20181203155948-6fb6489aac4e h1:n+DcnTNkQnHlwpsrHoQtkrJIO7CBx029fw6oR4vIob4=
 github.com/NebulousLabs/fastrand v0.0.0-20181203155948-6fb6489aac4e/go.mod h1:Bdzq+51GR4/0DIhaICZEOm+OHvXGwwB2trKZ8B4Y6eQ=
+github.com/NebulousLabs/go-upnp v0.0.0-20180202185039-29b680b06c82 h1:MG93+PZYs9PyEsj/n5/haQu2gK0h4tUtSy9ejtMwWa0=
 github.com/NebulousLabs/go-upnp v0.0.0-20180202185039-29b680b06c82/go.mod h1:GbuBk21JqF+driLX3XtJYNZjGa45YDoa9IqCTzNSfEc=
 github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU=
+github.com/Yawning/aez v0.0.0-20180114000226-4dad034d9db2 h1:2be4ykKKov3M1yISM2E8gnGXZ/N2SsPawfnGiXxaYEU=
 github.com/Yawning/aez v0.0.0-20180114000226-4dad034d9db2/go.mod h1:9pIqrY6SXNL8vjRQE5Hd/OL5GyK/9MrGUWs87z/eFfk=
 github.com/aead/chacha20 v0.0.0-20180709150244-8b13a72661da h1:KjTM2ks9d14ZYCvmHS9iAKVt9AyzRSqNU1qabPih5BY=
 github.com/aead/chacha20 v0.0.0-20180709150244-8b13a72661da/go.mod h1:eHEWzANqSiWQsof+nXEI9bUVUyV6F53Fp89EuCh2EAA=
@@ -131,7 +135,9 @@ github.com/grpc-ecosystem/grpc-gateway v1.14.3 h1:OCJlWkOUoTnl0neNGlf4fUm3TmbEtg
 github.com/grpc-ecosystem/grpc-gateway v1.14.3/go.mod h1:6CwZWGDSPRJidgKAtJVvND6soZe6fT7iteq8wDPdhb0=
 github.com/hpcloud/tail v1.0.0 h1:nfCOvKYfkgYP8hkirhJocXT2+zOD8yUNjXaWfTlyFKI=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
+github.com/jackpal/gateway v1.0.5 h1:qzXWUJfuMdlLMtt0a3Dgt+xkWQiA5itDEITVJtuSwMc=
 github.com/jackpal/gateway v1.0.5/go.mod h1:lTpwd4ACLXmpyiCTRtfiNyVnUmqT9RivzCDQetPfnjA=
+github.com/jackpal/go-nat-pmp v0.0.0-20170405195558-28a68d0c24ad h1:heFfj7z0pGsNCekUlsFhO2jstxO4b5iQ665LjwM5mDc=
 github.com/jackpal/go-nat-pmp v0.0.0-20170405195558-28a68d0c24ad/go.mod h1:QPH045xvCAeXUZOxsnwmrtiCoxIr9eob+4orBN1SBKc=
 github.com/jedib0t/go-pretty v4.3.0+incompatible/go.mod h1:XemHduiw8R651AF9Pt4FwCTKeG3oo7hrHJAoznj9nag=
 github.com/jessevdk/go-flags v0.0.0-20141203071132-1679536dcc89/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
@@ -253,6 +259,7 @@ github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5
 github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5 h1:LnC5Kc/wtumK+WB441p7ynQJzVuNRJiqddSIE3IlSEQ=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
+github.com/tv42/zbase32 v0.0.0-20160707012821-501572607d02 h1:tcJ6OjwOMvExLlzrAVZute09ocAGa7KqOON60++Gz4E=
 github.com/tv42/zbase32 v0.0.0-20160707012821-501572607d02/go.mod h1:tHlrkM198S068ZqfrO6S8HsoJq2bF3ETfTL+kt4tInY=
 github.com/urfave/cli v1.18.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
 github.com/urfave/cli v1.20.0 h1:fDqGv3UG/4jbVl/QkFwEdddtEDjh/5Ov6X+0B/3bPaw=

labels/labels.go

@@ -2,6 +2,8 @@ package labels
 
 import (
 	"errors"
+	"fmt"
+	"strings"
 )
 
 const (
@@ -11,6 +13,10 @@ const (
 	// Reserved is used as a prefix to separate labels that are created by
 	// loopd from those created by users.
 	Reserved = "[reserved]"
+
+	// autoOut is the label used for loop out swaps that are automatically
+	// dispatched.
+	autoOut = "autoloop-out"
 )
 
 var (
@@ -22,23 +28,23 @@ var (
 	ErrReservedPrefix = errors.New("label contains reserved prefix")
 )
 
+// AutoOutLabel returns a label with the reserved prefix that identifies
+// automatically dispatched loop outs.
+func AutoOutLabel() string {
+	return fmt.Sprintf("%v: %v", Reserved, autoOut)
+}
+
 // Validate checks that a label is of appropriate length and is not in our list
 // of reserved labels.
 func Validate(label string) error {
 	if len(label) > MaxLength {
 		return ErrLabelTooLong
 	}
 
-	// If the label is shorter than our reserved prefix, it cannot contain
-	// it.
-	if len(label) < len(Reserved) {
-		return nil
-	}
-
 	// Check if our label begins with our reserved prefix. We don't mind if
 	// it has our reserved prefix in another case, we just need to be able
 	// to reserve a subset of labels with this prefix.
-	if label[0:len(Reserved)] == Reserved {
+	if strings.HasPrefix(label, Reserved) {
 		return ErrReservedPrefix
 	}