_ Git - ldk-java/blob - src/main/java/org/ldk/structs/ChannelDerivationParameters.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 parameters required to derive a channel signer via [`SignerProvider`].
  13  */
  14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  15 public class ChannelDerivationParameters extends CommonBase {
  16         ChannelDerivationParameters(Object _dummy, long ptr) { super(ptr); }
  17         @Override @SuppressWarnings("deprecation")
  18         protected void finalize() throws Throwable {
  19                 super.finalize();
  20                 if (ptr != 0) { bindings.ChannelDerivationParameters_free(ptr); }
  21         }
  22
  23         /**
  24          * The value in satoshis of the channel we're attempting to spend the anchor output of.
  25          */
  26         public long get_value_satoshis() {
  27                 long ret = bindings.ChannelDerivationParameters_get_value_satoshis(this.ptr);
  28                 Reference.reachabilityFence(this);
  29                 return ret;
  30         }
  31
  32         /**
  33          * The value in satoshis of the channel we're attempting to spend the anchor output of.
  34          */
  35         public void set_value_satoshis(long val) {
  36                 bindings.ChannelDerivationParameters_set_value_satoshis(this.ptr, val);
  37                 Reference.reachabilityFence(this);
  38                 Reference.reachabilityFence(val);
  39         }
  40
  41         /**
  42          * The unique identifier to re-derive the signer for the associated channel.
  43          */
  44         public byte[] get_keys_id() {
  45                 byte[] ret = bindings.ChannelDerivationParameters_get_keys_id(this.ptr);
  46                 Reference.reachabilityFence(this);
  47                 return ret;
  48         }
  49
  50         /**
  51          * The unique identifier to re-derive the signer for the associated channel.
  52          */
  53         public void set_keys_id(byte[] val) {
  54                 bindings.ChannelDerivationParameters_set_keys_id(this.ptr, InternalUtils.check_arr_len(val, 32));
  55                 Reference.reachabilityFence(this);
  56                 Reference.reachabilityFence(val);
  57         }
  58
  59         /**
  60          * The necessary channel parameters that need to be provided to the re-derived signer through
  61          * [`ChannelSigner::provide_channel_parameters`].
  62          *
  63          * [`ChannelSigner::provide_channel_parameters`]: crate::sign::ChannelSigner::provide_channel_parameters
  64          */
  65         public ChannelTransactionParameters get_transaction_parameters() {
  66                 long ret = bindings.ChannelDerivationParameters_get_transaction_parameters(this.ptr);
  67                 Reference.reachabilityFence(this);
  68                 if (ret >= 0 && ret <= 4096) { return null; }
  69                 org.ldk.structs.ChannelTransactionParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelTransactionParameters(null, ret); }
  70                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  71                 return ret_hu_conv;
  72         }
  73
  74         /**
  75          * The necessary channel parameters that need to be provided to the re-derived signer through
  76          * [`ChannelSigner::provide_channel_parameters`].
  77          *
  78          * [`ChannelSigner::provide_channel_parameters`]: crate::sign::ChannelSigner::provide_channel_parameters
  79          */
  80         public void set_transaction_parameters(org.ldk.structs.ChannelTransactionParameters val) {
  81                 bindings.ChannelDerivationParameters_set_transaction_parameters(this.ptr, val == null ? 0 : val.ptr);
  82                 Reference.reachabilityFence(this);
  83                 Reference.reachabilityFence(val);
  84                 if (this != null) { this.ptrs_to.add(val); };
  85         }
  86
  87         /**
  88          * Constructs a new ChannelDerivationParameters given each field
  89          */
  90         public static ChannelDerivationParameters of(long value_satoshis_arg, byte[] keys_id_arg, org.ldk.structs.ChannelTransactionParameters transaction_parameters_arg) {
  91                 long ret = bindings.ChannelDerivationParameters_new(value_satoshis_arg, InternalUtils.check_arr_len(keys_id_arg, 32), transaction_parameters_arg == null ? 0 : transaction_parameters_arg.ptr);
  92                 Reference.reachabilityFence(value_satoshis_arg);
  93                 Reference.reachabilityFence(keys_id_arg);
  94                 Reference.reachabilityFence(transaction_parameters_arg);
  95                 if (ret >= 0 && ret <= 4096) { return null; }
  96                 org.ldk.structs.ChannelDerivationParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelDerivationParameters(null, ret); }
  97                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
  98                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(transaction_parameters_arg); };
  99                 return ret_hu_conv;
 100         }
 101
 102         long clone_ptr() {
 103                 long ret = bindings.ChannelDerivationParameters_clone_ptr(this.ptr);
 104                 Reference.reachabilityFence(this);
 105                 return ret;
 106         }
 107
 108         /**
 109          * Creates a copy of the ChannelDerivationParameters
 110          */
 111         public ChannelDerivationParameters clone() {
 112                 long ret = bindings.ChannelDerivationParameters_clone(this.ptr);
 113                 Reference.reachabilityFence(this);
 114                 if (ret >= 0 && ret <= 4096) { return null; }
 115                 org.ldk.structs.ChannelDerivationParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelDerivationParameters(null, ret); }
 116                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 117                 return ret_hu_conv;
 118         }
 119
 120         /**
 121          * Checks if two ChannelDerivationParameterss contain equal inner contents.
 122          * This ignores pointers and is_owned flags and looks at the values in fields.
 123          * Two objects with NULL inner values will be considered "equal" here.
 124          */
 125         public boolean eq(org.ldk.structs.ChannelDerivationParameters b) {
 126                 boolean ret = bindings.ChannelDerivationParameters_eq(this.ptr, b == null ? 0 : b.ptr);
 127                 Reference.reachabilityFence(this);
 128                 Reference.reachabilityFence(b);
 129                 if (this != null) { this.ptrs_to.add(b); };
 130                 return ret;
 131         }
 132
 133         @Override public boolean equals(Object o) {
 134                 if (!(o instanceof ChannelDerivationParameters)) return false;
 135                 return this.eq((ChannelDerivationParameters)o);
 136         }
 137         /**
 138          * Serialize the ChannelDerivationParameters object into a byte array which can be read by ChannelDerivationParameters_read
 139          */
 140         public byte[] write() {
 141                 byte[] ret = bindings.ChannelDerivationParameters_write(this.ptr);
 142                 Reference.reachabilityFence(this);
 143                 return ret;
 144         }
 145
 146         /**
 147          * Read a ChannelDerivationParameters from a byte array, created by ChannelDerivationParameters_write
 148          */
 149         public static Result_ChannelDerivationParametersDecodeErrorZ read(byte[] ser) {
 150                 long ret = bindings.ChannelDerivationParameters_read(ser);
 151                 Reference.reachabilityFence(ser);
 152                 if (ret >= 0 && ret <= 4096) { return null; }
 153                 Result_ChannelDerivationParametersDecodeErrorZ ret_hu_conv = Result_ChannelDerivationParametersDecodeErrorZ.constr_from_ptr(ret);
 154                 return ret_hu_conv;
 155         }
 156
 157 }