1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
9 //! A very simple serialization framework which is used to serialize/deserialize messages as well
10 //! as [`ChannelManager`]s and [`ChannelMonitor`]s.
12 //! [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
13 //! [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
15 use alloc::str::FromStr;
16 use alloc::string::String;
17 use core::ffi::c_void;
18 use core::convert::Infallible;
19 use bitcoin::hashes::Hash;
20 use crate::c_types::*;
21 #[cfg(feature="no-std")]
22 use alloc::{vec::Vec, boxed::Box};
24 /// serialization buffer size
27 pub static MAX_BUF_SIZE: usize = lightning::util::ser::MAX_BUF_SIZE;
29 use lightning::util::ser::BigSize as nativeBigSizeImport;
30 pub(crate) type nativeBigSize = nativeBigSizeImport;
32 /// Lightning TLV uses a custom variable-length integer called `BigSize`. It is similar to Bitcoin's
33 /// variable-length integers except that it is serialized in big-endian instead of little-endian.
35 /// Like Bitcoin's variable-length integer, it exhibits ambiguity in that certain values can be
36 /// encoded in several different ways, which we must check for at deserialization-time. Thus, if
37 /// you're looking for an example of a variable-length integer to use for your own project, move
38 /// along, this is a rather poor design.
42 /// A pointer to the opaque Rust object.
44 /// Nearly everywhere, inner must be non-null, however in places where
45 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
46 pub inner: *mut nativeBigSize,
47 /// Indicates that this is the only struct which contains the same pointer.
49 /// Rust functions which take ownership of an object provided via an argument require
50 /// this to be true and invalidate the object pointed to by inner.
54 impl Drop for BigSize {
56 if self.is_owned && !<*mut nativeBigSize>::is_null(self.inner) {
57 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
61 /// Frees any resources used by the BigSize, if is_owned is set and inner is non-NULL.
63 pub extern "C" fn BigSize_free(this_obj: BigSize) { }
65 /// Used only if an object of this type is returned as a trait impl by a method
66 pub(crate) extern "C" fn BigSize_free_void(this_ptr: *mut c_void) {
67 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeBigSize) };
71 pub(crate) fn get_native_ref(&self) -> &'static nativeBigSize {
72 unsafe { &*ObjOps::untweak_ptr(self.inner) }
74 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBigSize {
75 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
77 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
78 pub(crate) fn take_inner(mut self) -> *mut nativeBigSize {
79 assert!(self.is_owned);
80 let ret = ObjOps::untweak_ptr(self.inner);
81 self.inner = core::ptr::null_mut();
86 pub extern "C" fn BigSize_get_a(this_ptr: &BigSize) -> u64 {
87 let mut inner_val = &mut this_ptr.get_native_mut_ref().0;
91 pub extern "C" fn BigSize_set_a(this_ptr: &mut BigSize, mut val: u64) {
92 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.0 = val;
94 /// Constructs a new BigSize given each field
97 pub extern "C" fn BigSize_new(mut a_arg: u64) -> BigSize {
98 BigSize { inner: ObjOps::heap_alloc(lightning::util::ser::BigSize (
102 impl Clone for BigSize {
103 fn clone(&self) -> Self {
105 inner: if <*mut nativeBigSize>::is_null(self.inner) { core::ptr::null_mut() } else {
106 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
112 /// Used only if an object of this type is returned as a trait impl by a method
113 pub(crate) extern "C" fn BigSize_clone_void(this_ptr: *const c_void) -> *mut c_void {
114 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeBigSize)).clone() })) as *mut c_void
117 /// Creates a copy of the BigSize
118 pub extern "C" fn BigSize_clone(orig: &BigSize) -> BigSize {
121 /// Generates a non-cryptographic 64-bit hash of the BigSize.
123 pub extern "C" fn BigSize_hash(o: &BigSize) -> u64 {
124 if o.inner.is_null() { return 0; }
125 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
127 let mut hasher = core::hash::SipHasher::new();
128 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
129 core::hash::Hasher::finish(&hasher)
131 /// Checks if two BigSizes contain equal inner contents.
132 /// This ignores pointers and is_owned flags and looks at the values in fields.
133 /// Two objects with NULL inner values will be considered "equal" here.
135 pub extern "C" fn BigSize_eq(a: &BigSize, b: &BigSize) -> bool {
136 if a.inner == b.inner { return true; }
137 if a.inner.is_null() || b.inner.is_null() { return false; }
138 if a.get_native_ref() == b.get_native_ref() { true } else { false }
141 /// Serialize the BigSize object into a byte array which can be read by BigSize_read
142 pub extern "C" fn BigSize_write(obj: &crate::lightning::util::ser::BigSize) -> crate::c_types::derived::CVec_u8Z {
143 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
146 pub(crate) extern "C" fn BigSize_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
147 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeBigSize) })
150 /// Read a BigSize from a byte array, created by BigSize_write
151 pub extern "C" fn BigSize_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_BigSizeDecodeErrorZ {
152 let res: Result<lightning::util::ser::BigSize, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
153 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::ser::BigSize { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
157 use lightning::util::ser::Hostname as nativeHostnameImport;
158 pub(crate) type nativeHostname = nativeHostnameImport;
160 /// Represents a hostname for serialization purposes.
161 /// Only the character set and length will be validated.
162 /// The character set consists of ASCII alphanumeric characters, hyphens, and periods.
163 /// Its length is guaranteed to be representable by a single byte.
164 /// This serialization is used by [`BOLT 7`] hostnames.
166 /// [`BOLT 7`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md
169 pub struct Hostname {
170 /// A pointer to the opaque Rust object.
172 /// Nearly everywhere, inner must be non-null, however in places where
173 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
174 pub inner: *mut nativeHostname,
175 /// Indicates that this is the only struct which contains the same pointer.
177 /// Rust functions which take ownership of an object provided via an argument require
178 /// this to be true and invalidate the object pointed to by inner.
182 impl Drop for Hostname {
184 if self.is_owned && !<*mut nativeHostname>::is_null(self.inner) {
185 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
189 /// Frees any resources used by the Hostname, if is_owned is set and inner is non-NULL.
191 pub extern "C" fn Hostname_free(this_obj: Hostname) { }
193 /// Used only if an object of this type is returned as a trait impl by a method
194 pub(crate) extern "C" fn Hostname_free_void(this_ptr: *mut c_void) {
195 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeHostname) };
199 pub(crate) fn get_native_ref(&self) -> &'static nativeHostname {
200 unsafe { &*ObjOps::untweak_ptr(self.inner) }
202 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHostname {
203 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
205 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
206 pub(crate) fn take_inner(mut self) -> *mut nativeHostname {
207 assert!(self.is_owned);
208 let ret = ObjOps::untweak_ptr(self.inner);
209 self.inner = core::ptr::null_mut();
213 impl Clone for Hostname {
214 fn clone(&self) -> Self {
216 inner: if <*mut nativeHostname>::is_null(self.inner) { core::ptr::null_mut() } else {
217 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
223 /// Used only if an object of this type is returned as a trait impl by a method
224 pub(crate) extern "C" fn Hostname_clone_void(this_ptr: *const c_void) -> *mut c_void {
225 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHostname)).clone() })) as *mut c_void
228 /// Creates a copy of the Hostname
229 pub extern "C" fn Hostname_clone(orig: &Hostname) -> Hostname {
232 /// Checks if two Hostnames contain equal inner contents.
233 /// This ignores pointers and is_owned flags and looks at the values in fields.
234 /// Two objects with NULL inner values will be considered "equal" here.
236 pub extern "C" fn Hostname_eq(a: &Hostname, b: &Hostname) -> bool {
237 if a.inner == b.inner { return true; }
238 if a.inner.is_null() || b.inner.is_null() { return false; }
239 if a.get_native_ref() == b.get_native_ref() { true } else { false }
241 /// Returns the length of the hostname.
244 pub extern "C" fn Hostname_len(this_arg: &crate::lightning::util::ser::Hostname) -> u8 {
245 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.len();
250 /// Serialize the Hostname object into a byte array which can be read by Hostname_read
251 pub extern "C" fn Hostname_write(obj: &crate::lightning::util::ser::Hostname) -> crate::c_types::derived::CVec_u8Z {
252 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
255 pub(crate) extern "C" fn Hostname_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
256 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHostname) })
259 /// Read a Hostname from a byte array, created by Hostname_write
260 pub extern "C" fn Hostname_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HostnameDecodeErrorZ {
261 let res: Result<lightning::util::ser::Hostname, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
262 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::ser::Hostname { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
266 use lightning::util::ser::TransactionU16LenLimited as nativeTransactionU16LenLimitedImport;
267 pub(crate) type nativeTransactionU16LenLimited = nativeTransactionU16LenLimitedImport;
269 /// A wrapper for a `Transaction` which can only be constructed with [`TransactionU16LenLimited::new`]
270 /// if the `Transaction`'s consensus-serialized length is <= u16::MAX.
272 /// Use [`TransactionU16LenLimited::into_transaction`] to convert into the contained `Transaction`.
275 pub struct TransactionU16LenLimited {
276 /// A pointer to the opaque Rust object.
278 /// Nearly everywhere, inner must be non-null, however in places where
279 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
280 pub inner: *mut nativeTransactionU16LenLimited,
281 /// Indicates that this is the only struct which contains the same pointer.
283 /// Rust functions which take ownership of an object provided via an argument require
284 /// this to be true and invalidate the object pointed to by inner.
288 impl Drop for TransactionU16LenLimited {
290 if self.is_owned && !<*mut nativeTransactionU16LenLimited>::is_null(self.inner) {
291 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
295 /// Frees any resources used by the TransactionU16LenLimited, if is_owned is set and inner is non-NULL.
297 pub extern "C" fn TransactionU16LenLimited_free(this_obj: TransactionU16LenLimited) { }
299 /// Used only if an object of this type is returned as a trait impl by a method
300 pub(crate) extern "C" fn TransactionU16LenLimited_free_void(this_ptr: *mut c_void) {
301 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeTransactionU16LenLimited) };
304 impl TransactionU16LenLimited {
305 pub(crate) fn get_native_ref(&self) -> &'static nativeTransactionU16LenLimited {
306 unsafe { &*ObjOps::untweak_ptr(self.inner) }
308 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTransactionU16LenLimited {
309 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
311 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
312 pub(crate) fn take_inner(mut self) -> *mut nativeTransactionU16LenLimited {
313 assert!(self.is_owned);
314 let ret = ObjOps::untweak_ptr(self.inner);
315 self.inner = core::ptr::null_mut();
319 impl Clone for TransactionU16LenLimited {
320 fn clone(&self) -> Self {
322 inner: if <*mut nativeTransactionU16LenLimited>::is_null(self.inner) { core::ptr::null_mut() } else {
323 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
329 /// Used only if an object of this type is returned as a trait impl by a method
330 pub(crate) extern "C" fn TransactionU16LenLimited_clone_void(this_ptr: *const c_void) -> *mut c_void {
331 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeTransactionU16LenLimited)).clone() })) as *mut c_void
334 /// Creates a copy of the TransactionU16LenLimited
335 pub extern "C" fn TransactionU16LenLimited_clone(orig: &TransactionU16LenLimited) -> TransactionU16LenLimited {
338 /// Checks if two TransactionU16LenLimiteds contain equal inner contents.
339 /// This ignores pointers and is_owned flags and looks at the values in fields.
340 /// Two objects with NULL inner values will be considered "equal" here.
342 pub extern "C" fn TransactionU16LenLimited_eq(a: &TransactionU16LenLimited, b: &TransactionU16LenLimited) -> bool {
343 if a.inner == b.inner { return true; }
344 if a.inner.is_null() || b.inner.is_null() { return false; }
345 if a.get_native_ref() == b.get_native_ref() { true } else { false }
347 /// Constructs a new `TransactionU16LenLimited` from a `Transaction` only if it's consensus-
348 /// serialized length is <= u16::MAX.
351 pub extern "C" fn TransactionU16LenLimited_new(mut transaction: crate::c_types::Transaction) -> crate::c_types::derived::CResult_TransactionU16LenLimitedNoneZ {
352 let mut ret = lightning::util::ser::TransactionU16LenLimited::new(transaction.into_bitcoin());
353 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::ser::TransactionU16LenLimited { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
357 /// Consumes this `TransactionU16LenLimited` and returns its contained `Transaction`.
360 pub extern "C" fn TransactionU16LenLimited_into_transaction(mut this_arg: crate::lightning::util::ser::TransactionU16LenLimited) -> crate::c_types::Transaction {
361 let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_transaction();
362 crate::c_types::Transaction::from_bitcoin(&ret)
366 /// Serialize the TransactionU16LenLimited object into a byte array which can be read by TransactionU16LenLimited_read
367 pub extern "C" fn TransactionU16LenLimited_write(obj: &crate::lightning::util::ser::TransactionU16LenLimited) -> crate::c_types::derived::CVec_u8Z {
368 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
371 pub(crate) extern "C" fn TransactionU16LenLimited_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
372 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeTransactionU16LenLimited) })
375 /// Read a TransactionU16LenLimited from a byte array, created by TransactionU16LenLimited_write
376 pub extern "C" fn TransactionU16LenLimited_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_TransactionU16LenLimitedDecodeErrorZ {
377 let res: Result<lightning::util::ser::TransactionU16LenLimited, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
378 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::ser::TransactionU16LenLimited { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };