X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FFilter.java;h=f35fa9dc825627989dc30e73beee9d2c7af5eda0;hb=330ca992be304d0eac79bd59b411980dff294b03;hp=19e74505ed08756eebf864bc63dd7d5ce7548805;hpb=3d559f3266fde7c6a21248c10d9a7145125b5e69;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/Filter.java b/src/main/java/org/ldk/structs/Filter.java
index 19e74505..f35fa9dc 100644
--- a/src/main/java/org/ldk/structs/Filter.java
+++ b/src/main/java/org/ldk/structs/Filter.java
@@ -1,16 +1,105 @@
 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 `Filter` trait defines behavior for indicating chain activity of interest pertaining to
+ * channels.
+ * 
+ * This is useful in order to have a [`Watch`] implementation convey to a chain source which
+ * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
+ * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
+ * receiving full blocks from a chain source, any further filtering is unnecessary.
+ * 
+ * After an output has been registered, subsequent block retrievals from the chain source must not
+ * exclude any transactions matching the new criteria nor any in-block descendants of such
+ * transactions.
+ * 
+ * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
+ * should not block on I/O. Implementations should instead queue the newly monitored data to be
+ * processed later. Then, in order to block until the data has been processed, any [`Watch`]
+ * invocation that has called the `Filter` must return [`InProgress`].
+ * 
+ * [`InProgress`]: ChannelMonitorUpdateStatus::InProgress
+ * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
+ * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Filter extends CommonBase {
-	Filter(Object _dummy, long ptr) { super(ptr); }
-	public Filter(bindings.LDKFilter arg) {
+	final bindings.LDKFilter bindings_instance;
+	Filter(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
+	private Filter(bindings.LDKFilter arg) {
 		super(bindings.LDKFilter_new(arg));
 		this.ptrs_to.add(arg);
+		this.bindings_instance = arg;
 	}
 	@Override @SuppressWarnings("deprecation")
 	protected void finalize() throws Throwable {
-		bindings.Filter_free(ptr); super.finalize();
+		if (ptr != 0) { bindings.Filter_free(ptr); } super.finalize();
+	}
+
+	public static interface FilterInterface {
+		/**
+		 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
+		 * a spending condition.
+		 */
+		void register_tx(byte[] txid, byte[] script_pubkey);
+		/**
+		 * Registers interest in spends of a transaction output.
+		 * 
+		 * Note that this method might be called during processing of a new block. You therefore need
+		 * to ensure that also dependent output spents within an already connected block are correctly
+		 * handled, e.g., by re-scanning the block in question whenever new outputs have been
+		 * registered mid-processing.
+		 */
+		void register_output(WatchedOutput output);
+	}
+	private static class LDKFilterHolder { Filter held; }
+	public static Filter new_impl(FilterInterface arg) {
+		final LDKFilterHolder impl_holder = new LDKFilterHolder();
+		impl_holder.held = new Filter(new bindings.LDKFilter() {
+			@Override public void register_tx(byte[] txid, byte[] script_pubkey) {
+				arg.register_tx(txid, script_pubkey);
+				Reference.reachabilityFence(arg);
+			}
+			@Override public void register_output(long output) {
+				org.ldk.structs.WatchedOutput output_hu_conv = null; if (output < 0 || output > 4096) { output_hu_conv = new org.ldk.structs.WatchedOutput(null, output); }
+				if (output_hu_conv != null) { output_hu_conv.ptrs_to.add(this); };
+				arg.register_output(output_hu_conv);
+				Reference.reachabilityFence(arg);
+			}
+		});
+		return impl_holder.held;
+	}
+	/**
+	 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
+	 * a spending condition.
+	 */
+	public void register_tx(byte[] txid, byte[] script_pubkey) {
+		bindings.Filter_register_tx(this.ptr, InternalUtils.check_arr_len(txid, 32), script_pubkey);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(txid);
+		Reference.reachabilityFence(script_pubkey);
+	}
+
+	/**
+	 * Registers interest in spends of a transaction output.
+	 * 
+	 * Note that this method might be called during processing of a new block. You therefore need
+	 * to ensure that also dependent output spents within an already connected block are correctly
+	 * handled, e.g., by re-scanning the block in question whenever new outputs have been
+	 * registered mid-processing.
+	 */
+	public void register_output(org.ldk.structs.WatchedOutput output) {
+		bindings.Filter_register_output(this.ptr, output == null ? 0 : output.ptr);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(output);
+		if (this != null) { this.ptrs_to.add(output); };
 	}
 
 }