Merge pull request #439 from bhandras/ignore_cheap_paths

loopout: using server recommended routing plugins + low/high router

Author: bhandras

client.go

@@ -108,6 +108,14 @@ type ClientConfig struct {
 	// for a loop out swap. When greater than one, a multi-part payment may
 	// be attempted.
 	LoopOutMaxParts uint32
+
+	// TotalPaymentTimeout is the total amount of time until we time out
+	// off-chain payments (used in loop out).
+	TotalPaymentTimeout time.Duration
+
+	// MaxPaymentRetries is the maximum times we retry an off-chain payment
+	// (used in loop out).
+	MaxPaymentRetries int
 }
 
 // NewClient returns a new instance to initiate swaps with.
@@ -142,12 +150,14 @@ func NewClient(dbDir string, cfg *ClientConfig) (*Client, func(), error) {
 	}
 
 	executor := newExecutor(&executorConfig{
-		lnd:               cfg.Lnd,
-		store:             store,
-		sweeper:           sweeper,
-		createExpiryTimer: config.CreateExpiryTimer,
-		loopOutMaxParts:   cfg.LoopOutMaxParts,
-		cancelSwap:        swapServerClient.CancelLoopOutSwap,
+		lnd:                 cfg.Lnd,
+		store:               store,
+		sweeper:             sweeper,
+		createExpiryTimer:   config.CreateExpiryTimer,
+		loopOutMaxParts:     cfg.LoopOutMaxParts,
+		totalPaymentTimeout: cfg.TotalPaymentTimeout,
+		maxPaymentRetries:   cfg.MaxPaymentRetries,
+		cancelSwap:          swapServerClient.CancelLoopOutSwap,
 	})
 
 	client := &Client{

executor.go

@@ -26,6 +26,10 @@ type executorConfig struct {
 
 	loopOutMaxParts uint32
 
+	totalPaymentTimeout time.Duration
+
+	maxPaymentRetries int
+
 	cancelSwap func(ctx context.Context, details *outCancelDetails) error
 }
 
@@ -141,12 +145,14 @@ func (s *executor) run(mainCtx context.Context,
 				defer s.wg.Done()
 
 				err := newSwap.execute(mainCtx, &executeConfig{
-					statusChan:      statusChan,
-					sweeper:         s.sweeper,
-					blockEpochChan:  queue.ChanOut(),
-					timerFactory:    s.executorConfig.createExpiryTimer,
-					loopOutMaxParts: s.executorConfig.loopOutMaxParts,
-					cancelSwap:      s.executorConfig.cancelSwap,
+					statusChan:         statusChan,
+					sweeper:            s.sweeper,
+					blockEpochChan:     queue.ChanOut(),
+					timerFactory:       s.executorConfig.createExpiryTimer,
+					loopOutMaxParts:    s.executorConfig.loopOutMaxParts,
+					totalPaymentTimout: s.executorConfig.totalPaymentTimeout,
+					maxPaymentRetries:  s.executorConfig.maxPaymentRetries,
+					cancelSwap:         s.executorConfig.cancelSwap,
 				}, height)
 				if err != nil && err != context.Canceled {
 					log.Errorf("Execute error: %v", err)

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/btcsuite/btcutil v1.0.3-0.20210527170813-e2ba6805a890
 	github.com/btcsuite/btcwallet/wtxmgr v1.3.1-0.20210822222949-9b5a201c344c
 	github.com/coreos/bbolt v1.3.3
+	github.com/davecgh/go-spew v1.1.1
 	github.com/fortytw2/leaktest v1.3.0
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.5.0
 	github.com/jessevdk/go-flags v1.4.0

loopd/config.go

@@ -33,9 +33,11 @@ var (
 		LoopDirBase, DefaultNetwork, defaultConfigFilename,
 	)
 
-	defaultMaxLogFiles     = 3
-	defaultMaxLogFileSize  = 10
-	defaultLoopOutMaxParts = uint32(5)
+	defaultMaxLogFiles         = 3
+	defaultMaxLogFileSize      = 10
+	defaultLoopOutMaxParts     = uint32(5)
+	defaultTotalPaymentTimeout = time.Minute * 60
+	defaultMaxPaymentRetries   = 3
 
 	// DefaultTLSCertFilename is the default file name for the autogenerated
 	// TLS certificate.
@@ -144,6 +146,9 @@ type Config struct {
 
 	LoopOutMaxParts uint32 `long:"loopoutmaxparts" description:"The maximum number of payment parts that may be used for a loop out swap."`
 
+	TotalPaymentTimeout time.Duration `long:"totalpaymenttimeout" description:"The timeout to use for off-chain payments."`
+	MaxPaymentRetries   int           `long:"maxpaymentretries" description:"The maximum number of times an off-chain payment may be retried."`
+
 	Lnd *lndConfig `group:"lnd" namespace:"lnd"`
 
 	Server *loopServerConfig `group:"server" namespace:"server"`
@@ -165,19 +170,21 @@ func DefaultConfig() Config {
 		Server: &loopServerConfig{
 			NoTLS: false,
 		},
-		LoopDir:         LoopDirBase,
-		ConfigFile:      defaultConfigFile,
-		DataDir:         LoopDirBase,
-		LogDir:          defaultLogDir,
-		MaxLogFiles:     defaultMaxLogFiles,
-		MaxLogFileSize:  defaultMaxLogFileSize,
-		DebugLevel:      defaultLogLevel,
-		TLSCertPath:     DefaultTLSCertPath,
-		TLSKeyPath:      DefaultTLSKeyPath,
-		MacaroonPath:    DefaultMacaroonPath,
-		MaxLSATCost:     lsat.DefaultMaxCostSats,
-		MaxLSATFee:      lsat.DefaultMaxRoutingFeeSats,
-		LoopOutMaxParts: defaultLoopOutMaxParts,
+		LoopDir:             LoopDirBase,
+		ConfigFile:          defaultConfigFile,
+		DataDir:             LoopDirBase,
+		LogDir:              defaultLogDir,
+		MaxLogFiles:         defaultMaxLogFiles,
+		MaxLogFileSize:      defaultMaxLogFileSize,
+		DebugLevel:          defaultLogLevel,
+		TLSCertPath:         DefaultTLSCertPath,
+		TLSKeyPath:          DefaultTLSKeyPath,
+		MacaroonPath:        DefaultMacaroonPath,
+		MaxLSATCost:         lsat.DefaultMaxCostSats,
+		MaxLSATFee:          lsat.DefaultMaxRoutingFeeSats,
+		LoopOutMaxParts:     defaultLoopOutMaxParts,
+		TotalPaymentTimeout: defaultTotalPaymentTimeout,
+		MaxPaymentRetries:   defaultMaxPaymentRetries,
 		Lnd: &lndConfig{
 			Host:         "localhost:10009",
 			MacaroonPath: DefaultLndMacaroonPath,
@@ -299,6 +306,17 @@ func Validate(cfg *Config) error {
 		return fmt.Errorf("must specify --lnd.macaroonpath")
 	}
 
+	// Allow at most 2x the default total payment timeout.
+	if cfg.TotalPaymentTimeout > 2*defaultTotalPaymentTimeout {
+		return fmt.Errorf("max total payment timeout allowed is at "+
+			"most %v", 2*defaultTotalPaymentTimeout)
+	}
+
+	// At least one retry.
+	if cfg.MaxPaymentRetries < 1 {
+		return fmt.Errorf("max payment retries must be positive")
+	}
+
 	return nil
 }
 

loopd/utils.go

@@ -17,14 +17,16 @@ func getClient(config *Config, lnd *lndclient.LndServices) (*loop.Client,
 	func(), error) {
 
 	clientConfig := &loop.ClientConfig{
-		ServerAddress:   config.Server.Host,
-		ProxyAddress:    config.Server.Proxy,
-		SwapServerNoTLS: config.Server.NoTLS,
-		TLSPathServer:   config.Server.TLSPath,
-		Lnd:             lnd,
-		MaxLsatCost:     btcutil.Amount(config.MaxLSATCost),
-		MaxLsatFee:      btcutil.Amount(config.MaxLSATFee),
-		LoopOutMaxParts: config.LoopOutMaxParts,
+		ServerAddress:       config.Server.Host,
+		ProxyAddress:        config.Server.Proxy,
+		SwapServerNoTLS:     config.Server.NoTLS,
+		TLSPathServer:       config.Server.TLSPath,
+		Lnd:                 lnd,
+		MaxLsatCost:         btcutil.Amount(config.MaxLSATCost),
+		MaxLsatFee:          btcutil.Amount(config.MaxLSATFee),
+		LoopOutMaxParts:     config.LoopOutMaxParts,
+		TotalPaymentTimeout: config.TotalPaymentTimeout,
+		MaxPaymentRetries:   config.MaxPaymentRetries,
 	}
 
 	swapClient, cleanUp, err := loop.NewClient(config.DataDir, clientConfig)

loopdb/protocol_version.go

@@ -47,13 +47,17 @@ const (
 	// the server to perform a probe to test inbound liquidty.
 	ProtocolVersionProbe ProtocolVersion = 8
 
+	// The client may ask the server to use a custom routing helper plugin
+	// in order to enhance off-chain payments corresponding to a swap.
+	ProtocolVersionRoutingPlugin = 9
+
 	// ProtocolVersionUnrecorded is set for swaps were created before we
 	// started saving protocol version with swaps.
 	ProtocolVersionUnrecorded ProtocolVersion = math.MaxUint32
 
 	// CurrentRPCProtocolVersion defines the version of the RPC protocol
 	// that is currently supported by the loop client.
-	CurrentRPCProtocolVersion = looprpc.ProtocolVersion_PROBE
+	CurrentRPCProtocolVersion = looprpc.ProtocolVersion_ROUTING_PLUGIN
 
 	// CurrentInternalProtocolVersion defines the RPC current protocol in
 	// the internal representation.
@@ -95,6 +99,9 @@ func (p ProtocolVersion) String() string {
 	case ProtocolVersionProbe:
 		return "Probe"
 
+	case ProtocolVersionRoutingPlugin:
+		return "Routing Plugin"
+
 	default:
 		return "Unknown"
 	}

loopdb/protocol_version_test.go

@@ -23,6 +23,7 @@ func TestProtocolVersionSanity(t *testing.T) {
 		ProtocolVersionMultiLoopIn,
 		ProtocolVersionLoopOutCancel,
 		ProtocolVersionProbe,
+		ProtocolVersionRoutingPlugin,
 	}
 
 	rpcVersions := [...]looprpc.ProtocolVersion{
@@ -35,6 +36,7 @@ func TestProtocolVersionSanity(t *testing.T) {
 		looprpc.ProtocolVersion_MULTI_LOOP_IN,
 		looprpc.ProtocolVersion_LOOP_OUT_CANCEL,
 		looprpc.ProtocolVersion_PROBE,
+		looprpc.ProtocolVersion_ROUTING_PLUGIN,
 	}
 
 	require.Equal(t, len(versions), len(rpcVersions))