Migrate records and config types to UniFFI proc-macro export

Migrate `Config`, `AnchorChannelsConfig`, `BackgroundSyncConfig`,
`SyncTimeoutsConfig`, `EsploraSyncConfig`, `ElectrumSyncConfig`,
`ChannelConfig`, `CustomTlvRecord`, `PeerDetails`, `PaymentDetails`,
`BalanceDetails`, `NodeStatus`, `LSPS2ServiceConfig`, and
`ChannelDetails` from UDL dictionary definitions to
`#[derive(uniffi::Record)]` proc-macro exports.

Co-Authored-By: HAL 9000

Author: tnull

bindings/ldk_node.udl

@@ -3,59 +3,19 @@ namespace ldk_node {
 	Config default_config();
 };
 
-dictionary Config {
-	string storage_dir_path;
-	Network network;
-	sequence<SocketAddress>? listening_addresses;
-	sequence<SocketAddress>? announcement_addresses;
-	NodeAlias? node_alias;
-	sequence<PublicKey> trusted_peers_0conf;
-	u64 probing_liquidity_limit_multiplier;
-	AnchorChannelsConfig? anchor_channels_config;
-	RouteParametersConfig? route_parameters;
-};
+typedef dictionary Config;
 
-dictionary AnchorChannelsConfig {
-	sequence<PublicKey> trusted_peers_no_reserve;
-	u64 per_channel_reserve_sats;
-};
+typedef dictionary AnchorChannelsConfig;
 
-dictionary BackgroundSyncConfig {
-	u64 onchain_wallet_sync_interval_secs;
-	u64 lightning_wallet_sync_interval_secs;
-	u64 fee_rate_cache_update_interval_secs;
-};
+typedef dictionary BackgroundSyncConfig;
 
-dictionary SyncTimeoutsConfig {
-	u64 onchain_wallet_sync_timeout_secs;
-	u64 lightning_wallet_sync_timeout_secs;
-	u64 fee_rate_cache_update_timeout_secs;
-	u64 tx_broadcast_timeout_secs;
-	u8 per_request_timeout_secs;
-};
+typedef dictionary SyncTimeoutsConfig;
 
-dictionary EsploraSyncConfig {
-	BackgroundSyncConfig? background_sync_config;
-	SyncTimeoutsConfig timeouts_config;
-};
+typedef dictionary EsploraSyncConfig;
 
-dictionary ElectrumSyncConfig {
-	BackgroundSyncConfig? background_sync_config;
-	SyncTimeoutsConfig timeouts_config;
-};
+typedef dictionary ElectrumSyncConfig;
 
-dictionary LSPS2ServiceConfig {
-	string? require_token;
-	boolean advertise_service;
-	u32 channel_opening_fee_ppm;
-	u32 channel_over_provisioning_ppm;
-	u64 min_channel_opening_fee_msat;
-	u32 min_channel_lifetime;
-	u32 max_client_to_self_delay;
-	u64 min_payment_size_msat;
-	u64 max_payment_size_msat;
-	boolean client_trusts_lsp;
-};
+typedef dictionary LSPS2ServiceConfig;
 
 interface NodeEntropy {
 	[Name=from_bip39_mnemonic]
@@ -359,16 +319,7 @@ enum NodeError {
 	"HrnParsingFailed",
 };
 
-dictionary NodeStatus {
-	boolean is_running;
-	BestBlock current_best_block;
-	u64? latest_lightning_wallet_sync_timestamp;
-	u64? latest_onchain_wallet_sync_timestamp;
-	u64? latest_fee_rate_cache_update_timestamp;
-	u64? latest_rgs_snapshot_timestamp;
-	u64? latest_pathfinding_scores_sync_timestamp;
-	u64? latest_node_announcement_broadcast_timestamp;
-};
+typedef dictionary NodeStatus;
 
 [Remote]
 dictionary BestBlock {
@@ -423,15 +374,7 @@ typedef dictionary LSPFeeLimits;
 
 typedef enum ConfirmationStatus;
 
-dictionary PaymentDetails {
-	PaymentId id;
-	PaymentKind kind;
-	u64? amount_msat;
-	u64? fee_paid_msat;
-	PaymentDirection direction;
-	PaymentStatus status;
-	u64 latest_update_timestamp;
-};
+typedef dictionary PaymentDetails;
 
 [Remote]
 dictionary RouteParametersConfig {
@@ -441,10 +384,7 @@ dictionary RouteParametersConfig {
 	u8 max_channel_saturation_power_of_half;
 };
 
-dictionary CustomTlvRecord {
-	u64 type_num;
-	sequence<u8> value;
-};
+typedef dictionary CustomTlvRecord;
 
 [Remote]
 dictionary LSPS1OrderStatus {
@@ -517,47 +457,9 @@ dictionary OutPoint {
 	u32 vout;
 };
 
-dictionary ChannelDetails {
-	ChannelId channel_id;
-	PublicKey counterparty_node_id;
-	OutPoint? funding_txo;
-	ScriptBuf? funding_redeem_script;
-	u64? short_channel_id;
-	u64? outbound_scid_alias;
-	u64? inbound_scid_alias;
-	u64 channel_value_sats;
-	u64? unspendable_punishment_reserve;
-	UserChannelId user_channel_id;
-	u32 feerate_sat_per_1000_weight;
-	u64 outbound_capacity_msat;
-	u64 inbound_capacity_msat;
-	u32? confirmations_required;
-	u32? confirmations;
-	boolean is_outbound;
-	boolean is_channel_ready;
-	boolean is_usable;
-	boolean is_announced;
-	u16? cltv_expiry_delta;
-	u64 counterparty_unspendable_punishment_reserve;
-	u64? counterparty_outbound_htlc_minimum_msat;
-	u64? counterparty_outbound_htlc_maximum_msat;
-	u32? counterparty_forwarding_info_fee_base_msat;
-	u32? counterparty_forwarding_info_fee_proportional_millionths;
-	u16? counterparty_forwarding_info_cltv_expiry_delta;
-	u64 next_outbound_htlc_limit_msat;
-	u64 next_outbound_htlc_minimum_msat;
-	u16? force_close_spend_delay;
-	u64 inbound_htlc_minimum_msat;
-	u64? inbound_htlc_maximum_msat;
-	ChannelConfig config;
-};
-
-dictionary PeerDetails {
-	PublicKey node_id;
-	SocketAddress address;
-	boolean is_persisted;
-	boolean is_connected;
-};
+typedef dictionary ChannelDetails;
+
+typedef dictionary PeerDetails;
 
 typedef enum LightningBalance;
 
@@ -571,23 +473,9 @@ enum BalanceSource {
 
 typedef enum PendingSweepBalance;
 
-dictionary BalanceDetails {
-	u64 total_onchain_balance_sats;
-	u64 spendable_onchain_balance_sats;
-	u64 total_anchor_channels_reserve_sats;
-	u64 total_lightning_balance_sats;
-	sequence<LightningBalance> lightning_balances;
-	sequence<PendingSweepBalance> pending_balances_from_channel_closures;
-};
+typedef dictionary BalanceDetails;
 
-dictionary ChannelConfig {
-	u32 forwarding_fee_proportional_millionths;
-	u32 forwarding_fee_base_msat;
-	u16 cltv_expiry_delta;
-	MaxDustHTLCExposure max_dust_htlc_exposure;
-	u64 force_close_avoidance_max_fee_satoshis;
-	boolean accept_underpaying_htlcs;
-};
+typedef dictionary ChannelConfig;
 
 typedef enum MaxDustHTLCExposure;
 

src/balance.rs

@@ -17,6 +17,7 @@ use lightning_types::payment::{PaymentHash, PaymentPreimage};
 ///
 /// [`Node::list_balances`]: crate::Node::list_balances
 #[derive(Debug, Clone)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct BalanceDetails {
 	/// The total balance of our on-chain wallet.
 	pub total_onchain_balance_sats: u64,

src/config.rs

@@ -108,6 +108,7 @@ pub(crate) const EXTERNAL_PATHFINDING_SCORES_SYNC_TIMEOUT_SECS: u64 = 5;
 pub(crate) const HRN_RESOLUTION_TIMEOUT_SECS: u64 = 5;
 
 #[derive(Debug, Clone)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 /// Represents the configuration of an [`Node`] instance.
 ///
 /// ### Defaults
@@ -238,6 +239,7 @@ impl Default for Config {
 ///
 /// [BOLT 3]: https://github.com/lightning/bolts/blob/master/03-transactions.md#htlc-timeout-and-htlc-success-transactions
 #[derive(Debug, Clone)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct AnchorChannelsConfig {
 	/// A list of peers that we trust to get the required channel closing transactions confirmed
 	/// on-chain.
@@ -353,6 +355,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
 /// | `lightning_wallet_sync_interval_secs`  | 30                 |
 /// | `fee_rate_cache_update_interval_secs`  | 600                |
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct BackgroundSyncConfig {
 	/// The time in-between background sync attempts of the onchain wallet, in seconds.
 	///
@@ -392,6 +395,7 @@ impl Default for BackgroundSyncConfig {
 /// | `tx_broadcast_timeout_secs`            | 10                 |
 /// | `per_request_timeout_secs`             | 10                 |
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct SyncTimeoutsConfig {
 	/// The timeout after which we abort syncing the onchain wallet.
 	pub onchain_wallet_sync_timeout_secs: u64,
@@ -422,6 +426,7 @@ impl Default for SyncTimeoutsConfig {
 /// Background syncing is enabled by default, using the default values specified in
 /// [`BackgroundSyncConfig`].
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct EsploraSyncConfig {
 	/// Background sync configuration.
 	///
@@ -448,6 +453,7 @@ impl Default for EsploraSyncConfig {
 /// Background syncing is enabled by default, using the default values specified in
 /// [`BackgroundSyncConfig`].
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct ElectrumSyncConfig {
 	/// Background sync configuration.
 	///
@@ -481,6 +487,7 @@ pub struct BitcoindRestClientConfig {
 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
 /// with our counterparty.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct ChannelConfig {
 	/// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
 	/// over the channel.

src/ffi/types.rs

@@ -138,16 +138,12 @@ impl VssClientHeaderProvider for VssHeaderProviderAdapter {
 }
 
 use crate::builder::sanitize_alias;
-pub use crate::config::{
-	default_config, AnchorChannelsConfig, BackgroundSyncConfig, ElectrumSyncConfig,
-	EsploraSyncConfig, MaxDustHTLCExposure, SyncTimeoutsConfig,
-};
+pub use crate::config::{default_config, ElectrumSyncConfig, EsploraSyncConfig};
 pub use crate::entropy::{generate_entropy_mnemonic, EntropyError, NodeEntropy, WordCount};
 use crate::error::Error;
 pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
-pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig};
+pub use crate::liquidity::LSPS1OrderStatus;
 pub use crate::logger::{LogLevel, LogRecord, LogWriter};
-pub use crate::payment::store::{PaymentDirection, PaymentKind, PaymentStatus};
 pub use crate::payment::UnifiedPaymentResult;
 use crate::{hex_utils, SocketAddress, UserChannelId};
 

src/lib.rs

@@ -1735,6 +1735,7 @@ impl Drop for Node {
 
 /// Represents the status of the [`Node`].
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct NodeStatus {
 	/// Indicates whether the [`Node`] is running.
 	pub is_running: bool,

src/liquidity.rs

@@ -99,6 +99,7 @@ struct LSPS2Service {
 ///
 /// [bLIP-52 / LSPS2]: https://github.com/lightning/blips/blob/master/blip-0052.md
 #[derive(Debug, Clone)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct LSPS2ServiceConfig {
 	/// A token we may require to be sent by the clients.
 	///

src/payment/store.rs

@@ -24,6 +24,7 @@ use crate::hex_utils;
 
 /// Represents a payment.
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct PaymentDetails {
 	/// The identifier of this payment.
 	pub id: PaymentId,

src/types.rs

@@ -355,6 +355,7 @@ impl fmt::Display for UserChannelId {
 ///
 /// [`Node::list_channels`]: crate::Node::list_channels
 #[derive(Debug, Clone)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct ChannelDetails {
 	/// The channel's ID (prior to initial channel setup this is a random 32 bytes, thereafter it
 	/// is derived from channel funding or key material).
@@ -591,6 +592,7 @@ impl From<LdkChannelDetails> for ChannelDetails {
 ///
 /// [`Node::list_peers`]: crate::Node::list_peers
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct PeerDetails {
 	/// The node ID of the peer.
 	pub node_id: PublicKey,
@@ -604,6 +606,7 @@ pub struct PeerDetails {
 
 /// Custom TLV entry.
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 pub struct CustomTlvRecord {
 	/// Type number.
 	pub type_num: u64,