_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/util/ser.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history and in the source files from which this was generated.
   3 //
   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.
   8
   9 //! A very simple serialization framework which is used to serialize/deserialize messages as well
  10 //! as [`ChannelManager`]s and [`ChannelMonitor`]s.
  11 //!
  12 //! [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
  13 //! [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
  14
  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};
  23
  24 /// serialization buffer size
  25
  26 #[no_mangle]
  27 pub static MAX_BUF_SIZE: usize = lightning::util::ser::MAX_BUF_SIZE;
  28
  29 use lightning::util::ser::BigSize as nativeBigSizeImport;
  30 pub(crate) type nativeBigSize = nativeBigSizeImport;
  31
  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.
  34 ///
  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.
  39 #[must_use]
  40 #[repr(C)]
  41 pub struct BigSize {
  42         /// A pointer to the opaque Rust object.
  43
  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.
  48
  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.
  51         pub is_owned: bool,
  52 }
  53
  54 impl Drop for BigSize {
  55         fn drop(&mut self) {
  56                 if self.is_owned && !<*mut nativeBigSize>::is_null(self.inner) {
  57                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  58                 }
  59         }
  60 }
  61 /// Frees any resources used by the BigSize, if is_owned is set and inner is non-NULL.
  62 #[no_mangle]
  63 pub extern "C" fn BigSize_free(this_obj: BigSize) { }
  64 #[allow(unused)]
  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) };
  68 }
  69 #[allow(unused)]
  70 impl BigSize {
  71         pub(crate) fn get_native_ref(&self) -> &'static nativeBigSize {
  72                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  73         }
  74         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBigSize {
  75                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  76         }
  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();
  82                 ret
  83         }
  84 }
  85 #[no_mangle]
  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;
  88         *inner_val
  89 }
  90 #[no_mangle]
  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;
  93 }
  94 /// Constructs a new BigSize given each field
  95 #[must_use]
  96 #[no_mangle]
  97 pub extern "C" fn BigSize_new(mut a_arg: u64) -> BigSize {
  98         BigSize { inner: ObjOps::heap_alloc(lightning::util::ser::BigSize (
  99                 a_arg,
 100         )), is_owned: true }
 101 }
 102 impl Clone for BigSize {
 103         fn clone(&self) -> Self {
 104                 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()) },
 107                         is_owned: true,
 108                 }
 109         }
 110 }
 111 #[allow(unused)]
 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 *const nativeBigSize)).clone() })) as *mut c_void
 115 }
 116 #[no_mangle]
 117 /// Creates a copy of the BigSize
 118 pub extern "C" fn BigSize_clone(orig: &BigSize) -> BigSize {
 119         orig.clone()
 120 }
 121 /// Generates a non-cryptographic 64-bit hash of the BigSize.
 122 #[no_mangle]
 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
 126         #[allow(deprecated)]
 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)
 130 }
 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.
 134 #[no_mangle]
 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 }
 139 }
 140 #[no_mangle]
 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())
 144 }
 145 #[allow(unused)]
 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) })
 148 }
 149 #[no_mangle]
 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() };
 154         local_res
 155 }
 156
 157 use lightning::util::ser::Hostname as nativeHostnameImport;
 158 pub(crate) type nativeHostname = nativeHostnameImport;
 159
 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.
 165 ///
 166 /// [`BOLT 7`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md
 167 #[must_use]
 168 #[repr(C)]
 169 pub struct Hostname {
 170         /// A pointer to the opaque Rust object.
 171
 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.
 176
 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.
 179         pub is_owned: bool,
 180 }
 181
 182 impl Drop for Hostname {
 183         fn drop(&mut self) {
 184                 if self.is_owned && !<*mut nativeHostname>::is_null(self.inner) {
 185                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 186                 }
 187         }
 188 }
 189 /// Frees any resources used by the Hostname, if is_owned is set and inner is non-NULL.
 190 #[no_mangle]
 191 pub extern "C" fn Hostname_free(this_obj: Hostname) { }
 192 #[allow(unused)]
 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) };
 196 }
 197 #[allow(unused)]
 198 impl Hostname {
 199         pub(crate) fn get_native_ref(&self) -> &'static nativeHostname {
 200                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 201         }
 202         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHostname {
 203                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 204         }
 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();
 210                 ret
 211         }
 212 }
 213 impl Clone for Hostname {
 214         fn clone(&self) -> Self {
 215                 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()) },
 218                         is_owned: true,
 219                 }
 220         }
 221 }
 222 #[allow(unused)]
 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 *const nativeHostname)).clone() })) as *mut c_void
 226 }
 227 #[no_mangle]
 228 /// Creates a copy of the Hostname
 229 pub extern "C" fn Hostname_clone(orig: &Hostname) -> Hostname {
 230         orig.clone()
 231 }
 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.
 235 #[no_mangle]
 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 }
 240 }
 241 /// Returns the length of the hostname.
 242 #[must_use]
 243 #[no_mangle]
 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();
 246         ret
 247 }
 248
 249 #[no_mangle]
 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())
 253 }
 254 #[allow(unused)]
 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) })
 257 }
 258 #[no_mangle]
 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() };
 263         local_res
 264 }
 265
 266 use lightning::util::ser::TransactionU16LenLimited as nativeTransactionU16LenLimitedImport;
 267 pub(crate) type nativeTransactionU16LenLimited = nativeTransactionU16LenLimitedImport;
 268
 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.
 271 ///
 272 /// Use [`TransactionU16LenLimited::into_transaction`] to convert into the contained `Transaction`.
 273 #[must_use]
 274 #[repr(C)]
 275 pub struct TransactionU16LenLimited {
 276         /// A pointer to the opaque Rust object.
 277
 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.
 282
 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.
 285         pub is_owned: bool,
 286 }
 287
 288 impl Drop for TransactionU16LenLimited {
 289         fn drop(&mut self) {
 290                 if self.is_owned && !<*mut nativeTransactionU16LenLimited>::is_null(self.inner) {
 291                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 292                 }
 293         }
 294 }
 295 /// Frees any resources used by the TransactionU16LenLimited, if is_owned is set and inner is non-NULL.
 296 #[no_mangle]
 297 pub extern "C" fn TransactionU16LenLimited_free(this_obj: TransactionU16LenLimited) { }
 298 #[allow(unused)]
 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) };
 302 }
 303 #[allow(unused)]
 304 impl TransactionU16LenLimited {
 305         pub(crate) fn get_native_ref(&self) -> &'static nativeTransactionU16LenLimited {
 306                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 307         }
 308         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTransactionU16LenLimited {
 309                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 310         }
 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();
 316                 ret
 317         }
 318 }
 319 impl Clone for TransactionU16LenLimited {
 320         fn clone(&self) -> Self {
 321                 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()) },
 324                         is_owned: true,
 325                 }
 326         }
 327 }
 328 #[allow(unused)]
 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 *const nativeTransactionU16LenLimited)).clone() })) as *mut c_void
 332 }
 333 #[no_mangle]
 334 /// Creates a copy of the TransactionU16LenLimited
 335 pub extern "C" fn TransactionU16LenLimited_clone(orig: &TransactionU16LenLimited) -> TransactionU16LenLimited {
 336         orig.clone()
 337 }
 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.
 341 #[no_mangle]
 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 }
 346 }
 347 /// Constructs a new `TransactionU16LenLimited` from a `Transaction` only if it's consensus-
 348 /// serialized length is <= u16::MAX.
 349 #[must_use]
 350 #[no_mangle]
 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() };
 354         local_ret
 355 }
 356
 357 /// Consumes this `TransactionU16LenLimited` and returns its contained `Transaction`.
 358 #[must_use]
 359 #[no_mangle]
 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)
 363 }
 364
 365 #[no_mangle]
 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())
 369 }
 370 #[allow(unused)]
 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) })
 373 }
 374 #[no_mangle]
 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() };
 379         local_res
 380 }