1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
10 * Manager which keeps track of a number of channels and sends messages to the appropriate
11 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
13 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
14 * to individual Channels.
16 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
17 * all peers during write/read (though does not modify this instance, only the instance being
18 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
19 * called funding_transaction_generated for outbound channels).
21 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
22 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
23 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
24 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
25 * the serialization process). If the deserialized version is out-of-date compared to the
26 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
27 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
29 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
30 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
31 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
32 * block_connected() to step towards your best block) upon deserialization before using the
35 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
36 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
37 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
38 * offline for a full minute. In order to track this, you must call
39 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
41 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
42 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
43 * essentially you should default to using a SimpleRefChannelManager, and use a
44 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
45 * you're using lightning-net-tokio.
47 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
48 public class ChannelManager extends CommonBase {
49 ChannelManager(Object _dummy, long ptr) { super(ptr); }
50 @Override @SuppressWarnings("deprecation")
51 protected void finalize() throws Throwable {
53 if (ptr != 0) { bindings.ChannelManager_free(ptr); }
57 * Constructs a new ChannelManager to hold several channels and route between them.
59 * This is the main \"logic hub\" for all channel-related actions, and implements
60 * ChannelMessageHandler.
62 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
64 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
66 * Users need to notify the new ChannelManager when a new block is connected or
67 * disconnected using its `block_connected` and `block_disconnected` methods, starting
68 * from after `params.latest_hash`.
70 public static ChannelManager of(FeeEstimator fee_est, Watch chain_monitor, BroadcasterInterface tx_broadcaster, Logger logger, KeysInterface keys_manager, UserConfig config, ChainParameters params) {
71 long ret = bindings.ChannelManager_new(fee_est == null ? 0 : fee_est.ptr, chain_monitor == null ? 0 : chain_monitor.ptr, tx_broadcaster == null ? 0 : tx_broadcaster.ptr, logger == null ? 0 : logger.ptr, keys_manager == null ? 0 : keys_manager.ptr, config == null ? 0 : config.ptr & ~1, params == null ? 0 : params.ptr & ~1);
72 if (ret < 1024) { return null; }
73 ChannelManager ret_hu_conv = new ChannelManager(null, ret);
74 ret_hu_conv.ptrs_to.add(ret_hu_conv);
75 ret_hu_conv.ptrs_to.add(fee_est);
76 ret_hu_conv.ptrs_to.add(chain_monitor);
77 ret_hu_conv.ptrs_to.add(tx_broadcaster);
78 ret_hu_conv.ptrs_to.add(logger);
79 ret_hu_conv.ptrs_to.add(keys_manager);
80 ret_hu_conv.ptrs_to.add(config);
81 ret_hu_conv.ptrs_to.add(params);
86 * Gets the current configuration applied to all new channels, as
88 public UserConfig get_current_default_configuration() {
89 long ret = bindings.ChannelManager_get_current_default_configuration(this.ptr);
90 if (ret < 1024) { return null; }
91 UserConfig ret_hu_conv = new UserConfig(null, ret);
92 ret_hu_conv.ptrs_to.add(this);
97 * Creates a new outbound channel to the given remote node and with the given value.
99 * user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
100 * tracking of which events correspond with which create_channel call. Note that the
101 * user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
102 * user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
105 * If successful, will generate a SendOpenChannel message event, so you should probably poll
106 * PeerManager::process_events afterwards.
108 * Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
109 * greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
111 * Note that we do not check if you are currently connected to the given peer. If no
112 * connection is available, the outbound `open_channel` message may fail to send, resulting in
113 * the channel eventually being silently forgotten.
115 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
117 public Result_NoneAPIErrorZ create_channel(byte[] their_network_key, long channel_value_satoshis, long push_msat, long user_id, UserConfig override_config) {
118 long ret = bindings.ChannelManager_create_channel(this.ptr, their_network_key, channel_value_satoshis, push_msat, user_id, override_config == null ? 0 : override_config.ptr & ~1);
119 if (ret < 1024) { return null; }
120 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
121 this.ptrs_to.add(override_config);
126 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
129 public ChannelDetails[] list_channels() {
130 long[] ret = bindings.ChannelManager_list_channels(this.ptr);
131 ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret.length];
132 for (int q = 0; q < ret.length; q++) {
133 long ret_conv_16 = ret[q];
134 ChannelDetails ret_conv_16_hu_conv = new ChannelDetails(null, ret_conv_16);
135 ret_conv_16_hu_conv.ptrs_to.add(this);
136 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
138 return ret_conv_16_arr;
142 * Gets the list of usable channels, in random order. Useful as an argument to
143 * get_route to ensure non-announced channels are used.
145 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
146 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
149 public ChannelDetails[] list_usable_channels() {
150 long[] ret = bindings.ChannelManager_list_usable_channels(this.ptr);
151 ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret.length];
152 for (int q = 0; q < ret.length; q++) {
153 long ret_conv_16 = ret[q];
154 ChannelDetails ret_conv_16_hu_conv = new ChannelDetails(null, ret_conv_16);
155 ret_conv_16_hu_conv.ptrs_to.add(this);
156 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
158 return ret_conv_16_arr;
162 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
163 * will be accepted on the given channel, and after additional timeout/the closing of all
164 * pending HTLCs, the channel will be closed on chain.
166 * May generate a SendShutdown message event on success, which should be relayed.
168 public Result_NoneAPIErrorZ close_channel(byte[] channel_id) {
169 long ret = bindings.ChannelManager_close_channel(this.ptr, channel_id);
170 if (ret < 1024) { return null; }
171 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
176 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
177 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
179 public Result_NoneAPIErrorZ force_close_channel(byte[] channel_id) {
180 long ret = bindings.ChannelManager_force_close_channel(this.ptr, channel_id);
181 if (ret < 1024) { return null; }
182 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
187 * Force close all channels, immediately broadcasting the latest local commitment transaction
188 * for each to the chain and rejecting new HTLCs on each.
190 public void force_close_all_channels() {
191 bindings.ChannelManager_force_close_all_channels(this.ptr);
195 * Sends a payment along a given route.
197 * Value parameters are provided via the last hop in route, see documentation for RouteHop
198 * fields for more info.
200 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
201 * payment), we don't do anything to stop you! We always try to ensure that if the provided
202 * next hop knows the preimage to payment_hash they can claim an additional amount as
203 * specified in the last hop in the route! Thus, you should probably do your own
204 * payment_preimage tracking (which you should already be doing as they represent \"proof of
205 * payment\") and prevent double-sends yourself.
207 * May generate SendHTLCs message(s) event on success, which should be relayed.
209 * Each path may have a different return value, and PaymentSendValue may return a Vec with
210 * each entry matching the corresponding-index entry in the route paths, see
211 * PaymentSendFailure for more info.
213 * In general, a path may raise:
214 * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
215 * node public key) is specified.
216 * APIError::ChannelUnavailable if the next-hop channel is not available for updates
217 * (including due to previous monitor update failure or new permanent monitor update
219 * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
222 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
223 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
224 * different route unless you intend to pay twice!
226 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
227 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
228 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
229 * must not contain multiple paths as multi-path payments require a recipient-provided
231 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
232 * bit set (either as required or as available). If multiple paths are present in the Route,
233 * we assume the invoice had the basic_mpp feature set.
235 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
237 public Result_NonePaymentSendFailureZ send_payment(Route route, byte[] payment_hash, byte[] payment_secret) {
238 long ret = bindings.ChannelManager_send_payment(this.ptr, route == null ? 0 : route.ptr & ~1, payment_hash, payment_secret);
239 if (ret < 1024) { return null; }
240 Result_NonePaymentSendFailureZ ret_hu_conv = Result_NonePaymentSendFailureZ.constr_from_ptr(ret);
241 this.ptrs_to.add(route);
246 * Send a spontaneous payment, which is a payment that does not require the recipient to have
247 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
248 * the preimage, it must be a cryptographically secure random value that no intermediate node
249 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
250 * never reach the recipient.
252 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
253 * [`send_payment`] for more information about the risks of duplicate preimage usage.
255 * [`send_payment`]: Self::send_payment
257 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
259 public Result_PaymentHashPaymentSendFailureZ send_spontaneous_payment(Route route, @Nullable byte[] payment_preimage) {
260 long ret = bindings.ChannelManager_send_spontaneous_payment(this.ptr, route == null ? 0 : route.ptr & ~1, payment_preimage);
261 if (ret < 1024) { return null; }
262 Result_PaymentHashPaymentSendFailureZ ret_hu_conv = Result_PaymentHashPaymentSendFailureZ.constr_from_ptr(ret);
263 this.ptrs_to.add(route);
268 * Call this upon creation of a funding transaction for the given channel.
270 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
271 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
273 * Panics if a funding transaction has already been provided for this channel.
275 * May panic if the output found in the funding transaction is duplicative with some other
276 * channel (note that this should be trivially prevented by using unique funding transaction
279 * Do NOT broadcast the funding transaction yourself. When we have safely received our
280 * counterparty's signature the funding transaction will automatically be broadcast via the
281 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
283 * Note that this includes RBF or similar transaction replacement strategies - lightning does
284 * not currently support replacing a funding transaction on an existing channel. Instead,
285 * create a new channel with a conflicting funding transaction.
287 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
289 public Result_NoneAPIErrorZ funding_transaction_generated(byte[] temporary_channel_id, byte[] funding_transaction) {
290 long ret = bindings.ChannelManager_funding_transaction_generated(this.ptr, temporary_channel_id, funding_transaction);
291 if (ret < 1024) { return null; }
292 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
297 * Regenerates channel_announcements and generates a signed node_announcement from the given
298 * arguments, providing them in corresponding events via
299 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
300 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
301 * announcement to ensure that the lightning P2P network is aware of the channels we have and
302 * our network addresses.
304 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
305 * node to humans. They carry no in-protocol meaning.
307 * `addresses` represent the set (possibly empty) of socket addresses on which this node
308 * accepts incoming connections. These will be included in the node_announcement, publicly
309 * tying these addresses together and to this node. If you wish to preserve user privacy,
310 * addresses should likely contain only Tor Onion addresses.
312 * Panics if `addresses` is absurdly large (more than 500).
314 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
316 public void broadcast_node_announcement(byte[] rgb, byte[] alias, NetAddress[] addresses) {
317 bindings.ChannelManager_broadcast_node_announcement(this.ptr, rgb, alias, Arrays.stream(addresses).mapToLong(addresses_conv_12 -> addresses_conv_12.ptr).toArray());
318 /* TODO 2 NetAddress */;
322 * Processes HTLCs which are pending waiting on random forward delay.
324 * Should only really ever be called in response to a PendingHTLCsForwardable event.
325 * Will likely generate further events.
327 public void process_pending_htlc_forwards() {
328 bindings.ChannelManager_process_pending_htlc_forwards(this.ptr);
332 * If a peer is disconnected we mark any channels with that peer as 'disabled'.
333 * After some time, if channels are still disabled we need to broadcast a ChannelUpdate
334 * to inform the network about the uselessness of these channels.
336 * This method handles all the details, and must be called roughly once per minute.
338 * Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
340 public void timer_tick_occurred() {
341 bindings.ChannelManager_timer_tick_occurred(this.ptr);
345 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
346 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
347 * along the path (including in our own channel on which we received it).
348 * Returns false if no payment was found to fail backwards, true if the process of failing the
349 * HTLC backwards has been started.
351 public boolean fail_htlc_backwards(byte[] payment_hash) {
352 boolean ret = bindings.ChannelManager_fail_htlc_backwards(this.ptr, payment_hash);
357 * Provides a payment preimage in response to a PaymentReceived event, returning true and
358 * generating message events for the net layer to claim the payment, if possible. Thus, you
359 * should probably kick the net layer to go send messages if this returns true!
361 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
362 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
363 * event matches your expectation. If you fail to do so and call this method, you may provide
364 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
366 * May panic if called except in response to a PaymentReceived event.
368 * [`create_inbound_payment`]: Self::create_inbound_payment
369 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
371 public boolean claim_funds(byte[] payment_preimage) {
372 boolean ret = bindings.ChannelManager_claim_funds(this.ptr, payment_preimage);
377 * Gets the node_id held by this ChannelManager
379 public byte[] get_our_node_id() {
380 byte[] ret = bindings.ChannelManager_get_our_node_id(this.ptr);
385 * Restores a single, given channel to normal operation after a
386 * ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
389 * All ChannelMonitor updates up to and including highest_applied_update_id must have been
390 * fully committed in every copy of the given channels' ChannelMonitors.
392 * Note that there is no effect to calling with a highest_applied_update_id other than the
393 * current latest ChannelMonitorUpdate and one call to this function after multiple
394 * ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
395 * exists largely only to prevent races between this and concurrent update_monitor calls.
397 * Thus, the anticipated use is, at a high level:
398 * 1) You register a chain::Watch with this ChannelManager,
399 * 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
400 * said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
401 * any time it cannot do so instantly,
402 * 3) update(s) are applied to each remote copy of a ChannelMonitor,
403 * 4) once all remote copies are updated, you call this function with the update_id that
404 * completed, and once it is the latest the Channel will be re-enabled.
406 public void channel_monitor_updated(OutPoint funding_txo, long highest_applied_update_id) {
407 bindings.ChannelManager_channel_monitor_updated(this.ptr, funding_txo == null ? 0 : funding_txo.ptr & ~1, highest_applied_update_id);
408 this.ptrs_to.add(funding_txo);
412 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
415 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
416 * [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
418 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
419 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
420 * passed directly to [`claim_funds`].
422 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
424 * [`claim_funds`]: Self::claim_funds
425 * [`PaymentReceived`]: events::Event::PaymentReceived
426 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
427 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
429 public TwoTuple<byte[], byte[]> create_inbound_payment(Option_u64Z min_value_msat, int invoice_expiry_delta_secs, long user_payment_id) {
430 long ret = bindings.ChannelManager_create_inbound_payment(this.ptr, min_value_msat.ptr, invoice_expiry_delta_secs, user_payment_id);
431 if (ret < 1024) { return null; }
432 byte[] ret_a = bindings.LDKC2Tuple_PaymentHashPaymentSecretZ_get_a(ret);
433 byte[] ret_b = bindings.LDKC2Tuple_PaymentHashPaymentSecretZ_get_b(ret);
434 TwoTuple<byte[], byte[]> ret_conv = new TwoTuple<byte[], byte[]>(ret_a, ret_b, () -> {
435 bindings.C2Tuple_PaymentHashPaymentSecretZ_free(ret);
441 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
442 * stored external to LDK.
444 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
445 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
446 * the `min_value_msat` provided here, if one is provided.
448 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
449 * method may return an Err if another payment with the same payment_hash is still pending.
451 * `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
452 * allow tracking of which events correspond with which calls to this and
453 * [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
454 * copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
455 * with invoice metadata stored elsewhere.
457 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
458 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
459 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
460 * sender \"proof-of-payment\" unless they have paid the required amount.
462 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
463 * in excess of the current time. This should roughly match the expiry time set in the invoice.
464 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
465 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
466 * invoices when no timeout is set.
468 * Note that we use block header time to time-out pending inbound payments (with some margin
469 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
470 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
471 * If you need exact expiry semantics, you should enforce them upon receipt of
472 * [`PaymentReceived`].
474 * Pending inbound payments are stored in memory and in serialized versions of this
475 * [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
476 * space is limited, you may wish to rate-limit inbound payment creation.
478 * May panic if `invoice_expiry_delta_secs` is greater than one year.
480 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
481 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
483 * [`create_inbound_payment`]: Self::create_inbound_payment
484 * [`PaymentReceived`]: events::Event::PaymentReceived
485 * [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
487 public Result_PaymentSecretAPIErrorZ create_inbound_payment_for_hash(byte[] payment_hash, Option_u64Z min_value_msat, int invoice_expiry_delta_secs, long user_payment_id) {
488 long ret = bindings.ChannelManager_create_inbound_payment_for_hash(this.ptr, payment_hash, min_value_msat.ptr, invoice_expiry_delta_secs, user_payment_id);
489 if (ret < 1024) { return null; }
490 Result_PaymentSecretAPIErrorZ ret_hu_conv = Result_PaymentSecretAPIErrorZ.constr_from_ptr(ret);
495 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
496 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
498 public MessageSendEventsProvider as_MessageSendEventsProvider() {
499 long ret = bindings.ChannelManager_as_MessageSendEventsProvider(this.ptr);
500 if (ret < 1024) { return null; }
501 MessageSendEventsProvider ret_hu_conv = new MessageSendEventsProvider(null, ret);
502 ret_hu_conv.ptrs_to.add(this);
507 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
508 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
510 public EventsProvider as_EventsProvider() {
511 long ret = bindings.ChannelManager_as_EventsProvider(this.ptr);
512 if (ret < 1024) { return null; }
513 EventsProvider ret_hu_conv = new EventsProvider(null, ret);
514 ret_hu_conv.ptrs_to.add(this);
519 * Constructs a new Listen which calls the relevant methods on this_arg.
520 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
522 public Listen as_Listen() {
523 long ret = bindings.ChannelManager_as_Listen(this.ptr);
524 if (ret < 1024) { return null; }
525 Listen ret_hu_conv = new Listen(null, ret);
526 ret_hu_conv.ptrs_to.add(this);
531 * Constructs a new Confirm which calls the relevant methods on this_arg.
532 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
534 public Confirm as_Confirm() {
535 long ret = bindings.ChannelManager_as_Confirm(this.ptr);
536 if (ret < 1024) { return null; }
537 Confirm ret_hu_conv = new Confirm(null, ret);
538 ret_hu_conv.ptrs_to.add(this);
543 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
544 * indicating whether persistence is necessary. Only one listener on
545 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
547 * Note that the feature `allow_wallclock_use` must be enabled to use this function.
549 public boolean await_persistable_update_timeout(long max_wait) {
550 boolean ret = bindings.ChannelManager_await_persistable_update_timeout(this.ptr, max_wait);
555 * Blocks until ChannelManager needs to be persisted. Only one listener on
556 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
559 public void await_persistable_update() {
560 bindings.ChannelManager_await_persistable_update(this.ptr);
564 * Gets the latest best block which was connected either via the [`chain::Listen`] or
565 * [`chain::Confirm`] interfaces.
567 public BestBlock current_best_block() {
568 long ret = bindings.ChannelManager_current_best_block(this.ptr);
569 if (ret < 1024) { return null; }
570 BestBlock ret_hu_conv = new BestBlock(null, ret);
571 ret_hu_conv.ptrs_to.add(this);
576 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
577 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
579 public ChannelMessageHandler as_ChannelMessageHandler() {
580 long ret = bindings.ChannelManager_as_ChannelMessageHandler(this.ptr);
581 if (ret < 1024) { return null; }
582 ChannelMessageHandler ret_hu_conv = new ChannelMessageHandler(null, ret);
583 ret_hu_conv.ptrs_to.add(this);
588 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
590 public byte[] write() {
591 byte[] ret = bindings.ChannelManager_write(this.ptr);