feat: support push_asset_amount on RGB channel open

bitwalt · bitwalt · commit ea151249bc79 · 2026-03-12T13:31:45.000+01:00
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
@@ -2357,6 +2357,12 @@ pub(crate) struct FundingScope {
 	/// The minimum number of confirmations before the funding is locked. If set, this will override
 	/// [`ChannelContext::minimum_depth`].
 	minimum_depth_override: Option<u32>,
+
+	/// The consignment endpoint used to exchange the RGB consignment.
+	pub(super) consignment_endpoint: Option<RgbTransport>,
+
+	/// The RGB asset amount to push to the counterparty on channel open.
+	pub(super) push_asset_amount: Option<u64>,
 }
 
 impl Writeable for FundingScope {
@@ -2371,6 +2377,8 @@ impl Writeable for FundingScope {
 			(13, self.funding_tx_confirmation_height, required),
 			(15, self.short_channel_id, option),
 			(17, self.minimum_depth_override, option),
+			(19, self.consignment_endpoint, option),
+			(21, self.push_asset_amount, option),
 		});
 		Ok(())
 	}
@@ -2388,6 +2396,8 @@ impl Readable for FundingScope {
 		let mut funding_tx_confirmation_height = RequiredWrapper(None);
 		let mut short_channel_id = None;
 		let mut minimum_depth_override = None;
+		let mut consignment_endpoint = None;
+		let mut push_asset_amount = None;
 
 		read_tlv_fields!(reader, {
 			(1, value_to_self_msat, required),
@@ -2399,6 +2409,8 @@ impl Readable for FundingScope {
 			(13, funding_tx_confirmation_height, required),
 			(15, short_channel_id, option),
 			(17, minimum_depth_override, option),
+			(19, consignment_endpoint, option),
+			(21, push_asset_amount, option),
 		});
 
 		Ok(Self {
@@ -2415,6 +2427,8 @@ impl Readable for FundingScope {
 			funding_tx_confirmation_height: funding_tx_confirmation_height.0.unwrap(),
 			short_channel_id,
 			minimum_depth_override,
+			consignment_endpoint,
+			push_asset_amount,
 			#[cfg(any(test, fuzzing))]
 			next_local_fee: Mutex::new(PredictedNextFee::default()),
 			#[cfg(any(test, fuzzing))]
@@ -2602,6 +2616,8 @@ impl FundingScope {
 			funding_tx_confirmed_in: None,
 			minimum_depth_override: None,
 			short_channel_id: None,
+			consignment_endpoint: None,
+			push_asset_amount: None,
 		}
 	}
 
@@ -3128,8 +3144,7 @@ where
 	/// promotion.
 	pub interactive_tx_signing_session: Option<InteractiveTxSigningSession>,
 
-	/// The consignment endpoint used to exchange the RGB consignment
-	pub(super) consignment_endpoint: Option<RgbTransport>,
+	pub(super) is_colored: bool,
 
 	pub(crate) ldk_data_dir: PathBuf,
 }
@@ -3400,6 +3415,7 @@ where
 		msg_channel_reserve_satoshis: u64,
 		msg_push_msat: u64,
 		open_channel_fields: msgs::CommonOpenChannelFields,
+		push_asset_amount: Option<u64>,
 		ldk_data_dir: PathBuf,
 	) -> Result<(FundingScope, ChannelContext<SP>), ChannelError>
 		where
@@ -3608,6 +3624,8 @@ where
 			funding_tx_confirmation_height: 0,
 			short_channel_id: None,
 			minimum_depth_override: None,
+			consignment_endpoint: open_channel_fields.consignment_endpoint.clone(),
+			push_asset_amount,
 		};
 		let channel_context = ChannelContext {
 			user_id,
@@ -3721,7 +3739,7 @@ where
 
 			interactive_tx_signing_session: None,
 
-			consignment_endpoint: open_channel_fields.consignment_endpoint,
+			is_colored: funding.consignment_endpoint.is_some(),
 			ldk_data_dir,
 		};
 
@@ -3748,6 +3766,7 @@ where
 		_logger: L,
 		consignment_endpoint: Option<RgbTransport>,
 		ldk_data_dir: PathBuf,
+		push_asset_amount: Option<u64>,
 	) -> Result<(FundingScope, ChannelContext<SP>), APIError>
 		where
 			ES::Target: EntropySource,
@@ -3853,6 +3872,8 @@ where
 			funding_tx_confirmation_height: 0,
 			short_channel_id: None,
 			minimum_depth_override: None,
+			consignment_endpoint: consignment_endpoint.clone(),
+			push_asset_amount,
 		};
 		let channel_context = Self {
 			user_id,
@@ -3964,7 +3985,7 @@ where
 
 			interactive_tx_signing_session: None,
 
-			consignment_endpoint,
+			is_colored: funding.consignment_endpoint.is_some(),
 			ldk_data_dir,
 		};
 
@@ -3992,7 +4013,7 @@ where
 	}
 
 	pub fn is_colored(&self) -> bool {
-		self.consignment_endpoint.is_some()
+		self.is_colored
 	}
 
 	/// Gets the fee we'd want to charge for adding an HTLC output to this Channel
@@ -13549,7 +13570,7 @@ where
 	pub fn new<ES: Deref, F: Deref, L: Deref>(
 		fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP, counterparty_node_id: PublicKey, their_features: &InitFeatures,
 		channel_value_satoshis: u64, push_msat: u64, user_id: u128, config: &UserConfig, current_chain_height: u32,
-		outbound_scid_alias: u64, temporary_channel_id: Option<ChannelId>, logger: L, consignment_endpoint: Option<RgbTransport>, ldk_data_dir: PathBuf,
+		outbound_scid_alias: u64, temporary_channel_id: Option<ChannelId>, logger: L, consignment_endpoint: Option<RgbTransport>, ldk_data_dir: PathBuf, push_asset_amount: Option<u64>,
 	) -> Result<OutboundV1Channel<SP>, APIError>
 	where ES::Target: EntropySource,
 	      F::Target: FeeEstimator,
@@ -13589,6 +13610,7 @@ where
 			logger,
 			consignment_endpoint,
 			ldk_data_dir,
+			push_asset_amount,
 		)?;
 		let unfunded_context = UnfundedChannelContext {
 			unfunded_channel_age_ticks: 0,
@@ -13766,10 +13788,11 @@ where
 					None => Builder::new().into_script(),
 				}),
 				channel_type: Some(self.funding.get_channel_type().clone()),
-				consignment_endpoint: self.context.consignment_endpoint.clone(),
+				consignment_endpoint: self.funding.consignment_endpoint.clone(),
 			},
 			push_msat: self.funding.get_value_satoshis() * 1000 - self.funding.value_to_self_msat,
 			channel_reserve_satoshis: self.funding.holder_selected_channel_reserve_satoshis,
+			push_asset_amount: self.funding.push_asset_amount,
 		})
 	}
 
@@ -13965,6 +13988,7 @@ where
 			msg.channel_reserve_satoshis,
 			msg.push_msat,
 			msg.common_fields.clone(),
+			msg.push_asset_amount,
 			ldk_data_dir,
 		)?;
 		let unfunded_context = UnfundedChannelContext {
@@ -14209,6 +14233,7 @@ where
 			// ok to pass consignment_endpoint as None since this method is unused
 			None,
 			ldk_data_dir,
+			None,
 		)?;
 		let unfunded_context = UnfundedChannelContext {
 			unfunded_channel_age_ticks: 0,
@@ -14300,7 +14325,7 @@ where
 					None => Builder::new().into_script(),
 				}),
 				channel_type: Some(self.funding.get_channel_type().clone()),
-				consignment_endpoint: self.context.consignment_endpoint.clone(),
+				consignment_endpoint: self.funding.consignment_endpoint.clone(),
 			},
 			funding_feerate_sat_per_1000_weight: self.context.feerate_per_kw,
 			second_per_commitment_point,
@@ -14364,6 +14389,7 @@ where
 			counterparty_selected_channel_reserve_satoshis,
 			0 /* push_msat not used in dual-funding */,
 			msg.common_fields.clone(),
+			None,
 			ldk_data_dir,
 		)?;
 		let channel_id = ChannelId::v2_from_revocation_basepoints(
@@ -15047,7 +15073,8 @@ where
 			(65, self.quiescent_action, option), // Added in 0.2
 			(67, pending_outbound_held_htlc_flags, optional_vec), // Added in 0.2
 			(69, holding_cell_held_htlc_flags, optional_vec), // Added in 0.2
-			(71, self.context.consignment_endpoint, option),
+			(71, self.funding.consignment_endpoint, option),
+			(73, self.funding.push_asset_amount, option),
 		});
 
 		Ok(())
@@ -15384,6 +15411,7 @@ where
 		let mut temporary_channel_id: Option<ChannelId> = None;
 		let mut holder_max_accepted_htlcs: Option<u16> = None;
 		let mut consignment_endpoint: Option<RgbTransport> = None;
+		let mut push_asset_amount: Option<u64> = None;
 
 		let mut blocked_monitor_updates = Some(Vec::new());
 
@@ -15467,6 +15495,7 @@ where
 			(67, pending_outbound_held_htlc_flags_opt, optional_vec), // Added in 0.2
 			(69, holding_cell_held_htlc_flags_opt, optional_vec), // Added in 0.2
 			(71, consignment_endpoint, option),
+			(73, push_asset_amount, option),
 		});
 
 		let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
@@ -15745,6 +15774,8 @@ where
 				funding_tx_confirmation_height,
 				short_channel_id,
 				minimum_depth_override,
+				consignment_endpoint: consignment_endpoint.clone(),
+				push_asset_amount,
 			},
 			context: ChannelContext {
 				user_id,
@@ -15856,8 +15887,7 @@ where
 				is_manual_broadcast: is_manual_broadcast.unwrap_or(false),
 
 				interactive_tx_signing_session,
-
-				consignment_endpoint,
+				is_colored: consignment_endpoint.is_some(),
 				ldk_data_dir,
 			},
 			holder_commitment_point,
@@ -17848,6 +17878,8 @@ mod tests {
 			funding_tx_confirmation_height: 0,
 			short_channel_id: None,
 			minimum_depth_override: None,
+			consignment_endpoint: None,
+			push_asset_amount: None,
 		};
 		let post_channel_value =
 			funding.compute_post_splice_value(our_funding_contribution, their_funding_contribution);
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
@@ -4134,7 +4134,7 @@ where
 	/// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
 	/// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
 	#[rustfmt::skip]
-	pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, temporary_channel_id: Option<ChannelId>, override_config: Option<UserConfig>, consignment_endpoint: Option<RgbTransport>) -> Result<ChannelId, APIError> {
+	pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, temporary_channel_id: Option<ChannelId>, override_config: Option<UserConfig>, consignment_endpoint: Option<RgbTransport>, push_asset_amount: Option<u64>) -> Result<ChannelId, APIError> {
 		if channel_value_satoshis < 1000 {
 			return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
 		}
@@ -4170,7 +4170,7 @@ where
 			};
 			match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
 				their_features, channel_value_satoshis, push_msat, user_channel_id, config,
-				self.best_block.read().unwrap().height, outbound_scid_alias, temporary_channel_id, &*self.logger, consignment_endpoint, self.ldk_data_dir.clone())
+				self.best_block.read().unwrap().height, outbound_scid_alias, temporary_channel_id, &*self.logger, consignment_endpoint, self.ldk_data_dir.clone(), push_asset_amount)
 			{
 				Ok(res) => res,
 				Err(e) => {
@@ -10386,8 +10386,8 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 			{
 				Some(Ok(inbound_chan)) => {
 					let logger = WithChannelContext::from(&self.logger, &inbound_chan.context, None);
-					if let Some(consignment_endpoint) = &inbound_chan.context.consignment_endpoint {
-						handle_funding(&msg.temporary_channel_id, msg.funding_txid.to_string(), &self.ldk_data_dir, consignment_endpoint.clone())?;
+					if let Some(consignment_endpoint) = &inbound_chan.funding.consignment_endpoint {
+						handle_funding(&msg.temporary_channel_id, msg.funding_txid.to_string(), &self.ldk_data_dir, consignment_endpoint.clone(), inbound_chan.funding.push_asset_amount)?;
 					}
 					match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &&logger) {
 						Ok(res) => res,
diff --git a/lightning/src/ln/msgs.rs b/lightning/src/ln/msgs.rs
@@ -299,6 +299,8 @@ pub struct OpenChannel {
 	pub push_msat: u64,
 	/// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 	pub channel_reserve_satoshis: u64,
+	/// The amount of RGB assets to push to the counterparty as part of the open.
+	pub push_asset_amount: Option<u64>,
 }
 
 /// An [`open_channel2`] message to be sent by or received from the channel initiator.
@@ -3135,6 +3137,7 @@ impl Writeable for OpenChannel {
 			(0, self.common_fields.shutdown_scriptpubkey.as_ref().map(|s| WithoutLength(s)), option), // Don't encode length twice.
 			(1, self.common_fields.channel_type, option),
 			(2, self.common_fields.consignment_endpoint, option),
+			(3, self.push_asset_amount, option),
 		});
 		Ok(())
 	}
@@ -3164,10 +3167,12 @@ impl LengthReadable for OpenChannel {
 		let mut shutdown_scriptpubkey: Option<ScriptBuf> = None;
 		let mut channel_type: Option<ChannelTypeFeatures> = None;
 		let mut consignment_endpoint: Option<RgbTransport> = None;
+		let mut push_asset_amount: Option<u64> = None;
 		decode_tlv_stream!(r, {
 			(0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))),
 			(1, channel_type, option),
 			(2, consignment_endpoint, option),
+			(3, push_asset_amount, option),
 		});
 		Ok(OpenChannel {
 			common_fields: CommonOpenChannelFields {
@@ -3193,6 +3198,7 @@ impl LengthReadable for OpenChannel {
 			},
 			push_msat,
 			channel_reserve_satoshis,
+			push_asset_amount,
 		})
 	}
 }
diff --git a/lightning/src/rgb_utils/mod.rs b/lightning/src/rgb_utils/mod.rs
@@ -655,7 +655,7 @@ pub(crate) fn rename_rgb_files(
 /// Handle funding on the receiver side
 pub(crate) fn handle_funding(
 	temporary_channel_id: &ChannelId, funding_txid: String, ldk_data_dir: &Path,
-	consignment_endpoint: RgbTransport,
+	consignment_endpoint: RgbTransport, push_asset_amount: Option<u64>,
 ) -> Result<(), MsgHandleErrInternal> {
 	let handle = Handle::current();
 	let _ = handle.enter();
@@ -710,16 +710,17 @@ pub(crate) fn handle_funding(
 			*temporary_channel_id,
 		));
 	}
-	let remote_rgb_amount = match remote_rgb_assignments[0] {
+	let channel_rgb_amount = match remote_rgb_assignments[0] {
 		Assignment::Fungible(amt) => amt,
 		Assignment::NonFungible => 1,
 		_ => unreachable!("unsupported schema"),
 	};
+	let push_amount = push_asset_amount.unwrap_or(0);
 	let rgb_info = RgbInfo {
 		contract_id: consignment.contract_id(),
 		schema: AssetSchema::from_schema_id(consignment.schema_id()).unwrap(),
-		local_rgb_amount: 0,
-		remote_rgb_amount,
+		local_rgb_amount: push_amount,
+		remote_rgb_amount: channel_rgb_amount - push_amount,
 	};
 	let temporary_channel_id_str = temporary_channel_id.0.as_hex().to_string();
 	write_rgb_channel_info(
