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 * The set of public keys which are used in the creation of one commitment transaction.
13 * These are derived from the channel base keys and per-commitment data.
15 * A broadcaster key is provided from potential broadcaster of the computed transaction.
16 * A countersignatory key is coming from a protocol participant unable to broadcast the
19 * These keys are assumed to be good, either because the code derived them from
20 * channel basepoints via the new function, or they were obtained via
21 * CommitmentTransaction.trust().keys() because we trusted the source of the
22 * pre-calculated keys.
24 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
25 public class TxCreationKeys extends CommonBase {
26 TxCreationKeys(Object _dummy, long ptr) { super(ptr); }
27 @Override @SuppressWarnings("deprecation")
28 protected void finalize() throws Throwable {
30 if (ptr != 0) { bindings.TxCreationKeys_free(ptr); }
34 * The broadcaster's per-commitment public key which was used to derive the other keys.
36 public byte[] get_per_commitment_point() {
37 byte[] ret = bindings.TxCreationKeys_get_per_commitment_point(this.ptr);
38 Reference.reachabilityFence(this);
43 * The broadcaster's per-commitment public key which was used to derive the other keys.
45 public void set_per_commitment_point(byte[] val) {
46 bindings.TxCreationKeys_set_per_commitment_point(this.ptr, InternalUtils.check_arr_len(val, 33));
47 Reference.reachabilityFence(this);
48 Reference.reachabilityFence(val);
52 * The revocation key which is used to allow the broadcaster of the commitment
53 * transaction to provide their counterparty the ability to punish them if they broadcast
56 public byte[] get_revocation_key() {
57 byte[] ret = bindings.TxCreationKeys_get_revocation_key(this.ptr);
58 Reference.reachabilityFence(this);
63 * The revocation key which is used to allow the broadcaster of the commitment
64 * transaction to provide their counterparty the ability to punish them if they broadcast
67 public void set_revocation_key(byte[] val) {
68 bindings.TxCreationKeys_set_revocation_key(this.ptr, InternalUtils.check_arr_len(val, 33));
69 Reference.reachabilityFence(this);
70 Reference.reachabilityFence(val);
74 * Broadcaster's HTLC Key
76 public byte[] get_broadcaster_htlc_key() {
77 byte[] ret = bindings.TxCreationKeys_get_broadcaster_htlc_key(this.ptr);
78 Reference.reachabilityFence(this);
83 * Broadcaster's HTLC Key
85 public void set_broadcaster_htlc_key(byte[] val) {
86 bindings.TxCreationKeys_set_broadcaster_htlc_key(this.ptr, InternalUtils.check_arr_len(val, 33));
87 Reference.reachabilityFence(this);
88 Reference.reachabilityFence(val);
92 * Countersignatory's HTLC Key
94 public byte[] get_countersignatory_htlc_key() {
95 byte[] ret = bindings.TxCreationKeys_get_countersignatory_htlc_key(this.ptr);
96 Reference.reachabilityFence(this);
101 * Countersignatory's HTLC Key
103 public void set_countersignatory_htlc_key(byte[] val) {
104 bindings.TxCreationKeys_set_countersignatory_htlc_key(this.ptr, InternalUtils.check_arr_len(val, 33));
105 Reference.reachabilityFence(this);
106 Reference.reachabilityFence(val);
110 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
112 public byte[] get_broadcaster_delayed_payment_key() {
113 byte[] ret = bindings.TxCreationKeys_get_broadcaster_delayed_payment_key(this.ptr);
114 Reference.reachabilityFence(this);
119 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
121 public void set_broadcaster_delayed_payment_key(byte[] val) {
122 bindings.TxCreationKeys_set_broadcaster_delayed_payment_key(this.ptr, InternalUtils.check_arr_len(val, 33));
123 Reference.reachabilityFence(this);
124 Reference.reachabilityFence(val);
128 * Constructs a new TxCreationKeys given each field
130 public static TxCreationKeys of(byte[] per_commitment_point_arg, byte[] revocation_key_arg, byte[] broadcaster_htlc_key_arg, byte[] countersignatory_htlc_key_arg, byte[] broadcaster_delayed_payment_key_arg) {
131 long ret = bindings.TxCreationKeys_new(InternalUtils.check_arr_len(per_commitment_point_arg, 33), InternalUtils.check_arr_len(revocation_key_arg, 33), InternalUtils.check_arr_len(broadcaster_htlc_key_arg, 33), InternalUtils.check_arr_len(countersignatory_htlc_key_arg, 33), InternalUtils.check_arr_len(broadcaster_delayed_payment_key_arg, 33));
132 Reference.reachabilityFence(per_commitment_point_arg);
133 Reference.reachabilityFence(revocation_key_arg);
134 Reference.reachabilityFence(broadcaster_htlc_key_arg);
135 Reference.reachabilityFence(countersignatory_htlc_key_arg);
136 Reference.reachabilityFence(broadcaster_delayed_payment_key_arg);
137 if (ret >= 0 && ret <= 4096) { return null; }
138 org.ldk.structs.TxCreationKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.TxCreationKeys(null, ret); }
139 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
144 * Checks if two TxCreationKeyss contain equal inner contents.
145 * This ignores pointers and is_owned flags and looks at the values in fields.
146 * Two objects with NULL inner values will be considered "equal" here.
148 public boolean eq(org.ldk.structs.TxCreationKeys b) {
149 boolean ret = bindings.TxCreationKeys_eq(this.ptr, b == null ? 0 : b.ptr);
150 Reference.reachabilityFence(this);
151 Reference.reachabilityFence(b);
152 if (this != null) { this.ptrs_to.add(b); };
156 @Override public boolean equals(Object o) {
157 if (!(o instanceof TxCreationKeys)) return false;
158 return this.eq((TxCreationKeys)o);
161 long ret = bindings.TxCreationKeys_clone_ptr(this.ptr);
162 Reference.reachabilityFence(this);
167 * Creates a copy of the TxCreationKeys
169 public TxCreationKeys clone() {
170 long ret = bindings.TxCreationKeys_clone(this.ptr);
171 Reference.reachabilityFence(this);
172 if (ret >= 0 && ret <= 4096) { return null; }
173 org.ldk.structs.TxCreationKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.TxCreationKeys(null, ret); }
174 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
179 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
181 public byte[] write() {
182 byte[] ret = bindings.TxCreationKeys_write(this.ptr);
183 Reference.reachabilityFence(this);
188 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
190 public static Result_TxCreationKeysDecodeErrorZ read(byte[] ser) {
191 long ret = bindings.TxCreationKeys_read(ser);
192 Reference.reachabilityFence(ser);
193 if (ret >= 0 && ret <= 4096) { return null; }
194 Result_TxCreationKeysDecodeErrorZ ret_hu_conv = Result_TxCreationKeysDecodeErrorZ.constr_from_ptr(ret);
199 * Create per-state keys from channel base points and the per-commitment point.
200 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
202 public static TxCreationKeys derive_new(byte[] per_commitment_point, byte[] broadcaster_delayed_payment_base, byte[] broadcaster_htlc_base, byte[] countersignatory_revocation_base, byte[] countersignatory_htlc_base) {
203 long ret = bindings.TxCreationKeys_derive_new(InternalUtils.check_arr_len(per_commitment_point, 33), InternalUtils.check_arr_len(broadcaster_delayed_payment_base, 33), InternalUtils.check_arr_len(broadcaster_htlc_base, 33), InternalUtils.check_arr_len(countersignatory_revocation_base, 33), InternalUtils.check_arr_len(countersignatory_htlc_base, 33));
204 Reference.reachabilityFence(per_commitment_point);
205 Reference.reachabilityFence(broadcaster_delayed_payment_base);
206 Reference.reachabilityFence(broadcaster_htlc_base);
207 Reference.reachabilityFence(countersignatory_revocation_base);
208 Reference.reachabilityFence(countersignatory_htlc_base);
209 if (ret >= 0 && ret <= 4096) { return null; }
210 org.ldk.structs.TxCreationKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.TxCreationKeys(null, ret); }
211 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
216 * Generate per-state keys from channel static keys.
217 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
219 public static TxCreationKeys from_channel_static_keys(byte[] per_commitment_point, org.ldk.structs.ChannelPublicKeys broadcaster_keys, org.ldk.structs.ChannelPublicKeys countersignatory_keys) {
220 long ret = bindings.TxCreationKeys_from_channel_static_keys(InternalUtils.check_arr_len(per_commitment_point, 33), broadcaster_keys == null ? 0 : broadcaster_keys.ptr, countersignatory_keys == null ? 0 : countersignatory_keys.ptr);
221 Reference.reachabilityFence(per_commitment_point);
222 Reference.reachabilityFence(broadcaster_keys);
223 Reference.reachabilityFence(countersignatory_keys);
224 if (ret >= 0 && ret <= 4096) { return null; }
225 org.ldk.structs.TxCreationKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.TxCreationKeys(null, ret); }
226 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
227 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(broadcaster_keys); };
228 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(countersignatory_keys); };