routerrpc: add XAddLocalChanAliases & XDeleteLocalChanAliases

Author: GeorgeTsagk

lnrpc/marshall_utils.go

@@ -207,3 +207,31 @@ func UnmarshallCoinSelectionStrategy(strategy CoinSelectionStrategy,
 			"%v", strategy)
 	}
 }
+
+// ScidAliasMap is a map from a base short channel ID to a set of alias short
+// channel IDs.
+type ScidAliasMap map[lnwire.ShortChannelID][]lnwire.ShortChannelID
+
+// MarshalAliasMap converts a ScidAliasMap to its proto counterpart. This is
+// used in various RPCs that handle scid alias mappings.
+func MarshalAliasMap(scidMap ScidAliasMap) []*AliasMap {
+	res := make([]*AliasMap, 0, len(scidMap))
+
+	for base, aliases := range scidMap {
+		rpcMap := &AliasMap{
+			BaseScid: base.ToUint64(),
+		}
+
+		rpcMap.Aliases = make([]uint64, 0, len(aliases))
+
+		for _, alias := range aliases {
+			rpcMap.Aliases = append(
+				rpcMap.Aliases, alias.ToUint64(),
+			)
+		}
+
+		res = append(res, rpcMap)
+	}
+
+	return res
+}

lnrpc/routerrpc/config.go

@@ -1,6 +1,7 @@
 package routerrpc
 
 import (
+	"github.com/lightningnetwork/lnd/aliasmgr"
 	"github.com/lightningnetwork/lnd/macaroons"
 	"github.com/lightningnetwork/lnd/routing"
 )
@@ -46,6 +47,10 @@ type Config struct {
 	// RouterBackend contains shared logic between this sub server and the
 	// main rpc server.
 	RouterBackend *RouterBackend
+
+	// AliasMgr is the alias manager instance that is used to handle all the
+	// scid alias related information for channels.
+	AliasMgr *aliasmgr.Manager
 }
 
 // DefaultConfig defines the config defaults.

lnrpc/routerrpc/router.pb.go

@@ -176,6 +176,23 @@ service Router {
     */
     rpc UpdateChanStatus (UpdateChanStatusRequest)
         returns (UpdateChanStatusResponse);
+
+    /*
+    XAddLocalChanAliases is an experimental API that creates a set of new
+    channel SCID alias mappings. The list of successfully created mappings is
+    returned. This is only a locally stored alias, and will not be communicated
+    to the channel peer via any message. Therefore, routing over such an alias
+    will only work of the peer also calls this same RPC on their end.
+    */
+    rpc XAddLocalChanAliases (AddAliasesRequest) returns (AddAliasesResponse);
+
+    /*
+    XDeleteLocalChanAliases is an experimental API that deletes a set of new
+    alias mappings. The list of successfully deleted mappings is returned. The
+    deletion will not be communicated to the channel peer via any message.
+    */
+    rpc XDeleteLocalChanAliases (DeleteAliasesRequest)
+        returns (DeleteAliasesResponse);
 }
 
 message SendPaymentRequest {
@@ -1030,3 +1047,19 @@ enum ChanStatusAction {
 
 message UpdateChanStatusResponse {
 }
+
+message AddAliasesRequest {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}
+
+message AddAliasesResponse {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}
+
+message DeleteAliasesRequest {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}
+
+message DeleteAliasesResponse {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}