LSPS1 doc fixes

Author: Srg213

src/lsps1/client.rs

@@ -237,13 +237,11 @@ where
 		}
 	}
 
-	/// Initiate the creation of an invoice that when paid will open a channel
-	/// with enough inbound liquidity to be able to receive the payment.
+	/// Retrieve information from the LSP regarding the options supported.
 	///
 	/// `counterparty_node_id` is the node_id of the LSP you would like to use.
 	///
-	/// `token` is an optional String that will be provided to the LSP.
-	/// It can be used by the LSP as an API key, coupon code, or some other way to identify a user.
+	/// 'channel_id' is the id used to uniquely identify the channel with counterparty node.
 	pub fn request_for_info(&self, counterparty_node_id: PublicKey, channel_id: u128) {
 		let channel = InboundCRChannel::new(channel_id);
 
@@ -321,9 +319,8 @@ where
 		Ok(())
 	}
 
-	/// Used by client to place an order to LSP with the provided parameters.
-	/// The client agrees to paying an channel fees as per requested by
-	/// the LSP.
+	/// Places an order with the connected LSP given its `counterparty_node_id`.
+	/// The client agrees to paying channel fees according to the provided parameters.
 	///
 	/// Should be called in response to receiving a [`LSPS1ClientEvent::GetInfoResponse`] event.
 	///
@@ -481,12 +478,12 @@ where
 		}
 	}
 
-	/// Used by client to check whether payment is received by LSP and status of order.
+	/// Queries the status of a pending payment, i.e., whether a payment has been received by the LSP.
 	///
 	/// Should be called in response to receiving a [`LSPS1ClientEvent::DisplayOrder`] event.
 	///
 	/// [`LSPS1ClientEvent::DisplayOrder`]: crate::lsps1::event::LSPS1ClientEvent::DisplayOrder
-	fn check_order_status(
+	pub fn check_order_status(
 		&self, counterparty_node_id: &PublicKey, order_id: OrderId, channel_id: u128,
 	) -> Result<(), APIError> {
 		let outer_state_lock = self.per_peer_state.write().unwrap();

src/lsps1/event.rs

@@ -21,12 +21,13 @@ use bitcoin::secp256k1::PublicKey;
 pub enum LSPS1ClientEvent {
 	/// Information from the LSP about their supported protocol options.
 	///
-	/// You must check whether LSP supports the params the client wants and then call
+	/// You must check whether LSP supports the parameters the client wants and then call
 	/// [`LSPS1ClientHandler::place_order`] to place an order.
 	///
-	/// [`LSPS1ClientHandler::place_order`] : crate::lsps1::client::LSPS1ClientHandler::place_order
+	/// [`LSPS1ClientHandler::place_order`]: crate::lsps1::client::LSPS1ClientHandler::place_order
 	GetInfoResponse {
 		/// This is a randomly generated identifier used to track the channel state.
+		///
 		/// It is not related in anyway to the eventual lightning channel id.
 		/// It needs to be passed to [`LSPS1ClientHandler::place_order`].
 		///
@@ -43,7 +44,7 @@ pub enum LSPS1ClientEvent {
 	},
 	/// Confirmation from the LSP about the order created by the client.
 	///
-	/// When the invoice is paid, the LSP will open a channel to you
+	/// When the payment is confirmed, the LSP will open a channel to you
 	/// with the below agreed upon parameters.
 	///
 	/// You must pay the invoice if you want to continue and then
@@ -72,8 +73,8 @@ pub enum LSPS1ClientEvent {
 /// An event which an LSPS1 server should take some action in response to.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum LSPS1ServiceEvent {
-	/// A client has selected the parameters to use from the supported options of LSP
-	/// and would like to open a channel with the given invoice.
+	/// A client has selected the parameters to use from the supported options of the LSP
+	/// and would like to open a channel with the given payment parameters.
 	///
 	/// You must call [`LSPS1ServiceHandler::send_invoice_for_order`] to
 	/// generate a complete invoice including the details regarding the
@@ -97,7 +98,7 @@ pub enum LSPS1ServiceEvent {
 	/// You must call [`LSPS1ServiceHandler::update_order_status`] to update the client
 	/// regarding the status of the payment and order.
 	///
-	/// [`LSPS1ServiceHandler::send_invoice_for_order`]: crate::lsps1::service::LSPS1ServiceHandler::send_invoice_for_order
+	/// [`LSPS1ServiceHandler::update_order_status`]: crate::lsps1::service::LSPS1ServiceHandler::update_order_status
 	CheckPaymentConfirmation {
 		/// An identifier that must be passed to [`LSPS1ServiceHandler::update_order_status`].
 		///