[TS] Update auto-generated bindings to LDK-C-Bindings 0.0.123.1
[ldk-java] / c_sharp / src / org / ldk / structs / Offer.cs
index c23621e4a4a5eb9ea02ed7f1c03095b7e306c11d..3db5c8443c8d61e5c6ce11f80ce09a2506ab54c2 100644 (file)
@@ -51,19 +51,18 @@ public class Offer : CommonBase {
         * for the selected chain.
         */
        public byte[][] chains() {
-               byte[][] ret = bindings.Offer_chains(this.ptr);
+               long ret = bindings.Offer_chains(this.ptr);
                GC.KeepAlive(this);
-               return ret;
-       }
-
-       /**
-        * Returns whether the given chain is supported by the offer.
-        */
-       public bool supports_chain(byte[] chain) {
-               bool ret = bindings.Offer_supports_chain(this.ptr, InternalUtils.check_arr_len(chain, 32));
-               GC.KeepAlive(this);
-               GC.KeepAlive(chain);
-               return ret;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               int ret_conv_8_len = InternalUtils.getArrayLength(ret);
+               byte[][] ret_conv_8_arr = new byte[ret_conv_8_len][];
+               for (int i = 0; i < ret_conv_8_len; i++) {
+                       long ret_conv_8 = InternalUtils.getU64ArrayElem(ret, i);
+                       byte[] ret_conv_8_conv = InternalUtils.decodeUint8Array(ret_conv_8);
+                       ret_conv_8_arr[i] = ret_conv_8_conv;
+               }
+               bindings.free_buffer(ret);
+               return ret_conv_8_arr;
        }
 
        /**
@@ -81,14 +80,12 @@ public class Offer : CommonBase {
 
        /**
         * The minimum amount required for a successful payment of a single item.
-        * 
-        * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
         */
-       public Amount amount() {
+       public Option_AmountZ amount() {
                long ret = bindings.Offer_amount(this.ptr);
                GC.KeepAlive(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               org.ldk.structs.Amount ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Amount(null, ret); }
+               org.ldk.structs.Option_AmountZ ret_hu_conv = org.ldk.structs.Option_AmountZ.constr_from_ptr(ret);
                if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
                return ret_hu_conv;
        }
@@ -96,6 +93,8 @@ public class Offer : CommonBase {
        /**
         * A complete description of the purpose of the payment. Intended to be displayed to the user
         * but with the caveat that it has not been verified in any way.
+        * 
+        * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
         */
        public PrintableString description() {
                long ret = bindings.Offer_description(this.ptr);
@@ -109,8 +108,8 @@ public class Offer : CommonBase {
        /**
         * Features pertaining to the offer.
         */
-       public OfferFeatures features() {
-               long ret = bindings.Offer_features(this.ptr);
+       public OfferFeatures offer_features() {
+               long ret = bindings.Offer_offer_features(this.ptr);
                GC.KeepAlive(this);
                if (ret >= 0 && ret <= 4096) { return null; }
                org.ldk.structs.OfferFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OfferFeatures(null, ret); }
@@ -123,24 +122,15 @@ public class Offer : CommonBase {
         * 
         * If `None`, the offer does not expire.
         */
-       public Option_DurationZ absolute_expiry() {
+       public Option_u64Z absolute_expiry() {
                long ret = bindings.Offer_absolute_expiry(this.ptr);
                GC.KeepAlive(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               org.ldk.structs.Option_DurationZ ret_hu_conv = org.ldk.structs.Option_DurationZ.constr_from_ptr(ret);
+               org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
                if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
                return ret_hu_conv;
        }
 
-       /**
-        * Whether the offer has expired.
-        */
-       public bool is_expired() {
-               bool ret = bindings.Offer_is_expired(this.ptr);
-               GC.KeepAlive(this);
-               return ret;
-       }
-
        /**
         * The issuer of the offer, possibly beginning with `user@domain` or `domain`. Intended to be
         * displayed to the user but with the caveat that it has not been verified in any way.
@@ -161,16 +151,18 @@ public class Offer : CommonBase {
         * recipient privacy by obfuscating its node id.
         */
        public BlindedPath[] paths() {
-               long[] ret = bindings.Offer_paths(this.ptr);
+               long ret = bindings.Offer_paths(this.ptr);
                GC.KeepAlive(this);
-               int ret_conv_13_len = ret.Length;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               int ret_conv_13_len = InternalUtils.getArrayLength(ret);
                BlindedPath[] ret_conv_13_arr = new BlindedPath[ret_conv_13_len];
                for (int n = 0; n < ret_conv_13_len; n++) {
-                       long ret_conv_13 = ret[n];
+                       long ret_conv_13 = InternalUtils.getU64ArrayElem(ret, n);
                        org.ldk.structs.BlindedPath ret_conv_13_hu_conv = null; if (ret_conv_13 < 0 || ret_conv_13 > 4096) { ret_conv_13_hu_conv = new org.ldk.structs.BlindedPath(null, ret_conv_13); }
                        if (ret_conv_13_hu_conv != null) { ret_conv_13_hu_conv.ptrs_to.AddLast(this); };
                        ret_conv_13_arr[n] = ret_conv_13_hu_conv;
                }
+               bindings.free_buffer(ret);
                return ret_conv_13_arr;
        }
 
@@ -181,11 +173,65 @@ public class Offer : CommonBase {
                long ret = bindings.Offer_supported_quantity(this.ptr);
                GC.KeepAlive(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               org.ldk.structs.Quantity ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Quantity(null, ret); }
+               org.ldk.structs.Quantity ret_hu_conv = org.ldk.structs.Quantity.constr_from_ptr(ret);
                if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
                return ret_hu_conv;
        }
 
+       /**
+        * The public key used by the recipient to sign invoices.
+        * 
+        * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+        */
+       public byte[] signing_pubkey() {
+               long ret = bindings.Offer_signing_pubkey(this.ptr);
+               GC.KeepAlive(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
+               return ret_conv;
+       }
+
+       /**
+        * Returns the id of the offer.
+        */
+       public OfferId id() {
+               long ret = bindings.Offer_id(this.ptr);
+               GC.KeepAlive(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.OfferId ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OfferId(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Returns whether the given chain is supported by the offer.
+        */
+       public bool supports_chain(byte[] chain) {
+               bool ret = bindings.Offer_supports_chain(this.ptr, InternalUtils.encodeUint8Array(InternalUtils.check_arr_len(chain, 32)));
+               GC.KeepAlive(this);
+               GC.KeepAlive(chain);
+               return ret;
+       }
+
+       /**
+        * Whether the offer has expired.
+        */
+       public bool is_expired() {
+               bool ret = bindings.Offer_is_expired(this.ptr);
+               GC.KeepAlive(this);
+               return ret;
+       }
+
+       /**
+        * Whether the offer has expired given the duration since the Unix epoch.
+        */
+       public bool is_expired_no_std(long duration_since_epoch) {
+               bool ret = bindings.Offer_is_expired_no_std(this.ptr, duration_since_epoch);
+               GC.KeepAlive(this);
+               GC.KeepAlive(duration_since_epoch);
+               return ret;
+       }
+
        /**
         * Returns whether the given quantity is valid for the offer.
         */
@@ -208,33 +254,126 @@ public class Offer : CommonBase {
        }
 
        /**
-        * The public key used by the recipient to sign invoices.
+        * Similar to [`Offer::request_invoice`] except it:
+        * - derives the [`InvoiceRequest::payer_id`] such that a different key can be used for each
+        * request,
+        * - sets [`InvoiceRequest::payer_metadata`] when [`InvoiceRequestBuilder::build`] is called
+        * such that it can be used by [`Bolt12Invoice::verify`] to determine if the invoice was
+        * requested using a base [`ExpandedKey`] from which the payer id was derived, and
+        * - includes the [`PaymentId`] encrypted in [`InvoiceRequest::payer_metadata`] so that it can
+        * be used when sending the payment for the requested invoice.
+        * 
+        * Useful to protect the sender's privacy.
+        * 
+        * [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
+        * [`InvoiceRequest::payer_metadata`]: crate::offers::invoice_request::InvoiceRequest::payer_metadata
+        * [`Bolt12Invoice::verify`]: crate::offers::invoice::Bolt12Invoice::verify
+        * [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
         */
-       public byte[] signing_pubkey() {
-               byte[] ret = bindings.Offer_signing_pubkey(this.ptr);
+       public Result_InvoiceRequestWithDerivedPayerIdBuilderBolt12SemanticErrorZ request_invoice_deriving_payer_id(org.ldk.structs.ExpandedKey expanded_key, org.ldk.structs.EntropySource entropy_source, byte[] payment_id) {
+               long ret = bindings.Offer_request_invoice_deriving_payer_id(this.ptr, expanded_key.ptr, entropy_source.ptr, InternalUtils.encodeUint8Array(InternalUtils.check_arr_len(payment_id, 32)));
+               GC.KeepAlive(this);
+               GC.KeepAlive(expanded_key);
+               GC.KeepAlive(entropy_source);
+               GC.KeepAlive(payment_id);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_InvoiceRequestWithDerivedPayerIdBuilderBolt12SemanticErrorZ ret_hu_conv = Result_InvoiceRequestWithDerivedPayerIdBuilderBolt12SemanticErrorZ.constr_from_ptr(ret);
+               if (this != null) { this.ptrs_to.AddLast(expanded_key); };
+               if (this != null) { this.ptrs_to.AddLast(entropy_source); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Similar to [`Offer::request_invoice_deriving_payer_id`] except uses `payer_id` for the
+        * [`InvoiceRequest::payer_id`] instead of deriving a different key for each request.
+        * 
+        * Useful for recurring payments using the same `payer_id` with different invoices.
+        * 
+        * [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
+        */
+       public Result_InvoiceRequestWithExplicitPayerIdBuilderBolt12SemanticErrorZ request_invoice_deriving_metadata(byte[] payer_id, org.ldk.structs.ExpandedKey expanded_key, org.ldk.structs.EntropySource entropy_source, byte[] payment_id) {
+               long ret = bindings.Offer_request_invoice_deriving_metadata(this.ptr, InternalUtils.encodeUint8Array(InternalUtils.check_arr_len(payer_id, 33)), expanded_key.ptr, entropy_source.ptr, InternalUtils.encodeUint8Array(InternalUtils.check_arr_len(payment_id, 32)));
+               GC.KeepAlive(this);
+               GC.KeepAlive(payer_id);
+               GC.KeepAlive(expanded_key);
+               GC.KeepAlive(entropy_source);
+               GC.KeepAlive(payment_id);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_InvoiceRequestWithExplicitPayerIdBuilderBolt12SemanticErrorZ ret_hu_conv = Result_InvoiceRequestWithExplicitPayerIdBuilderBolt12SemanticErrorZ.constr_from_ptr(ret);
+               if (this != null) { this.ptrs_to.AddLast(expanded_key); };
+               if (this != null) { this.ptrs_to.AddLast(entropy_source); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Creates an [`InvoiceRequestBuilder`] for the offer with the given `metadata` and `payer_id`,
+        * which will be reflected in the `Bolt12Invoice` response.
+        * 
+        * The `metadata` is useful for including information about the derivation of `payer_id` such
+        * that invoice response handling can be stateless. Also serves as payer-provided entropy while
+        * hashing in the signature calculation.
+        * 
+        * This should not leak any information such as by using a simple BIP-32 derivation path.
+        * Otherwise, payments may be correlated.
+        * 
+        * Errors if the offer contains unknown required features.
+        * 
+        * [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
+        */
+       public Result_InvoiceRequestWithExplicitPayerIdBuilderBolt12SemanticErrorZ request_invoice(byte[] metadata, byte[] payer_id) {
+               long ret = bindings.Offer_request_invoice(this.ptr, InternalUtils.encodeUint8Array(metadata), InternalUtils.encodeUint8Array(InternalUtils.check_arr_len(payer_id, 33)));
+               GC.KeepAlive(this);
+               GC.KeepAlive(metadata);
+               GC.KeepAlive(payer_id);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_InvoiceRequestWithExplicitPayerIdBuilderBolt12SemanticErrorZ ret_hu_conv = Result_InvoiceRequestWithExplicitPayerIdBuilderBolt12SemanticErrorZ.constr_from_ptr(ret);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Generates a non-cryptographic 64-bit hash of the Offer.
+        */
+       public long hash() {
+               long ret = bindings.Offer_hash(this.ptr);
                GC.KeepAlive(this);
                return ret;
        }
 
+       public override int GetHashCode() {
+               return (int)this.hash();
+       }
        /**
         * Serialize the Offer object into a byte array which can be read by Offer_read
         */
        public byte[] write() {
-               byte[] ret = bindings.Offer_write(this.ptr);
+               long ret = bindings.Offer_write(this.ptr);
                GC.KeepAlive(this);
-               return ret;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
+               return ret_conv;
        }
 
        /**
         * Read a Offer object from a string
         */
        public static Result_OfferBolt12ParseErrorZ from_str(string s) {
-               long ret = bindings.Offer_from_str(s);
+               long ret = bindings.Offer_from_str(InternalUtils.encodeString(s));
                GC.KeepAlive(s);
                if (ret >= 0 && ret <= 4096) { return null; }
                Result_OfferBolt12ParseErrorZ ret_hu_conv = Result_OfferBolt12ParseErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }
 
+       /**
+        * Get the string representation of a Offer object
+        */
+       public string to_str() {
+               long ret = bindings.Offer_to_str(this.ptr);
+               GC.KeepAlive(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               string ret_conv = InternalUtils.decodeString(ret);
+               return ret_conv;
+       }
+
 }
 } } }