Merge pull request #46 from TheBlueMatt/main
[ldk-java] / src / main / java / org / ldk / structs / ClosingTransaction.java
1 package org.ldk.structs;
2
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
5 import org.ldk.util.*;
6 import java.util.Arrays;
7 import javax.annotation.Nullable;
8
9
10 /**
11  * This class tracks the per-transaction information needed to build a closing transaction and will
12  * actually build it and sign.
13  * 
14  * This class can be used inside a signer implementation to generate a signature given the relevant
15  * secret key.
16  */
17 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
18 public class ClosingTransaction extends CommonBase {
19         ClosingTransaction(Object _dummy, long ptr) { super(ptr); }
20         @Override @SuppressWarnings("deprecation")
21         protected void finalize() throws Throwable {
22                 super.finalize();
23                 if (ptr != 0) { bindings.ClosingTransaction_free(ptr); }
24         }
25
26         /**
27          * Construct an object of the class
28          */
29         public static ClosingTransaction of(long to_holder_value_sat, long to_counterparty_value_sat, byte[] to_holder_script, byte[] to_counterparty_script, OutPoint funding_outpoint) {
30                 long ret = bindings.ClosingTransaction_new(to_holder_value_sat, to_counterparty_value_sat, to_holder_script, to_counterparty_script, funding_outpoint == null ? 0 : funding_outpoint.ptr & ~1);
31                 if (ret < 1024) { return null; }
32                 ClosingTransaction ret_hu_conv = new ClosingTransaction(null, ret);
33                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
34                 ret_hu_conv.ptrs_to.add(funding_outpoint);
35                 return ret_hu_conv;
36         }
37
38         /**
39          * Trust our pre-built transaction.
40          * 
41          * Applies a wrapper which allows access to the transaction.
42          * 
43          * This should only be used if you fully trust the builder of this object. It should not
44          * be used by an external signer - instead use the verify function.
45          */
46         public TrustedClosingTransaction trust() {
47                 long ret = bindings.ClosingTransaction_trust(this.ptr);
48                 if (ret < 1024) { return null; }
49                 TrustedClosingTransaction ret_hu_conv = new TrustedClosingTransaction(null, ret);
50                 ret_hu_conv.ptrs_to.add(this);
51                 return ret_hu_conv;
52         }
53
54         /**
55          * Verify our pre-built transaction.
56          * 
57          * Applies a wrapper which allows access to the transaction.
58          * 
59          * An external validating signer must call this method before signing
60          * or using the built transaction.
61          */
62         public Result_TrustedClosingTransactionNoneZ verify(OutPoint funding_outpoint) {
63                 long ret = bindings.ClosingTransaction_verify(this.ptr, funding_outpoint == null ? 0 : funding_outpoint.ptr & ~1);
64                 if (ret < 1024) { return null; }
65                 Result_TrustedClosingTransactionNoneZ ret_hu_conv = Result_TrustedClosingTransactionNoneZ.constr_from_ptr(ret);
66                 this.ptrs_to.add(funding_outpoint);
67                 return ret_hu_conv;
68         }
69
70         /**
71          * The value to be sent to the holder, or zero if the output will be omitted
72          */
73         public long to_holder_value_sat() {
74                 long ret = bindings.ClosingTransaction_to_holder_value_sat(this.ptr);
75                 return ret;
76         }
77
78         /**
79          * The value to be sent to the counterparty, or zero if the output will be omitted
80          */
81         public long to_counterparty_value_sat() {
82                 long ret = bindings.ClosingTransaction_to_counterparty_value_sat(this.ptr);
83                 return ret;
84         }
85
86         /**
87          * The destination of the holder's output
88          */
89         public byte[] to_holder_script() {
90                 byte[] ret = bindings.ClosingTransaction_to_holder_script(this.ptr);
91                 return ret;
92         }
93
94         /**
95          * The destination of the counterparty's output
96          */
97         public byte[] to_counterparty_script() {
98                 byte[] ret = bindings.ClosingTransaction_to_counterparty_script(this.ptr);
99                 return ret;
100         }
101
102 }