multi: move server proto files to their own directory

Protobuf does not allow naming conflicts for files within the same
process, because all proto messages register themselves in a global
registry.

This is problematic because the server's itests import the client's
looprpc package to make rpc queries to the loopd client, thus importing
duplicate common.proto and server.proto from the client's looprc package
(since they're both in there as well).

This change moves the server's proto files into their own directory so
that they are not imported when we want to use the client's files. We
cannot change the package name for the server, because that would be
a breaking change (the package name is included in URIS). Fortunately,
we have the go_package option which allows us to place generated files
in a different location.

Author: carlaKC

Makefile

@@ -75,6 +75,7 @@ install:
 
 rpc:
 	@$(call print, "Compiling protos.")
+	cd ./swapserverrpc; ./gen_protos_docker.sh
 	cd ./looprpc; ./gen_protos_docker.sh
 
 rpc-check: rpc
@@ -85,6 +86,9 @@ rpc-js-compile:
 	@$(call print, "Compiling JSON/WASM stubs.")
 	GOOS=js GOARCH=wasm $(GOBUILD) $(PKG)/looprpc
 
+rpc-format:
+	cd ./looprpc; find . -name "*.proto" | xargs clang-format --style=file -i
+	cd ./swapserverrpc; find . -name "*.proto" | xargs clang-format --style=file -i
 
 clean:
 	@$(call print, "Cleaning up.")

cmd/loop/utils.go

@@ -4,16 +4,16 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/lightninglabs/loop/looprpc"
+	"github.com/lightninglabs/loop/swapserverrpc"
 	"github.com/urfave/cli"
 )
 
 // validateRouteHints ensures that the Private flag isn't set along with
 // the RouteHints flag. We don't allow both options to be set as these options
 // are alternatives to each other. Private autogenerates hopHints while
 // RouteHints are manually passed.
-func validateRouteHints(ctx *cli.Context) ([]*looprpc.RouteHint, error) {
-	var hints []*looprpc.RouteHint
+func validateRouteHints(ctx *cli.Context) ([]*swapserverrpc.RouteHint, error) {
+	var hints []*swapserverrpc.RouteHint
 
 	if ctx.IsSet(routeHintsFlag.Name) {
 		if ctx.IsSet(privateFlag.Name) {

loopd/swapclient_server.go

@@ -19,6 +19,7 @@ import (
 	"github.com/lightninglabs/loop/loopdb"
 	"github.com/lightninglabs/loop/looprpc"
 	"github.com/lightninglabs/loop/swap"
+	"github.com/lightninglabs/loop/swapserverrpc"
 	"github.com/lightningnetwork/lnd/lntypes"
 	"github.com/lightningnetwork/lnd/lnwallet/chainfee"
 	"github.com/lightningnetwork/lnd/lnwire"
@@ -525,7 +526,7 @@ func (s *swapClientServer) GetLoopInQuote(ctx context.Context,
 }
 
 // unmarshallRouteHints unmarshalls a list of route hints.
-func unmarshallRouteHints(rpcRouteHints []*looprpc.RouteHint) (
+func unmarshallRouteHints(rpcRouteHints []*swapserverrpc.RouteHint) (
 	[][]zpay32.HopHint, error) {
 
 	routeHints := make([][]zpay32.HopHint, 0, len(rpcRouteHints))
@@ -548,7 +549,7 @@ func unmarshallRouteHints(rpcRouteHints []*looprpc.RouteHint) (
 }
 
 // unmarshallHopHint unmarshalls a single hop hint.
-func unmarshallHopHint(rpcHint *looprpc.HopHint) (zpay32.HopHint, error) {
+func unmarshallHopHint(rpcHint *swapserverrpc.HopHint) (zpay32.HopHint, error) {
 	pubBytes, err := hex.DecodeString(rpcHint.NodeId)
 	if err != nil {
 		return zpay32.HopHint{}, err

loopdb/protocol_version.go

@@ -3,7 +3,7 @@ package loopdb
 import (
 	"math"
 
-	"github.com/lightninglabs/loop/looprpc"
+	"github.com/lightninglabs/loop/swapserverrpc"
 )
 
 // ProtocolVersion represents the protocol version (declared on rpc level) that
@@ -53,7 +53,7 @@ const (
 
 	// CurrentRPCProtocolVersion defines the version of the RPC protocol
 	// that is currently supported by the loop client.
-	CurrentRPCProtocolVersion = looprpc.ProtocolVersion_PROBE
+	CurrentRPCProtocolVersion = swapserverrpc.ProtocolVersion_PROBE
 
 	// CurrentInternalProtocolVersion defines the RPC current protocol in
 	// the internal representation.

loopdb/protocol_version_test.go

@@ -3,7 +3,7 @@ package loopdb
 import (
 	"testing"
 
-	"github.com/lightninglabs/loop/looprpc"
+	"github.com/lightninglabs/loop/swapserverrpc"
 	"github.com/stretchr/testify/require"
 )
 
@@ -25,16 +25,16 @@ func TestProtocolVersionSanity(t *testing.T) {
 		ProtocolVersionProbe,
 	}
 
-	rpcVersions := [...]looprpc.ProtocolVersion{
-		looprpc.ProtocolVersion_LEGACY,
-		looprpc.ProtocolVersion_MULTI_LOOP_OUT,
-		looprpc.ProtocolVersion_NATIVE_SEGWIT_LOOP_IN,
-		looprpc.ProtocolVersion_PREIMAGE_PUSH_LOOP_OUT,
-		looprpc.ProtocolVersion_USER_EXPIRY_LOOP_OUT,
-		looprpc.ProtocolVersion_HTLC_V2,
-		looprpc.ProtocolVersion_MULTI_LOOP_IN,
-		looprpc.ProtocolVersion_LOOP_OUT_CANCEL,
-		looprpc.ProtocolVersion_PROBE,
+	rpcVersions := [...]swapserverrpc.ProtocolVersion{
+		swapserverrpc.ProtocolVersion_LEGACY,
+		swapserverrpc.ProtocolVersion_MULTI_LOOP_OUT,
+		swapserverrpc.ProtocolVersion_NATIVE_SEGWIT_LOOP_IN,
+		swapserverrpc.ProtocolVersion_PREIMAGE_PUSH_LOOP_OUT,
+		swapserverrpc.ProtocolVersion_USER_EXPIRY_LOOP_OUT,
+		swapserverrpc.ProtocolVersion_HTLC_V2,
+		swapserverrpc.ProtocolVersion_MULTI_LOOP_IN,
+		swapserverrpc.ProtocolVersion_LOOP_OUT_CANCEL,
+		swapserverrpc.ProtocolVersion_PROBE,
 	}
 
 	require.Equal(t, len(versions), len(rpcVersions))

looprpc/.clang-format

@@ -4,4 +4,4 @@ BasedOnStyle: Google
 IndentWidth: 4
 AllowShortFunctionsOnASingleLine: None
 SpaceBeforeParens: Always
-CompactNamespaces: false
+CompactNamespaces: false

looprpc/client.pb.go

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common.proto";
+import "swapserverrpc/common.proto";
 
 package looprpc;
 
@@ -268,7 +268,7 @@ message LoopInRequest {
     /*
     Optional route hints to reach the destination through private channels.
     */
-    repeated RouteHint route_hints = 9;
+    repeated looprpc.RouteHint route_hints = 9;
 
     /*
     Private indicates whether the destination node should be considered
@@ -591,7 +591,7 @@ message QuoteRequest {
     /*
     Optional route hints to reach the destination through private channels.
     */
-    repeated RouteHint loop_in_route_hints = 6;
+    repeated looprpc.RouteHint loop_in_route_hints = 6;
 
     /*
     Private indicates whether the destination node should be considered
@@ -678,7 +678,7 @@ message ProbeRequest {
     /*
     Optional route hints to reach the destination through private channels.
     */
-    repeated RouteHint route_hints = 3;
+    repeated looprpc.RouteHint route_hints = 3;
 }
 
 message ProbeResponse {

looprpc/client.proto

@@ -7,22 +7,22 @@ function generate() {
   # Generate the gRPC bindings for all proto files.
   for file in ./*.proto
   do
-    protoc -I/usr/local/include -I. \
+    protoc -I/usr/local/include -I. -I.. \
       --go_out . --go_opt paths=source_relative \
       --go-grpc_out . --go-grpc_opt paths=source_relative \
       "${file}"
   done
 
   # Generate the REST reverse proxy for the client only.
-  protoc -I/usr/local/include -I. \
+  protoc -I/usr/local/include -I. -I.. \
     --grpc-gateway_out . \
     --grpc-gateway_opt logtostderr=true \
     --grpc-gateway_opt paths=source_relative \
     --grpc-gateway_opt grpc_api_configuration=client.yaml \
     client.proto
 
   # Finally, generate the swagger file which describes the REST API in detail.
-  protoc -I/usr/local/include -I. \
+  protoc -I/usr/local/include -I. -I.. \
     --openapiv2_out . \
     --openapiv2_opt logtostderr=true \
     --openapiv2_opt grpc_api_configuration=client.yaml \