all coinselect changes

Author: hieblmi

cmd/loop/staticaddr.go

@@ -5,7 +5,6 @@ import (
 	"encoding/hex"
 	"errors"
 	"fmt"
-	"sort"
 	"strconv"
 	"strings"
 
@@ -15,8 +14,6 @@ import (
 	"github.com/lightninglabs/loop/staticaddr/deposit"
 	"github.com/lightninglabs/loop/staticaddr/loopin"
 	"github.com/lightninglabs/loop/swapserverrpc"
-	"github.com/lightningnetwork/lnd/input"
-	"github.com/lightningnetwork/lnd/lnwallet"
 	"github.com/lightningnetwork/lnd/routing/route"
 	"github.com/urfave/cli"
 )
@@ -509,17 +506,16 @@ func staticAddressLoopIn(ctx *cli.Context) error {
 	defer cleanup()
 
 	var (
-		ctxb                  = context.Background()
-		isAllSelected         = ctx.IsSet("all")
-		isUtxoSelected        = ctx.IsSet("utxo")
-		isAmountSelected      bool
-		selectedAmount        = ctx.Int64("amount")
-		label                 = ctx.String("static-loop-in")
-		hints                 []*swapserverrpc.RouteHint
-		lastHop               []byte
-		paymentTimeoutSeconds = uint32(loopin.DefaultPaymentTimeoutSeconds)
+		ctxb                   = context.Background()
+		isAllSelected          = ctx.IsSet("all")
+		isUtxoSelected         = ctx.IsSet("utxo")
+		selectedAmount         = ctx.Int64("amount")
+		selectDepositsForQuote bool
+		label                  = ctx.String("static-loop-in")
+		hints                  []*swapserverrpc.RouteHint
+		lastHop                []byte
+		paymentTimeoutSeconds  = uint32(loopin.DefaultPaymentTimeoutSeconds)
 	)
-	isAmountSelected = selectedAmount > 0
 
 	// Validate our label early so that we can fail before getting a quote.
 	if err := labels.Validate(label); err != nil {
@@ -575,15 +571,8 @@ func staticAddressLoopIn(ctx *cli.Context) error {
 	case isUtxoSelected:
 		depositOutpoints = ctx.StringSlice("utxo")
 
-	case isAmountSelected:
-		// If there's only a swap amount specified we'll coin-select
-		// deposits to cover the swap amount.
-		depositOutpoints, err = selectDeposits(
-			allDeposits, selectedAmount,
-		)
-		if err != nil {
-			return err
-		}
+	case selectedAmount > 0:
+		// If only an amount is selected we will trigger coin selection.
 
 	default:
 		return fmt.Errorf("unknown quote request")
@@ -593,12 +582,17 @@ func staticAddressLoopIn(ctx *cli.Context) error {
 		return errors.New("duplicate outpoints detected")
 	}
 
+	if len(depositOutpoints) == 0 && selectedAmount > 0 {
+		selectDepositsForQuote = true
+	}
+
 	quoteReq := &looprpc.QuoteRequest{
 		Amt:              selectedAmount,
 		LoopInRouteHints: hints,
 		LoopInLastHop:    lastHop,
 		Private:          ctx.Bool(privateFlag.Name),
 		DepositOutpoints: depositOutpoints,
+		SelectDeposits:   selectDepositsForQuote,
 	}
 	quote, err := client.GetLoopInQuote(ctxb, quoteReq)
 	if err != nil {
@@ -640,47 +634,6 @@ func staticAddressLoopIn(ctx *cli.Context) error {
 	return nil
 }
 
-// selectDeposits sorts the deposits by amount in descending order, then by
-// blocks-until-expiry in ascending order. It then selects the deposits that
-// are needed to cover the amount requested without leaving a dust change. It
-// returns an error if the sum of deposits minus dust is less than the requested
-// amount.
-func selectDeposits(deposits []*looprpc.Deposit, targetAmount int64) ([]string,
-	error) {
-
-	// Sort the deposits by amount in descending order, then by
-	// blocks-until-expiry in ascending order.
-	sort.Slice(deposits, func(i, j int) bool {
-		if deposits[i].Value == deposits[j].Value {
-			return deposits[i].BlocksUntilExpiry <
-				deposits[j].BlocksUntilExpiry
-		}
-		return deposits[i].Value > deposits[j].Value
-	})
-
-	// Select the deposits that are needed to cover the swap amount without
-	// leaving a dust change.
-	var selectedDeposits []string
-	var selectedAmount int64
-	dustLimit := lnwallet.DustLimitForSize(input.P2TRSize)
-	for _, deposit := range deposits {
-		selectedDeposits = append(selectedDeposits, deposit.Outpoint)
-		selectedAmount += deposit.Value
-		if selectedAmount == targetAmount {
-			return selectedDeposits, nil
-		}
-		if selectedAmount > targetAmount {
-			if selectedAmount-targetAmount >= int64(dustLimit) {
-				return selectedDeposits, nil
-			}
-		}
-	}
-
-	return nil, fmt.Errorf("not enough deposits to cover "+
-		"requested amount, selected %d but need %d",
-		selectedAmount, targetAmount)
-}
-
 func containsDuplicates(outpoints []string) bool {
 	found := make(map[string]struct{})
 	for _, outpoint := range outpoints {

cmd/loop/staticaddr_test.go

@@ -895,25 +895,60 @@ func (s *swapClientServer) GetLoopInQuote(ctx context.Context,
 	var (
 		selectedAmount     = btcutil.Amount(req.Amt)
 		totalDepositAmount btcutil.Amount
-		numDeposits        = len(req.DepositOutpoints)
+		autoSelectDeposits = req.SelectDeposits
 		err                error
 	)
 
 	htlcConfTarget, err := validateLoopInRequest(
-		req.ConfTarget, req.ExternalHtlc, uint32(numDeposits),
-		int64(selectedAmount),
+		req.ConfTarget, req.ExternalHtlc,
+		uint32(len(req.DepositOutpoints)), int64(selectedAmount),
+		autoSelectDeposits,
 	)
 	if err != nil {
 		return nil, err
 	}
 
-	// Retrieve deposits to calculate their total value.
-	var depositList *looprpc.ListStaticAddressDepositsResponse
+	// If deposits should be automatically selected we do so and count the
+	// number of deposits to quote for.
+	numDeposits := 0
+	if autoSelectDeposits {
+		deposits, err := s.depositManager.GetActiveDepositsInState(
+			deposit.Deposited,
+		)
+		if err != nil {
+			return nil, fmt.Errorf("unable to retrieve all "+
+				"deposits: %w", err)
+		}
+
+		// TODO(hieblmi): add params to deposit for multi-address
+		//      support.
+		params, err := s.staticAddressManager.GetStaticAddressParameters(
+			ctx,
+		)
+		if err != nil {
+			return nil, fmt.Errorf("unable to retrieve static "+
+				"address parameters: %w", err)
+		}
+
+		info, err := s.lnd.Client.GetInfo(ctx)
+		if err != nil {
+			return nil, fmt.Errorf("unable to get lnd info: %w",
+				err)
+		}
+		selectedDeposits, err := loopin.SelectDeposits(
+			selectedAmount, deposits, params.Expiry,
+			info.BlockHeight,
+		)
+		if err != nil {
+			return nil, fmt.Errorf("unable to select deposits: %w",
+				err)
+		}
 
-	// If deposits are selected, we need to retrieve them to calculate the
-	// total value which we request a quote for.
-	if numDeposits > 0 {
-		depositList, err = s.ListStaticAddressDeposits(
+		numDeposits = len(selectedDeposits)
+	} else if len(req.DepositOutpoints) > 0 {
+		// If deposits are selected, we need to retrieve them to
+		// calculate the total value which we request a quote for.
+		depositList, err := s.ListStaticAddressDeposits(
 			ctx, &looprpc.ListStaticAddressDepositsRequest{
 				Outpoints: req.DepositOutpoints,
 			},
@@ -927,9 +962,13 @@ func (s *swapClientServer) GetLoopInQuote(ctx context.Context,
 				"deposit outpoints")
 		}
 
-		if numDeposits != len(depositList.FilteredDeposits) {
+		if len(req.DepositOutpoints) !=
+			len(depositList.FilteredDeposits) {
+
 			return nil, fmt.Errorf("expected %d deposits, got %d",
 				numDeposits, len(depositList.FilteredDeposits))
+		} else {
+			numDeposits = len(depositList.FilteredDeposits)
 		}
 
 		// In case we quote for deposits we send the server both the
@@ -942,12 +981,15 @@ func (s *swapClientServer) GetLoopInQuote(ctx context.Context,
 			)
 		}
 
-		selectedAmount, err = s.staticLoopInManager.SwapAmountFromSelectedAmount(
-			selectedAmount, totalDepositAmount,
+		// If a fractional amount is also selected, we check if it would
+		// lead to a dust change output.
+		selectedAmount, err = loopin.SwapAmountFromSelectedAmount(
+			totalDepositAmount, selectedAmount,
 		)
 		if err != nil {
-			return nil, fmt.Errorf("error calculating swap "+
-				"amount from selected amount: %v", err)
+			return nil, fmt.Errorf("error calculating "+
+				"swap amount from selected amount: %v",
+				err)
 		}
 	}
 
@@ -1077,8 +1119,11 @@ func (s *swapClientServer) LoopIn(ctx context.Context,
 
 	infof("Loop in request received")
 
+	selectDeposits := false
+	numDeposits := uint32(0)
 	htlcConfTarget, err := validateLoopInRequest(
-		in.HtlcConfTarget, in.ExternalHtlc, 0, in.Amt,
+		in.HtlcConfTarget, in.ExternalHtlc, numDeposits, in.Amt,
+		selectDeposits,
 	)
 	if err != nil {
 		return nil, err
@@ -2184,10 +2229,17 @@ func validateConfTarget(target, defaultTarget int32) (int32, error) {
 // validateLoopInRequest fails if the mutually exclusive conf target and
 // external parameters are both set.
 func validateLoopInRequest(htlcConfTarget int32, external bool,
-	numDeposits uint32, amount int64) (int32, error) {
+	numDeposits uint32, amount int64, autoSelectDeposits bool) (int32,
+	error) {
 
 	if amount == 0 && numDeposits == 0 {
-		return 0, errors.New("either amount or deposits must be set")
+		return 0, errors.New("either amount, or deposits or both " +
+			"must be set")
+	}
+
+	if autoSelectDeposits && numDeposits > 0 {
+		return 0, errors.New("cannot auto-select deposits while " +
+			"providing deposits at the same time")
 	}
 
 	// If the htlc is going to be externally set, the htlcConfTarget should
@@ -2205,7 +2257,7 @@ func validateLoopInRequest(htlcConfTarget int32, external bool,
 
 	// If the loop in uses static address deposits, we do not need to set a
 	// confirmation target since the HTLC won't be published by the client.
-	if numDeposits > 0 {
+	if numDeposits > 0 || autoSelectDeposits {
 		return 0, nil
 	}