]> git.bitcoin.ninja Git - ldk-java/blobdiff - c_sharp/src/org/ldk/structs/ChainMonitor.cs
[C#] Update auto-generated C# bindings
[ldk-java] / c_sharp / src / org / ldk / structs / ChainMonitor.cs
index 9ed40b58ef1b9230ba786ca6caf4ae91cdd85931..b3285516b222b3eaded165ebd9a3736d502a947b 100644 (file)
@@ -14,8 +14,15 @@ namespace org { namespace ldk { namespace structs {
  * or used independently to monitor channels remotely. See the [module-level documentation] for
  * details.
  * 
+ * Note that `ChainMonitor` should regularly trigger rebroadcasts/fee bumps of pending claims from
+ * a force-closed channel. This is crucial in preventing certain classes of pinning attacks,
+ * detecting substantial mempool feerate changes between blocks, and ensuring reliability if
+ * broadcasting fails. We recommend invoking this every 30 seconds, or lower if running in an
+ * environment with spotty connections, like on mobile.
+ * 
  * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
  * [module-level documentation]: crate::chain::chainmonitor
+ * [`rebroadcast_pending_claims`]: Self::rebroadcast_pending_claims
  */
 public class ChainMonitor : CommonBase {
        internal ChainMonitor(object _dummy, long ptr) : base(ptr) { }
@@ -33,7 +40,7 @@ public class ChainMonitor : CommonBase {
         * transactions relevant to the watched channels.
         */
        public static ChainMonitor of(org.ldk.structs.Option_FilterZ chain_source, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.Logger logger, org.ldk.structs.FeeEstimator feeest, org.ldk.structs.Persist persister) {
-               long ret = bindings.ChainMonitor_new(chain_source.ptr, broadcaster == null ? 0 : broadcaster.ptr, logger == null ? 0 : logger.ptr, feeest == null ? 0 : feeest.ptr, persister == null ? 0 : persister.ptr);
+               long ret = bindings.ChainMonitor_new(chain_source.ptr, broadcaster.ptr, logger.ptr, feeest.ptr, persister.ptr);
                GC.KeepAlive(chain_source);
                GC.KeepAlive(broadcaster);
                GC.KeepAlive(logger);
@@ -62,17 +69,19 @@ public class ChainMonitor : CommonBase {
         * inclusion in the return value.
         */
        public Balance[] get_claimable_balances(ChannelDetails[] ignored_channels) {
-               long[] ret = bindings.ChainMonitor_get_claimable_balances(this.ptr, ignored_channels != null ? InternalUtils.mapArray(ignored_channels, ignored_channels_conv_16 => ignored_channels_conv_16 == null ? 0 : ignored_channels_conv_16.ptr) : null);
+               long ret = bindings.ChainMonitor_get_claimable_balances(this.ptr, InternalUtils.encodeUint64Array(InternalUtils.mapArray(ignored_channels, ignored_channels_conv_16 => ignored_channels_conv_16 == null ? 0 : ignored_channels_conv_16.ptr)));
                GC.KeepAlive(this);
                GC.KeepAlive(ignored_channels);
-               int ret_conv_9_len = ret.Length;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               int ret_conv_9_len = InternalUtils.getArrayLength(ret);
                Balance[] ret_conv_9_arr = new Balance[ret_conv_9_len];
                for (int j = 0; j < ret_conv_9_len; j++) {
-                       long ret_conv_9 = ret[j];
+                       long ret_conv_9 = InternalUtils.getU64ArrayElem(ret, j);
                        org.ldk.structs.Balance ret_conv_9_hu_conv = org.ldk.structs.Balance.constr_from_ptr(ret_conv_9);
                        if (ret_conv_9_hu_conv != null) { ret_conv_9_hu_conv.ptrs_to.AddLast(this); };
                        ret_conv_9_arr[j] = ret_conv_9_hu_conv;
                }
+               bindings.free_buffer(ret);
                foreach (ChannelDetails ignored_channels_conv_16 in ignored_channels) { if (this != null) { this.ptrs_to.AddLast(ignored_channels_conv_16); }; };
                return ret_conv_9_arr;
        }
@@ -101,16 +110,18 @@ public class ChainMonitor : CommonBase {
         * monitoring for on-chain state resolutions.
         */
        public OutPoint[] list_monitors() {
-               long[] ret = bindings.ChainMonitor_list_monitors(this.ptr);
+               long ret = bindings.ChainMonitor_list_monitors(this.ptr);
                GC.KeepAlive(this);
-               int ret_conv_10_len = ret.Length;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               int ret_conv_10_len = InternalUtils.getArrayLength(ret);
                OutPoint[] ret_conv_10_arr = new OutPoint[ret_conv_10_len];
                for (int k = 0; k < ret_conv_10_len; k++) {
-                       long ret_conv_10 = ret[k];
+                       long ret_conv_10 = InternalUtils.getU64ArrayElem(ret, k);
                        org.ldk.structs.OutPoint ret_conv_10_hu_conv = null; if (ret_conv_10 < 0 || ret_conv_10 > 4096) { ret_conv_10_hu_conv = new org.ldk.structs.OutPoint(null, ret_conv_10); }
                        if (ret_conv_10_hu_conv != null) { ret_conv_10_hu_conv.ptrs_to.AddLast(this); };
                        ret_conv_10_arr[k] = ret_conv_10_hu_conv;
                }
+               bindings.free_buffer(ret);
                return ret_conv_10_arr;
        }
 
@@ -118,16 +129,18 @@ public class ChainMonitor : CommonBase {
         * Lists the pending updates for each [`ChannelMonitor`] (by `OutPoint` being monitored).
         */
        public TwoTuple_OutPointCVec_MonitorUpdateIdZZ[] list_pending_monitor_updates() {
-               long[] ret = bindings.ChainMonitor_list_pending_monitor_updates(this.ptr);
+               long ret = bindings.ChainMonitor_list_pending_monitor_updates(this.ptr);
                GC.KeepAlive(this);
-               int ret_conv_41_len = ret.Length;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               int ret_conv_41_len = InternalUtils.getArrayLength(ret);
                TwoTuple_OutPointCVec_MonitorUpdateIdZZ[] ret_conv_41_arr = new TwoTuple_OutPointCVec_MonitorUpdateIdZZ[ret_conv_41_len];
                for (int p = 0; p < ret_conv_41_len; p++) {
-                       long ret_conv_41 = ret[p];
+                       long ret_conv_41 = InternalUtils.getU64ArrayElem(ret, p);
                        TwoTuple_OutPointCVec_MonitorUpdateIdZZ ret_conv_41_hu_conv = new TwoTuple_OutPointCVec_MonitorUpdateIdZZ(null, ret_conv_41);
                        if (ret_conv_41_hu_conv != null) { ret_conv_41_hu_conv.ptrs_to.AddLast(this); };
                        ret_conv_41_arr[p] = ret_conv_41_hu_conv;
                }
+               bindings.free_buffer(ret);
                return ret_conv_41_arr;
        }
 
@@ -158,6 +171,37 @@ public class ChainMonitor : CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Gets a [`Future`] that completes when an event is available either via
+        * [`chain::Watch::release_pending_monitor_events`] or
+        * [`EventsProvider::process_pending_events`].
+        * 
+        * Note that callbacks registered on the [`Future`] MUST NOT call back into this
+        * [`ChainMonitor`] and should instead register actions to be taken later.
+        * 
+        * [`EventsProvider::process_pending_events`]: crate::events::EventsProvider::process_pending_events
+        */
+       public Future get_update_future() {
+               long ret = bindings.ChainMonitor_get_update_future(this.ptr);
+               GC.KeepAlive(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Future ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Future(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
+        * crucial in preventing certain classes of pinning attacks, detecting substantial mempool
+        * feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
+        * invoking this every 30 seconds, or lower if running in an environment with spotty
+        * connections, like on mobile.
+        */
+       public void rebroadcast_pending_claims() {
+               bindings.ChainMonitor_rebroadcast_pending_claims(this.ptr);
+               GC.KeepAlive(this);
+       }
+
        /**
         * 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