Merge remote-tracking branch 'origin/main' into bolt11-data

.github/workflows/rust.yml

@@ -17,8 +17,6 @@ jobs:
           ]
         toolchain: [
           stable,
-          beta,
-          1.63.0, # Our MSRV
           ]
         include:
           - toolchain: stable
@@ -29,8 +27,6 @@ jobs:
             platform: macos-latest
           - toolchain: stable
             platform: windows-latest
-          - toolchain: 1.63.0
-            msrv: true
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Checkout source code
@@ -65,10 +61,6 @@ jobs:
       - name: Build with UniFFI support on Rust ${{ matrix.toolchain }}
         if: matrix.build-uniffi
         run: cargo build --features uniffi --verbose --color always
-      - name: Build documentation on Rust ${{ matrix.toolchain }}
-        run: |
-          cargo doc --release --verbose --color always
-          cargo doc --document-private-items --verbose --color always
       - name: Check release build on Rust ${{ matrix.toolchain }}
         run: cargo check --release --verbose --color always
       - name: Check release build with UniFFI support on Rust ${{ matrix.toolchain }}

.gitignore

@@ -24,3 +24,5 @@ swift.swiftdoc
 /bindings/swift/LDKNodeFFI.xcframework
 /bindings/kotlin/ldk-node-android/lib/src/main/jniLibs
 /bindings/kotlin/ldk-node-android/lib/src/main/kotlin/org/lightningdevkit/ldknode/ldk_node.kt
+
+/ffi/

Cargo.toml

@@ -99,6 +99,8 @@ uniffi = { version = "0.25.3", features = ["build"], optional = true }
 
 [profile.release]
 panic = "abort"
+lto = true
+rpath = true
 
 [profile.dev]
 panic = "abort"

bindings/ldk_node.udl

@@ -72,7 +72,7 @@ interface LDKNode {
 	[Throws=NodeError]
 	PaymentHash send_payment_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat);
 	[Throws=NodeError]
-	PaymentHash send_spontaneous_payment(u64 amount_msat, PublicKey node_id);
+	PaymentHash send_spontaneous_payment(u64 amount_msat, PublicKey node_id, sequence<TlvEntry> custom_tlvs);
 	[Throws=NodeError]
 	void send_payment_probes([ByRef]Bolt11Invoice invoice);
 	[Throws=NodeError]
@@ -131,6 +131,7 @@ enum NodeError {
 	"InvalidInvoice",
 	"InvalidChannelId",
 	"InvalidNetwork",
+	"InvalidCustomTlv",
 	"DuplicatePayment",
 	"InsufficientFunds",
 	"LiquiditySourceUnavailable",
@@ -316,6 +317,11 @@ enum LogLevel {
 	"Error",
 };
 
+dictionary TlvEntry {
+	u64 type;
+	sequence<u8> value;
+};
+
 [Custom]
 typedef string Txid;
 

scripts/uniffi_bindgen_generate_go.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -e
+
+if ! command -v cross &> /dev/null; then
+  echo "cross-rs is required to build bindings. Install it by running:"
+  echo "  cargo install cross --git https://github.com/cross-rs/cross"
+  exit 1
+fi
+
+uniffi-bindgen-go bindings/ldk_node.udl -o ffi/golang -c ./uniffi.toml
+
+build_lib() {
+  local TOOL=$1
+  local TARGET=$2
+  local OUTPUT_FILE=$3
+
+  $TOOL build --release --target $TARGET --features uniffi || exit 1
+  mkdir -p "ffi/golang/ldk_node/$TARGET" || exit 1
+  cp "target/$TARGET/release/$OUTPUT_FILE" "ffi/golang/ldk_node/$TARGET/" || exit 1
+}
+
+is_target_installed() {
+  local TARGET=$1
+  rustup target list --installed | grep -q $TARGET
+}
+
+# If we're running on macOS, build the macOS library using the host compiler.
+# Cross compilation is not supported (needs more complex setup).
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  build_lib "cargo" "aarch64-apple-darwin" "libldk_node.dylib"
+fi
+
+build_lib "cross" "x86_64-unknown-linux-gnu" "libldk_node.so"
+build_lib "cross" "x86_64-pc-windows-gnu" "ldk_node.dll"

src/error.rs

@@ -61,6 +61,8 @@ pub enum Error {
 	InvalidChannelId,
 	/// The given network is invalid.
 	InvalidNetwork,
+	/// The custom TLVs are invalid.
+	InvalidCustomTlv,
 	/// A payment with the given hash has already been initiated.
 	DuplicatePayment,
 	/// The available funds are insufficient to complete the given operation.
@@ -107,6 +109,7 @@ impl fmt::Display for Error {
 			Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 			Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 			Self::InvalidNetwork => write!(f, "The given network is invalid."),
+			Self::InvalidCustomTlv => write!(f, "The given custom TLVs are invalid."),
 			Self::DuplicatePayment => {
 				write!(f, "A payment with the given hash has already been initiated.")
 			},

src/lib.rs

@@ -134,7 +134,7 @@ use types::{
 	Broadcaster, ChainMonitor, ChannelManager, FeeEstimator, KeysManager, NetworkGraph,
 	PeerManager, Router, Scorer, Sweeper, Wallet,
 };
-pub use types::{ChannelDetails, PeerDetails, UserChannelId};
+pub use types::{ChannelDetails, PeerDetails, TlvEntry, UserChannelId};
 
 use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
 
@@ -1234,7 +1234,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 
 	/// Send a spontaneous, aka. "keysend", payment
 	pub fn send_spontaneous_payment(
-		&self, amount_msat: u64, node_id: PublicKey,
+		&self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<TlvEntry>,
 	) -> Result<PaymentHash, Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
@@ -1257,7 +1257,12 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 			PaymentParameters::from_node_id(node_id, self.config.default_cltv_expiry_delta),
 			amount_msat,
 		);
-		let recipient_fields = RecipientOnionFields::spontaneous_empty();
+		let recipient_fields = RecipientOnionFields::spontaneous_empty()
+			.with_custom_tlvs(custom_tlvs.into_iter().map(|tlv| (tlv.r#type, tlv.value)).collect())
+			.map_err(|_| {
+				log_error!(self.logger, "Payment error: invalid custom TLVs.");
+				Error::InvalidCustomTlv
+			})?;
 
 		match self.channel_manager.send_spontaneous_payment_with_retry(
 			Some(payment_preimage),

src/types.rs

@@ -456,3 +456,12 @@ impl Default for ChannelConfig {
 		LdkChannelConfig::default().into()
 	}
 }
+
+/// Custom TLV entry.
+pub struct TlvEntry {
+	/// Type number.
+	pub r#type: u64,
+
+	/// Serialized value.
+	pub value: Vec<u8>,
+}