Merge pull request lightningdevkit#3545 from TheBlueMatt/2024-12-0.1-bindings

0.1 bindings

Author: TheBlueMatt

fuzz/src/chanmon_consistency.rs

@@ -48,13 +48,13 @@ use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
 use lightning::ln::channel_state::ChannelDetails;
 use lightning::ln::channelmanager::{
 	ChainParameters, ChannelManager, ChannelManagerReadArgs, PaymentId, RecentPaymentDetails,
-	RecipientOnionFields, Retry,
 };
 use lightning::ln::functional_test_utils::*;
 use lightning::ln::inbound_payment::ExpandedKey;
 use lightning::ln::msgs::{
 	self, ChannelMessageHandler, CommitmentUpdate, DecodeError, Init, UpdateAddHTLC,
 };
+use lightning::ln::outbound_payment::{RecipientOnionFields, Retry};
 use lightning::ln::script::ShutdownScript;
 use lightning::ln::types::ChannelId;
 use lightning::offers::invoice::UnsignedBolt12Invoice;

fuzz/src/full_stack.rs

@@ -39,12 +39,11 @@ use lightning::chain::transaction::OutPoint;
 use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
 use lightning::events::Event;
 use lightning::ln::channel_state::ChannelDetails;
-use lightning::ln::channelmanager::{
-	ChainParameters, ChannelManager, InterceptId, PaymentId, RecipientOnionFields, Retry,
-};
+use lightning::ln::channelmanager::{ChainParameters, ChannelManager, InterceptId, PaymentId};
 use lightning::ln::functional_test_utils::*;
 use lightning::ln::inbound_payment::ExpandedKey;
 use lightning::ln::msgs::{self, DecodeError};
+use lightning::ln::outbound_payment::{RecipientOnionFields, Retry};
 use lightning::ln::peer_handler::{
 	IgnoringMessageHandler, MessageHandler, PeerManager, SocketDescriptor,
 };

fuzz/src/onion_message.rs

@@ -133,7 +133,7 @@ impl AsyncPaymentsMessageHandler for TestAsyncPaymentsMessageHandler {
 	fn handle_release_held_htlc(&self, _message: ReleaseHeldHtlc, _context: AsyncPaymentsContext) {}
 }
 
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 struct TestCustomMessage {}
 
 const CUSTOM_MESSAGE_TYPE: u64 = 4242;

lightning-background-processor/src/lib.rs

@@ -924,7 +924,7 @@ impl BackgroundProcessor {
 		SC: for<'b> WriteableScore<'b>,
 	>(
 		persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
-		onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
+		onion_messenger: OM, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 		logger: L, scorer: Option<S>,
 	) -> Self
 	where
@@ -961,34 +961,27 @@ impl BackgroundProcessor {
 				}
 				event_handler.handle_event(event)
 			};
+			let om_opt = Some(&*onion_messenger);
 			define_run_body!(
 				persister,
 				chain_monitor,
 				chain_monitor.process_pending_events(&event_handler),
 				channel_manager,
 				channel_manager.get_cm().process_pending_events(&event_handler),
-				onion_messenger,
-				if let Some(om) = &onion_messenger {
-					om.get_om().process_pending_events(&event_handler)
-				},
+				om_opt,
+				onion_messenger.get_om().process_pending_events(&event_handler),
 				peer_manager,
 				gossip_sync,
 				logger,
 				scorer,
 				stop_thread.load(Ordering::Acquire),
 				{
-					let sleeper = if let Some(om) = onion_messenger.as_ref() {
+					let sleeper =
 						Sleeper::from_three_futures(
 							&channel_manager.get_cm().get_event_or_persistence_needed_future(),
 							&chain_monitor.get_update_future(),
-							&om.get_om().get_update_future(),
-						)
-					} else {
-						Sleeper::from_two_futures(
-							&channel_manager.get_cm().get_event_or_persistence_needed_future(),
-							&chain_monitor.get_update_future(),
-						)
-					};
+							&onion_messenger.get_om().get_update_future(),
+						);
 					sleeper.wait_timeout(Duration::from_millis(100));
 				},
 				|_| Instant::now(),
@@ -1141,8 +1134,6 @@ mod tests {
 				Arc<test_utils::TestLogger>,
 				Arc<KeysManager>,
 				Arc<LockingWrapper<TestScorer>>,
-				(),
-				TestScorer,
 			>,
 		>,
 		Arc<
@@ -1412,10 +1403,11 @@ mod tests {
 	}
 
 	impl ScoreLookUp for TestScorer {
+		#[cfg(not(c_bindings))]
 		type ScoreParams = ();
 		fn channel_penalty_msat(
 			&self, _candidate: &CandidateRouteHop, _usage: ChannelUsage,
-			_score_params: &Self::ScoreParams,
+			_score_params: &lightning::routing::scoring::ProbabilisticScoringFeeParameters,
 		) -> u64 {
 			unimplemented!();
 		}

lightning-dns-resolver/src/lib.rs

@@ -162,9 +162,10 @@ mod test {
 	use lightning::blinded_path::message::{BlindedMessagePath, MessageContext};
 	use lightning::blinded_path::NodeIdLookUp;
 	use lightning::events::{Event, PaymentPurpose};
-	use lightning::ln::channelmanager::{PaymentId, Retry};
+	use lightning::ln::channelmanager::PaymentId;
 	use lightning::ln::functional_test_utils::*;
 	use lightning::ln::msgs::{ChannelMessageHandler, Init, OnionMessageHandler};
+	use lightning::ln::outbound_payment::Retry;
 	use lightning::ln::peer_handler::IgnoringMessageHandler;
 	use lightning::onion_message::dns_resolution::{HumanReadableName, OMNameResolver};
 	use lightning::onion_message::messenger::{

lightning-invoice/src/lib.rs

@@ -86,7 +86,9 @@ pub use crate::ser::Base32Iterable;
 #[allow(missing_docs)]
 #[derive(PartialEq, Eq, Debug, Clone)]
 pub enum Bolt11ParseError {
-	Bech32Error(CheckedHrpstringError),
+	Bech32Error(
+		/// This is not exported to bindings users as the specific error isn't all that useful.
+		CheckedHrpstringError),
 	ParseAmountError(ParseIntError),
 	MalformedSignature(bitcoin::secp256k1::Error),
 	BadPrefix,

lightning-liquidity/tests/common/mod.rs

@@ -80,8 +80,6 @@ type ChannelManager = channelmanager::ChannelManager<
 			Arc<test_utils::TestLogger>,
 			Arc<KeysManager>,
 			Arc<LockingWrapper<TestScorer>>,
-			(),
-			TestScorer,
 		>,
 	>,
 	Arc<
@@ -286,10 +284,11 @@ impl lightning::util::ser::Writeable for TestScorer {
 }
 
 impl ScoreLookUp for TestScorer {
+	#[cfg(not(c_bindings))]
 	type ScoreParams = ();
 	fn channel_penalty_msat(
 		&self, _candidate: &CandidateRouteHop, _usage: ChannelUsage,
-		_score_params: &Self::ScoreParams,
+		_score_params: &lightning::routing::scoring::ProbabilisticScoringFeeParameters,
 	) -> u64 {
 		unimplemented!();
 	}

lightning-transaction-sync/src/electrum.rs

@@ -5,6 +5,8 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
+//! Chain sync using the electrum protocol
+
 use crate::common::{ConfirmedTx, FilterQueue, SyncState};
 use crate::error::{InternalError, TxSyncError};
 

lightning-transaction-sync/src/error.rs

@@ -5,6 +5,8 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
+//! Common error types
+
 use std::fmt;
 
 #[derive(Debug)]

lightning-transaction-sync/src/esplora.rs

@@ -5,6 +5,8 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
+//! Chain sync using the Esplora API
+
 use crate::common::{ConfirmedTx, FilterQueue, SyncState};
 use crate::error::{InternalError, TxSyncError};
 

lightning-transaction-sync/src/lib.rs

@@ -72,15 +72,15 @@
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 
 #[cfg(any(feature = "esplora-blocking", feature = "esplora-async"))]
-mod esplora;
+pub mod esplora;
 
 #[cfg(any(feature = "electrum"))]
-mod electrum;
+pub mod electrum;
 
 #[cfg(any(feature = "esplora-blocking", feature = "esplora-async", feature = "electrum"))]
 mod common;
 #[cfg(any(feature = "esplora-blocking", feature = "esplora-async", feature = "electrum"))]
-mod error;
+pub mod error;
 #[cfg(any(feature = "esplora-blocking", feature = "esplora-async", feature = "electrum"))]
 pub use error::TxSyncError;
 

lightning-types/src/features.rs

@@ -638,6 +638,7 @@ pub struct Features<T: sealed::Context> {
 	mark: PhantomData<T>,
 }
 
+/// This is not exported to bindings users but probably should be.
 impl<T: sealed::Context, Rhs: Borrow<Self>> core::ops::BitOrAssign<Rhs> for Features<T> {
 	fn bitor_assign(&mut self, rhs: Rhs) {
 		let total_feature_len = cmp::max(self.flags.len(), rhs.borrow().flags.len());
@@ -648,6 +649,7 @@ impl<T: sealed::Context, Rhs: Borrow<Self>> core::ops::BitOrAssign<Rhs> for Feat
 	}
 }
 
+/// This is not exported to bindings users but probably should be.
 impl<T: sealed::Context> core::ops::BitOr for Features<T> {
 	type Output = Self;
 

lightning/src/blinded_path/message.rs

@@ -143,13 +143,12 @@ impl BlindedMessagePath {
 	/// introduction node.
 	///
 	/// Will only modify `self` when returning `Ok`.
-	pub fn advance_path_by_one<NS: Deref, NL: Deref, T>(
+	pub fn advance_path_by_one<NS: Deref, NL: Deref, T: secp256k1::Signing + secp256k1::Verification>(
 		&mut self, node_signer: &NS, node_id_lookup: &NL, secp_ctx: &Secp256k1<T>
 	) -> Result<(), ()>
 	where
 		NS::Target: NodeSigner,
 		NL::Target: NodeIdLookUp,
-		T: secp256k1::Signing + secp256k1::Verification,
 	{
 		let control_tlvs_ss = node_signer.ecdh(Recipient::Node, &self.0.blinding_point, None)?;
 		let rho = onion_utils::gen_rho_from_shared_secret(&control_tlvs_ss.secret_bytes());
@@ -344,7 +343,7 @@ pub enum OffersContext {
 		/// used with an [`InvoiceError`].
 		///
 		/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
-		hmac: Option<Hmac<Sha256>>,
+		hmac: Option<[u8; 32]>,
 	},
 	/// Context used by a [`BlindedMessagePath`] as a reply path for a [`Bolt12Invoice`].
 	///
@@ -369,7 +368,7 @@ pub enum OffersContext {
 		/// used to log the received [`InvoiceError`].
 		///
 		/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
-		hmac: Hmac<Sha256>,
+		hmac: [u8; 32],
 	},
 }
 
@@ -400,7 +399,7 @@ pub enum AsyncPaymentsContext {
 		///
 		/// Prevents the recipient from being able to deanonymize us by creating a blinded path to us
 		/// containing the expected [`PaymentId`].
-		hmac: Hmac<Sha256>,
+		hmac: [u8; 32],
 	},
 }
 

lightning/src/blinded_path/mod.rs

@@ -185,15 +185,15 @@ impl_writeable!(BlindedHop, {
 
 impl Direction {
 	/// Returns the [`NodeId`] from the inputs corresponding to the direction.
-	pub fn select_node_id(&self, node_a: NodeId, node_b: NodeId) -> NodeId {
+	pub(crate) fn select_node_id(&self, node_a: NodeId, node_b: NodeId) -> NodeId {
 		match self {
 			Direction::NodeOne => core::cmp::min(node_a, node_b),
 			Direction::NodeTwo => core::cmp::max(node_a, node_b),
 		}
 	}
 
 	/// Returns the [`PublicKey`] from the inputs corresponding to the direction.
-	pub fn select_pubkey<'a>(&self, node_a: &'a PublicKey, node_b: &'a PublicKey) -> &'a PublicKey {
+	pub(crate) fn select_pubkey<'a>(&self, node_a: &'a PublicKey, node_b: &'a PublicKey) -> &'a PublicKey {
 		let (node_one, node_two) = if NodeId::from_pubkey(node_a) < NodeId::from_pubkey(node_b) {
 			(node_a, node_b)
 		} else {

lightning/src/blinded_path/payment.rs

@@ -95,7 +95,7 @@ impl BlindedPaymentPath {
 		// be in relation to a specific channel.
 		let htlc_maximum_msat = u64::max_value();
 		Self::new(
-			&[], payee_node_id, payee_tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta,
+			Vec::new(), payee_node_id, payee_tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta,
 			entropy_source, secp_ctx
 		)
 	}
@@ -108,7 +108,7 @@ impl BlindedPaymentPath {
 	/// * any unknown features are required in the provided [`ForwardTlvs`]
 	//  TODO: make all payloads the same size with padding + add dummy hops
 	pub fn new<ES: Deref, T: secp256k1::Signing + secp256k1::Verification>(
-		intermediate_nodes: &[PaymentForwardNode], payee_node_id: PublicKey,
+		intermediate_nodes: Vec<PaymentForwardNode>, payee_node_id: PublicKey,
 		payee_tlvs: ReceiveTlvs, htlc_maximum_msat: u64, min_final_cltv_expiry_delta: u16,
 		entropy_source: ES, secp_ctx: &Secp256k1<T>,
 	) -> Result<Self, ()> where ES::Target: EntropySource {
@@ -119,14 +119,14 @@ impl BlindedPaymentPath {
 		let blinding_secret = SecretKey::from_slice(&blinding_secret_bytes[..]).expect("RNG is busted");
 
 		let blinded_payinfo = compute_payinfo(
-			intermediate_nodes, &payee_tlvs.tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta
+			&intermediate_nodes, &payee_tlvs.tlvs, htlc_maximum_msat, min_final_cltv_expiry_delta
 		)?;
 		Ok(Self {
 			inner_path: BlindedPath {
 				introduction_node,
 				blinding_point: PublicKey::from_secret_key(secp_ctx, &blinding_secret),
 				blinded_hops: blinded_hops(
-					secp_ctx, intermediate_nodes, payee_node_id, payee_tlvs, &blinding_secret
+					secp_ctx, &intermediate_nodes, payee_node_id, payee_tlvs, &blinding_secret
 				).map_err(|_| ())?,
 			},
 			payinfo: blinded_payinfo
@@ -162,13 +162,12 @@ impl BlindedPaymentPath {
 	/// introduction node.
 	///
 	/// Will only modify `self` when returning `Ok`.
-	pub fn advance_path_by_one<NS: Deref, NL: Deref, T>(
+	pub fn advance_path_by_one<NS: Deref, NL: Deref, T: secp256k1::Signing + secp256k1::Verification>(
 		&mut self, node_signer: &NS, node_id_lookup: &NL, secp_ctx: &Secp256k1<T>
 	) -> Result<(), ()>
 	where
 		NS::Target: NodeSigner,
 		NL::Target: NodeIdLookUp,
-		T: secp256k1::Signing + secp256k1::Verification,
 	{
 		let control_tlvs_ss = node_signer.ecdh(Recipient::Node, &self.inner_path.blinding_point, None)?;
 		let rho = onion_utils::gen_rho_from_shared_secret(&control_tlvs_ss.secret_bytes());
@@ -264,7 +263,7 @@ pub struct ReceiveTlvs {
 	/// The TLVs for which the HMAC in `authentication` is derived.
 	pub(crate) tlvs: UnauthenticatedReceiveTlvs,
 	/// An HMAC of `tlvs` along with a nonce used to construct it.
-	pub(crate) authentication: (Hmac<Sha256>, Nonce),
+	pub(crate) authentication: ([u8; 32], Nonce),
 }
 
 impl ReceiveTlvs {

lightning/src/chain/channelmonitor.rs

@@ -854,7 +854,7 @@ pub struct ChannelMonitor<Signer: EcdsaChannelSigner> {
 	pub(super) inner: Mutex<ChannelMonitorImpl<Signer>>,
 }
 
-impl<Signer: EcdsaChannelSigner> Clone for ChannelMonitor<Signer> where Signer: Clone {
+impl<Signer: EcdsaChannelSigner> Clone for ChannelMonitor<Signer> {
 	fn clone(&self) -> Self {
 		let inner = self.inner.lock().unwrap().clone();
 		ChannelMonitor::from_impl(inner)
@@ -4735,8 +4735,8 @@ where
 
 const MAX_ALLOC_SIZE: usize = 64*1024;
 
-impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP)>
-		for (BlockHash, ChannelMonitor<SP::EcdsaSigner>) {
+impl<'a, 'b, ES: EntropySource, Signer: EcdsaChannelSigner, SP: SignerProvider<EcdsaSigner=Signer>> ReadableArgs<(&'a ES, &'b SP)>
+		for (BlockHash, ChannelMonitor<Signer>) {
 	fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
 		macro_rules! unwrap_obj {
 			($key: expr) => {

lightning/src/events/bump_transaction.rs

@@ -275,6 +275,8 @@ impl Utxo {
 	}
 
 	/// Returns a `Utxo` with the `satisfaction_weight` estimate for a P2WPKH nested in P2SH output.
+	///
+	/// This is not exported to bindings users as WPubkeyHash is not yet exported
 	pub fn new_nested_p2wpkh(outpoint: OutPoint, value: Amount, pubkey_hash: &WPubkeyHash) -> Self {
 		let script_sig_size = 1 /* script_sig length */ +
 			1 /* OP_0 */ +
@@ -291,6 +293,8 @@ impl Utxo {
 	}
 
 	/// Returns a `Utxo` with the `satisfaction_weight` estimate for a SegWit v0 P2WPKH output.
+	///
+	/// This is not exported to bindings users as WPubkeyHash is not yet exported
 	pub fn new_v0_p2wpkh(outpoint: OutPoint, value: Amount, pubkey_hash: &WPubkeyHash) -> Self {
 		Self {
 			outpoint,

lightning/src/ln/bolt11_payment.rs

@@ -12,7 +12,7 @@
 use bitcoin::hashes::Hash;
 use lightning_invoice::Bolt11Invoice;
 
-use crate::ln::channelmanager::RecipientOnionFields;
+use crate::ln::outbound_payment::RecipientOnionFields;
 use crate::routing::router::{PaymentParameters, RouteParameters};
 use crate::types::payment::PaymentHash;
 
@@ -161,9 +161,10 @@ mod tests {
 	#[test]
 	fn payment_metadata_end_to_end() {
 		use crate::events::Event;
-		use crate::ln::channelmanager::{PaymentId, Retry};
+		use crate::ln::channelmanager::PaymentId;
 		use crate::ln::functional_test_utils::*;
 		use crate::ln::msgs::ChannelMessageHandler;
+		use crate::ln::outbound_payment::Retry;
 
 		// Test that a payment metadata read from an invoice passed to `pay_invoice` makes it all
 		// the way out through the `PaymentClaimable` event.