_ Git - ldk-java/blob - src/main/java/org/ldk/structs/Payee.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 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * The recipient of a payment.
  13  */
  14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  15 public class Payee extends CommonBase {
  16         Payee(Object _dummy, long ptr) { super(ptr); }
  17         @Override @SuppressWarnings("deprecation")
  18         protected void finalize() throws Throwable {
  19                 super.finalize();
  20                 if (ptr != 0) { bindings.Payee_free(ptr); }
  21         }
  22
  23         /**
  24          * The node id of the payee.
  25          */
  26         public byte[] get_pubkey() {
  27                 byte[] ret = bindings.Payee_get_pubkey(this.ptr);
  28                 Reference.reachabilityFence(this);
  29                 return ret;
  30         }
  31
  32         /**
  33          * The node id of the payee.
  34          */
  35         public void set_pubkey(byte[] val) {
  36                 bindings.Payee_set_pubkey(this.ptr, InternalUtils.check_arr_len(val, 33));
  37                 Reference.reachabilityFence(this);
  38                 Reference.reachabilityFence(val);
  39         }
  40
  41         /**
  42          * Features supported by the payee.
  43          *
  44          * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
  45          * does not contain any features.
  46          *
  47          * [`for_keysend`]: Self::for_keysend
  48          *
  49          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
  50          */
  51         @Nullable
  52         public InvoiceFeatures get_features() {
  53                 long ret = bindings.Payee_get_features(this.ptr);
  54                 Reference.reachabilityFence(this);
  55                 if (ret >= 0 && ret <= 4096) { return null; }
  56                 InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new InvoiceFeatures(null, ret); }
  57                 ret_hu_conv.ptrs_to.add(this);
  58                 return ret_hu_conv;
  59         }
  60
  61         /**
  62          * Features supported by the payee.
  63          *
  64          * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
  65          * does not contain any features.
  66          *
  67          * [`for_keysend`]: Self::for_keysend
  68          *
  69          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
  70          */
  71         public void set_features(@Nullable InvoiceFeatures val) {
  72                 bindings.Payee_set_features(this.ptr, val == null ? 0 : val.ptr & ~1);
  73                 Reference.reachabilityFence(this);
  74                 Reference.reachabilityFence(val);
  75         }
  76
  77         /**
  78          * Hints for routing to the payee, containing channels connecting the payee to public nodes.
  79          */
  80         public RouteHint[] get_route_hints() {
  81                 long[] ret = bindings.Payee_get_route_hints(this.ptr);
  82                 Reference.reachabilityFence(this);
  83                 int ret_conv_11_len = ret.length;
  84                 RouteHint[] ret_conv_11_arr = new RouteHint[ret_conv_11_len];
  85                 for (int l = 0; l < ret_conv_11_len; l++) {
  86                         long ret_conv_11 = ret[l];
  87                         RouteHint ret_conv_11_hu_conv = null; if (ret_conv_11 < 0 || ret_conv_11 > 4096) { ret_conv_11_hu_conv = new RouteHint(null, ret_conv_11); }
  88                         ret_conv_11_hu_conv.ptrs_to.add(this);
  89                         ret_conv_11_arr[l] = ret_conv_11_hu_conv;
  90                 }
  91                 return ret_conv_11_arr;
  92         }
  93
  94         /**
  95          * Hints for routing to the payee, containing channels connecting the payee to public nodes.
  96          */
  97         public void set_route_hints(RouteHint[] val) {
  98                 bindings.Payee_set_route_hints(this.ptr, val != null ? Arrays.stream(val).mapToLong(val_conv_11 -> val_conv_11 == null ? 0 : val_conv_11.ptr & ~1).toArray() : null);
  99                 Reference.reachabilityFence(this);
 100                 Reference.reachabilityFence(val);
 101         }
 102
 103         /**
 104          * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
 105          */
 106         public Option_u64Z get_expiry_time() {
 107                 long ret = bindings.Payee_get_expiry_time(this.ptr);
 108                 Reference.reachabilityFence(this);
 109                 if (ret >= 0 && ret <= 4096) { return null; }
 110                 Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
 111                 ret_hu_conv.ptrs_to.add(this);
 112                 return ret_hu_conv;
 113         }
 114
 115         /**
 116          * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
 117          */
 118         public void set_expiry_time(Option_u64Z val) {
 119                 bindings.Payee_set_expiry_time(this.ptr, val.ptr);
 120                 Reference.reachabilityFence(this);
 121                 Reference.reachabilityFence(val);
 122         }
 123
 124         /**
 125          * Constructs a new Payee given each field
 126          */
 127         public static Payee of(byte[] pubkey_arg, InvoiceFeatures features_arg, RouteHint[] route_hints_arg, Option_u64Z expiry_time_arg) {
 128                 long ret = bindings.Payee_new(InternalUtils.check_arr_len(pubkey_arg, 33), features_arg == null ? 0 : features_arg.ptr & ~1, route_hints_arg != null ? Arrays.stream(route_hints_arg).mapToLong(route_hints_arg_conv_11 -> route_hints_arg_conv_11 == null ? 0 : route_hints_arg_conv_11.ptr & ~1).toArray() : null, expiry_time_arg.ptr);
 129                 Reference.reachabilityFence(pubkey_arg);
 130                 Reference.reachabilityFence(features_arg);
 131                 Reference.reachabilityFence(route_hints_arg);
 132                 Reference.reachabilityFence(expiry_time_arg);
 133                 if (ret >= 0 && ret <= 4096) { return null; }
 134                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 135                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 136                 return ret_hu_conv;
 137         }
 138
 139         long clone_ptr() {
 140                 long ret = bindings.Payee_clone_ptr(this.ptr);
 141                 Reference.reachabilityFence(this);
 142                 return ret;
 143         }
 144
 145         /**
 146          * Creates a copy of the Payee
 147          */
 148         public Payee clone() {
 149                 long ret = bindings.Payee_clone(this.ptr);
 150                 Reference.reachabilityFence(this);
 151                 if (ret >= 0 && ret <= 4096) { return null; }
 152                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 153                 ret_hu_conv.ptrs_to.add(this);
 154                 return ret_hu_conv;
 155         }
 156
 157         /**
 158          * Checks if two Payees contain equal inner contents.
 159          */
 160         public long hash() {
 161                 long ret = bindings.Payee_hash(this.ptr);
 162                 Reference.reachabilityFence(this);
 163                 return ret;
 164         }
 165
 166         @Override public int hashCode() {
 167                 return (int)this.hash();
 168         }
 169         /**
 170          * Checks if two Payees contain equal inner contents.
 171          * This ignores pointers and is_owned flags and looks at the values in fields.
 172          * Two objects with NULL inner values will be considered "equal" here.
 173          */
 174         public boolean eq(Payee b) {
 175                 boolean ret = bindings.Payee_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
 176                 Reference.reachabilityFence(this);
 177                 Reference.reachabilityFence(b);
 178                 this.ptrs_to.add(b);
 179                 return ret;
 180         }
 181
 182         @Override public boolean equals(Object o) {
 183                 if (!(o instanceof Payee)) return false;
 184                 return this.eq((Payee)o);
 185         }
 186         /**
 187          * Serialize the Payee object into a byte array which can be read by Payee_read
 188          */
 189         public byte[] write() {
 190                 byte[] ret = bindings.Payee_write(this.ptr);
 191                 Reference.reachabilityFence(this);
 192                 return ret;
 193         }
 194
 195         /**
 196          * Read a Payee from a byte array, created by Payee_write
 197          */
 198         public static Result_PayeeDecodeErrorZ read(byte[] ser) {
 199                 long ret = bindings.Payee_read(ser);
 200                 Reference.reachabilityFence(ser);
 201                 if (ret >= 0 && ret <= 4096) { return null; }
 202                 Result_PayeeDecodeErrorZ ret_hu_conv = Result_PayeeDecodeErrorZ.constr_from_ptr(ret);
 203                 return ret_hu_conv;
 204         }
 205
 206         /**
 207          * Creates a payee with the node id of the given `pubkey`.
 208          */
 209         public static Payee from_node_id(byte[] pubkey) {
 210                 long ret = bindings.Payee_from_node_id(InternalUtils.check_arr_len(pubkey, 33));
 211                 Reference.reachabilityFence(pubkey);
 212                 if (ret >= 0 && ret <= 4096) { return null; }
 213                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 214                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 215                 return ret_hu_conv;
 216         }
 217
 218         /**
 219          * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
 220          */
 221         public static Payee for_keysend(byte[] pubkey) {
 222                 long ret = bindings.Payee_for_keysend(InternalUtils.check_arr_len(pubkey, 33));
 223                 Reference.reachabilityFence(pubkey);
 224                 if (ret >= 0 && ret <= 4096) { return null; }
 225                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 226                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 227                 return ret_hu_conv;
 228         }
 229
 230 }