_ 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                 RouteHint[] ret_conv_11_arr = new RouteHint[ret.length];
  84                 for (int l = 0; l < ret.length; l++) {
  85                         long ret_conv_11 = ret[l];
  86                         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); }
  87                         ret_conv_11_hu_conv.ptrs_to.add(this);
  88                         ret_conv_11_arr[l] = ret_conv_11_hu_conv;
  89                 }
  90                 return ret_conv_11_arr;
  91         }
  92
  93         /**
  94          * Hints for routing to the payee, containing channels connecting the payee to public nodes.
  95          */
  96         public void set_route_hints(RouteHint[] val) {
  97                 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);
  98                 Reference.reachabilityFence(this);
  99                 Reference.reachabilityFence(val);
 100         }
 101
 102         /**
 103          * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
 104          */
 105         public Option_u64Z get_expiry_time() {
 106                 long ret = bindings.Payee_get_expiry_time(this.ptr);
 107                 Reference.reachabilityFence(this);
 108                 if (ret >= 0 && ret <= 4096) { return null; }
 109                 Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
 110                 ret_hu_conv.ptrs_to.add(this);
 111                 return ret_hu_conv;
 112         }
 113
 114         /**
 115          * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
 116          */
 117         public void set_expiry_time(Option_u64Z val) {
 118                 bindings.Payee_set_expiry_time(this.ptr, val.ptr);
 119                 Reference.reachabilityFence(this);
 120                 Reference.reachabilityFence(val);
 121         }
 122
 123         /**
 124          * Constructs a new Payee given each field
 125          */
 126         public static Payee of(byte[] pubkey_arg, InvoiceFeatures features_arg, RouteHint[] route_hints_arg, Option_u64Z expiry_time_arg) {
 127                 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);
 128                 Reference.reachabilityFence(pubkey_arg);
 129                 Reference.reachabilityFence(features_arg);
 130                 Reference.reachabilityFence(route_hints_arg);
 131                 Reference.reachabilityFence(expiry_time_arg);
 132                 if (ret >= 0 && ret <= 4096) { return null; }
 133                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 134                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 135                 return ret_hu_conv;
 136         }
 137
 138         long clone_ptr() {
 139                 long ret = bindings.Payee_clone_ptr(this.ptr);
 140                 Reference.reachabilityFence(this);
 141                 return ret;
 142         }
 143
 144         /**
 145          * Creates a copy of the Payee
 146          */
 147         public Payee clone() {
 148                 long ret = bindings.Payee_clone(this.ptr);
 149                 Reference.reachabilityFence(this);
 150                 if (ret >= 0 && ret <= 4096) { return null; }
 151                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 152                 ret_hu_conv.ptrs_to.add(this);
 153                 return ret_hu_conv;
 154         }
 155
 156         /**
 157          * Checks if two Payees contain equal inner contents.
 158          */
 159         public long hash() {
 160                 long ret = bindings.Payee_hash(this.ptr);
 161                 Reference.reachabilityFence(this);
 162                 return ret;
 163         }
 164
 165         @Override public int hashCode() {
 166                 return (int)this.hash();
 167         }
 168         /**
 169          * Checks if two Payees contain equal inner contents.
 170          * This ignores pointers and is_owned flags and looks at the values in fields.
 171          * Two objects with NULL inner values will be considered "equal" here.
 172          */
 173         public boolean eq(Payee b) {
 174                 boolean ret = bindings.Payee_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
 175                 Reference.reachabilityFence(this);
 176                 Reference.reachabilityFence(b);
 177                 this.ptrs_to.add(b);
 178                 return ret;
 179         }
 180
 181         @Override public boolean equals(Object o) {
 182                 if (!(o instanceof Payee)) return false;
 183                 return this.eq((Payee)o);
 184         }
 185         /**
 186          * Serialize the Payee object into a byte array which can be read by Payee_read
 187          */
 188         public byte[] write() {
 189                 byte[] ret = bindings.Payee_write(this.ptr);
 190                 Reference.reachabilityFence(this);
 191                 return ret;
 192         }
 193
 194         /**
 195          * Read a Payee from a byte array, created by Payee_write
 196          */
 197         public static Result_PayeeDecodeErrorZ read(byte[] ser) {
 198                 long ret = bindings.Payee_read(ser);
 199                 Reference.reachabilityFence(ser);
 200                 if (ret >= 0 && ret <= 4096) { return null; }
 201                 Result_PayeeDecodeErrorZ ret_hu_conv = Result_PayeeDecodeErrorZ.constr_from_ptr(ret);
 202                 return ret_hu_conv;
 203         }
 204
 205         /**
 206          * Creates a payee with the node id of the given `pubkey`.
 207          */
 208         public static Payee from_node_id(byte[] pubkey) {
 209                 long ret = bindings.Payee_from_node_id(InternalUtils.check_arr_len(pubkey, 33));
 210                 Reference.reachabilityFence(pubkey);
 211                 if (ret >= 0 && ret <= 4096) { return null; }
 212                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 213                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 214                 return ret_hu_conv;
 215         }
 216
 217         /**
 218          * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
 219          */
 220         public static Payee for_keysend(byte[] pubkey) {
 221                 long ret = bindings.Payee_for_keysend(InternalUtils.check_arr_len(pubkey, 33));
 222                 Reference.reachabilityFence(pubkey);
 223                 if (ret >= 0 && ret <= 4096) { return null; }
 224                 Payee ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Payee(null, ret); }
 225                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 226                 return ret_hu_conv;
 227         }
 228
 229 }