Merge pull request #4140 from carlaKC/lnrpc-pendingchannelinitiator

lnrpc: use initiator enum for pending channel open initiator

lnrpc/rpc.proto

@@ -1483,6 +1483,13 @@ message ListChannelsResponse {
     repeated Channel channels = 11;
 }
 
+enum Initiator {
+    INITIATOR_UNKNOWN = 0;
+    INITIATOR_LOCAL = 1;
+    INITIATOR_REMOTE = 2;
+    INITIATOR_BOTH = 3;
+}
+
 message ChannelCloseSummary {
     /// The outpoint (txid:index) of the funding transaction.
     string channel_point = 1;
@@ -1523,13 +1530,6 @@ message ChannelCloseSummary {
     /// Details on how the channel was closed.
     ClosureType close_type = 10;
 
-    enum Initiator {
-        UNKNOWN = 0;
-        LOCAL = 1;
-        REMOTE = 2;
-        BOTH = 3;
-    }
-
     /**
     Open initiator is the party that initiated opening the channel. Note that
     this value may be unknown if the channel was closed before we migrated to
@@ -2093,8 +2093,8 @@ message PendingChannelsResponse {
         */
         int64 remote_chan_reserve_sat = 7;
 
-        // True if we initiated opening the channel.
+        // The party that initiated opening the channel.
-        bool initiator = 8;
+        Initiator initiator = 8;
 
         /// The commitment type used by this channel.
         CommitmentType commitment_type = 9;

lnrpc/rpc.swagger.json

@@ -1513,16 +1513,6 @@
       ],
       "default": "COOPERATIVE_CLOSE"
     },
-    "ChannelCloseSummaryInitiator": {
-      "type": "string",
-      "enum": [
-        "UNKNOWN",
-        "LOCAL",
-        "REMOTE",
-        "BOTH"
-      ],
-      "default": "UNKNOWN"
-    },
     "ChannelEventUpdateUpdateType": {
       "type": "string",
       "enum": [
@@ -1743,9 +1733,8 @@
           "description": "*\nThe minimum satoshis the other node is required to reserve in its\nbalance."
         },
         "initiator": {
-          "type": "boolean",
+          "$ref": "#/definitions/lnrpcInitiator",
-          "format": "boolean",
+          "description": "The party that initiated opening the channel."
-          "description": "True if we initiated opening the channel."
         },
         "commitment_type": {
           "$ref": "#/definitions/lnrpcCommitmentType",
@@ -2233,11 +2222,11 @@
           "description": "/ Details on how the channel was closed."
         },
         "open_initiator": {
-          "$ref": "#/definitions/ChannelCloseSummaryInitiator",
+          "$ref": "#/definitions/lnrpcInitiator",
           "description": "*\nOpen initiator is the party that initiated opening the channel. Note that\nthis value may be unknown if the channel was closed before we migrated to\nstore open channel information after close."
         },
         "close_initiator": {
-          "$ref": "#/definitions/ChannelCloseSummaryInitiator",
+          "$ref": "#/definitions/lnrpcInitiator",
           "description": "*\nClose initiator indicates which party initiated the close. This value will\nbe unknown for channels that were cooperatively closed before we started\ntracking cooperative close initiators. Note that this indicates which party\ninitiated a close, and it is possible for both to initiate cooperative or\nforce closes, although only one party's close will be confirmed on chain."
         }
       }
@@ -3183,6 +3172,16 @@
     "lnrpcInitWalletResponse": {
       "type": "object"
     },
+    "lnrpcInitiator": {
+      "type": "string",
+      "enum": [
+        "INITIATOR_UNKNOWN",
+        "INITIATOR_LOCAL",
+        "INITIATOR_REMOTE",
+        "INITIATOR_BOTH"
+      ],
+      "default": "INITIATOR_UNKNOWN"
+    },
     "lnrpcInvoice": {
       "type": "object",
       "properties": {

lntest/itest/lnd_test.go

@@ -6715,7 +6715,7 @@ func subscribeChannelNotifications(ctxb context.Context, t *harnessTest,
 // expected type.
 func verifyCloseUpdate(chanUpdate *lnrpc.ChannelEventUpdate,
 	closeType lnrpc.ChannelCloseSummary_ClosureType,
-	closeInitiator lnrpc.ChannelCloseSummary_Initiator) error {
+	closeInitiator lnrpc.Initiator) error {
 
 	// We should receive one inactive and one closed notification
 	// for each channel.
@@ -6859,7 +6859,7 @@ func testBasicChannelCreationAndUpdates(net *lntest.NetworkHarness, t *harnessTe
 	// receive the correct channel updates in order.
 	verifyCloseUpdatesReceived := func(sub channelSubscription,
 		forceType lnrpc.ChannelCloseSummary_ClosureType,
-		closeInitiator lnrpc.ChannelCloseSummary_Initiator) error {
+		closeInitiator lnrpc.Initiator) error {
 
 		// Ensure one inactive and one closed notification is received for each
 		// closed channel.
@@ -6905,7 +6905,7 @@ func testBasicChannelCreationAndUpdates(net *lntest.NetworkHarness, t *harnessTe
 	// close initiator because Alice closed the channels.
 	if err := verifyCloseUpdatesReceived(bobChanSub,
 		lnrpc.ChannelCloseSummary_REMOTE_FORCE_CLOSE,
-		lnrpc.ChannelCloseSummary_REMOTE); err != nil {
+		lnrpc.Initiator_INITIATOR_REMOTE); err != nil {
 		t.Fatalf("errored verifying close updates: %v", err)
 	}
 
@@ -6915,7 +6915,7 @@ func testBasicChannelCreationAndUpdates(net *lntest.NetworkHarness, t *harnessTe
 	// close initiator because Alice closed the channels.
 	if err := verifyCloseUpdatesReceived(aliceChanSub,
 		lnrpc.ChannelCloseSummary_LOCAL_FORCE_CLOSE,
-		lnrpc.ChannelCloseSummary_LOCAL); err != nil {
+		lnrpc.Initiator_INITIATOR_LOCAL); err != nil {
 		t.Fatalf("errored verifying close updates: %v", err)
 	}
 }

rpcserver.go

@@ -2646,6 +2646,16 @@ func (r *rpcServer) PendingChannels(ctx context.Context,
 
 	resp := &lnrpc.PendingChannelsResponse{}
 
+	// rpcInitiator returns the correct lnrpc initiator for channels where
+	// we have a record of the opening channel.
+	rpcInitiator := func(isInitiator bool) lnrpc.Initiator {
+		if isInitiator {
+			return lnrpc.Initiator_INITIATOR_LOCAL
+		}
+
+		return lnrpc.Initiator_INITIATOR_REMOTE
+	}
+
 	// First, we'll populate the response with all the channels that are
 	// soon to be opened. We can easily fetch this data from the database
 	// and map the db struct to the proto response.
@@ -2680,7 +2690,7 @@ func (r *rpcServer) PendingChannels(ctx context.Context,
 				RemoteBalance:        int64(localCommitment.RemoteBalance.ToSatoshis()),
 				LocalChanReserveSat:  int64(pendingChan.LocalChanCfg.ChanReserve),
 				RemoteChanReserveSat: int64(pendingChan.RemoteChanCfg.ChanReserve),
-				Initiator:            pendingChan.IsInitiator,
+				Initiator:            rpcInitiator(pendingChan.IsInitiator),
 				CommitmentType:       rpcCommitmentType(pendingChan.ChanType),
 			},
 			CommitWeight: commitWeight,
@@ -2707,12 +2717,18 @@ func (r *rpcServer) PendingChannels(ctx context.Context,
 		// needed regardless of how this channel was closed.
 		pub := pendingClose.RemotePub.SerializeCompressed()
 		chanPoint := pendingClose.ChanPoint
+
+		// Create the pending channel. If this channel was closed before
+		// we started storing historical channel data, we will not know
+		// who initiated the channel, so we set the initiator field to
+		// unknown.
 		channel := &lnrpc.PendingChannelsResponse_PendingChannel{
 			RemoteNodePub:  hex.EncodeToString(pub),
 			ChannelPoint:   chanPoint.String(),
 			Capacity:       int64(pendingClose.Capacity),
 			LocalBalance:   int64(pendingClose.SettledBalance),
 			CommitmentType: lnrpc.CommitmentType_UNKNOWN_COMMITMENT_TYPE,
+			Initiator:      lnrpc.Initiator_INITIATOR_UNKNOWN,
 		}
 
 		// Lookup the channel in the historical channel bucket to obtain
@@ -2730,7 +2746,7 @@ func (r *rpcServer) PendingChannels(ctx context.Context,
 		case channeldb.ErrChannelNotFound:
 
 		case nil:
-			channel.Initiator = historical.IsInitiator
+			channel.Initiator = rpcInitiator(historical.IsInitiator)
 			channel.CommitmentType = rpcCommitmentType(
 				historical.ChanType,
 			)
@@ -2860,7 +2876,7 @@ func (r *rpcServer) PendingChannels(ctx context.Context,
 			RemoteBalance:        int64(waitingClose.LocalCommitment.RemoteBalance.ToSatoshis()),
 			LocalChanReserveSat:  int64(waitingClose.LocalChanCfg.ChanReserve),
 			RemoteChanReserveSat: int64(waitingClose.RemoteChanCfg.ChanReserve),
-			Initiator:            waitingClose.IsInitiator,
+			Initiator:            rpcInitiator(waitingClose.IsInitiator),
 			CommitmentType:       rpcCommitmentType(waitingClose.ChanType),
 		}
 
@@ -3352,8 +3368,8 @@ func (r *rpcServer) createRPCClosedChannel(
 
 	var (
 		closeType      lnrpc.ChannelCloseSummary_ClosureType
-		openInit       lnrpc.ChannelCloseSummary_Initiator
+		openInit       lnrpc.Initiator
-		closeInitiator lnrpc.ChannelCloseSummary_Initiator
+		closeInitiator lnrpc.Initiator
 		err            error
 	)
 
@@ -3404,12 +3420,12 @@ func (r *rpcServer) createRPCClosedChannel(
 // channel is not present (which indicates that it was closed before we started
 // writing channels to the historical close bucket).
 func (r *rpcServer) getInitiators(chanPoint *wire.OutPoint) (
-	lnrpc.ChannelCloseSummary_Initiator,
+	lnrpc.Initiator,
-	lnrpc.ChannelCloseSummary_Initiator, error) {
+	lnrpc.Initiator, error) {
 
 	var (
-		openInitiator  = lnrpc.ChannelCloseSummary_UNKNOWN
+		openInitiator  = lnrpc.Initiator_INITIATOR_UNKNOWN
-		closeInitiator = lnrpc.ChannelCloseSummary_UNKNOWN
+		closeInitiator = lnrpc.Initiator_INITIATOR_UNKNOWN
 	)
 
 	// To get the close initiator for cooperative closes, we need
@@ -3434,9 +3450,9 @@ func (r *rpcServer) getInitiators(chanPoint *wire.OutPoint) (
 	// If we successfully looked up the channel, determine initiator based
 	// on channels status.
 	if histChan.IsInitiator {
-		openInitiator = lnrpc.ChannelCloseSummary_LOCAL
+		openInitiator = lnrpc.Initiator_INITIATOR_LOCAL
 	} else {
-		openInitiator = lnrpc.ChannelCloseSummary_REMOTE
+		openInitiator = lnrpc.Initiator_INITIATOR_REMOTE
 	}
 
 	localInit := histChan.HasChanStatus(
@@ -3452,13 +3468,13 @@ func (r *rpcServer) getInitiators(chanPoint *wire.OutPoint) (
 	// We return the initiator as both in this case to provide full
 	// information about the close.
 	case localInit && remoteInit:
-		closeInitiator = lnrpc.ChannelCloseSummary_BOTH
+		closeInitiator = lnrpc.Initiator_INITIATOR_BOTH
 
 	case localInit:
-		closeInitiator = lnrpc.ChannelCloseSummary_LOCAL
+		closeInitiator = lnrpc.Initiator_INITIATOR_LOCAL
 
 	case remoteInit:
-		closeInitiator = lnrpc.ChannelCloseSummary_REMOTE
+		closeInitiator = lnrpc.Initiator_INITIATOR_REMOTE
 	}
 
 	return openInitiator, closeInitiator, nil