Update auto-generated bindings
[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                 return ret_hu_conv;
35         }
36
37         /**
38          * Trust our pre-built transaction.
39          * 
40          * Applies a wrapper which allows access to the transaction.
41          * 
42          * This should only be used if you fully trust the builder of this object. It should not
43          * be used by an external signer - instead use the verify function.
44          */
45         public TrustedClosingTransaction trust() {
46                 long ret = bindings.ClosingTransaction_trust(this.ptr);
47                 if (ret < 1024) { return null; }
48                 TrustedClosingTransaction ret_hu_conv = new TrustedClosingTransaction(null, ret);
49                 ret_hu_conv.ptrs_to.add(this);
50                 return ret_hu_conv;
51         }
52
53         /**
54          * Verify our pre-built transaction.
55          * 
56          * Applies a wrapper which allows access to the transaction.
57          * 
58          * An external validating signer must call this method before signing
59          * or using the built transaction.
60          */
61         public Result_TrustedClosingTransactionNoneZ verify(OutPoint funding_outpoint) {
62                 long ret = bindings.ClosingTransaction_verify(this.ptr, funding_outpoint == null ? 0 : funding_outpoint.ptr & ~1);
63                 if (ret < 1024) { return null; }
64                 Result_TrustedClosingTransactionNoneZ ret_hu_conv = Result_TrustedClosingTransactionNoneZ.constr_from_ptr(ret);
65                 return ret_hu_conv;
66         }
67
68         /**
69          * The value to be sent to the holder, or zero if the output will be omitted
70          */
71         public long to_holder_value_sat() {
72                 long ret = bindings.ClosingTransaction_to_holder_value_sat(this.ptr);
73                 return ret;
74         }
75
76         /**
77          * The value to be sent to the counterparty, or zero if the output will be omitted
78          */
79         public long to_counterparty_value_sat() {
80                 long ret = bindings.ClosingTransaction_to_counterparty_value_sat(this.ptr);
81                 return ret;
82         }
83
84         /**
85          * The destination of the holder's output
86          */
87         public byte[] to_holder_script() {
88                 byte[] ret = bindings.ClosingTransaction_to_holder_script(this.ptr);
89                 return ret;
90         }
91
92         /**
93          * The destination of the counterparty's output
94          */
95         public byte[] to_counterparty_script() {
96                 byte[] ret = bindings.ClosingTransaction_to_counterparty_script(this.ptr);
97                 return ret;
98         }
99
100 }