Update auto-generated bindings
[ldk-c-bindings] / lightning-c-bindings / src / lightning / routing / gossip.rs
index 021fa0b35df9ece9b4f3b00dcc9dc7f80c63c6ce..bef0af53db63e514ce89a10150fada96f1d32326 100644 (file)
@@ -9,6 +9,7 @@
 //! The [`NetworkGraph`] stores the network gossip and [`P2PGossipSync`] fetches it from peers
 
 use alloc::str::FromStr;
+use alloc::string::String;
 use core::ffi::c_void;
 use core::convert::Infallible;
 use bitcoin::hashes::Hash;
@@ -106,7 +107,7 @@ pub extern "C" fn NodeId_as_slice(this_arg: &crate::lightning::routing::gossip::
 /// Get the public key from this NodeId
 #[must_use]
 #[no_mangle]
-pub extern "C" fn NodeId_as_pubkey(this_arg: &crate::lightning::routing::gossip::NodeId) -> crate::c_types::derived::CResult_PublicKeyErrorZ {
+pub extern "C" fn NodeId_as_pubkey(this_arg: &crate::lightning::routing::gossip::NodeId) -> crate::c_types::derived::CResult_PublicKeySecp256k1ErrorZ {
        let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_pubkey();
        let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::PublicKey::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
        local_ret
@@ -496,9 +497,9 @@ pub extern "C" fn P2PGossipSync_new(network_graph: &crate::lightning::routing::g
 /// existing announcements unless they are updated.
 /// Add, update or remove the provider would replace the current one.
 #[no_mangle]
-pub extern "C" fn P2PGossipSync_add_utxo_lookup(this_arg: &mut crate::lightning::routing::gossip::P2PGossipSync, mut utxo_lookup: crate::c_types::derived::COption_UtxoLookupZ) {
+pub extern "C" fn P2PGossipSync_add_utxo_lookup(this_arg: &crate::lightning::routing::gossip::P2PGossipSync, mut utxo_lookup: crate::c_types::derived::COption_UtxoLookupZ) {
        let mut local_utxo_lookup = { /*utxo_lookup*/ let utxo_lookup_opt = utxo_lookup; if utxo_lookup_opt.is_none() { None } else { Some({ { { utxo_lookup_opt.take() } }})} };
-       unsafe { &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut crate::lightning::routing::gossip::nativeP2PGossipSync)) }.add_utxo_lookup(local_utxo_lookup)
+       unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.add_utxo_lookup(local_utxo_lookup)
 }
 
 /// Handles any network updates originating from [`Event`]s.
@@ -509,6 +510,34 @@ pub extern "C" fn NetworkGraph_handle_network_update(this_arg: &crate::lightning
        unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.handle_network_update(&network_update.to_native())
 }
 
+/// Gets the genesis hash for this network graph.
+#[must_use]
+#[no_mangle]
+pub extern "C" fn NetworkGraph_get_genesis_hash(this_arg: &crate::lightning::routing::gossip::NetworkGraph) -> crate::c_types::ThirtyTwoBytes {
+       let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_genesis_hash();
+       crate::c_types::ThirtyTwoBytes { data: ret.into_inner() }
+}
+
+/// Verifies the signature of a [`NodeAnnouncement`].
+///
+/// Returns an error if it is invalid.
+#[no_mangle]
+pub extern "C" fn verify_node_announcement(msg: &crate::lightning::ln::msgs::NodeAnnouncement) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
+       let mut ret = lightning::routing::gossip::verify_node_announcement(msg.get_native_ref(), secp256k1::global::SECP256K1);
+       let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::LightningError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
+       local_ret
+}
+
+/// Verifies all signatures included in a [`ChannelAnnouncement`].
+///
+/// Returns an error if one of the signatures is invalid.
+#[no_mangle]
+pub extern "C" fn verify_channel_announcement(msg: &crate::lightning::ln::msgs::ChannelAnnouncement) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
+       let mut ret = lightning::routing::gossip::verify_channel_announcement(msg.get_native_ref(), secp256k1::global::SECP256K1);
+       let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::LightningError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
+       local_ret
+}
+
 impl From<nativeP2PGossipSync> for crate::lightning::ln::msgs::RoutingMessageHandler {
        fn from(obj: nativeP2PGossipSync) -> Self {
                let mut rust_obj = P2PGossipSync { inner: ObjOps::heap_alloc(obj), is_owned: true };
@@ -795,6 +824,8 @@ pub extern "C" fn ChannelUpdateInfo_set_last_update_message(this_ptr: &mut Chann
        unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.last_update_message = local_val;
 }
 /// Constructs a new ChannelUpdateInfo given each field
+///
+/// Note that last_update_message_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 #[must_use]
 #[no_mangle]
 pub extern "C" fn ChannelUpdateInfo_new(mut last_update_arg: u32, mut enabled_arg: bool, mut cltv_expiry_delta_arg: u16, mut htlc_minimum_msat_arg: u64, mut htlc_maximum_msat_arg: u64, mut fees_arg: crate::lightning::routing::gossip::RoutingFees, mut last_update_message_arg: crate::lightning::ln::msgs::ChannelUpdate) -> ChannelUpdateInfo {
@@ -1178,7 +1209,7 @@ pub enum EffectiveCapacity {
                liquidity_msat: u64,
        },
        /// The maximum HTLC amount in one direction as advertised on the gossip network.
-       MaximumHTLC {
+       AdvertisedMaxHTLC {
                /// The maximum HTLC amount denominated in millisatoshi.
                amount_msat: u64,
        },
@@ -1192,6 +1223,11 @@ pub enum EffectiveCapacity {
        /// A capacity sufficient to route any payment, typically used for private channels provided by
        /// an invoice.
        Infinite,
+       /// The maximum HTLC amount as provided by an invoice route hint.
+       HintMaxHTLC {
+               /// The maximum HTLC amount denominated in millisatoshi.
+               amount_msat: u64,
+       },
        /// A capacity that is unknown possibly because either the chain state is unavailable to know
        /// the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.
        Unknown,
@@ -1209,9 +1245,9 @@ impl EffectiveCapacity {
                                        liquidity_msat: liquidity_msat_nonref,
                                }
                        },
-                       EffectiveCapacity::MaximumHTLC {ref amount_msat, } => {
+                       EffectiveCapacity::AdvertisedMaxHTLC {ref amount_msat, } => {
                                let mut amount_msat_nonref = Clone::clone(amount_msat);
-                               nativeEffectiveCapacity::MaximumHTLC {
+                               nativeEffectiveCapacity::AdvertisedMaxHTLC {
                                        amount_msat: amount_msat_nonref,
                                }
                        },
@@ -1224,6 +1260,12 @@ impl EffectiveCapacity {
                                }
                        },
                        EffectiveCapacity::Infinite => nativeEffectiveCapacity::Infinite,
+                       EffectiveCapacity::HintMaxHTLC {ref amount_msat, } => {
+                               let mut amount_msat_nonref = Clone::clone(amount_msat);
+                               nativeEffectiveCapacity::HintMaxHTLC {
+                                       amount_msat: amount_msat_nonref,
+                               }
+                       },
                        EffectiveCapacity::Unknown => nativeEffectiveCapacity::Unknown,
                }
        }
@@ -1235,8 +1277,8 @@ impl EffectiveCapacity {
                                        liquidity_msat: liquidity_msat,
                                }
                        },
-                       EffectiveCapacity::MaximumHTLC {mut amount_msat, } => {
-                               nativeEffectiveCapacity::MaximumHTLC {
+                       EffectiveCapacity::AdvertisedMaxHTLC {mut amount_msat, } => {
+                               nativeEffectiveCapacity::AdvertisedMaxHTLC {
                                        amount_msat: amount_msat,
                                }
                        },
@@ -1247,6 +1289,11 @@ impl EffectiveCapacity {
                                }
                        },
                        EffectiveCapacity::Infinite => nativeEffectiveCapacity::Infinite,
+                       EffectiveCapacity::HintMaxHTLC {mut amount_msat, } => {
+                               nativeEffectiveCapacity::HintMaxHTLC {
+                                       amount_msat: amount_msat,
+                               }
+                       },
                        EffectiveCapacity::Unknown => nativeEffectiveCapacity::Unknown,
                }
        }
@@ -1259,9 +1306,9 @@ impl EffectiveCapacity {
                                        liquidity_msat: liquidity_msat_nonref,
                                }
                        },
-                       nativeEffectiveCapacity::MaximumHTLC {ref amount_msat, } => {
+                       nativeEffectiveCapacity::AdvertisedMaxHTLC {ref amount_msat, } => {
                                let mut amount_msat_nonref = Clone::clone(amount_msat);
-                               EffectiveCapacity::MaximumHTLC {
+                               EffectiveCapacity::AdvertisedMaxHTLC {
                                        amount_msat: amount_msat_nonref,
                                }
                        },
@@ -1274,6 +1321,12 @@ impl EffectiveCapacity {
                                }
                        },
                        nativeEffectiveCapacity::Infinite => EffectiveCapacity::Infinite,
+                       nativeEffectiveCapacity::HintMaxHTLC {ref amount_msat, } => {
+                               let mut amount_msat_nonref = Clone::clone(amount_msat);
+                               EffectiveCapacity::HintMaxHTLC {
+                                       amount_msat: amount_msat_nonref,
+                               }
+                       },
                        nativeEffectiveCapacity::Unknown => EffectiveCapacity::Unknown,
                }
        }
@@ -1285,8 +1338,8 @@ impl EffectiveCapacity {
                                        liquidity_msat: liquidity_msat,
                                }
                        },
-                       nativeEffectiveCapacity::MaximumHTLC {mut amount_msat, } => {
-                               EffectiveCapacity::MaximumHTLC {
+                       nativeEffectiveCapacity::AdvertisedMaxHTLC {mut amount_msat, } => {
+                               EffectiveCapacity::AdvertisedMaxHTLC {
                                        amount_msat: amount_msat,
                                }
                        },
@@ -1297,6 +1350,11 @@ impl EffectiveCapacity {
                                }
                        },
                        nativeEffectiveCapacity::Infinite => EffectiveCapacity::Infinite,
+                       nativeEffectiveCapacity::HintMaxHTLC {mut amount_msat, } => {
+                               EffectiveCapacity::HintMaxHTLC {
+                                       amount_msat: amount_msat,
+                               }
+                       },
                        nativeEffectiveCapacity::Unknown => EffectiveCapacity::Unknown,
                }
        }
@@ -1317,9 +1375,9 @@ pub extern "C" fn EffectiveCapacity_exact_liquidity(liquidity_msat: u64) -> Effe
        }
 }
 #[no_mangle]
-/// Utility method to constructs a new MaximumHTLC-variant EffectiveCapacity
-pub extern "C" fn EffectiveCapacity_maximum_htlc(amount_msat: u64) -> EffectiveCapacity {
-       EffectiveCapacity::MaximumHTLC {
+/// Utility method to constructs a new AdvertisedMaxHTLC-variant EffectiveCapacity
+pub extern "C" fn EffectiveCapacity_advertised_max_htlc(amount_msat: u64) -> EffectiveCapacity {
+       EffectiveCapacity::AdvertisedMaxHTLC {
                amount_msat,
        }
 }
@@ -1336,6 +1394,13 @@ pub extern "C" fn EffectiveCapacity_total(capacity_msat: u64, htlc_maximum_msat:
 pub extern "C" fn EffectiveCapacity_infinite() -> EffectiveCapacity {
        EffectiveCapacity::Infinite}
 #[no_mangle]
+/// Utility method to constructs a new HintMaxHTLC-variant EffectiveCapacity
+pub extern "C" fn EffectiveCapacity_hint_max_htlc(amount_msat: u64) -> EffectiveCapacity {
+       EffectiveCapacity::HintMaxHTLC {
+               amount_msat,
+       }
+}
+#[no_mangle]
 /// Utility method to constructs a new Unknown-variant EffectiveCapacity
 pub extern "C" fn EffectiveCapacity_unknown() -> EffectiveCapacity {
        EffectiveCapacity::Unknown}
@@ -1615,6 +1680,8 @@ pub extern "C" fn NodeAnnouncementInfo_set_announcement_message(this_ptr: &mut N
        unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.announcement_message = local_val;
 }
 /// Constructs a new NodeAnnouncementInfo given each field
+///
+/// Note that announcement_message_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 #[must_use]
 #[no_mangle]
 pub extern "C" fn NodeAnnouncementInfo_new(mut features_arg: crate::lightning::ln::features::NodeFeatures, mut last_update_arg: u32, mut rgb_arg: crate::c_types::ThreeBytes, mut alias_arg: crate::lightning::routing::gossip::NodeAlias, mut announcement_message_arg: crate::lightning::ln::msgs::NodeAnnouncement) -> NodeAnnouncementInfo {
@@ -1658,9 +1725,9 @@ pub extern "C" fn NodeAnnouncementInfo_eq(a: &NodeAnnouncementInfo, b: &NodeAnno
 /// Internet-level addresses via which one can connect to the node
 #[must_use]
 #[no_mangle]
-pub extern "C" fn NodeAnnouncementInfo_addresses(this_arg: &crate::lightning::routing::gossip::NodeAnnouncementInfo) -> crate::c_types::derived::CVec_NetAddressZ {
+pub extern "C" fn NodeAnnouncementInfo_addresses(this_arg: &crate::lightning::routing::gossip::NodeAnnouncementInfo) -> crate::c_types::derived::CVec_SocketAddressZ {
        let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.addresses();
-       let mut local_ret_clone = Vec::new(); local_ret_clone.extend_from_slice(ret); let mut ret = local_ret_clone; let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::msgs::NetAddress::native_into(item) }); };
+       let mut local_ret_clone = Vec::new(); local_ret_clone.extend_from_slice(ret); let mut ret = local_ret_clone; let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::msgs::SocketAddress::native_into(item) }); };
        local_ret.into()
 }
 
@@ -1883,6 +1950,8 @@ pub extern "C" fn NodeInfo_set_announcement_info(this_ptr: &mut NodeInfo, mut va
        unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.announcement_info = local_val;
 }
 /// Constructs a new NodeInfo given each field
+///
+/// Note that announcement_info_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 #[must_use]
 #[no_mangle]
 pub extern "C" fn NodeInfo_new(mut channels_arg: crate::c_types::derived::CVec_u64Z, mut announcement_info_arg: crate::lightning::routing::gossip::NodeAnnouncementInfo) -> NodeInfo {
@@ -2015,8 +2084,8 @@ pub extern "C" fn NetworkGraph_update_node_from_unsigned_announcement(this_arg:
 
 /// Store or update channel info from a channel announcement.
 ///
-/// You probably don't want to call this directly, instead relying on a P2PGossipSync's
-/// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
+/// You probably don't want to call this directly, instead relying on a [`P2PGossipSync`]'s
+/// [`RoutingMessageHandler`] implementation to call it indirectly. This may be useful to accept
 /// routing messages from a source using a protocol other than the lightning P2P protocol.
 ///
 /// If a [`UtxoLookup`] object is provided via `utxo_lookup`, it will be called to verify
@@ -2030,6 +2099,21 @@ pub extern "C" fn NetworkGraph_update_channel_from_announcement(this_arg: &crate
        local_ret
 }
 
+/// Store or update channel info from a channel announcement.
+///
+/// You probably don't want to call this directly, instead relying on a [`P2PGossipSync`]'s
+/// [`RoutingMessageHandler`] implementation to call it indirectly. This may be useful to accept
+/// routing messages from a source using a protocol other than the lightning P2P protocol.
+///
+/// This will skip verification of if the channel is actually on-chain.
+#[must_use]
+#[no_mangle]
+pub extern "C" fn NetworkGraph_update_channel_from_announcement_no_lookup(this_arg: &crate::lightning::routing::gossip::NetworkGraph, msg: &crate::lightning::ln::msgs::ChannelAnnouncement) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
+       let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_channel_from_announcement_no_lookup(msg.get_native_ref());
+       let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::LightningError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
+       local_ret
+}
+
 /// Store or update channel info from a channel announcement without verifying the associated
 /// signatures. Because we aren't given the associated signatures here we cannot relay the
 /// channel announcement to any of our peers.
@@ -2189,9 +2273,9 @@ pub extern "C" fn ReadOnlyNetworkGraph_list_nodes(this_arg: &crate::lightning::r
 /// or if node announcement for the node was never received.
 #[must_use]
 #[no_mangle]
-pub extern "C" fn ReadOnlyNetworkGraph_get_addresses(this_arg: &crate::lightning::routing::gossip::ReadOnlyNetworkGraph, mut pubkey: crate::c_types::PublicKey) -> crate::c_types::derived::COption_CVec_NetAddressZZ {
+pub extern "C" fn ReadOnlyNetworkGraph_get_addresses(this_arg: &crate::lightning::routing::gossip::ReadOnlyNetworkGraph, mut pubkey: crate::c_types::PublicKey) -> crate::c_types::derived::COption_CVec_SocketAddressZZ {
        let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_addresses(&pubkey.into_rust());
-       let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_CVec_NetAddressZZ::None } else { crate::c_types::derived::COption_CVec_NetAddressZZ::Some( { let mut local_ret_0 = Vec::new(); for mut item in ret.unwrap().drain(..) { local_ret_0.push( { crate::lightning::ln::msgs::NetAddress::native_into(item) }); }; local_ret_0.into() }) };
+       let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_CVec_SocketAddressZZ::None } else { crate::c_types::derived::COption_CVec_SocketAddressZZ::Some( { let mut local_ret_0 = Vec::new(); for mut item in ret.unwrap().drain(..) { local_ret_0.push( { crate::lightning::ln::msgs::SocketAddress::native_into(item) }); }; local_ret_0.into() }) };
        local_ret
 }