Skip to content

Commit cb13676

Browse files
GeorgeTsagkguggero
authored andcommitted
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 ce6a485 commit cb13676

File tree

3 files changed

+25
-13
lines changed

3 files changed

+25
-13
lines changed

taprpc/tapchannelrpc/tapchannel.pb.go

+12-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

taprpc/tapchannelrpc/tapchannel.proto

+12-6
Original file line numberDiff line numberDiff line change
@@ -184,13 +184,19 @@ message AddInvoiceRequest {
184184
// there are multiple channels with the given asset ID.
185185
bytes peer_pubkey = 3;
186186

187-
// The full lnd invoice request to send. All fields (except for the value
188-
// and the route hints) behave the same way as they do for lnd's
189-
// lnrpc.AddInvoice RPC method (see the API docs at
187+
// The full lnd invoice request to send. All fields behave the same way as
188+
// they do for lnd's lnrpc.AddInvoice RPC method (see the API docs at
190189
// https://lightning.engineering/api-docs/api/lnd/lightning/add-invoice
191-
// for more details). The value/value_msat fields will be overwritten by the
192-
// satoshi (or milli-satoshi) equivalent of the asset amount, after
193-
// negotiating a quote with a peer that supports the given asset ID.
190+
// for more details).
191+
//
192+
// Only one of the asset_amount/value/value_msat may be set to dictate the
193+
// value of the invoice. When using asset_amount, the value/value_msat
194+
// fields will be overwritten by the satoshi (or milli-satoshi) equivalent
195+
// of the asset amount, after negotiating a quote with a peer that supports
196+
// the given asset ID.
197+
//
198+
// If the value/value_msat are used, we still receive assets, but they will
199+
// exactly evaluate to the defined amount in sats/msats.
194200
lnrpc.Invoice invoice_request = 4;
195201

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

taprpc/tapchannelrpc/tapchannel.swagger.json

+1-1
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.\n\nIf the value/value_msat are used, we still receive assets, but they will\nexactly evaluate to the defined amount in sats/msats."
15111511
},
15121512
"hodl_invoice": {
15131513
"$ref": "#/definitions/tapchannelrpcHodlInvoice",

0 commit comments

Comments
 (0)