org.ldk.structs.InvoiceRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldk-java Show documentation
Show all versions of ldk-java Show documentation
LDK Java Bindings and Release Binaries
package org.ldk.structs;
import org.ldk.impl.bindings;
import org.ldk.enums.*;
import org.ldk.util.*;
import java.util.Arrays;
import java.lang.ref.Reference;
import javax.annotation.Nullable;
/**
* An `InvoiceRequest` is a request for a [`Bolt12Invoice`] formulated from an [`Offer`].
*
* An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
* specifies these such that its recipient can send an invoice for payment.
*
* [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
* [`Offer`]: crate::offers::offer::Offer
*/
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class InvoiceRequest extends CommonBase {
InvoiceRequest(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
super.finalize();
if (ptr != 0) { bindings.InvoiceRequest_free(ptr); }
}
long clone_ptr() {
long ret = bindings.InvoiceRequest_clone_ptr(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
/**
* Creates a copy of the InvoiceRequest
*/
public InvoiceRequest clone() {
long ret = bindings.InvoiceRequest_clone(this.ptr);
Reference.reachabilityFence(this);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.InvoiceRequest ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceRequest(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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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.InvoiceRequest_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;
}
/**
* Signature of the invoice request using [`payer_id`].
*
* [`payer_id`]: Self::payer_id
*/
public byte[] signature() {
byte[] ret = bindings.InvoiceRequest_signature(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
/**
* Verifies that the request was for an offer created using the given key. Returns the verified
* request which contains the derived keys needed to sign a [`Bolt12Invoice`] for the request
* if they could be extracted from the metadata.
*
* [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
*/
public Result_VerifiedInvoiceRequestNoneZ verify(org.ldk.structs.ExpandedKey key) {
long ret = bindings.InvoiceRequest_verify(this.ptr, key == null ? 0 : key.ptr);
Reference.reachabilityFence(this);
Reference.reachabilityFence(key);
if (ret >= 0 && ret <= 4096) { return null; }
Result_VerifiedInvoiceRequestNoneZ ret_hu_conv = Result_VerifiedInvoiceRequestNoneZ.constr_from_ptr(ret);
if (this != null) { this.ptrs_to.add(key); };
if (this != null) { this.ptrs_to.add(this); };
return ret_hu_conv;
}
/**
* Serialize the InvoiceRequest object into a byte array which can be read by InvoiceRequest_read
*/
public byte[] write() {
byte[] ret = bindings.InvoiceRequest_write(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
}