Merge pull request #1774 from lightninglabs/fix/rfq-order-optional-peer

rfqrpc+rpcserver: fix peer_pub_key doc and simplify comments

Author: ffranr

docs/release-notes/release-notes-0.7.0.md

@@ -35,6 +35,10 @@
   optimized sending to V2 TAP addresses by removing the need for creating
   tombstone outputs on a full-value send (by using interactive transfers for V2
   addresses).
+- [Updated](https://github.com/lightninglabs/taproot-assets/pull/1774) 
+  `BuyOrderRequest` and `SellOrderRequest` proto docs to mark `peer_pub_key` as
+  required. Previously, the field was incorrectly documented as optional.
+  This change corrects the documentation to match the current implementation.
 
 # New Features
 

rpcserver.go

@@ -7715,7 +7715,7 @@ func (r *rpcServer) AddAssetBuyOrder(ctx context.Context,
 		return nil, fmt.Errorf("error unmarshalling buy order: %w", err)
 	}
 
-	// Currently, we require the peer to be specified in the buy order.
+	// Currently, we require the peer to be specified.
 	peer, err := buyOrder.Peer.UnwrapOrErr(
 		fmt.Errorf("buy order peer must be specified"),
 	)
@@ -7932,7 +7932,7 @@ func (r *rpcServer) AddAssetSellOrder(ctx context.Context,
 			err)
 	}
 
-	// Currently, we require the peer to be specified in the buy order.
+	// Currently, we require the peer to be specified.
 	peer, err := sellOrder.Peer.UnwrapOrErr(
 		fmt.Errorf("sell order peer must be specified"),
 	)

taprpc/rfqrpc/rfq.pb.go

@@ -131,8 +131,7 @@ message AddAssetBuyOrderRequest {
     // The unix timestamp in seconds after which the order is no longer valid.
     uint64 expiry = 3;
 
-    // peer_pub_key is an optional field for specifying the public key of the
-    // intended recipient peer for the order.
+    // The public key of the intended recipient peer for the order.
     bytes peer_pub_key = 4;
 
     // timeout_seconds is the number of seconds to wait for the peer to respond
@@ -183,8 +182,7 @@ message AddAssetSellOrderRequest {
     // The unix timestamp in seconds after which the order is no longer valid.
     uint64 expiry = 3;
 
-    // peer_pub_key is an optional field for specifying the public key of the
-    // intended recipient peer for the order.
+    // The public key of the intended recipient peer for the order.
     bytes peer_pub_key = 4;
 
     // timeout_seconds is the number of seconds to wait for the peer to respond

taprpc/rfqrpc/rfq.proto

@@ -475,7 +475,7 @@
         "peer_pub_key": {
           "type": "string",
           "format": "byte",
-          "description": "peer_pub_key is an optional field for specifying the public key of the\nintended recipient peer for the order."
+          "description": "The public key of the intended recipient peer for the order."
         },
         "timeout_seconds": {
           "type": "integer",
@@ -560,7 +560,7 @@
         "peer_pub_key": {
           "type": "string",
           "format": "byte",
-          "description": "peer_pub_key is an optional field for specifying the public key of the\nintended recipient peer for the order."
+          "description": "The public key of the intended recipient peer for the order."
         },
         "timeout_seconds": {
           "type": "integer",