X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FUnsignedInvoiceRequest.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FUnsignedInvoiceRequest.java;h=b8b19b9c96ef46fdbc49ea786a4cda91e7f76065;hb=07d5d868dfe064aadb28a7f7ca6002c16be9723d;hp=4a772806f2b6c2f92f641009e0388b590498bd81;hpb=32973ea2749f8efd05b543dd774763513013b38b;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/UnsignedInvoiceRequest.java b/src/main/java/org/ldk/structs/UnsignedInvoiceRequest.java
index 4a772806..b8b19b9c 100644
--- a/src/main/java/org/ldk/structs/UnsignedInvoiceRequest.java
+++ b/src/main/java/org/ldk/structs/UnsignedInvoiceRequest.java
@@ -10,6 +10,11 @@ import javax.annotation.Nullable;
 
 /**
  * A semantically valid [`InvoiceRequest`] that hasn't been signed.
+ * 
+ * # Serialization
+ * 
+ * This is serialized as a TLV stream, which includes TLV records from the originating message. As
+ * such, it may include unknown, odd TLV records.
  */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class UnsignedInvoiceRequest extends CommonBase {
@@ -20,4 +25,243 @@ public class UnsignedInvoiceRequest extends CommonBase {
 		if (ptr != 0) { bindings.UnsignedInvoiceRequest_free(ptr); }
 	}
 
+	/**
+	 * Returns the [`TaggedHash`] of the invoice to sign.
+	 */
+	public TaggedHash tagged_hash() {
+		long ret = bindings.UnsignedInvoiceRequest_tagged_hash(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.TaggedHash ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.TaggedHash(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * The chains that may be used when paying a requested invoice (e.g., bitcoin mainnet).
+	 * Payments must be denominated in units of the minimal lightning-payable unit (e.g., msats)
+	 * for the selected chain.
+	 */
+	public byte[][] chains() {
+		byte[][] ret = bindings.UnsignedInvoiceRequest_chains(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * Opaque bytes set by the originator. Useful for authentication and validating fields since it
+	 * is reflected in `invoice_request` messages along with all the other fields from the `offer`.
+	 */
+	public Option_CVec_u8ZZ metadata() {
+		long ret = bindings.UnsignedInvoiceRequest_metadata(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.Option_CVec_u8ZZ ret_hu_conv = org.ldk.structs.Option_CVec_u8ZZ.constr_from_ptr(ret);
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * 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
+	 */
+	@Nullable
+	public Amount amount() {
+		long ret = bindings.UnsignedInvoiceRequest_amount(this.ptr);
+		Reference.reachabilityFence(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); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * 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.
+	 */
+	public PrintableString description() {
+		long ret = bindings.UnsignedInvoiceRequest_description(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Features pertaining to the offer.
+	 */
+	public OfferFeatures offer_features() {
+		long ret = bindings.UnsignedInvoiceRequest_offer_features(this.ptr);
+		Reference.reachabilityFence(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); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Duration since the Unix epoch when an invoice should no longer be requested.
+	 * 
+	 * If `None`, the offer does not expire.
+	 */
+	public Option_u64Z absolute_expiry() {
+		long ret = bindings.UnsignedInvoiceRequest_absolute_expiry(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		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.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * 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.
+	 * 
+	 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	@Nullable
+	public PrintableString issuer() {
+		long ret = bindings.UnsignedInvoiceRequest_issuer(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Paths to the recipient originating from publicly reachable nodes. Blinded paths provide
+	 * recipient privacy by obfuscating its node id.
+	 */
+	public BlindedPath[] paths() {
+		long[] ret = bindings.UnsignedInvoiceRequest_paths(this.ptr);
+		Reference.reachabilityFence(this);
+		int ret_conv_13_len = ret.length;
+		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];
+			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.add(this); };
+			ret_conv_13_arr[n] = ret_conv_13_hu_conv;
+		}
+		return ret_conv_13_arr;
+	}
+
+	/**
+	 * The quantity of items supported.
+	 */
+	public Quantity supported_quantity() {
+		long ret = bindings.UnsignedInvoiceRequest_supported_quantity(this.ptr);
+		Reference.reachabilityFence(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); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * The public key used by the recipient to sign invoices.
+	 */
+	public byte[] signing_pubkey() {
+		byte[] ret = bindings.UnsignedInvoiceRequest_signing_pubkey(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * An unpredictable series of bytes, typically containing information about the derivation of
+	 * [`payer_id`].
+	 * 
+	 * [`payer_id`]: Self::payer_id
+	 */
+	public byte[] payer_metadata() {
+		byte[] ret = bindings.UnsignedInvoiceRequest_payer_metadata(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * A chain from [`Offer::chains`] that the offer is valid for.
+	 */
+	public byte[] chain() {
+		byte[] ret = bindings.UnsignedInvoiceRequest_chain(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
+	 * must be greater than or equal to [`Offer::amount`], converted if necessary.
+	 * 
+	 * [`chain`]: Self::chain
+	 */
+	public Option_u64Z amount_msats() {
+		long ret = bindings.UnsignedInvoiceRequest_amount_msats(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		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.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Features pertaining to requesting an invoice.
+	 */
+	public InvoiceRequestFeatures invoice_request_features() {
+		long ret = bindings.UnsignedInvoiceRequest_invoice_request_features(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.InvoiceRequestFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceRequestFeatures(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
+	 */
+	public Option_u64Z quantity() {
+		long ret = bindings.UnsignedInvoiceRequest_quantity(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		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.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * A possibly transient pubkey used to sign the invoice request.
+	 */
+	public byte[] payer_id() {
+		byte[] ret = bindings.UnsignedInvoiceRequest_payer_id(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * A payer-provided note which will be seen by the recipient and reflected back in the invoice
+	 * response.
+	 * 
+	 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	@Nullable
+	public PrintableString payer_note() {
+		long ret = bindings.UnsignedInvoiceRequest_payer_note(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Serialize the UnsignedInvoiceRequest object into a byte array which can be read by UnsignedInvoiceRequest_read
+	 */
+	public byte[] write() {
+		byte[] ret = bindings.UnsignedInvoiceRequest_write(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
 }