_ Git - ldk-java/blob - src/main/java/org/ldk/structs/SignedRawInvoice.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7
   8
   9 /**
  10  * Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
  11  * invalid.
  12  *
  13  * # Invariants
  14  * The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
  15  */
  16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  17 public class SignedRawInvoice extends CommonBase {
  18         SignedRawInvoice(Object _dummy, long ptr) { super(ptr); }
  19         @Override @SuppressWarnings("deprecation")
  20         protected void finalize() throws Throwable {
  21                 super.finalize();
  22                 if (ptr != 0) { bindings.SignedRawInvoice_free(ptr); }
  23         }
  24
  25         /**
  26          * Checks if two SignedRawInvoices contain equal inner contents.
  27          * This ignores pointers and is_owned flags and looks at the values in fields.
  28          * Two objects with NULL inner values will be considered "equal" here.
  29          */
  30         public boolean eq(SignedRawInvoice b) {
  31                 boolean ret = bindings.SignedRawInvoice_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
  32                 this.ptrs_to.add(b);
  33                 return ret;
  34         }
  35
  36         /**
  37          * Creates a copy of the SignedRawInvoice
  38          */
  39         public SignedRawInvoice clone() {
  40                 long ret = bindings.SignedRawInvoice_clone(this.ptr);
  41                 if (ret < 1024) { return null; }
  42                 SignedRawInvoice ret_hu_conv = new SignedRawInvoice(null, ret);
  43                 ret_hu_conv.ptrs_to.add(this);
  44                 return ret_hu_conv;
  45         }
  46
  47         /**
  48          * Disassembles the `SignedRawInvoice` into its three parts:
  49          * 1. raw invoice
  50          * 2. hash of the raw invoice
  51          * 3. signature
  52          */
  53         public ThreeTuple<RawInvoice, byte[], InvoiceSignature> into_parts() {
  54                 long ret = bindings.SignedRawInvoice_into_parts(this.ptr);
  55                 if (ret < 1024) { return null; }
  56                 long ret_a = bindings.LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ_get_a(ret);
  57                 RawInvoice ret_a_hu_conv = new RawInvoice(null, ret_a);
  58                 ret_a_hu_conv.ptrs_to.add(this);;
  59                 byte[] ret_b = bindings.LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ_get_b(ret);
  60                 long ret_c = bindings.LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ_get_c(ret);
  61                 InvoiceSignature ret_c_hu_conv = new InvoiceSignature(null, ret_c);
  62                 ret_c_hu_conv.ptrs_to.add(this);;
  63                 ThreeTuple<RawInvoice, byte[], InvoiceSignature> ret_conv = new ThreeTuple<RawInvoice, byte[], InvoiceSignature>(ret_a_hu_conv, ret_b, ret_c_hu_conv, () -> {
  64                         bindings.C3Tuple_RawInvoice_u832InvoiceSignatureZ_free(ret);
  65                 });
  66                 ret_a_hu_conv.ptrs_to.add(ret_conv);
  67                 ret_c_hu_conv.ptrs_to.add(ret_conv);
  68                 this.ptrs_to.add(this);
  69                 return ret_conv;
  70         }
  71
  72         /**
  73          * The `RawInvoice` which was signed.
  74          */
  75         public RawInvoice raw_invoice() {
  76                 long ret = bindings.SignedRawInvoice_raw_invoice(this.ptr);
  77                 if (ret < 1024) { return null; }
  78                 RawInvoice ret_hu_conv = new RawInvoice(null, ret);
  79                 ret_hu_conv.ptrs_to.add(this);
  80                 return ret_hu_conv;
  81         }
  82
  83         /**
  84          * The hash of the `RawInvoice` that was signed.
  85          */
  86         public byte[] hash() {
  87                 byte[] ret = bindings.SignedRawInvoice_hash(this.ptr);
  88                 return ret;
  89         }
  90
  91         /**
  92          * InvoiceSignature for the invoice.
  93          */
  94         public InvoiceSignature signature() {
  95                 long ret = bindings.SignedRawInvoice_signature(this.ptr);
  96                 if (ret < 1024) { return null; }
  97                 InvoiceSignature ret_hu_conv = new InvoiceSignature(null, ret);
  98                 ret_hu_conv.ptrs_to.add(this);
  99                 return ret_hu_conv;
 100         }
 101
 102         /**
 103          * Recovers the public key used for signing the invoice from the recoverable signature.
 104          */
 105         public Result_PayeePubKeyErrorZ recover_payee_pub_key() {
 106                 long ret = bindings.SignedRawInvoice_recover_payee_pub_key(this.ptr);
 107                 if (ret < 1024) { return null; }
 108                 Result_PayeePubKeyErrorZ ret_hu_conv = Result_PayeePubKeyErrorZ.constr_from_ptr(ret);
 109                 return ret_hu_conv;
 110         }
 111
 112         /**
 113          * Checks if the signature is valid for the included payee public key or if none exists if it's
 114          * valid for the recovered signature (which should always be true?).
 115          */
 116         public boolean check_signature() {
 117                 boolean ret = bindings.SignedRawInvoice_check_signature(this.ptr);
 118                 return ret;
 119         }
 120
 121         /**
 122          * Read a SignedRawInvoice object from a string
 123          */
 124         public static Result_SignedRawInvoiceNoneZ from_str(String s) {
 125                 long ret = bindings.SignedRawInvoice_from_str(s);
 126                 if (ret < 1024) { return null; }
 127                 Result_SignedRawInvoiceNoneZ ret_hu_conv = Result_SignedRawInvoiceNoneZ.constr_from_ptr(ret);
 128                 return ret_hu_conv;
 129         }
 130
 131         /**
 132          * Get the string representation of a SignedRawInvoice object
 133          */
 134         public String to_str() {
 135                 String ret = bindings.SignedRawInvoice_to_str(this.ptr);
 136                 return ret;
 137         }
 138
 139 }