1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import javax.annotation.Nullable;
11 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
13 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
14 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
15 * the return value of [`Filter::register_output`].
17 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
18 * may have been spent there. See [`Filter::register_output`] for details.
20 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
21 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
23 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
24 public class WatchedOutput extends CommonBase {
25 WatchedOutput(Object _dummy, long ptr) { super(ptr); }
26 @Override @SuppressWarnings("deprecation")
27 protected void finalize() throws Throwable {
29 if (ptr != 0) { bindings.WatchedOutput_free(ptr); }
33 * First block where the transaction output may have been spent.
35 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
38 public byte[] get_block_hash() {
39 byte[] ret = bindings.WatchedOutput_get_block_hash(this.ptr);
44 * First block where the transaction output may have been spent.
46 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
48 public void set_block_hash(@Nullable byte[] val) {
49 bindings.WatchedOutput_set_block_hash(this.ptr, val);
53 * Outpoint identifying the transaction output.
55 public OutPoint get_outpoint() {
56 long ret = bindings.WatchedOutput_get_outpoint(this.ptr);
57 if (ret < 1024) { return null; }
58 OutPoint ret_hu_conv = new OutPoint(null, ret);
59 ret_hu_conv.ptrs_to.add(this);
64 * Outpoint identifying the transaction output.
66 public void set_outpoint(OutPoint val) {
67 bindings.WatchedOutput_set_outpoint(this.ptr, val == null ? 0 : val.ptr & ~1);
68 this.ptrs_to.add(val);
72 * Spending condition of the transaction output.
74 public byte[] get_script_pubkey() {
75 byte[] ret = bindings.WatchedOutput_get_script_pubkey(this.ptr);
80 * Spending condition of the transaction output.
82 public void set_script_pubkey(byte[] val) {
83 bindings.WatchedOutput_set_script_pubkey(this.ptr, val);
87 * Constructs a new WatchedOutput given each field
89 public static WatchedOutput of(byte[] block_hash_arg, OutPoint outpoint_arg, byte[] script_pubkey_arg) {
90 long ret = bindings.WatchedOutput_new(block_hash_arg, outpoint_arg == null ? 0 : outpoint_arg.ptr & ~1, script_pubkey_arg);
91 if (ret < 1024) { return null; }
92 WatchedOutput ret_hu_conv = new WatchedOutput(null, ret);
93 ret_hu_conv.ptrs_to.add(ret_hu_conv);
94 ret_hu_conv.ptrs_to.add(outpoint_arg);
99 * Creates a copy of the WatchedOutput
101 public WatchedOutput clone() {
102 long ret = bindings.WatchedOutput_clone(this.ptr);
103 if (ret < 1024) { return null; }
104 WatchedOutput ret_hu_conv = new WatchedOutput(null, ret);
105 ret_hu_conv.ptrs_to.add(this);
110 * Checks if two WatchedOutputs contain equal inner contents.
113 long ret = bindings.WatchedOutput_hash(this.ptr);