_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/offers/refund.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 //! Data structures and encoding for refunds.
  10 //!
  11 //! A [`Refund`] is an \"offer for money\" and is typically constructed by a merchant and presented
  12 //! directly to the customer. The recipient responds with a [`Bolt12Invoice`] to be paid.
  13 //!
  14 //! This is an [`InvoiceRequest`] produced *not* in response to an [`Offer`].
  15 //!
  16 //! [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
  17 //! [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
  18 //! [`Offer`]: crate::offers::offer::Offer
  19 //!
  20 //! ```
  21 //! extern crate bitcoin;
  22 //! extern crate core;
  23 //! extern crate lightning;
  24 //!
  25 //! use core::convert::TryFrom;
  26 //! use core::time::Duration;
  27 //!
  28 //! use bitcoin::network::constants::Network;
  29 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
  30 //! use lightning::offers::parse::Bolt12ParseError;
  31 //! use lightning::offers::refund::{Refund, RefundBuilder};
  32 //! use lightning::util::ser::{Readable, Writeable};
  33 //!
  34 //! # use lightning::blinded_path::BlindedPath;
  35 //! # #[cfg(feature = \"std\")]
  36 //! # use std::time::SystemTime;
  37 //! #
  38 //! # fn create_blinded_path() -> BlindedPath { unimplemented!() }
  39 //! # fn create_another_blinded_path() -> BlindedPath { unimplemented!() }
  40 //! #
  41 //! # #[cfg(feature = \"std\")]
  42 //! # fn build() -> Result<(), Bolt12ParseError> {
  43 //! let secp_ctx = Secp256k1::new();
  44 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
  45 //! let pubkey = PublicKey::from(keys);
  46 //!
  47 //! let expiration = SystemTime::now() + Duration::from_secs(24 * 60 * 60);
  48 //! let refund = RefundBuilder::new(\"coffee, large\".to_string(), vec![1; 32], pubkey, 20_000)?
  49 //!     .absolute_expiry(expiration.duration_since(SystemTime::UNIX_EPOCH).unwrap())
  50 //!     .issuer(\"Foo Bar\".to_string())
  51 //!     .path(create_blinded_path())
  52 //!     .path(create_another_blinded_path())
  53 //!     .chain(Network::Bitcoin)
  54 //!     .payer_note(\"refund for order #12345\".to_string())
  55 //!     .build()?;
  56 //!
  57 //! // Encode as a bech32 string for use in a QR code.
  58 //! let encoded_refund = refund.to_string();
  59 //!
  60 //! // Parse from a bech32 string after scanning from a QR code.
  61 //! let refund = encoded_refund.parse::<Refund>()?;
  62 //!
  63 //! // Encode refund as raw bytes.
  64 //! let mut bytes = Vec::new();
  65 //! refund.write(&mut bytes).unwrap();
  66 //!
  67 //! // Decode raw bytes into an refund.
  68 //! let refund = Refund::try_from(bytes)?;
  69 //! # Ok(())
  70 //! # }
  71 //! ```
  72
  73 use alloc::str::FromStr;
  74 use alloc::string::String;
  75 use core::ffi::c_void;
  76 use core::convert::Infallible;
  77 use bitcoin::hashes::Hash;
  78 use crate::c_types::*;
  79 #[cfg(feature="no-std")]
  80 use alloc::{vec::Vec, boxed::Box};
  81
  82
  83 use lightning::offers::refund::Refund as nativeRefundImport;
  84 pub(crate) type nativeRefund = nativeRefundImport;
  85
  86 /// A `Refund` is a request to send an [`Bolt12Invoice`] without a preceding [`Offer`].
  87 ///
  88 /// Typically, after an invoice is paid, the recipient may publish a refund allowing the sender to
  89 /// recoup their funds. A refund may be used more generally as an \"offer for money\", such as with a
  90 /// bitcoin ATM.
  91 ///
  92 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
  93 /// [`Offer`]: crate::offers::offer::Offer
  94 #[must_use]
  95 #[repr(C)]
  96 pub struct Refund {
  97         /// A pointer to the opaque Rust object.
  98
  99         /// Nearly everywhere, inner must be non-null, however in places where
 100         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 101         pub inner: *mut nativeRefund,
 102         /// Indicates that this is the only struct which contains the same pointer.
 103
 104         /// Rust functions which take ownership of an object provided via an argument require
 105         /// this to be true and invalidate the object pointed to by inner.
 106         pub is_owned: bool,
 107 }
 108
 109 impl Drop for Refund {
 110         fn drop(&mut self) {
 111                 if self.is_owned && !<*mut nativeRefund>::is_null(self.inner) {
 112                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 113                 }
 114         }
 115 }
 116 /// Frees any resources used by the Refund, if is_owned is set and inner is non-NULL.
 117 #[no_mangle]
 118 pub extern "C" fn Refund_free(this_obj: Refund) { }
 119 #[allow(unused)]
 120 /// Used only if an object of this type is returned as a trait impl by a method
 121 pub(crate) extern "C" fn Refund_free_void(this_ptr: *mut c_void) {
 122         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeRefund) };
 123 }
 124 #[allow(unused)]
 125 impl Refund {
 126         pub(crate) fn get_native_ref(&self) -> &'static nativeRefund {
 127                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 128         }
 129         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRefund {
 130                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 131         }
 132         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 133         pub(crate) fn take_inner(mut self) -> *mut nativeRefund {
 134                 assert!(self.is_owned);
 135                 let ret = ObjOps::untweak_ptr(self.inner);
 136                 self.inner = core::ptr::null_mut();
 137                 ret
 138         }
 139 }
 140 impl Clone for Refund {
 141         fn clone(&self) -> Self {
 142                 Self {
 143                         inner: if <*mut nativeRefund>::is_null(self.inner) { core::ptr::null_mut() } else {
 144                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 145                         is_owned: true,
 146                 }
 147         }
 148 }
 149 #[allow(unused)]
 150 /// Used only if an object of this type is returned as a trait impl by a method
 151 pub(crate) extern "C" fn Refund_clone_void(this_ptr: *const c_void) -> *mut c_void {
 152         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRefund)).clone() })) as *mut c_void
 153 }
 154 #[no_mangle]
 155 /// Creates a copy of the Refund
 156 pub extern "C" fn Refund_clone(orig: &Refund) -> Refund {
 157         orig.clone()
 158 }
 159 /// A complete description of the purpose of the refund. Intended to be displayed to the user
 160 /// but with the caveat that it has not been verified in any way.
 161 #[must_use]
 162 #[no_mangle]
 163 pub extern "C" fn Refund_description(this_arg: &crate::lightning::offers::refund::Refund) -> crate::lightning::util::string::PrintableString {
 164         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.description();
 165         crate::lightning::util::string::PrintableString { inner: ObjOps::heap_alloc(ret), is_owned: true }
 166 }
 167
 168 /// Duration since the Unix epoch when an invoice should no longer be sent.
 169 ///
 170 /// If `None`, the refund does not expire.
 171 #[must_use]
 172 #[no_mangle]
 173 pub extern "C" fn Refund_absolute_expiry(this_arg: &crate::lightning::offers::refund::Refund) -> crate::c_types::derived::COption_u64Z {
 174         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.absolute_expiry();
 175         let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { ret.unwrap().as_secs() }) };
 176         local_ret
 177 }
 178
 179 /// Whether the refund has expired.
 180 #[must_use]
 181 #[no_mangle]
 182 pub extern "C" fn Refund_is_expired(this_arg: &crate::lightning::offers::refund::Refund) -> bool {
 183         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_expired();
 184         ret
 185 }
 186
 187 /// The issuer of the refund, possibly beginning with `user@domain` or `domain`. Intended to be
 188 /// displayed to the user but with the caveat that it has not been verified in any way.
 189 ///
 190 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 191 #[must_use]
 192 #[no_mangle]
 193 pub extern "C" fn Refund_issuer(this_arg: &crate::lightning::offers::refund::Refund) -> crate::lightning::util::string::PrintableString {
 194         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.issuer();
 195         let mut local_ret = crate::lightning::util::string::PrintableString { inner: if ret.is_none() { core::ptr::null_mut() } else {  { ObjOps::heap_alloc((ret.unwrap())) } }, is_owned: true };
 196         local_ret
 197 }
 198
 199 /// Paths to the sender originating from publicly reachable nodes. Blinded paths provide sender
 200 /// privacy by obfuscating its node id.
 201 #[must_use]
 202 #[no_mangle]
 203 pub extern "C" fn Refund_paths(this_arg: &crate::lightning::offers::refund::Refund) -> crate::c_types::derived::CVec_BlindedPathZ {
 204         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.paths();
 205         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::blinded_path::BlindedPath { inner: ObjOps::heap_alloc(item), is_owned: true } }); };
 206         local_ret.into()
 207 }
 208
 209 /// An unpredictable series of bytes, typically containing information about the derivation of
 210 /// [`payer_id`].
 211 ///
 212 /// [`payer_id`]: Self::payer_id
 213 #[must_use]
 214 #[no_mangle]
 215 pub extern "C" fn Refund_payer_metadata(this_arg: &crate::lightning::offers::refund::Refund) -> crate::c_types::u8slice {
 216         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.payer_metadata();
 217         let mut local_ret = crate::c_types::u8slice::from_slice(ret);
 218         local_ret
 219 }
 220
 221 /// A chain that the refund is valid for.
 222 #[must_use]
 223 #[no_mangle]
 224 pub extern "C" fn Refund_chain(this_arg: &crate::lightning::offers::refund::Refund) -> crate::c_types::ThirtyTwoBytes {
 225         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.chain();
 226         crate::c_types::ThirtyTwoBytes { data: ret.to_bytes() }
 227 }
 228
 229 /// The amount to refund in msats (i.e., the minimum lightning-payable unit for [`chain`]).
 230 ///
 231 /// [`chain`]: Self::chain
 232 #[must_use]
 233 #[no_mangle]
 234 pub extern "C" fn Refund_amount_msats(this_arg: &crate::lightning::offers::refund::Refund) -> u64 {
 235         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.amount_msats();
 236         ret
 237 }
 238
 239 /// Features pertaining to requesting an invoice.
 240 #[must_use]
 241 #[no_mangle]
 242 pub extern "C" fn Refund_features(this_arg: &crate::lightning::offers::refund::Refund) -> crate::lightning::ln::features::InvoiceRequestFeatures {
 243         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.features();
 244         crate::lightning::ln::features::InvoiceRequestFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::features::InvoiceRequestFeatures<>) as *mut _) }, is_owned: false }
 245 }
 246
 247 /// The quantity of an item that refund is for.
 248 #[must_use]
 249 #[no_mangle]
 250 pub extern "C" fn Refund_quantity(this_arg: &crate::lightning::offers::refund::Refund) -> crate::c_types::derived::COption_u64Z {
 251         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.quantity();
 252         let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { ret.unwrap() }) };
 253         local_ret
 254 }
 255
 256 /// A public node id to send to in the case where there are no [`paths`]. Otherwise, a possibly
 257 /// transient pubkey.
 258 ///
 259 /// [`paths`]: Self::paths
 260 #[must_use]
 261 #[no_mangle]
 262 pub extern "C" fn Refund_payer_id(this_arg: &crate::lightning::offers::refund::Refund) -> crate::c_types::PublicKey {
 263         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.payer_id();
 264         crate::c_types::PublicKey::from_rust(&ret)
 265 }
 266
 267 /// Payer provided note to include in the invoice.
 268 ///
 269 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 270 #[must_use]
 271 #[no_mangle]
 272 pub extern "C" fn Refund_payer_note(this_arg: &crate::lightning::offers::refund::Refund) -> crate::lightning::util::string::PrintableString {
 273         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.payer_note();
 274         let mut local_ret = crate::lightning::util::string::PrintableString { inner: if ret.is_none() { core::ptr::null_mut() } else {  { ObjOps::heap_alloc((ret.unwrap())) } }, is_owned: true };
 275         local_ret
 276 }
 277
 278 #[no_mangle]
 279 /// Serialize the Refund object into a byte array which can be read by Refund_read
 280 pub extern "C" fn Refund_write(obj: &crate::lightning::offers::refund::Refund) -> crate::c_types::derived::CVec_u8Z {
 281         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 282 }
 283 #[no_mangle]
 284 pub(crate) extern "C" fn Refund_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 285         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRefund) })
 286 }
 287 #[no_mangle]
 288 /// Read a Refund object from a string
 289 pub extern "C" fn Refund_from_str(s: crate::c_types::Str) -> crate::c_types::derived::CResult_RefundBolt12ParseErrorZ {
 290         match lightning::offers::refund::Refund::from_str(s.into_str()) {
 291                 Ok(r) => {
 292                         crate::c_types::CResultTempl::ok(
 293                                 crate::lightning::offers::refund::Refund { inner: ObjOps::heap_alloc(r), is_owned: true }
 294                         )
 295                 },
 296                 Err(e) => {
 297                         crate::c_types::CResultTempl::err(
 298                                 crate::lightning::offers::parse::Bolt12ParseError { inner: ObjOps::heap_alloc(e), is_owned: true }
 299                         )
 300                 },
 301         }.into()
 302 }