1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Information about a spendable output to a P2WSH script.
14 * See [`SpendableOutputDescriptor::DelayedPaymentOutput`] for more details on how to spend this.
16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
17 public class DelayedPaymentOutputDescriptor extends CommonBase {
18 DelayedPaymentOutputDescriptor(Object _dummy, long ptr) { super(ptr); }
19 @Override @SuppressWarnings("deprecation")
20 protected void finalize() throws Throwable {
22 if (ptr != 0) { bindings.DelayedPaymentOutputDescriptor_free(ptr); }
26 * The outpoint which is spendable.
28 public OutPoint get_outpoint() {
29 long ret = bindings.DelayedPaymentOutputDescriptor_get_outpoint(this.ptr);
30 Reference.reachabilityFence(this);
31 if (ret >= 0 && ret <= 4096) { return null; }
32 org.ldk.structs.OutPoint ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OutPoint(null, ret); }
33 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
38 * The outpoint which is spendable.
40 public void set_outpoint(org.ldk.structs.OutPoint val) {
41 bindings.DelayedPaymentOutputDescriptor_set_outpoint(this.ptr, val == null ? 0 : val.ptr);
42 Reference.reachabilityFence(this);
43 Reference.reachabilityFence(val);
44 if (this != null) { this.ptrs_to.add(val); };
48 * Per commitment point to derive the delayed payment key by key holder.
50 public byte[] get_per_commitment_point() {
51 byte[] ret = bindings.DelayedPaymentOutputDescriptor_get_per_commitment_point(this.ptr);
52 Reference.reachabilityFence(this);
57 * Per commitment point to derive the delayed payment key by key holder.
59 public void set_per_commitment_point(byte[] val) {
60 bindings.DelayedPaymentOutputDescriptor_set_per_commitment_point(this.ptr, InternalUtils.check_arr_len(val, 33));
61 Reference.reachabilityFence(this);
62 Reference.reachabilityFence(val);
66 * The `nSequence` value which must be set in the spending input to satisfy the `OP_CSV` in
69 public short get_to_self_delay() {
70 short ret = bindings.DelayedPaymentOutputDescriptor_get_to_self_delay(this.ptr);
71 Reference.reachabilityFence(this);
76 * The `nSequence` value which must be set in the spending input to satisfy the `OP_CSV` in
79 public void set_to_self_delay(short val) {
80 bindings.DelayedPaymentOutputDescriptor_set_to_self_delay(this.ptr, val);
81 Reference.reachabilityFence(this);
82 Reference.reachabilityFence(val);
86 * The output which is referenced by the given outpoint.
88 public TxOut get_output() {
89 long ret = bindings.DelayedPaymentOutputDescriptor_get_output(this.ptr);
90 Reference.reachabilityFence(this);
91 if (ret >= 0 && ret <= 4096) { return null; }
92 TxOut ret_conv = new TxOut(null, ret);
97 * The output which is referenced by the given outpoint.
99 public void set_output(org.ldk.structs.TxOut val) {
100 bindings.DelayedPaymentOutputDescriptor_set_output(this.ptr, val.ptr);
101 Reference.reachabilityFence(this);
102 Reference.reachabilityFence(val);
106 * The revocation point specific to the commitment transaction which was broadcast. Used to
107 * derive the witnessScript for this output.
109 public byte[] get_revocation_pubkey() {
110 byte[] ret = bindings.DelayedPaymentOutputDescriptor_get_revocation_pubkey(this.ptr);
111 Reference.reachabilityFence(this);
116 * The revocation point specific to the commitment transaction which was broadcast. Used to
117 * derive the witnessScript for this output.
119 public void set_revocation_pubkey(byte[] val) {
120 bindings.DelayedPaymentOutputDescriptor_set_revocation_pubkey(this.ptr, InternalUtils.check_arr_len(val, 33));
121 Reference.reachabilityFence(this);
122 Reference.reachabilityFence(val);
126 * Arbitrary identification information returned by a call to [`ChannelSigner::channel_keys_id`].
127 * This may be useful in re-deriving keys used in the channel to spend the output.
129 public byte[] get_channel_keys_id() {
130 byte[] ret = bindings.DelayedPaymentOutputDescriptor_get_channel_keys_id(this.ptr);
131 Reference.reachabilityFence(this);
136 * Arbitrary identification information returned by a call to [`ChannelSigner::channel_keys_id`].
137 * This may be useful in re-deriving keys used in the channel to spend the output.
139 public void set_channel_keys_id(byte[] val) {
140 bindings.DelayedPaymentOutputDescriptor_set_channel_keys_id(this.ptr, InternalUtils.check_arr_len(val, 32));
141 Reference.reachabilityFence(this);
142 Reference.reachabilityFence(val);
146 * The value of the channel which this output originated from, possibly indirectly.
148 public long get_channel_value_satoshis() {
149 long ret = bindings.DelayedPaymentOutputDescriptor_get_channel_value_satoshis(this.ptr);
150 Reference.reachabilityFence(this);
155 * The value of the channel which this output originated from, possibly indirectly.
157 public void set_channel_value_satoshis(long val) {
158 bindings.DelayedPaymentOutputDescriptor_set_channel_value_satoshis(this.ptr, val);
159 Reference.reachabilityFence(this);
160 Reference.reachabilityFence(val);
164 * Constructs a new DelayedPaymentOutputDescriptor given each field
166 public static DelayedPaymentOutputDescriptor of(org.ldk.structs.OutPoint outpoint_arg, byte[] per_commitment_point_arg, short to_self_delay_arg, org.ldk.structs.TxOut output_arg, byte[] revocation_pubkey_arg, byte[] channel_keys_id_arg, long channel_value_satoshis_arg) {
167 long ret = bindings.DelayedPaymentOutputDescriptor_new(outpoint_arg == null ? 0 : outpoint_arg.ptr, InternalUtils.check_arr_len(per_commitment_point_arg, 33), to_self_delay_arg, output_arg.ptr, InternalUtils.check_arr_len(revocation_pubkey_arg, 33), InternalUtils.check_arr_len(channel_keys_id_arg, 32), channel_value_satoshis_arg);
168 Reference.reachabilityFence(outpoint_arg);
169 Reference.reachabilityFence(per_commitment_point_arg);
170 Reference.reachabilityFence(to_self_delay_arg);
171 Reference.reachabilityFence(output_arg);
172 Reference.reachabilityFence(revocation_pubkey_arg);
173 Reference.reachabilityFence(channel_keys_id_arg);
174 Reference.reachabilityFence(channel_value_satoshis_arg);
175 if (ret >= 0 && ret <= 4096) { return null; }
176 org.ldk.structs.DelayedPaymentOutputDescriptor ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.DelayedPaymentOutputDescriptor(null, ret); }
177 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
178 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(outpoint_arg); };
183 long ret = bindings.DelayedPaymentOutputDescriptor_clone_ptr(this.ptr);
184 Reference.reachabilityFence(this);
189 * Creates a copy of the DelayedPaymentOutputDescriptor
191 public DelayedPaymentOutputDescriptor clone() {
192 long ret = bindings.DelayedPaymentOutputDescriptor_clone(this.ptr);
193 Reference.reachabilityFence(this);
194 if (ret >= 0 && ret <= 4096) { return null; }
195 org.ldk.structs.DelayedPaymentOutputDescriptor ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.DelayedPaymentOutputDescriptor(null, ret); }
196 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
201 * Generates a non-cryptographic 64-bit hash of the DelayedPaymentOutputDescriptor.
204 long ret = bindings.DelayedPaymentOutputDescriptor_hash(this.ptr);
205 Reference.reachabilityFence(this);
209 @Override public int hashCode() {
210 return (int)this.hash();
213 * Checks if two DelayedPaymentOutputDescriptors contain equal inner contents.
214 * This ignores pointers and is_owned flags and looks at the values in fields.
215 * Two objects with NULL inner values will be considered "equal" here.
217 public boolean eq(org.ldk.structs.DelayedPaymentOutputDescriptor b) {
218 boolean ret = bindings.DelayedPaymentOutputDescriptor_eq(this.ptr, b == null ? 0 : b.ptr);
219 Reference.reachabilityFence(this);
220 Reference.reachabilityFence(b);
221 if (this != null) { this.ptrs_to.add(b); };
225 @Override public boolean equals(Object o) {
226 if (!(o instanceof DelayedPaymentOutputDescriptor)) return false;
227 return this.eq((DelayedPaymentOutputDescriptor)o);
230 * Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
232 public byte[] write() {
233 byte[] ret = bindings.DelayedPaymentOutputDescriptor_write(this.ptr);
234 Reference.reachabilityFence(this);
239 * Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
241 public static Result_DelayedPaymentOutputDescriptorDecodeErrorZ read(byte[] ser) {
242 long ret = bindings.DelayedPaymentOutputDescriptor_read(ser);
243 Reference.reachabilityFence(ser);
244 if (ret >= 0 && ret <= 4096) { return null; }
245 Result_DelayedPaymentOutputDescriptorDecodeErrorZ ret_hu_conv = Result_DelayedPaymentOutputDescriptorDecodeErrorZ.constr_from_ptr(ret);