commands: cli commands for sendonionmessage and subscribeonionmessage

cmd/commands/cmd_onion_message.go

@@ -0,0 +1,95 @@
+package commands
+
+import (
+	"encoding/hex"
+	"fmt"
+
+	"github.com/lightningnetwork/lnd/lnrpc"
+	"github.com/urfave/cli"
+)
+
+var sendOnionMessageCommand = cli.Command{
+	Name:     "sendonionmessage",
+	Category: "Peers",
+	Usage:    "Send an onion message to a peer",
+	Flags: []cli.Flag{
+		cli.StringFlag{
+			Name: "peer",
+		},
+		cli.StringFlag{
+			Name: "path_key",
+		},
+		cli.StringFlag{
+			Name: "onion",
+		},
+	},
+	Action: actionDecorator(sendOnionMessage),
+}
+
+// sendOnionMessage sends an onion message to a peer.
+func sendOnionMessage(ctx *cli.Context) error {
+	ctxc := getContext()
+	client, cleanUp := getClient(ctx)
+	defer cleanUp()
+
+	peer, err := hex.DecodeString(ctx.String("peer"))
+	if err != nil {
+		return fmt.Errorf("invalid peer hex: %w", err)
+	}
+
+	pathKey, err := hex.DecodeString(ctx.String("path_key"))
+	if err != nil {
+		return fmt.Errorf("invalid path_key hex: %w", err)
+	}
+
+	onion, err := hex.DecodeString(ctx.String("onion"))
+	if err != nil {
+		return fmt.Errorf("invalid onion hex: %w", err)
+	}
+
+	resp, err := client.SendOnionMessage(
+		ctxc, &lnrpc.SendOnionMessageRequest{
+			Peer:    peer,
+			PathKey: pathKey,
+			Onion:   onion,
+		},
+	)
+
+	if err != nil {
+		return err
+	}
+
+	printRespJSON(resp)
+
+	return nil
+}
+
+var subscribeOnionMessageCommand = cli.Command{
+	Name:     "subscribeonionmessage",
+	Category: "Peers",
+	Usage:    "Subscribe to incoming onion messages",
+	Action:   actionDecorator(subscribeOnionMessage),
+}
+
+// subscribeOnionMessage subscribes to incoming onion messages.
+func subscribeOnionMessage(ctx *cli.Context) error {
+	ctxc := getContext()
+	client, cleanUp := getClient(ctx)
+	defer cleanUp()
+
+	stream, err := client.SubscribeOnionMessages(
+		ctxc, &lnrpc.SubscribeOnionMessagesRequest{},
+	)
+	if err != nil {
+		return err
+	}
+
+	for {
+		msg, err := stream.Recv()
+		if err != nil {
+			return err
+		}
+
+		printRespJSON(msg)
+	}
+}

cmd/commands/main.go

@@ -513,6 +513,8 @@ func Main() {
 		deletePaymentsCommand,
 		sendCustomCommand,
 		subscribeCustomCommand,
+		sendOnionMessageCommand,
+		subscribeOnionMessageCommand,
 		fishCompletionCommand,
 		listAliasesCommand,
 		estimateRouteFeeCommand,

docs/release-notes/release-notes-0.21.0.md

@@ -98,6 +98,9 @@
 * The `estimatefee` command now supports the `--utxos` flag to specify explicit
   inputs for fee estimation.
 
+* [`SendOnionMessage` and `SubscribeOnionMessages`](https://github.com/lightningnetwork/lnd/pull/10560)
+  RPCs now have corresponding `lncli` commands.
+
 # Improvements
 ## Functional Updates
 
@@ -177,6 +180,7 @@
 
 # Contributors (Alphabetical Order)
 
+* Abdulkbk
 * Boris Nagaev
 * Elle Mouton
 * Erick Cestari

lnrpc/lightning.proto

@@ -597,13 +597,13 @@ service Lightning {
     rpc SubscribeCustomMessages (SubscribeCustomMessagesRequest)
         returns (stream CustomMessage);
 
-    /* lncli: `sendonion`
+    /* lncli: `sendonionmessage`
     SendOnionMessage sends an onion message to a peer.
     */
     rpc SendOnionMessage (SendOnionMessageRequest)
         returns (SendOnionMessageResponse);
 
-    /* lncli: `subscribeonion`
+    /* lncli: `subscribeonionmessage`
     SubscribeOnionMessages subscribes to a stream of incoming onion messages.
     */
     rpc SubscribeOnionMessages (SubscribeOnionMessagesRequest)

lnrpc/lightning.swagger.json

@@ -2266,7 +2266,7 @@
     },
     "/v1/onionmessage": {
       "post": {
-        "summary": "lncli: `sendonion`\nSendOnionMessage sends an onion message to a peer.",
+        "summary": "lncli: `sendonionmessage`\nSendOnionMessage sends an onion message to a peer.",
         "operationId": "Lightning_SendOnionMessage",
         "responses": {
           "200": {
@@ -2299,7 +2299,7 @@
     },
     "/v1/onionmessage/subscribe": {
       "get": {
-        "summary": "lncli: `subscribeonion`\nSubscribeOnionMessages subscribes to a stream of incoming onion messages.",
+        "summary": "lncli: `subscribeonionmessage`\nSubscribeOnionMessages subscribes to a stream of incoming onion messages.",
         "operationId": "Lightning_SubscribeOnionMessages",
         "responses": {
           "200": {