X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FRevocationKey.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FRevocationKey.java;h=f52d4ae9af61c6c20f8d8f3e4f41fd2ae7e85f6c;hb=2bb592fb946e316dba9f4d1123f8ac72ff4e9bf8;hp=0000000000000000000000000000000000000000;hpb=519dc944de5b88f95975140a13fbc6d77dd15a95;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/RevocationKey.java b/src/main/java/org/ldk/structs/RevocationKey.java
new file mode 100644
index 00000000..f52d4ae9
--- /dev/null
+++ b/src/main/java/org/ldk/structs/RevocationKey.java
@@ -0,0 +1,152 @@
+package org.ldk.structs;
+
+import org.ldk.impl.bindings;
+import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
+
+
+/**
+ * The revocation key is used to allow a channel party to revoke their state - giving their
+ * counterparty the required material to claim all of their funds if they broadcast that state.
+ * 
+ * Each commitment transaction has a revocation key based on the basepoint and
+ * per_commitment_point which is used in both commitment and HTLC transactions.
+ * 
+ * See [the BOLT spec for derivation details]
+ * (https://github.com/lightning/bolts/blob/master/03-transactions.md#revocationpubkey-derivation)
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
+public class RevocationKey extends CommonBase {
+	RevocationKey(Object _dummy, long ptr) { super(ptr); }
+	@Override @SuppressWarnings("deprecation")
+	protected void finalize() throws Throwable {
+		super.finalize();
+		if (ptr != 0) { bindings.RevocationKey_free(ptr); }
+	}
+
+	public byte[] get_a() {
+		byte[] ret = bindings.RevocationKey_get_a(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	public void set_a(byte[] val) {
+		bindings.RevocationKey_set_a(this.ptr, InternalUtils.check_arr_len(val, 33));
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(val);
+	}
+
+	/**
+	 * Constructs a new RevocationKey given each field
+	 */
+	public static RevocationKey of(byte[] a_arg) {
+		long ret = bindings.RevocationKey_new(InternalUtils.check_arr_len(a_arg, 33));
+		Reference.reachabilityFence(a_arg);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.RevocationKey ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RevocationKey(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Checks if two RevocationKeys contain equal inner contents.
+	 * This ignores pointers and is_owned flags and looks at the values in fields.
+	 * Two objects with NULL inner values will be considered "equal" here.
+	 */
+	public boolean eq(org.ldk.structs.RevocationKey b) {
+		boolean ret = bindings.RevocationKey_eq(this.ptr, b == null ? 0 : b.ptr);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(b);
+		if (this != null) { this.ptrs_to.add(b); };
+		return ret;
+	}
+
+	@Override public boolean equals(Object o) {
+		if (!(o instanceof RevocationKey)) return false;
+		return this.eq((RevocationKey)o);
+	}
+	long clone_ptr() {
+		long ret = bindings.RevocationKey_clone_ptr(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * Creates a copy of the RevocationKey
+	 */
+	public RevocationKey clone() {
+		long ret = bindings.RevocationKey_clone(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.RevocationKey ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RevocationKey(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Generates a non-cryptographic 64-bit hash of the RevocationKey.
+	 */
+	public long hash() {
+		long ret = bindings.RevocationKey_hash(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	@Override public int hashCode() {
+		return (int)this.hash();
+	}
+	/**
+	 * Derives a per-commitment-transaction revocation public key from one party's per-commitment
+	 * point and the other party's [`RevocationBasepoint`]. This is the public equivalent of
+	 * [`chan_utils::derive_private_revocation_key`] - using only public keys to derive a public
+	 * key instead of private keys.
+	 * 
+	 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
+	 * generated (ie our own).
+	 * 
+	 * [`chan_utils::derive_private_revocation_key`]: crate::ln::chan_utils::derive_private_revocation_key
+	 */
+	public static RevocationKey from_basepoint(org.ldk.structs.RevocationBasepoint countersignatory_basepoint, byte[] per_commitment_point) {
+		long ret = bindings.RevocationKey_from_basepoint(countersignatory_basepoint == null ? 0 : countersignatory_basepoint.ptr, InternalUtils.check_arr_len(per_commitment_point, 33));
+		Reference.reachabilityFence(countersignatory_basepoint);
+		Reference.reachabilityFence(per_commitment_point);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.RevocationKey ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RevocationKey(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(countersignatory_basepoint); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Get inner Public Key
+	 */
+	public byte[] to_public_key() {
+		byte[] ret = bindings.RevocationKey_to_public_key(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * Serialize the RevocationKey object into a byte array which can be read by RevocationKey_read
+	 */
+	public byte[] write() {
+		byte[] ret = bindings.RevocationKey_write(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * Read a RevocationKey from a byte array, created by RevocationKey_write
+	 */
+	public static Result_RevocationKeyDecodeErrorZ read(byte[] ser) {
+		long ret = bindings.RevocationKey_read(ser);
+		Reference.reachabilityFence(ser);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		Result_RevocationKeyDecodeErrorZ ret_hu_conv = Result_RevocationKeyDecodeErrorZ.constr_from_ptr(ret);
+		return ret_hu_conv;
+	}
+
+}