Merge pull request #9950 from starius/describegraph-authproofs2

lnrpc: add auth_proof to graph APIs

Author: yyforyongyu

cmd/commands/commands.go

@@ -1987,6 +1987,11 @@ var describeGraphCommand = cli.Command{
 				"graph. Unannounced channels are both private channels, and " +
 				"public channels that are not yet announced to the network.",
 		},
+		cli.BoolFlag{
+			Name: "include_auth_proof",
+			Usage: "If set, will include announcements' " +
+				"signatures into ChannelEdge.",
+		},
 	},
 	Action: actionDecorator(describeGraph),
 }
@@ -1998,6 +2003,7 @@ func describeGraph(ctx *cli.Context) error {
 
 	req := &lnrpc.ChannelGraphRequest{
 		IncludeUnannounced: ctx.Bool("include_unannounced"),
+		IncludeAuthProof:   ctx.Bool("include_auth_proof"),
 	}
 
 	graph, err := client.DescribeGraph(ctxc, req)
@@ -2055,6 +2061,11 @@ var getChanInfoCommand = cli.Command{
 				"the chan_id param is set this param is " +
 				"ignored.",
 		},
+		cli.BoolFlag{
+			Name: "include_auth_proof",
+			Usage: "If set, will include announcements' " +
+				"signatures into ChannelEdge.",
+		},
 	},
 	Action: actionDecorator(getChanInfo),
 }
@@ -2088,8 +2099,9 @@ func getChanInfo(ctx *cli.Context) error {
 	}
 
 	req := &lnrpc.ChanInfoRequest{
-		ChanId:    chanID,
-		ChanPoint: chanPoint,
+		ChanId:           chanID,
+		ChanPoint:        chanPoint,
+		IncludeAuthProof: ctx.Bool("include_auth_proof"),
 	}
 
 	chanInfo, err := client.GetChanInfo(ctxc, req)
@@ -2118,6 +2130,12 @@ var getNodeInfoCommand = cli.Command{
 			Usage: "if true, will return all known channels " +
 				"associated with the node",
 		},
+		cli.BoolFlag{
+			Name: "include_auth_proof",
+			Usage: "If set, will include announcements' " +
+				"signatures into ChannelEdge. Depends on " +
+				"include_channels",
+		},
 	},
 	Action: actionDecorator(getNodeInfo),
 }
@@ -2140,8 +2158,9 @@ func getNodeInfo(ctx *cli.Context) error {
 	}
 
 	req := &lnrpc.NodeInfoRequest{
-		PubKey:          pubKey,
-		IncludeChannels: ctx.Bool("include_channels"),
+		PubKey:           pubKey,
+		IncludeChannels:  ctx.Bool("include_channels"),
+		IncludeAuthProof: ctx.Bool("include_auth_proof"),
 	}
 
 	nodeInfo, err := client.GetNodeInfo(ctxc, req)

docs/release-notes/release-notes-0.20.0.md

@@ -48,6 +48,13 @@ circuit. The indices are only available for forwarding events saved after v0.20.
   [`incoming_chan_ids` and `outgoing_chan_ids`](https://github.com/lightningnetwork/lnd/pull/9356). 
   This allows to retrieve forwarding events for specific channels.
 
+
+* `DescribeGraph`, `GetNodeInfo`, `GetChanInfo` and the corresponding lncli
+   commands [now have flag](https://github.com/lightningnetwork/lnd/pull/9950)
+  `include_auth_proof`. With the flag, these APIs add AuthProof (signatures from
+  the channel announcement) to the returned ChannelEdge.
+
+
 ## lncli Additions
 
 * [`lncli sendpayment` and `lncli queryroutes` now support the
@@ -127,6 +134,7 @@ circuit. The indices are only available for forwarding events saved after v0.20.
 # Contributors (Alphabetical Order)
 
 * Abdulkbk
+* Boris Nagaev
 * Elle Mouton
 * Funyug
 * Mohamed Awnallah

lnrpc/devrpc/dev.swagger.json

@@ -106,6 +106,32 @@
         }
       }
     },
+    "lnrpcChannelAuthProof": {
+      "type": "object",
+      "properties": {
+        "node_sig1": {
+          "type": "string",
+          "format": "byte",
+          "description": "node_sig1 are the raw bytes of the first node signature encoded\nin DER format."
+        },
+        "bitcoin_sig1": {
+          "type": "string",
+          "format": "byte",
+          "description": "bitcoin_sig1 are the raw bytes of the first bitcoin signature of the\nMultiSigKey key of the channel encoded in DER format."
+        },
+        "node_sig2": {
+          "type": "string",
+          "format": "byte",
+          "description": "node_sig2 are the raw bytes of the second node signature encoded\nin DER format."
+        },
+        "bitcoin_sig2": {
+          "type": "string",
+          "format": "byte",
+          "description": "bitcoin_sig2 are the raw bytes of the second bitcoin signature of the\nMultiSigKey key of the channel encoded in DER format."
+        }
+      },
+      "description": "ChannelAuthProof is the authentication proof (the signature portion) for a\nchannel. Using the four signatures contained in the struct, and some\nauxiliary knowledge (the funding script, node identities, and outpoint) nodes\non the network are able to validate the authenticity and existence of a\nchannel."
+    },
     "lnrpcChannelEdge": {
       "type": "object",
       "properties": {
@@ -144,6 +170,10 @@
             "format": "byte"
           },
           "description": "Custom channel announcement tlv records."
+        },
+        "auth_proof": {
+          "$ref": "#/definitions/lnrpcChannelAuthProof",
+          "description": "Authentication proof for this channel. This proof contains a set of\nsignatures binding four identities, which attests to the legitimacy of\nthe advertised channel. This only is available for advertised channels.\nThis field is not filled by default. Pass include_auth_proof flag to\nDescribeGraph, GetNodeInfo or GetChanInfo to get this data."
         }
       },
       "description": "A fully authenticated channel along with all its unique attributes.\nOnce an authenticated channel announcement has been processed on the network,\nthen an instance of ChannelEdgeInfo encapsulating the channels attributes is\nstored. The other portions relevant to routing policy of a channel are stored\nwithin a ChannelEdgePolicy for each direction of the channel."