Merge pull request #697 from sputn1ck/instantout_quote

Instantout: Add fee estimation to CLI

Author: sputn1ck

cmd/loop/instantout.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"strconv"
 	"strings"
@@ -97,14 +98,18 @@ func instantOut(ctx *cli.Context) error {
 	fmt.Scanln(&answer)
 
 	// Parse
-	var selectedReservations [][]byte
+	var (
+		selectedReservations [][]byte
+		selectedAmt          uint64
+	)
 	switch answer {
 	case "ALL":
 		for _, res := range confirmedReservations {
 			selectedReservations = append(
 				selectedReservations,
 				res.ReservationId,
 			)
+			selectedAmt += res.Amount
 		}
 
 	case "":
@@ -135,9 +140,33 @@ func instantOut(ctx *cli.Context) error {
 			)
 
 			selectedIndexMap[idx] = struct{}{}
+			selectedAmt += confirmedReservations[idx-1].Amount
 		}
 	}
 
+	// Now that we have the selected reservations we can estimate the
+	// fee-rates.
+	quote, err := client.InstantOutQuote(
+		context.Background(), &looprpc.InstantOutQuoteRequest{
+			Amt:             selectedAmt,
+			NumReservations: int32(len(selectedReservations)),
+		},
+	)
+	if err != nil {
+		return err
+	}
+	fmt.Println()
+	fmt.Printf(satAmtFmt, "Estimated on-chain fee:", quote.SweepFeeSat)
+	fmt.Printf(satAmtFmt, "Service fee:", quote.ServiceFeeSat)
+	fmt.Println()
+
+	fmt.Printf("CONTINUE SWAP? (y/n): ")
+
+	fmt.Scanln(&answer)
+	if answer != "y" {
+		return errors.New("swap canceled")
+	}
+
 	fmt.Println("Starting instant swap out")
 
 	// Now we can request the instant out swap.

instantout/manager.go

@@ -7,7 +7,9 @@ import (
 	"sync"
 	"time"
 
+	"github.com/btcsuite/btcd/btcutil"
 	"github.com/lightninglabs/loop/instantout/reservation"
+	"github.com/lightninglabs/loop/swapserverrpc"
 	"github.com/lightningnetwork/lnd/lntypes"
 )
 
@@ -199,3 +201,50 @@ func (m *Manager) GetActiveInstantOut(swapHash lntypes.Hash) (*FSM, error) {
 
 	return fsm, nil
 }
+
+type Quote struct {
+	// ServiceFee is the fee in sat that is paid to the loop service.
+	ServiceFee btcutil.Amount
+
+	// OnChainFee is the estimated on chain fee in sat.
+	OnChainFee btcutil.Amount
+}
+
+// GetInstantOutQuote returns a quote for an instant out.
+func (m *Manager) GetInstantOutQuote(ctx context.Context,
+	amt btcutil.Amount, numReservations int) (Quote, error) {
+
+	if numReservations <= 0 {
+		return Quote{}, fmt.Errorf("no reservations selected")
+	}
+
+	if amt <= 0 {
+		return Quote{}, fmt.Errorf("no amount selected")
+	}
+
+	// Get the service fee.
+	quoteRes, err := m.cfg.InstantOutClient.GetInstantOutQuote(
+		ctx, &swapserverrpc.GetInstantOutQuoteRequest{
+			Amount: uint64(amt),
+		},
+	)
+	if err != nil {
+		return Quote{}, err
+	}
+
+	// Get the offchain fee by getting the fee estimate from the lnd client
+	// and multiplying it by the estimated sweepless sweep transaction.
+	feeRate, err := m.cfg.Wallet.EstimateFeeRate(ctx, normalConfTarget)
+	if err != nil {
+		return Quote{}, err
+	}
+
+	// The on chain chainFee is the chainFee rate times the estimated
+	// sweepless sweep transaction size.
+	chainFee := feeRate.FeeForWeight(sweeplessSweepWeight(numReservations))
+
+	return Quote{
+		ServiceFee: btcutil.Amount(quoteRes.SwapFee),
+		OnChainFee: chainFee,
+	}, nil
+}

loopd/perms/perms.go

@@ -104,4 +104,8 @@ var RequiredPermissions = map[string][]bakery.Op{
 		Entity: "swap",
 		Action: "execute",
 	}},
+	"/looprpc.SwapClient/InstantOutQuote": {{
+		Entity: "swap",
+		Action: "read",
+	}},
 }

loopd/swapclient_server.go

@@ -1209,6 +1209,25 @@ func (s *swapClientServer) InstantOut(ctx context.Context,
 	return res, nil
 }
 
+// InstantOutQuote returns a quote for an instant out swap with the provided
+// parameters.
+func (s *swapClientServer) InstantOutQuote(ctx context.Context,
+	req *clientrpc.InstantOutQuoteRequest) (
+	*clientrpc.InstantOutQuoteResponse, error) {
+
+	quote, err := s.instantOutManager.GetInstantOutQuote(
+		ctx, btcutil.Amount(req.Amt), int(req.NumReservations),
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return &clientrpc.InstantOutQuoteResponse{
+		ServiceFeeSat: int64(quote.ServiceFee),
+		SweepFeeSat:   int64(quote.OnChainFee),
+	}, nil
+}
+
 func rpcAutoloopReason(reason liquidity.Reason) (clientrpc.AutoReason, error) {
 	switch reason {
 	case liquidity.ReasonNone: