7bd5fe6a52914f93007c6d071e6e8ff34c8267e6
[ldk-java] / c_sharp / src / org / ldk / structs / ChannelTransactionParameters.cs
1 using org.ldk.impl;
2 using org.ldk.enums;
3 using org.ldk.util;
4 using System;
5
6 namespace org { namespace ldk { namespace structs {
7
8
9 /**
10  * Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
11  * The fields are organized by holder/counterparty.
12  * 
13  * Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
14  * before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
15  */
16 public class ChannelTransactionParameters : CommonBase {
17         internal ChannelTransactionParameters(object _dummy, long ptr) : base(ptr) { }
18         ~ChannelTransactionParameters() {
19                 if (ptr != 0) { bindings.ChannelTransactionParameters_free(ptr); }
20         }
21
22         /**
23          * Holder public keys
24          */
25         public ChannelPublicKeys get_holder_pubkeys() {
26                 long ret = bindings.ChannelTransactionParameters_get_holder_pubkeys(this.ptr);
27                 GC.KeepAlive(this);
28                 if (ret >= 0 && ret <= 4096) { return null; }
29                 org.ldk.structs.ChannelPublicKeys ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelPublicKeys(null, ret); }
30                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
31                 return ret_hu_conv;
32         }
33
34         /**
35          * Holder public keys
36          */
37         public void set_holder_pubkeys(org.ldk.structs.ChannelPublicKeys val) {
38                 bindings.ChannelTransactionParameters_set_holder_pubkeys(this.ptr, val == null ? 0 : val.ptr);
39                 GC.KeepAlive(this);
40                 GC.KeepAlive(val);
41                 if (this != null) { this.ptrs_to.AddLast(val); };
42         }
43
44         /**
45          * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
46          */
47         public short get_holder_selected_contest_delay() {
48                 short ret = bindings.ChannelTransactionParameters_get_holder_selected_contest_delay(this.ptr);
49                 GC.KeepAlive(this);
50                 return ret;
51         }
52
53         /**
54          * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
55          */
56         public void set_holder_selected_contest_delay(short val) {
57                 bindings.ChannelTransactionParameters_set_holder_selected_contest_delay(this.ptr, val);
58                 GC.KeepAlive(this);
59                 GC.KeepAlive(val);
60         }
61
62         /**
63          * Whether the holder is the initiator of this channel.
64          * This is an input to the commitment number obscure factor computation.
65          */
66         public bool get_is_outbound_from_holder() {
67                 bool ret = bindings.ChannelTransactionParameters_get_is_outbound_from_holder(this.ptr);
68                 GC.KeepAlive(this);
69                 return ret;
70         }
71
72         /**
73          * Whether the holder is the initiator of this channel.
74          * This is an input to the commitment number obscure factor computation.
75          */
76         public void set_is_outbound_from_holder(bool val) {
77                 bindings.ChannelTransactionParameters_set_is_outbound_from_holder(this.ptr, val);
78                 GC.KeepAlive(this);
79                 GC.KeepAlive(val);
80         }
81
82         /**
83          * The late-bound counterparty channel transaction parameters.
84          * These parameters are populated at the point in the protocol where the counterparty provides them.
85          * 
86          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
87          */
88         public CounterpartyChannelTransactionParameters get_counterparty_parameters() {
89                 long ret = bindings.ChannelTransactionParameters_get_counterparty_parameters(this.ptr);
90                 GC.KeepAlive(this);
91                 if (ret >= 0 && ret <= 4096) { return null; }
92                 org.ldk.structs.CounterpartyChannelTransactionParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.CounterpartyChannelTransactionParameters(null, ret); }
93                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
94                 return ret_hu_conv;
95         }
96
97         /**
98          * The late-bound counterparty channel transaction parameters.
99          * These parameters are populated at the point in the protocol where the counterparty provides them.
100          * 
101          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
102          */
103         public void set_counterparty_parameters(org.ldk.structs.CounterpartyChannelTransactionParameters val) {
104                 bindings.ChannelTransactionParameters_set_counterparty_parameters(this.ptr, val == null ? 0 : val.ptr);
105                 GC.KeepAlive(this);
106                 GC.KeepAlive(val);
107                 if (this != null) { this.ptrs_to.AddLast(val); };
108         }
109
110         /**
111          * The late-bound funding outpoint
112          * 
113          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
114          */
115         public OutPoint get_funding_outpoint() {
116                 long ret = bindings.ChannelTransactionParameters_get_funding_outpoint(this.ptr);
117                 GC.KeepAlive(this);
118                 if (ret >= 0 && ret <= 4096) { return null; }
119                 org.ldk.structs.OutPoint ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OutPoint(null, ret); }
120                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
121                 return ret_hu_conv;
122         }
123
124         /**
125          * The late-bound funding outpoint
126          * 
127          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
128          */
129         public void set_funding_outpoint(org.ldk.structs.OutPoint val) {
130                 bindings.ChannelTransactionParameters_set_funding_outpoint(this.ptr, val == null ? 0 : val.ptr);
131                 GC.KeepAlive(this);
132                 GC.KeepAlive(val);
133                 if (this != null) { this.ptrs_to.AddLast(val); };
134         }
135
136         /**
137          * Are anchors (zero fee HTLC transaction variant) used for this channel. Boolean is
138          * serialization backwards-compatible.
139          */
140         public COption_NoneZ get_opt_anchors() {
141                 COption_NoneZ ret = bindings.ChannelTransactionParameters_get_opt_anchors(this.ptr);
142                 GC.KeepAlive(this);
143                 return ret;
144         }
145
146         /**
147          * Are anchors (zero fee HTLC transaction variant) used for this channel. Boolean is
148          * serialization backwards-compatible.
149          */
150         public void set_opt_anchors(COption_NoneZ val) {
151                 bindings.ChannelTransactionParameters_set_opt_anchors(this.ptr, val);
152                 GC.KeepAlive(this);
153                 GC.KeepAlive(val);
154         }
155
156         /**
157          * Are non-zero-fee anchors are enabled (used in conjuction with opt_anchors)
158          * It is intended merely for backwards compatibility with signers that need it.
159          * There is no support for this feature in LDK channel negotiation.
160          */
161         public COption_NoneZ get_opt_non_zero_fee_anchors() {
162                 COption_NoneZ ret = bindings.ChannelTransactionParameters_get_opt_non_zero_fee_anchors(this.ptr);
163                 GC.KeepAlive(this);
164                 return ret;
165         }
166
167         /**
168          * Are non-zero-fee anchors are enabled (used in conjuction with opt_anchors)
169          * It is intended merely for backwards compatibility with signers that need it.
170          * There is no support for this feature in LDK channel negotiation.
171          */
172         public void set_opt_non_zero_fee_anchors(COption_NoneZ val) {
173                 bindings.ChannelTransactionParameters_set_opt_non_zero_fee_anchors(this.ptr, val);
174                 GC.KeepAlive(this);
175                 GC.KeepAlive(val);
176         }
177
178         /**
179          * Constructs a new ChannelTransactionParameters given each field
180          */
181         public static ChannelTransactionParameters of(org.ldk.structs.ChannelPublicKeys holder_pubkeys_arg, short holder_selected_contest_delay_arg, bool is_outbound_from_holder_arg, org.ldk.structs.CounterpartyChannelTransactionParameters counterparty_parameters_arg, org.ldk.structs.OutPoint funding_outpoint_arg, COption_NoneZ opt_anchors_arg, COption_NoneZ opt_non_zero_fee_anchors_arg) {
182                 long ret = bindings.ChannelTransactionParameters_new(holder_pubkeys_arg == null ? 0 : holder_pubkeys_arg.ptr, holder_selected_contest_delay_arg, is_outbound_from_holder_arg, counterparty_parameters_arg == null ? 0 : counterparty_parameters_arg.ptr, funding_outpoint_arg == null ? 0 : funding_outpoint_arg.ptr, opt_anchors_arg, opt_non_zero_fee_anchors_arg);
183                 GC.KeepAlive(holder_pubkeys_arg);
184                 GC.KeepAlive(holder_selected_contest_delay_arg);
185                 GC.KeepAlive(is_outbound_from_holder_arg);
186                 GC.KeepAlive(counterparty_parameters_arg);
187                 GC.KeepAlive(funding_outpoint_arg);
188                 GC.KeepAlive(opt_anchors_arg);
189                 GC.KeepAlive(opt_non_zero_fee_anchors_arg);
190                 if (ret >= 0 && ret <= 4096) { return null; }
191                 org.ldk.structs.ChannelTransactionParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelTransactionParameters(null, ret); }
192                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
193                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(holder_pubkeys_arg); };
194                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(counterparty_parameters_arg); };
195                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(funding_outpoint_arg); };
196                 return ret_hu_conv;
197         }
198
199         internal long clone_ptr() {
200                 long ret = bindings.ChannelTransactionParameters_clone_ptr(this.ptr);
201                 GC.KeepAlive(this);
202                 return ret;
203         }
204
205         /**
206          * Creates a copy of the ChannelTransactionParameters
207          */
208         public ChannelTransactionParameters clone() {
209                 long ret = bindings.ChannelTransactionParameters_clone(this.ptr);
210                 GC.KeepAlive(this);
211                 if (ret >= 0 && ret <= 4096) { return null; }
212                 org.ldk.structs.ChannelTransactionParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelTransactionParameters(null, ret); }
213                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
214                 return ret_hu_conv;
215         }
216
217         /**
218          * Whether the late bound parameters are populated.
219          */
220         public bool is_populated() {
221                 bool ret = bindings.ChannelTransactionParameters_is_populated(this.ptr);
222                 GC.KeepAlive(this);
223                 return ret;
224         }
225
226         /**
227          * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
228          * given that the holder is the broadcaster.
229          * 
230          * self.is_populated() must be true before calling this function.
231          */
232         public DirectedChannelTransactionParameters as_holder_broadcastable() {
233                 long ret = bindings.ChannelTransactionParameters_as_holder_broadcastable(this.ptr);
234                 GC.KeepAlive(this);
235                 if (ret >= 0 && ret <= 4096) { return null; }
236                 org.ldk.structs.DirectedChannelTransactionParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.DirectedChannelTransactionParameters(null, ret); }
237                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
238                 return ret_hu_conv;
239         }
240
241         /**
242          * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
243          * given that the counterparty is the broadcaster.
244          * 
245          * self.is_populated() must be true before calling this function.
246          */
247         public DirectedChannelTransactionParameters as_counterparty_broadcastable() {
248                 long ret = bindings.ChannelTransactionParameters_as_counterparty_broadcastable(this.ptr);
249                 GC.KeepAlive(this);
250                 if (ret >= 0 && ret <= 4096) { return null; }
251                 org.ldk.structs.DirectedChannelTransactionParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.DirectedChannelTransactionParameters(null, ret); }
252                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
253                 return ret_hu_conv;
254         }
255
256         /**
257          * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
258          */
259         public byte[] write() {
260                 byte[] ret = bindings.ChannelTransactionParameters_write(this.ptr);
261                 GC.KeepAlive(this);
262                 return ret;
263         }
264
265         /**
266          * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
267          */
268         public static Result_ChannelTransactionParametersDecodeErrorZ read(byte[] ser) {
269                 long ret = bindings.ChannelTransactionParameters_read(ser);
270                 GC.KeepAlive(ser);
271                 if (ret >= 0 && ret <= 4096) { return null; }
272                 Result_ChannelTransactionParametersDecodeErrorZ ret_hu_conv = Result_ChannelTransactionParametersDecodeErrorZ.constr_from_ptr(ret);
273                 return ret_hu_conv;
274         }
275
276 }
277 } } }