Update auto-generated bindings

[ldk-java] / src / main / java / org / ldk / structs / ChannelManager.java

package org.ldk.structs;

import org.ldk.impl.bindings;
import org.ldk.enums.*;
import org.ldk.util.*;
import java.util.Arrays;


/**
 * Manager which keeps track of a number of channels and sends messages to the appropriate
 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
 * 
 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
 * to individual Channels.
 * 
 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
 * all peers during write/read (though does not modify this instance, only the instance being
 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
 * called funding_transaction_generated for outbound channels).
 * 
 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
 * the serialization process). If the deserialized version is out-of-date compared to the
 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
 * 
 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
 * block_connected() to step towards your best block) upon deserialization before using the
 * object!
 * 
 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
 * offline for a full minute. In order to track this, you must call
 * timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
 * 
 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
 * essentially you should default to using a SimpleRefChannelManager, and use a
 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
 * you're using lightning-net-tokio.
 */
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class ChannelManager extends CommonBase {
        ChannelManager(Object _dummy, long ptr) { super(ptr); }
        @Override @SuppressWarnings("deprecation")
        protected void finalize() throws Throwable {
                super.finalize();
                if (ptr != 0) { bindings.ChannelManager_free(ptr); }
        }

        /**
         * Constructs a new ChannelManager to hold several channels and route between them.
         * 
         * This is the main \"logic hub\" for all channel-related actions, and implements
         * ChannelMessageHandler.
         * 
         * Non-proportional fees are fixed according to our risk using the provided fee estimator.
         * 
         * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
         * 
         * Users need to notify the new ChannelManager when a new block is connected or
         * disconnected using its `block_connected` and `block_disconnected` methods, starting
         * from after `params.latest_hash`.
         */
        public static ChannelManager constructor_new(FeeEstimator fee_est, Watch chain_monitor, BroadcasterInterface tx_broadcaster, Logger logger, KeysInterface keys_manager, UserConfig config, LDKNetwork params_network_arg, byte[] params_latest_hash_arg, long params_latest_height_arg) {
                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, bindings.ChainParameters_new(params_network_arg, params_latest_hash_arg, params_latest_height_arg));
                ChannelManager ret_hu_conv = new ChannelManager(null, ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                ret_hu_conv.ptrs_to.add(fee_est);
                ret_hu_conv.ptrs_to.add(chain_monitor);
                ret_hu_conv.ptrs_to.add(tx_broadcaster);
                ret_hu_conv.ptrs_to.add(logger);
                ret_hu_conv.ptrs_to.add(keys_manager);
                ret_hu_conv.ptrs_to.add(config);
                return ret_hu_conv;
        }

        /**
         * Creates a new outbound channel to the given remote node and with the given value.
         * 
         * user_id will be provided back as user_channel_id in FundingGenerationReady and
         * FundingBroadcastSafe events to allow tracking of which events correspond with which
         * create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
         * may wish to avoid using 0 for user_id here.
         * 
         * If successful, will generate a SendOpenChannel message event, so you should probably poll
         * PeerManager::process_events afterwards.
         * 
         * Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
         * greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
         */
        public Result_NoneAPIErrorZ create_channel(byte[] their_network_key, long channel_value_satoshis, long push_msat, long user_id, UserConfig override_config) {
                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);
                Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
                this.ptrs_to.add(override_config);
                return ret_hu_conv;
        }

        /**
         * Gets the list of open channels, in random order. See ChannelDetail field documentation for
         * more information.
         */
        public ChannelDetails[] list_channels() {
                long[] ret = bindings.ChannelManager_list_channels(this.ptr);
                ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret.length];
                for (int q = 0; q < ret.length; q++) {
                        long ret_conv_16 = ret[q];
                        ChannelDetails ret_conv_16_hu_conv = new ChannelDetails(null, ret_conv_16);
                        ret_conv_16_hu_conv.ptrs_to.add(this);
                        ret_conv_16_arr[q] = ret_conv_16_hu_conv;
                }
                return ret_conv_16_arr;
        }

        /**
         * Gets the list of usable channels, in random order. Useful as an argument to
         * get_route to ensure non-announced channels are used.
         * 
         * These are guaranteed to have their is_live value set to true, see the documentation for
         * ChannelDetails::is_live for more info on exactly what the criteria are.
         */
        public ChannelDetails[] list_usable_channels() {
                long[] ret = bindings.ChannelManager_list_usable_channels(this.ptr);
                ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret.length];
                for (int q = 0; q < ret.length; q++) {
                        long ret_conv_16 = ret[q];
                        ChannelDetails ret_conv_16_hu_conv = new ChannelDetails(null, ret_conv_16);
                        ret_conv_16_hu_conv.ptrs_to.add(this);
                        ret_conv_16_arr[q] = ret_conv_16_hu_conv;
                }
                return ret_conv_16_arr;
        }

        /**
         * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
         * will be accepted on the given channel, and after additional timeout/the closing of all
         * pending HTLCs, the channel will be closed on chain.
         * 
         * May generate a SendShutdown message event on success, which should be relayed.
         */
        public Result_NoneAPIErrorZ close_channel(byte[] channel_id) {
                long ret = bindings.ChannelManager_close_channel(this.ptr, channel_id);
                Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }

        /**
         * Force closes a channel, immediately broadcasting the latest local commitment transaction to
         * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
         */
        public Result_NoneAPIErrorZ force_close_channel(byte[] channel_id) {
                long ret = bindings.ChannelManager_force_close_channel(this.ptr, channel_id);
                Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }

        /**
         * Force close all channels, immediately broadcasting the latest local commitment transaction
         * for each to the chain and rejecting new HTLCs on each.
         */
        public void force_close_all_channels() {
                bindings.ChannelManager_force_close_all_channels(this.ptr);
        }

        /**
         * Sends a payment along a given route.
         * 
         * Value parameters are provided via the last hop in route, see documentation for RouteHop
         * fields for more info.
         * 
         * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
         * payment), we don't do anything to stop you! We always try to ensure that if the provided
         * next hop knows the preimage to payment_hash they can claim an additional amount as
         * specified in the last hop in the route! Thus, you should probably do your own
         * payment_preimage tracking (which you should already be doing as they represent \"proof of
         * payment\") and prevent double-sends yourself.
         * 
         * May generate SendHTLCs message(s) event on success, which should be relayed.
         * 
         * Each path may have a different return value, and PaymentSendValue may return a Vec with
         * each entry matching the corresponding-index entry in the route paths, see
         * PaymentSendFailure for more info.
         * 
         * In general, a path may raise:
         * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
         * node public key) is specified.
         * APIError::ChannelUnavailable if the next-hop channel is not available for updates
         * (including due to previous monitor update failure or new permanent monitor update
         * failure).
         * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
         * relevant updates.
         * 
         * Note that depending on the type of the PaymentSendFailure the HTLC may have been
         * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
         * different route unless you intend to pay twice!
         * 
         * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
         * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
         * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
         * must not contain multiple paths as multi-path payments require a recipient-provided
         * payment_secret.
         * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
         * bit set (either as required or as available). If multiple paths are present in the Route,
         * we assume the invoice had the basic_mpp feature set.
         */
        public Result_NonePaymentSendFailureZ send_payment(Route route, byte[] payment_hash, byte[] payment_secret) {
                long ret = bindings.ChannelManager_send_payment(this.ptr, route == null ? 0 : route.ptr & ~1, payment_hash, payment_secret);
                Result_NonePaymentSendFailureZ ret_hu_conv = Result_NonePaymentSendFailureZ.constr_from_ptr(ret);
                this.ptrs_to.add(route);
                return ret_hu_conv;
        }

        /**
         * Call this upon creation of a funding transaction for the given channel.
         * 
         * Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
         * or your counterparty can steal your funds!
         * 
         * Panics if a funding transaction has already been provided for this channel.
         * 
         * May panic if the funding_txo is duplicative with some other channel (note that this should
         * be trivially prevented by using unique funding transaction keys per-channel).
         */
        public void funding_transaction_generated(byte[] temporary_channel_id, OutPoint funding_txo) {
                bindings.ChannelManager_funding_transaction_generated(this.ptr, temporary_channel_id, funding_txo == null ? 0 : funding_txo.ptr & ~1);
                this.ptrs_to.add(funding_txo);
        }

        /**
         * Generates a signed node_announcement from the given arguments and creates a
         * BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
         * seen a channel_announcement from us (ie unless we have public channels open).
         * 
         * RGB is a node \"color\" and alias is a printable human-readable string to describe this node
         * to humans. They carry no in-protocol meaning.
         * 
         * addresses represent the set (possibly empty) of socket addresses on which this node accepts
         * incoming connections. These will be broadcast to the network, publicly tying these
         * addresses together. If you wish to preserve user privacy, addresses should likely contain
         * only Tor Onion addresses.
         * 
         * Panics if addresses is absurdly large (more than 500).
         */
        public void broadcast_node_announcement(byte[] rgb, byte[] alias, NetAddress[] addresses) {
                bindings.ChannelManager_broadcast_node_announcement(this.ptr, rgb, alias, Arrays.stream(addresses).mapToLong(addresses_conv_12 -> addresses_conv_12.ptr).toArray());
                /* TODO 2 NetAddress  */;
        }

        /**
         * Processes HTLCs which are pending waiting on random forward delay.
         * 
         * Should only really ever be called in response to a PendingHTLCsForwardable event.
         * Will likely generate further events.
         */
        public void process_pending_htlc_forwards() {
                bindings.ChannelManager_process_pending_htlc_forwards(this.ptr);
        }

        /**
         * If a peer is disconnected we mark any channels with that peer as 'disabled'.
         * After some time, if channels are still disabled we need to broadcast a ChannelUpdate
         * to inform the network about the uselessness of these channels.
         * 
         * This method handles all the details, and must be called roughly once per minute.
         * 
         * Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
         */
        public void timer_chan_freshness_every_min() {
                bindings.ChannelManager_timer_chan_freshness_every_min(this.ptr);
        }

        /**
         * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
         * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
         * along the path (including in our own channel on which we received it).
         * Returns false if no payment was found to fail backwards, true if the process of failing the
         * HTLC backwards has been started.
         */
        public boolean fail_htlc_backwards(byte[] payment_hash, byte[] payment_secret) {
                boolean ret = bindings.ChannelManager_fail_htlc_backwards(this.ptr, payment_hash, payment_secret);
                return ret;
        }

        /**
         * Provides a payment preimage in response to a PaymentReceived event, returning true and
         * generating message events for the net layer to claim the payment, if possible. Thus, you
         * should probably kick the net layer to go send messages if this returns true!
         * 
         * You must specify the expected amounts for this HTLC, and we will only claim HTLCs
         * available within a few percent of the expected amount. This is critical for several
         * reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
         * payment_preimage without having provided the full value and b) it avoids certain
         * privacy-breaking recipient-probing attacks which may reveal payment activity to
         * motivated attackers.
         * 
         * Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
         * set. Thus, for such payments we will claim any payments which do not under-pay.
         * 
         * May panic if called except in response to a PaymentReceived event.
         */
        public boolean claim_funds(byte[] payment_preimage, byte[] payment_secret, long expected_amount) {
                boolean ret = bindings.ChannelManager_claim_funds(this.ptr, payment_preimage, payment_secret, expected_amount);
                return ret;
        }

        /**
         * Gets the node_id held by this ChannelManager
         */
        public byte[] get_our_node_id() {
                byte[] ret = bindings.ChannelManager_get_our_node_id(this.ptr);
                return ret;
        }

        /**
         * Restores a single, given channel to normal operation after a
         * ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
         * operation.
         * 
         * All ChannelMonitor updates up to and including highest_applied_update_id must have been
         * fully committed in every copy of the given channels' ChannelMonitors.
         * 
         * Note that there is no effect to calling with a highest_applied_update_id other than the
         * current latest ChannelMonitorUpdate and one call to this function after multiple
         * ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
         * exists largely only to prevent races between this and concurrent update_monitor calls.
         * 
         * Thus, the anticipated use is, at a high level:
         * 1) You register a chain::Watch with this ChannelManager,
         * 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
         * said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
         * any time it cannot do so instantly,
         * 3) update(s) are applied to each remote copy of a ChannelMonitor,
         * 4) once all remote copies are updated, you call this function with the update_id that
         * completed, and once it is the latest the Channel will be re-enabled.
         */
        public void channel_monitor_updated(OutPoint funding_txo, long highest_applied_update_id) {
                bindings.ChannelManager_channel_monitor_updated(this.ptr, funding_txo == null ? 0 : funding_txo.ptr & ~1, highest_applied_update_id);
                this.ptrs_to.add(funding_txo);
        }

        /**
         * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
         * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
         */
        public MessageSendEventsProvider as_MessageSendEventsProvider() {
                long ret = bindings.ChannelManager_as_MessageSendEventsProvider(this.ptr);
                MessageSendEventsProvider ret_hu_conv = new MessageSendEventsProvider(null, ret);
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }

        /**
         * Constructs a new EventsProvider which calls the relevant methods on this_arg.
         * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
         */
        public EventsProvider as_EventsProvider() {
                long ret = bindings.ChannelManager_as_EventsProvider(this.ptr);
                EventsProvider ret_hu_conv = new EventsProvider(null, ret);
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }

        /**
         * Constructs a new Listen which calls the relevant methods on this_arg.
         * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
         */
        public Listen as_Listen() {
                long ret = bindings.ChannelManager_as_Listen(this.ptr);
                Listen ret_hu_conv = new Listen(null, ret);
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }

        /**
         * Updates channel state based on transactions seen in a connected block.
         */
        public void block_connected(byte[] header, TwoTuple<Long, byte[]>[] txdata, int height) {
                bindings.ChannelManager_block_connected(this.ptr, header, Arrays.stream(txdata).mapToLong(txdata_conv_24 -> bindings.C2Tuple_usizeTransactionZ_new(txdata_conv_24.a, txdata_conv_24.b)).toArray(), height);
                /* TODO 2 TwoTuple<Long, byte[]>  */;
        }

        /**
         * Updates channel state based on a disconnected block.
         * 
         * If necessary, the channel may be force-closed without letting the counterparty participate
         * in the shutdown.
         */
        public void block_disconnected(byte[] header) {
                bindings.ChannelManager_block_disconnected(this.ptr, header);
        }

        /**
         * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
         * indicating whether persistence is necessary. Only one listener on
         * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
         * up.
         * Note that the feature `allow_wallclock_use` must be enabled to use this function.
         */
        public boolean await_persistable_update_timeout(long max_wait) {
                boolean ret = bindings.ChannelManager_await_persistable_update_timeout(this.ptr, max_wait);
                return ret;
        }

        /**
         * Blocks until ChannelManager needs to be persisted. Only one listener on
         * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
         * up.
         */
        public void await_persistable_update() {
                bindings.ChannelManager_await_persistable_update(this.ptr);
        }

        /**
         * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
         * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
         */
        public ChannelMessageHandler as_ChannelMessageHandler() {
                long ret = bindings.ChannelManager_as_ChannelMessageHandler(this.ptr);
                ChannelMessageHandler ret_hu_conv = new ChannelMessageHandler(null, ret);
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }

        /**
         * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
         */
        public byte[] write() {
                byte[] ret = bindings.ChannelManager_write(this.ptr);
                return ret;
        }

}