Skip to content

rfqrpc+rpcserver: fix peer_pub_key doc and simplify comments #1774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 3, 2025
Merged

rfqrpc+rpcserver: fix peer_pub_key doc and simplify comments #1774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ca81c1
rfqrpc: update peer_pub_key comments to reflect required status
ffranr Aug 28, 2025
815feba
rpcserver: simplify comments and fix incorrect order reference
ffranr Aug 28, 2025
d1bc9e4
docs: add release notes
ffranr Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/release-notes/release-notes-0.7.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions rpcserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
)
Expand Down Expand Up @@ -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"),
)
Expand Down
6 changes: 2 additions & 4 deletions taprpc/rfqrpc/rfq.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions taprpc/rfqrpc/rfq.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions taprpc/rfqrpc/rfq.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
Loading