Merge pull request #316 from guggero/user-agent-initiator

Add initiator field to user agent string

Author: guggero

Makefile

@@ -10,7 +10,7 @@ GOINSTALL := GO111MODULE=on go install -v
 GOMOD := GO111MODULE=on go mod
 
 COMMIT := $(shell git describe --abbrev=40 --dirty)
-LDFLAGS := -ldflags "-X $(PKG)/build.Commit=$(COMMIT)"
+LDFLAGS := -ldflags "-X $(PKG).Commit=$(COMMIT)"
 DEV_TAGS = dev
 
 GOFILES_NOVENDOR = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
@@ -72,3 +72,7 @@ install:
 	@$(call print, "Installing loop and loopd.")
 	$(GOINSTALL) -tags="${tags}" $(LDFLAGS) $(PKG)/cmd/loop
 	$(GOINSTALL) -tags="${tags}" $(LDFLAGS) $(PKG)/cmd/loopd
+
+rpc:
+	@$(call print, "Compiling RPC protos.")
+	cd looprpc; ./gen_protos.sh

client_test.go

@@ -34,6 +34,7 @@ var (
 		MaxPrepayAmount:     100,
 		MaxPrepayRoutingFee: 75000,
 		MaxSwapRoutingFee:   70000,
+		Initiator:           "test",
 	}
 
 	swapInvoiceDesc   = "swap"

cmd/loop/loopin.go

@@ -150,6 +150,7 @@ func loopIn(ctx *cli.Context) error {
 		ExternalHtlc:   external,
 		HtlcConfTarget: htlcConfTarget,
 		Label:          label,
+		Initiator:      defaultInitiator,
 	}
 
 	if ctx.IsSet(lastHopFlag.Name) {

cmd/loop/loopout.go

@@ -195,6 +195,7 @@ func loopOut(ctx *cli.Context) error {
 		HtlcConfirmations:       htlcConfs,
 		SwapPublicationDeadline: uint64(swapDeadline.Unix()),
 		Label:                   label,
+		Initiator:               defaultInitiator,
 	})
 	if err != nil {
 		return err

cmd/loop/main.go

@@ -48,6 +48,10 @@ var (
 	// that we set when sending it over the line.
 	defaultMacaroonTimeout int64 = 60
 
+	// defaultInitiator is the default value for the "initiator" part of the
+	// user agent string we send when using the command line utility.
+	defaultInitiator = "loop-cli"
+
 	loopDirFlag = cli.StringFlag{
 		Name:  "loopdir",
 		Value: loopd.LoopDirBase,

interface.go

@@ -81,6 +81,11 @@ type OutRequest struct {
 
 	// Label contains an optional label for the swap.
 	Label string
+
+	// Initiator is an optional string that identifies what software
+	// initiated the swap (loop CLI, autolooper, LiT UI and so on) and is
+	// appended to the user agent string.
+	Initiator string
 }
 
 // Out contains the full details of a loop out request. This includes things
@@ -196,6 +201,11 @@ type LoopInRequest struct {
 
 	// Label contains an optional label for the swap.
 	Label string
+
+	// Initiator is an optional string that identifies what software
+	// initiated the swap (loop CLI, autolooper, LiT UI and so on) and is
+	// appended to the user agent string.
+	Initiator string
 }
 
 // LoopInTerms are the server terms on which it executes loop in swaps.

liquidity/autoloop_test.go

@@ -146,6 +146,7 @@ func TestAutoLoopEnabled(t *testing.T) {
 			SweepConfTarget: params.SweepConfTarget,
 			OutgoingChanSet: loopdb.ChannelSet{chanID1.ToUint64()},
 			Label:           labels.AutoOutLabel(),
+			Initiator:       autoloopSwapInitiator,
 		}
 
 		chan2Swap = &loop.OutRequest{
@@ -161,6 +162,7 @@ func TestAutoLoopEnabled(t *testing.T) {
 			SweepConfTarget: params.SweepConfTarget,
 			OutgoingChanSet: loopdb.ChannelSet{chanID2.ToUint64()},
 			Label:           labels.AutoOutLabel(),
+			Initiator:       autoloopSwapInitiator,
 		}
 
 		loopOuts = []loopOutRequestResp{

liquidity/liquidity.go

@@ -99,6 +99,10 @@ const (
 	// DefaultAutoOutTicker is the default amount of time between automated
 	// loop out checks.
 	DefaultAutoOutTicker = time.Minute * 10
+
+	// autoloopSwapInitiator is the value we send in the initiator field of
+	// a swap request when issuing an automatic swap.
+	autoloopSwapInitiator = "autoloop"
 )
 
 var (
@@ -704,6 +708,7 @@ func (m *Manager) makeLoopOutRequest(ctx context.Context,
 		MaxSwapFee:          quote.SwapFee,
 		MaxPrepayAmount:     quote.PrepayAmount,
 		SweepConfTarget:     m.params.SweepConfTarget,
+		Initiator:           autoloopSwapInitiator,
 	}
 
 	if autoOut {

liquidity/liquidity_test.go

@@ -68,6 +68,7 @@ var (
 		MaxSwapFee:          testQuote.SwapFee,
 		MaxPrepayAmount:     testQuote.PrepayAmount,
 		SweepConfTarget:     loop.DefaultSweepConfTarget,
+		Initiator:           autoloopSwapInitiator,
 	}
 
 	// chan2Rec is the suggested swap for channel 2 when we use chanRule.
@@ -80,6 +81,7 @@ var (
 		MaxPrepayAmount:     testQuote.PrepayAmount,
 		MaxSwapFee:          testQuote.SwapFee,
 		SweepConfTarget:     loop.DefaultSweepConfTarget,
+		Initiator:           autoloopSwapInitiator,
 	}
 
 	// chan1Out is a contract that uses channel 1, used to represent on

loopd/swapclient_server.go

@@ -99,7 +99,8 @@ func (s *swapClientServer) LoopOut(ctx context.Context,
 		SwapPublicationDeadline: time.Unix(
 			int64(in.SwapPublicationDeadline), 0,
 		),
-		Label: in.Label,
+		Label:     in.Label,
+		Initiator: in.Initiator,
 	}
 
 	switch {
@@ -496,6 +497,7 @@ func (s *swapClientServer) LoopIn(ctx context.Context,
 		HtlcConfTarget: htlcConfTarget,
 		ExternalHtlc:   in.ExternalHtlc,
 		Label:          in.Label,
+		Initiator:      in.Initiator,
 	}
 	if in.LastHop != nil {
 		lastHop, err := route.NewVertexFromBytes(in.LastHop)