Skip to content

Commit 47c57a2

Browse files
committed
taprpc: update AddInvoice docs
Since we now support setting the existing fields value/value_msat we need to update the godoc in order to reflect the new behavior to the RPC user.
1 parent 89e1069 commit 47c57a2

File tree

3 files changed

+19
-13
lines changed

3 files changed

+19
-13
lines changed

taprpc/tapchannelrpc/tapchannel.pb.go

Lines changed: 9 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

taprpc/tapchannelrpc/tapchannel.proto

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -175,13 +175,16 @@ message AddInvoiceRequest {
175175
// there are multiple channels with the given asset ID.
176176
bytes peer_pubkey = 3;
177177

178-
// The full lnd invoice request to send. All fields (except for the value
179-
// and the route hints) behave the same way as they do for lnd's
180-
// lnrpc.AddInvoice RPC method (see the API docs at
178+
// The full lnd invoice request to send. All fields behave the same way as
179+
// they do for lnd's lnrpc.AddInvoice RPC method (see the API docs at
181180
// https://lightning.engineering/api-docs/api/lnd/lightning/add-invoice
182-
// for more details). The value/value_msat fields will be overwritten by the
183-
// satoshi (or milli-satoshi) equivalent of the asset amount, after
184-
// negotiating a quote with a peer that supports the given asset ID.
181+
// for more details).
182+
//
183+
// Only one of the asset_amount/value/value_msat may be set to dictate the
184+
// value of the invoice. When using asset_amount, the value/value_msat
185+
// fields will be overwritten by the satoshi (or milli-satoshi) equivalent
186+
// of the asset amount, after negotiating a quote with a peer that supports
187+
// the given asset ID.
185188
lnrpc.Invoice invoice_request = 4;
186189

187190
// If set, then this will make the invoice created a hodl invoice, which

taprpc/tapchannelrpc/tapchannel.swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1507,7 +1507,7 @@
15071507
},
15081508
"invoice_request": {
15091509
"$ref": "#/definitions/lnrpcInvoice",
1510-
"description": "The full lnd invoice request to send. All fields (except for the value\nand the route hints) behave the same way as they do for lnd's\nlnrpc.AddInvoice RPC method (see the API docs at\nhttps://lightning.engineering/api-docs/api/lnd/lightning/add-invoice\nfor more details). The value/value_msat fields will be overwritten by the\nsatoshi (or milli-satoshi) equivalent of the asset amount, after\nnegotiating a quote with a peer that supports the given asset ID."
1510+
"description": "The full lnd invoice request to send. All fields behave the same way as\nthey do for lnd's lnrpc.AddInvoice RPC method (see the API docs at\nhttps://lightning.engineering/api-docs/api/lnd/lightning/add-invoice\nfor more details).\n\nOnly one of the asset_amount/value/value_msat may be set to dictate the\nvalue of the invoice. When using asset_amount, the value/value_msat\nfields will be overwritten by the satoshi (or milli-satoshi) equivalent\nof the asset amount, after negotiating a quote with a peer that supports\nthe given asset ID."
15111511
},
15121512
"hodl_invoice": {
15131513
"$ref": "#/definitions/tapchannelrpcHodlInvoice",

0 commit comments

Comments
 (0)