Merge pull request #71 from johncantrell97/user-channel-id

allow user selected user_channel_id

Author: tnull

src/lsps2/client.rs

@@ -27,7 +27,7 @@ use core::ops::Deref;
 
 use crate::lsps2::msgs::{
 	BuyRequest, BuyResponse, GetInfoRequest, GetInfoResponse, GetVersionsRequest,
-	GetVersionsResponse, JITChannelScid, LSPS2Message, LSPS2Request, LSPS2Response,
+	GetVersionsResponse, InterceptScid, LSPS2Message, LSPS2Request, LSPS2Response,
 	OpeningFeeParams,
 };
 
@@ -57,7 +57,7 @@ enum InboundJITChannelState {
 	MenuRequested { version: u16 },
 	PendingMenuSelection { version: u16 },
 	BuyRequested { version: u16 },
-	PendingPayment { client_trusts_lsp: bool, short_channel_id: JITChannelScid },
+	PendingPayment { client_trusts_lsp: bool, intercept_scid: InterceptScid },
 }
 
 impl InboundJITChannelState {
@@ -108,11 +108,11 @@ impl InboundJITChannelState {
 	}
 
 	fn invoice_params_received(
-		&self, client_trusts_lsp: bool, short_channel_id: JITChannelScid,
+		&self, client_trusts_lsp: bool, intercept_scid: InterceptScid,
 	) -> Result<Self, ChannelStateError> {
 		match self {
 			InboundJITChannelState::BuyRequested { .. } => {
-				Ok(InboundJITChannelState::PendingPayment { client_trusts_lsp, short_channel_id })
+				Ok(InboundJITChannelState::PendingPayment { client_trusts_lsp, intercept_scid })
 			}
 			state => Err(ChannelStateError(format!(
 				"Invoice params received when JIT Channel was in state: {:?}",
@@ -167,9 +167,9 @@ impl InboundJITChannel {
 	}
 
 	fn invoice_params_received(
-		&mut self, client_trusts_lsp: bool, jit_channel_scid: JITChannelScid,
+		&mut self, client_trusts_lsp: bool, intercept_scid: InterceptScid,
 	) -> Result<(), LightningError> {
-		self.state = self.state.invoice_params_received(client_trusts_lsp, jit_channel_scid)?;
+		self.state = self.state.invoice_params_received(client_trusts_lsp, intercept_scid)?;
 		Ok(())
 	}
 }
@@ -519,17 +519,17 @@ where
 
 				if let Err(e) = jit_channel.invoice_params_received(
 					result.client_trusts_lsp,
-					result.jit_channel_scid.clone(),
+					result.intercept_scid.clone(),
 				) {
 					peer_state.remove_inbound_channel(jit_channel_id);
 					return Err(e);
 				}
 
-				if let Ok(scid) = result.jit_channel_scid.to_scid() {
+				if let Ok(intercept_scid) = result.intercept_scid.to_scid() {
 					self.pending_events.enqueue(Event::LSPS2Client(
 						LSPS2ClientEvent::InvoiceGenerationReady {
 							counterparty_node_id: *counterparty_node_id,
-							scid,
+							intercept_scid,
 							cltv_expiry_delta: result.lsp_cltv_expiry_delta,
 							payment_size_msat: jit_channel.config.payment_size_msat,
 							client_trusts_lsp: result.client_trusts_lsp,
@@ -539,8 +539,8 @@ where
 				} else {
 					return Err(LightningError {
 						err: format!(
-							"Received buy response with an invalid scid {:?}",
-							result.jit_channel_scid
+							"Received buy response with an invalid intercept scid {:?}",
+							result.intercept_scid
 						),
 						action: ErrorAction::IgnoreAndLog(Level::Info),
 					});

src/lsps2/event.rs

@@ -52,8 +52,8 @@ pub enum LSPS2ClientEvent {
 	InvoiceGenerationReady {
 		/// The node id of the LSP.
 		counterparty_node_id: PublicKey,
-		/// The short channel id to use in the route hint.
-		scid: u64,
+		/// The intercept short channel id to use in the route hint.
+		intercept_scid: u64,
 		/// The `cltv_expiry_delta` to use in the route hint.
 		cltv_expiry_delta: u32,
 		/// The initial payment size you specified.
@@ -98,7 +98,7 @@ pub enum LSPS2ServiceEvent {
 	/// If `payment_size_msat` is [`Option::Some`] then the payer is allowed to use MPP.
 	/// If `payment_size_msat` is [`Option::None`] then the payer cannot use MPP.
 	///
-	/// You must generate an scid and `cltv_expiry_delta` for them to use
+	/// You must generate an intercept scid and `cltv_expiry_delta` for them to use
 	/// and call [`LSPS2ServiceHandler::invoice_parameters_generated`].
 	///
 	/// [`LSPS2ServiceHandler::invoice_parameters_generated`]: crate::lsps2::service::LSPS2ServiceHandler::invoice_parameters_generated
@@ -126,7 +126,9 @@ pub enum LSPS2ServiceEvent {
 		amt_to_forward_msat: u64,
 		/// The fee earned for opening the channel.
 		opening_fee_msat: u64,
-		/// An internal id used to track channel open.
+		/// A user specified id used to track channel open.
 		user_channel_id: u128,
+		/// The intercept short channel id to use in the route hint.
+		intercept_scid: u64,
 	},
 }

src/lsps2/msgs.rs

@@ -128,9 +128,9 @@ pub struct BuyRequest {
 
 /// A newtype that holds a `short_channel_id` in human readable format of BBBxTTTx000.
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
-pub struct JITChannelScid(String);
+pub struct InterceptScid(String);
 
-impl From<u64> for JITChannelScid {
+impl From<u64> for InterceptScid {
 	fn from(scid: u64) -> Self {
 		let block = utils::block_from_scid(&scid);
 		let tx_index = utils::tx_index_from_scid(&scid);
@@ -140,8 +140,8 @@ impl From<u64> for JITChannelScid {
 	}
 }
 
-impl JITChannelScid {
-	/// Try to convert a [`JITChannelScid`] into a u64 used by LDK.
+impl InterceptScid {
+	/// Try to convert a [`InterceptScid`] into a u64 used by LDK.
 	pub fn to_scid(&self) -> Result<u64, ()> {
 		utils::scid_from_human_readable_string(&self.0)
 	}
@@ -152,8 +152,8 @@ impl JITChannelScid {
 /// Includes information needed to construct an invoice.
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 pub struct BuyResponse {
-	/// The short channel id used by LSP to identify need to open channel.
-	pub jit_channel_scid: JITChannelScid,
+	/// The intercept short channel id used by LSP to identify need to open channel.
+	pub intercept_scid: InterceptScid,
 	/// The locktime expiry delta the lsp requires.
 	pub lsp_cltv_expiry_delta: u32,
 	/// A flag that indicates who is trusting who.