import org.ldk.util.*;
import java.util.Arrays;
+
+/**
+ * The set of public keys which are used in the creation of one commitment transaction.
+ * These are derived from the channel base keys and per-commitment data.
+ *
+ * A broadcaster key is provided from potential broadcaster of the computed transaction.
+ * A countersignatory key is coming from a protocol participant unable to broadcast the
+ * transaction.
+ *
+ * These keys are assumed to be good, either because the code derived them from
+ * channel basepoints via the new function, or they were obtained via
+ * CommitmentTransaction.trust().keys() because we trusted the source of the
+ * pre-calculated keys.
+ */
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class TxCreationKeys extends CommonBase {
TxCreationKeys(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
super.finalize();
- bindings.TxCreationKeys_free(ptr);
- }
-
- public static TxCreationKeys constructor_clone(TxCreationKeys orig) {
- long ret = bindings.TxCreationKeys_clone(orig == null ? 0 : orig.ptr & ~1);
- TxCreationKeys ret_hu_conv = new TxCreationKeys(null, ret);
- ret_hu_conv.ptrs_to.add(orig);
- return ret_hu_conv;
+ if (ptr != 0) { bindings.TxCreationKeys_free(ptr); }
}
+ /**
+ * The broadcaster's per-commitment public key which was used to derive the other keys.
+ */
public byte[] get_per_commitment_point() {
byte[] ret = bindings.TxCreationKeys_get_per_commitment_point(this.ptr);
return ret;
}
+ /**
+ * The broadcaster's per-commitment public key which was used to derive the other keys.
+ */
public void set_per_commitment_point(byte[] val) {
bindings.TxCreationKeys_set_per_commitment_point(this.ptr, val);
}
+ /**
+ * The revocation key which is used to allow the broadcaster of the commitment
+ * transaction to provide their counterparty the ability to punish them if they broadcast
+ * an old state.
+ */
public byte[] get_revocation_key() {
byte[] ret = bindings.TxCreationKeys_get_revocation_key(this.ptr);
return ret;
}
+ /**
+ * The revocation key which is used to allow the broadcaster of the commitment
+ * transaction to provide their counterparty the ability to punish them if they broadcast
+ * an old state.
+ */
public void set_revocation_key(byte[] val) {
bindings.TxCreationKeys_set_revocation_key(this.ptr, val);
}
+ /**
+ * Broadcaster's HTLC Key
+ */
public byte[] get_broadcaster_htlc_key() {
byte[] ret = bindings.TxCreationKeys_get_broadcaster_htlc_key(this.ptr);
return ret;
}
+ /**
+ * Broadcaster's HTLC Key
+ */
public void set_broadcaster_htlc_key(byte[] val) {
bindings.TxCreationKeys_set_broadcaster_htlc_key(this.ptr, val);
}
+ /**
+ * Countersignatory's HTLC Key
+ */
public byte[] get_countersignatory_htlc_key() {
byte[] ret = bindings.TxCreationKeys_get_countersignatory_htlc_key(this.ptr);
return ret;
}
+ /**
+ * Countersignatory's HTLC Key
+ */
public void set_countersignatory_htlc_key(byte[] val) {
bindings.TxCreationKeys_set_countersignatory_htlc_key(this.ptr, val);
}
+ /**
+ * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
+ */
public byte[] get_broadcaster_delayed_payment_key() {
byte[] ret = bindings.TxCreationKeys_get_broadcaster_delayed_payment_key(this.ptr);
return ret;
}
+ /**
+ * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
+ */
public void set_broadcaster_delayed_payment_key(byte[] val) {
bindings.TxCreationKeys_set_broadcaster_delayed_payment_key(this.ptr, val);
}
- public static TxCreationKeys constructor_new(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) {
+ /**
+ * Constructs a new TxCreationKeys given each field
+ */
+ 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) {
long ret = bindings.TxCreationKeys_new(per_commitment_point_arg, revocation_key_arg, broadcaster_htlc_key_arg, countersignatory_htlc_key_arg, broadcaster_delayed_payment_key_arg);
TxCreationKeys ret_hu_conv = new TxCreationKeys(null, ret);
+ ret_hu_conv.ptrs_to.add(ret_hu_conv);
return ret_hu_conv;
}
- public byte[] write(TxCreationKeys obj) {
- byte[] ret = bindings.TxCreationKeys_write(obj == null ? 0 : obj.ptr & ~1);
- this.ptrs_to.add(obj);
+ /**
+ * Creates a copy of the TxCreationKeys
+ */
+ public TxCreationKeys clone() {
+ long ret = bindings.TxCreationKeys_clone(this.ptr);
+ TxCreationKeys ret_hu_conv = new TxCreationKeys(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
+ }
+
+ /**
+ * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
+ */
+ public byte[] write() {
+ byte[] ret = bindings.TxCreationKeys_write(this.ptr);
return ret;
}
- public static TxCreationKeys constructor_read(byte[] ser) {
+ /**
+ * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
+ */
+ public static Result_TxCreationKeysDecodeErrorZ read(byte[] ser) {
long ret = bindings.TxCreationKeys_read(ser);
- TxCreationKeys ret_hu_conv = new TxCreationKeys(null, ret);
+ Result_TxCreationKeysDecodeErrorZ ret_hu_conv = Result_TxCreationKeysDecodeErrorZ.constr_from_ptr(ret);
return ret_hu_conv;
}
- public Result_TxCreationKeysSecpErrorZ derive_new(byte[] per_commitment_point, byte[] broadcaster_delayed_payment_base, byte[] broadcaster_htlc_base, byte[] countersignatory_revocation_base, byte[] countersignatory_htlc_base) {
+ /**
+ * Create per-state keys from channel base points and the per-commitment point.
+ * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
+ */
+ public static Result_TxCreationKeysErrorZ derive_new(byte[] per_commitment_point, byte[] broadcaster_delayed_payment_base, byte[] broadcaster_htlc_base, byte[] countersignatory_revocation_base, byte[] countersignatory_htlc_base) {
long ret = bindings.TxCreationKeys_derive_new(per_commitment_point, broadcaster_delayed_payment_base, broadcaster_htlc_base, countersignatory_revocation_base, countersignatory_htlc_base);
- Result_TxCreationKeysSecpErrorZ ret_hu_conv = Result_TxCreationKeysSecpErrorZ.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(this);
+ Result_TxCreationKeysErrorZ ret_hu_conv = Result_TxCreationKeysErrorZ.constr_from_ptr(ret);
+ return ret_hu_conv;
+ }
+
+ /**
+ * Generate per-state keys from channel static keys.
+ * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
+ */
+ public static Result_TxCreationKeysErrorZ from_channel_static_keys(byte[] per_commitment_point, ChannelPublicKeys broadcaster_keys, ChannelPublicKeys countersignatory_keys) {
+ long ret = bindings.TxCreationKeys_from_channel_static_keys(per_commitment_point, broadcaster_keys == null ? 0 : broadcaster_keys.ptr & ~1, countersignatory_keys == null ? 0 : countersignatory_keys.ptr & ~1);
+ Result_TxCreationKeysErrorZ ret_hu_conv = Result_TxCreationKeysErrorZ.constr_from_ptr(ret);
+ ret_hu_conv.ptrs_to.add(broadcaster_keys);
+ ret_hu_conv.ptrs_to.add(countersignatory_keys);
return ret_hu_conv;
}
projects / ldk-java / blobdiff