Documentation for lsps1 #77
Conversation
| id: u128, | ||
| /// TODO | ||
| /// An identifier to track messages received. |
There was a problem hiding this comment.
Why do we need to expose this request id in the events? What do we expect the user to do with it?
There was a problem hiding this comment.
Right. It should not be exposed to user. Removed.
| @@ -254,7 +255,12 @@ where | |||
| Ok(()) | |||
| } | |||
|
|
|||
| fn send_invoice_for_order( | |||
| /// Used by LSP to send invoice containing details regarding the channel fees and payment information. | |||
There was a problem hiding this comment.
I'm confused: this doesn't actually send and invoice (which seems more like the LSPS2-flow anyways), but simply a CreateOrderResponse. What am I missing?
There was a problem hiding this comment.
This simply sends a CreateOrderResponse. Will rename the functions.
There was a problem hiding this comment.
Renamed to send_payment_details.
|
Added commits only related to docs. I will create a new PR for api fixes. |
| /// | ||
| /// `counterparty_node_id` is the node_id of the LSP you would like to use. | ||
| /// | ||
| /// 'channel_id' is the id used to uniquely identify the channel with counterparty node. |
There was a problem hiding this comment.
nit: Wrong ticks used here:
| /// 'channel_id' is the id used to uniquely identify the channel with counterparty node. | |
| /// `channel_id` is the id used to uniquely identify the channel with counterparty node. |
But happy to fix this in a follow up sometime.
Closes #67.