multi: add htlc confirmations parameter to client loop out request

Author: carlaKC

client_test.go

@@ -27,6 +27,7 @@ var (
 		Amount:              btcutil.Amount(50000),
 		DestAddr:            testAddr,
 		MaxMinerFee:         50000,
+		HtlcConfirmations:   defaultConfirmations,
 		SweepConfTarget:     2,
 		MaxSwapFee:          1050,
 		MaxPrepayAmount:     100,
@@ -40,14 +41,18 @@ var (
 	defaultConfirmations = int32(loopdb.DefaultLoopOutHtlcConfirmations)
 )
 
-// TestSuccess tests the loop out happy flow.
+// TestSuccess tests the loop out happy flow, using a custom htlc confirmation
+// target.
 func TestSuccess(t *testing.T) {
 	defer test.Guard(t)()
 
 	ctx := createClientTestContext(t, nil)
 
+	req := *testRequest
+	req.HtlcConfirmations = 2
+
 	// Initiate loop out.
-	info, err := ctx.swapClient.LoopOut(context.Background(), testRequest)
+	info, err := ctx.swapClient.LoopOut(context.Background(), &req)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -59,7 +64,7 @@ func TestSuccess(t *testing.T) {
 	signalPrepaymentResult := ctx.AssertPaid(prepayInvoiceDesc)
 
 	// Expect client to register for conf.
-	confIntent := ctx.AssertRegisterConf(false, defaultConfirmations)
+	confIntent := ctx.AssertRegisterConf(false, req.HtlcConfirmations)
 
 	testSuccess(ctx, testRequest.Amount, info.SwapHash,
 		signalPrepaymentResult, signalSwapPaymentResult, false,
@@ -143,18 +148,25 @@ func TestFailWrongAmount(t *testing.T) {
 func TestResume(t *testing.T) {
 	defer test.Guard(t)()
 
+	defaultConfs := loopdb.DefaultLoopOutHtlcConfirmations
+
 	t.Run("not expired", func(t *testing.T) {
-		testResume(t, false, false, true)
+		testResume(t, defaultConfs, false, false, true)
+	})
+	t.Run("not expired, custom confirmations", func(t *testing.T) {
+		testResume(t, 3, false, false, true)
 	})
 	t.Run("expired not revealed", func(t *testing.T) {
-		testResume(t, true, false, false)
+		testResume(t, defaultConfs, true, false, false)
 	})
 	t.Run("expired revealed", func(t *testing.T) {
-		testResume(t, true, true, true)
+		testResume(t, defaultConfs, true, true, true)
 	})
 }
 
-func testResume(t *testing.T, expired, preimageRevealed, expectSuccess bool) {
+func testResume(t *testing.T, confs uint32, expired, preimageRevealed,
+	expectSuccess bool) {
+
 	defer test.Guard(t)()
 
 	preimage := testPreimage
@@ -193,12 +205,13 @@ func testResume(t *testing.T, expired, preimageRevealed, expectSuccess bool) {
 		update.HtlcTxHash = &chainhash.Hash{1, 2, 6}
 	}
 
+	// Create a pending swap with our custom number of confirmations.
 	pendingSwap := &loopdb.LoopOut{
 		Contract: &loopdb.LoopOutContract{
 			DestAddr:          dest,
 			SwapInvoice:       swapPayReq,
 			SweepConfTarget:   2,
-			HtlcConfirmations: loopdb.DefaultLoopOutHtlcConfirmations,
+			HtlcConfirmations: confs,
 			MaxSwapRoutingFee: 70000,
 			PrepayInvoice:     prePayReq,
 			SwapContract: loopdb.SwapContract{
@@ -234,10 +247,8 @@ func testResume(t *testing.T, expired, preimageRevealed, expectSuccess bool) {
 	signalSwapPaymentResult := ctx.AssertPaid(swapInvoiceDesc)
 	signalPrepaymentResult := ctx.AssertPaid(prepayInvoiceDesc)
 
-	// Expect client to register for conf.
-	confIntent := ctx.AssertRegisterConf(
-		preimageRevealed, defaultConfirmations,
-	)
+	// Expect client to register for our expected number of confirmations.
+	confIntent := ctx.AssertRegisterConf(preimageRevealed, int32(confs))
 
 	signalSwapPaymentResult(nil)
 	signalPrepaymentResult(nil)

interface.go

@@ -64,6 +64,10 @@ type OutRequest struct {
 	// client sweep tx.
 	SweepConfTarget int32
 
+	// HtlcConfirmations specifies the number of confirmations we require
+	// for on chain loop out htlcs.
+	HtlcConfirmations int32
+
 	// OutgoingChanSet optionally specifies the short channel ids of the
 	// channels that may be used to loop out.
 	OutgoingChanSet loopdb.ChannelSet

loopd/swapclient_server.go

@@ -86,6 +86,7 @@ func (s *swapClientServer) LoopOut(ctx context.Context,
 		MaxSwapRoutingFee:   btcutil.Amount(in.MaxSwapRoutingFee),
 		MaxSwapFee:          btcutil.Amount(in.MaxSwapFee),
 		SweepConfTarget:     sweepConfTarget,
+		HtlcConfirmations:   in.HtlcConfirmations,
 		SwapPublicationDeadline: time.Unix(
 			int64(in.SwapPublicationDeadline), 0,
 		),

loopout.go

@@ -138,6 +138,15 @@ func newLoopOutSwap(globalCtx context.Context, cfg *swapConfig,
 		return nil, err
 	}
 
+	// If a htlc confirmation target was not provided, we use the default
+	// number of confirmations. We overwrite this value rather than failing
+	// it because the field is a new addition to the rpc, and we don't want
+	// to break older clients that are not aware of this new field.
+	confs := uint32(request.HtlcConfirmations)
+	if confs == 0 {
+		confs = loopdb.DefaultLoopOutHtlcConfirmations
+	}
+
 	// Instantiate a struct that contains all required data to start the
 	// swap.
 	initiationTime := time.Now()
@@ -147,7 +156,7 @@ func newLoopOutSwap(globalCtx context.Context, cfg *swapConfig,
 		DestAddr:                request.DestAddr,
 		MaxSwapRoutingFee:       request.MaxSwapRoutingFee,
 		SweepConfTarget:         request.SweepConfTarget,
-		HtlcConfirmations:       loopdb.DefaultLoopOutHtlcConfirmations,
+		HtlcConfirmations:       confs,
 		PrepayInvoice:           swapResp.prepayInvoice,
 		MaxPrepayRoutingFee:     request.MaxPrepayRoutingFee,
 		SwapPublicationDeadline: request.SwapPublicationDeadline,