Update auto-updated Java files
[ldk-java] / src / main / java / org / ldk / structs / APIError.java
index 48152a61b9312c492ca6a168f29ad893ebb55436..a2e070f98f456db1a101f2d70960748451af31bf 100644 (file)
@@ -4,6 +4,7 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
 import javax.annotation.Nullable;
 
 
@@ -42,6 +43,10 @@ public class APIError extends CommonBase {
                assert false; return null; // Unreachable without extending the (internal) bindings interface
        }
 
+       /**
+        * Indicates the API was wholly misused (see err for more). Cases where these can be returned
+        * are documented, but generally indicates some precondition of a function was violated.
+        */
        public final static class APIMisuseError extends APIError {
                /**
                 * A human-readable error message
@@ -52,6 +57,11 @@ public class APIError extends CommonBase {
                        this.err = obj.err;
                }
        }
+       /**
+        * Due to a high feerate, we were unable to complete the request.
+        * For example, this may be returned if the feerate implies we cannot open a channel at the
+        * requested value, but opening a larger channel would succeed.
+        */
        public final static class FeeRateTooHigh extends APIError {
                /**
                 * A human-readable error message
@@ -67,6 +77,10 @@ public class APIError extends CommonBase {
                        this.feerate = obj.feerate;
                }
        }
+       /**
+        * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
+        * too-many-hops, etc).
+        */
        public final static class RouteError extends APIError {
                /**
                 * A human-readable error message
@@ -77,6 +91,11 @@ public class APIError extends CommonBase {
                        this.err = obj.err;
                }
        }
+       /**
+        * We were unable to complete the request as the Channel required to do so is unable to
+        * complete the request (or was not found). This can take many forms, including disconnected
+        * peer, channel at capacity, channel shutting down, etc.
+        */
        public final static class ChannelUnavailable extends APIError {
                /**
                 * A human-readable error message
@@ -87,11 +106,25 @@ public class APIError extends CommonBase {
                        this.err = obj.err;
                }
        }
+       /**
+        * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
+        * attempted action to fail.
+        */
        public final static class MonitorUpdateFailed extends APIError {
                private MonitorUpdateFailed(long ptr, bindings.LDKAPIError.MonitorUpdateFailed obj) {
                        super(null, ptr);
                }
        }
+       /**
+        * [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
+        * with the channel counterparty as negotiated in [`InitFeatures`].
+        * 
+        * Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
+        * a channel or cooperatively close one with this peer (and will have to force-close instead).
+        * 
+        * [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
+        * [`InitFeatures`]: crate::ln::features::InitFeatures
+        */
        public final static class IncompatibleShutdownScript extends APIError {
                /**
                 * The incompatible shutdown script.
@@ -100,17 +133,24 @@ public class APIError extends CommonBase {
                private IncompatibleShutdownScript(long ptr, bindings.LDKAPIError.IncompatibleShutdownScript obj) {
                        super(null, ptr);
                        long script = obj.script;
-                       ShutdownScript script_hu_conv = new ShutdownScript(null, script);
+                       ShutdownScript script_hu_conv = null; if (script < 0 || script > 4096) { script_hu_conv = new ShutdownScript(null, script); }
                        script_hu_conv.ptrs_to.add(this);
                        this.script = script_hu_conv;
                }
        }
+       long clone_ptr() {
+               long ret = bindings.APIError_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
        /**
         * Creates a copy of the APIError
         */
        public APIError clone() {
                long ret = bindings.APIError_clone(this.ptr);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
@@ -121,7 +161,8 @@ public class APIError extends CommonBase {
         */
        public static APIError apimisuse_error(java.lang.String err) {
                long ret = bindings.APIError_apimisuse_error(err);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(err);
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                return ret_hu_conv;
@@ -132,7 +173,9 @@ public class APIError extends CommonBase {
         */
        public static APIError fee_rate_too_high(java.lang.String err, int feerate) {
                long ret = bindings.APIError_fee_rate_too_high(err, feerate);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(err);
+               Reference.reachabilityFence(feerate);
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                return ret_hu_conv;
@@ -143,7 +186,8 @@ public class APIError extends CommonBase {
         */
        public static APIError route_error(java.lang.String err) {
                long ret = bindings.APIError_route_error(err);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(err);
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                return ret_hu_conv;
@@ -154,7 +198,8 @@ public class APIError extends CommonBase {
         */
        public static APIError channel_unavailable(java.lang.String err) {
                long ret = bindings.APIError_channel_unavailable(err);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(err);
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                return ret_hu_conv;
@@ -165,7 +210,7 @@ public class APIError extends CommonBase {
         */
        public static APIError monitor_update_failed() {
                long ret = bindings.APIError_monitor_update_failed();
-               if (ret < 1024) { return null; }
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
                return ret_hu_conv;
@@ -176,10 +221,10 @@ public class APIError extends CommonBase {
         */
        public static APIError incompatible_shutdown_script(ShutdownScript script) {
                long ret = bindings.APIError_incompatible_shutdown_script(script == null ? 0 : script.ptr & ~1);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(script);
+               if (ret >= 0 && ret <= 4096) { return null; }
                APIError ret_hu_conv = APIError.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);
-               ret_hu_conv.ptrs_to.add(script);
                return ret_hu_conv;
        }